app-connection.test.ts•11.1 kB
import {
DefaultProjectRole,
PackageType,
PlatformRole,
PrincipalType,
ProjectRole,
} from '@activepieces/shared'
import { FastifyBaseLogger, FastifyInstance } from 'fastify'
import { StatusCodes } from 'http-status-codes'
import { initializeDatabase } from '../../../../src/app/database'
import { databaseConnection } from '../../../../src/app/database/database-connection'
import { pieceMetadataService } from '../../../../src/app/pieces/piece-metadata-service'
import { setupServer } from '../../../../src/app/server'
import { generateMockToken } from '../../../helpers/auth'
import {
createMockPieceMetadata,
createMockProjectMember,
mockAndSaveBasicSetup,
mockBasicUser,
} from '../../../helpers/mocks'
let app: FastifyInstance | null = null
let mockLog: FastifyBaseLogger
beforeAll(async () => {
await initializeDatabase({ runMigrations: false })
app = await setupServer()
mockLog = app!.log!
})
afterAll(async () => {
await databaseConnection().destroy()
await app?.close()
})
describe('AppConnection API', () => {
describe('Upsert AppConnection endpoint', () => {
it('Succeeds with metadata field', async () => {
// arrange
const { mockPlatform, mockProject } = await mockAndSaveBasicSetup()
const { mockUser } = await mockBasicUser({
user: {
platformId: mockPlatform.id,
platformRole: PlatformRole.ADMIN,
},
})
const mockPieceMetadata = createMockPieceMetadata({
projectId: mockProject.id,
platformId: mockPlatform.id,
packageType: PackageType.REGISTRY,
})
await databaseConnection().getRepository('piece_metadata').save([mockPieceMetadata])
pieceMetadataService(mockLog).getOrThrow = jest.fn().mockResolvedValue(mockPieceMetadata)
const mockToken = await generateMockToken({
id: mockUser.id,
type: PrincipalType.USER,
projectId: mockProject.id,
platform: {
id: mockPlatform.id,
},
})
const mockUpsertAppConnectionRequest = {
externalId: 'test-app-connection-with-metadata',
displayName: 'Test Connection with Metadata',
pieceName: mockPieceMetadata.name,
projectId: mockProject.id,
type: 'SECRET_TEXT',
value: {
type: 'SECRET_TEXT',
secret_text: 'test-secret-text',
},
metadata: {
foo: 'bar',
},
}
// act
const response = await app?.inject({
method: 'POST',
url: '/v1/app-connections',
headers: {
authorization: `Bearer ${mockToken}`,
},
body: mockUpsertAppConnectionRequest,
})
// assert
expect(response?.statusCode).toBe(StatusCodes.CREATED)
const responseBody = response?.json()
expect(responseBody.metadata).toEqual(mockUpsertAppConnectionRequest.metadata)
// Verify connection can be updated with new metadata
const updateResponse = await app?.inject({
method: 'POST',
url: `/v1/app-connections/${responseBody.id}`,
headers: {
authorization: `Bearer ${mockToken}`,
},
body: {
displayName: 'Updated Connection Name',
metadata: {
foo: 'baz',
},
},
})
expect(updateResponse?.statusCode).toBe(StatusCodes.OK)
const updatedResponseBody = updateResponse?.json()
expect(updatedResponseBody.metadata).toEqual({
foo: 'baz',
})
})
it.each([
DefaultProjectRole.ADMIN,
DefaultProjectRole.EDITOR,
])('Succeeds if user role is %s', async (testRole) => {
// arrange
const { mockPlatform, mockProject } = await mockAndSaveBasicSetup()
const { mockUser } = await mockBasicUser({
user: {
platformId: mockPlatform.id,
platformRole: PlatformRole.MEMBER,
},
})
const projectRole = await databaseConnection().getRepository('project_role').findOneByOrFail({ name: testRole }) as ProjectRole
const mockProjectMember = createMockProjectMember({
userId: mockUser.id,
platformId: mockPlatform.id,
projectId: mockProject.id,
projectRoleId: projectRole.id,
})
await databaseConnection().getRepository('project_member').save([mockProjectMember])
const mockPieceMetadata = createMockPieceMetadata({
projectId: mockProject.id,
platformId: mockPlatform.id,
packageType: PackageType.REGISTRY,
})
await databaseConnection().getRepository('piece_metadata').save([mockPieceMetadata])
pieceMetadataService(mockLog).getOrThrow = jest.fn().mockResolvedValue(mockPieceMetadata)
const mockToken = await generateMockToken({
id: mockUser.id,
type: PrincipalType.USER,
projectId: mockProject.id,
platform: {
id: mockPlatform.id,
},
})
const mockUpsertAppConnectionRequest = {
externalId: 'test-app-connection',
displayName: 'test-app-connection',
pieceName: mockPieceMetadata.name,
projectId: mockProject.id,
type: 'SECRET_TEXT',
value: {
type: 'SECRET_TEXT',
secret_text: 'test-secret-text',
},
}
// act
const response = await app?.inject({
method: 'POST',
url: '/v1/app-connections',
headers: {
authorization: `Bearer ${mockToken}`,
},
body: mockUpsertAppConnectionRequest,
})
// assert
expect(response?.statusCode).toBe(StatusCodes.CREATED)
})
it('Fails if user role is VIEWER', async () => {
// arrange
const { mockPlatform, mockProject } = await mockAndSaveBasicSetup()
const { mockUser } = await mockBasicUser({
user: {
platformId: mockPlatform.id,
platformRole: PlatformRole.MEMBER,
},
})
const projectRole = await databaseConnection().getRepository('project_role').findOneByOrFail({ name: DefaultProjectRole.VIEWER }) as ProjectRole
const mockProjectMember = createMockProjectMember({
userId: mockUser.id,
platformId: mockPlatform.id,
projectId: mockProject.id,
projectRoleId: projectRole.id,
})
await databaseConnection().getRepository('project_member').save([mockProjectMember])
const mockPieceMetadata = createMockPieceMetadata({
projectId: mockProject.id,
platformId: mockPlatform.id,
})
await databaseConnection().getRepository('piece_metadata').save([mockPieceMetadata])
pieceMetadataService(mockLog).getOrThrow = jest.fn().mockResolvedValue(mockPieceMetadata)
const mockToken = await generateMockToken({
id: mockUser.id,
type: PrincipalType.USER,
projectId: mockProject.id,
platform: {
id: mockPlatform.id,
},
})
const mockUpsertAppConnectionRequest = {
externalId: 'test-app-connection',
displayName: 'test-app-connection',
pieceName: mockPieceMetadata.name,
projectId: mockProject.id,
type: 'SECRET_TEXT',
value: {
type: 'SECRET_TEXT',
secret_text: 'test-secret-text',
},
}
// act
const response = await app?.inject({
method: 'POST',
url: '/v1/app-connections',
headers: {
authorization: `Bearer ${mockToken}`,
},
body: mockUpsertAppConnectionRequest,
})
// assert
expect(response?.statusCode).toBe(StatusCodes.FORBIDDEN)
const responseBody = response?.json()
expect(responseBody?.code).toBe('PERMISSION_DENIED')
expect(responseBody?.params?.userId).toBe(mockUser.id)
expect(responseBody?.params?.projectId).toBe(mockProject.id)
})
})
describe('List AppConnections endpoint', () => {
it.each([
DefaultProjectRole.ADMIN,
DefaultProjectRole.EDITOR,
DefaultProjectRole.VIEWER,
])('Succeeds if user role is %s', async (testRole) => {
// arrange
const { mockPlatform, mockProject } = await mockAndSaveBasicSetup()
const { mockUser } = await mockBasicUser({
user: {
platformId: mockPlatform.id,
platformRole: PlatformRole.MEMBER,
},
})
const projectRole = await databaseConnection().getRepository('project_role').findOneByOrFail({ name: testRole }) as ProjectRole
const mockProjectMember = createMockProjectMember({
userId: mockUser.id,
platformId: mockPlatform.id,
projectId: mockProject.id,
projectRoleId: projectRole.id,
})
await databaseConnection().getRepository('project_member').save([mockProjectMember])
const mockToken = await generateMockToken({
id: mockUser.id,
type: PrincipalType.USER,
projectId: mockProject.id,
platform: {
id: mockPlatform.id,
},
})
// act
const response = await app?.inject({
method: 'GET',
url: '/v1/app-connections',
headers: {
authorization: `Bearer ${mockToken}`,
},
query: {
projectId: mockProject.id,
},
})
// assert
expect(response?.statusCode).toBe(StatusCodes.OK)
})
})
})