Skip to content

AI Agents & MCPs & AI Workflow Automation • (~400 MCP servers for AI agents) • AI Automation / AI Agent with MCPs • AI Workflows & AI Agents • MCPs for AI Agents

6.0 KB
Raw Blame
import { apId, Permission, RoleType } from '@activepieces/core-utils'
import {
    AppConnectionType,
    DefaultProjectRole,
    PackageType,
} from '@activepieces/shared'
import { FastifyBaseLogger, FastifyInstance } from 'fastify'
import { StatusCodes } from 'http-status-codes'
import { pieceMetadataService } from '../../../../src/app/pieces/metadata/piece-metadata-service'
import { db } from '../../../helpers/db'
import {
    createMockPieceMetadata,
    createMockProjectRole,
} from '../../../helpers/mocks'
import { describeRolePermissions } from '../../../helpers/permission-test'
import { createMemberContext, createTestContext } from '../../../helpers/test-context'
import { setupTestEnvironment, teardownTestEnvironment } from '../../../helpers/test-setup'

let app: FastifyInstance | null = null
let mockLog: FastifyBaseLogger

beforeAll(async () => {
    app = await setupTestEnvironment()
    mockLog = app!.log!
})

afterAll(async () => {
    await teardownTestEnvironment()
})

describe('AppConnection API', () => {
    describe('Upsert AppConnection endpoint', () => {
        it('Succeeds with metadata field', async () => {
            const ctx = await createTestContext(app!)

            const mockPieceMetadata = createMockPieceMetadata({
                platformId: ctx.platform.id,
                packageType: PackageType.REGISTRY,
            })
            await db.save('piece_metadata', mockPieceMetadata)
            pieceMetadataService(mockLog).getOrThrow = vi.fn().mockResolvedValue(mockPieceMetadata)

            const response = await ctx.post('/v1/app-connections', {
                externalId: 'test-app-connection-with-metadata',
                displayName: 'Test Connection with Metadata',
                pieceName: mockPieceMetadata.name,
                projectId: ctx.project.id,
                type: AppConnectionType.SECRET_TEXT,
                value: {
                    type: AppConnectionType.SECRET_TEXT,
                    secret_text: 'test-secret-text',
                },
                metadata: { foo: 'bar' },
                pieceVersion: mockPieceMetadata.version,
            })

            expect(response?.statusCode).toBe(StatusCodes.CREATED)
            const responseBody = response?.json()
            expect(responseBody.metadata).toEqual({ foo: 'bar' })
            expect(responseBody.pieceVersion).toEqual(mockPieceMetadata.version)

            const updateResponse = await ctx.post(`/v1/app-connections/${responseBody.id}`, {
                displayName: 'Updated Connection Name',
                metadata: { foo: 'baz' },
            })

            expect(updateResponse?.statusCode).toBe(StatusCodes.OK)
            const updatedResponseBody = updateResponse?.json()
            expect(updatedResponseBody.metadata).toEqual({ foo: 'baz' })
        })

        describeRolePermissions({
            app: () => app!,
            request: async (memberCtx, ownerCtx) => {
                const mockPieceMetadata = createMockPieceMetadata({
                    platformId: ownerCtx.platform.id,
                    packageType: PackageType.REGISTRY,
                })
                await db.save('piece_metadata', mockPieceMetadata)
                pieceMetadataService(mockLog).getOrThrow = vi.fn().mockResolvedValue(mockPieceMetadata)

                return memberCtx.post('/v1/app-connections', {
                    externalId: 'test-app-connection',
                    displayName: 'test-app-connection',
                    pieceName: mockPieceMetadata.name,
                    projectId: ownerCtx.project.id,
                    type: AppConnectionType.SECRET_TEXT,
                    value: {
                        type: AppConnectionType.SECRET_TEXT,
                        secret_text: 'test-secret-text',
                    },
                    pieceVersion: mockPieceMetadata.version,
                })
            },
            allowedRoles: [DefaultProjectRole.ADMIN, DefaultProjectRole.EDITOR],
            forbiddenRoles: [DefaultProjectRole.VIEWER],
        })
    })

    describe('List AppConnections endpoint', () => {
        describeRolePermissions({
            app: () => app!,
            request: (memberCtx, ownerCtx) => {
                return memberCtx.get('/v1/app-connections', {
                    projectId: ownerCtx.project.id,
                })
            },
            allowedRoles: [DefaultProjectRole.ADMIN, DefaultProjectRole.EDITOR, DefaultProjectRole.VIEWER],
            forbiddenRoles: [],
        })
    })

    describe('Replace AppConnections endpoint', () => {
        describeRolePermissions({
            app: () => app!,
            request: (memberCtx, ownerCtx) => {
                return memberCtx.post('/v1/app-connections/replace', {
                    sourceAppConnectionId: apId(),
                    targetAppConnectionId: apId(),
                    projectId: ownerCtx.project.id,
                    flowIds: [apId()],
                })
            },
            allowedRoles: [DefaultProjectRole.ADMIN, DefaultProjectRole.EDITOR],
            forbiddenRoles: [DefaultProjectRole.VIEWER],
        })

        it('Fails for a custom role that can write connections but not replace them', async () => {
            const ctx = await createTestContext(app!)
            const role = createMockProjectRole({
                platformId: ctx.platform.id,
                name: `custom-${apId()}`,
                permissions: [Permission.READ_APP_CONNECTION, Permission.WRITE_APP_CONNECTION],
                type: RoleType.CUSTOM,
            })
            await db.save('project_role', role)
            const memberCtx = await createMemberContext(app!, ctx, { projectRole: role.name })

            const response = await memberCtx.post('/v1/app-connections/replace', {
                sourceAppConnectionId: apId(),
                targetAppConnectionId: apId(),
                projectId: ctx.project.id,
                flowIds: [apId()],
            })

            expect(response.statusCode).toBe(StatusCodes.FORBIDDEN)
        })
    })
})