Compare commits

...

2 Commits

Author SHA1 Message Date
DarkSky
774c537f0e fix: prisma client import 2025-02-20 10:07:38 +08:00
darkskygit
c954d22844 feat(server): online copilot api test (#8807) 2025-02-19 11:59:10 +08:00
8 changed files with 460 additions and 224 deletions

View File

@@ -534,7 +534,8 @@ jobs:
filters: |
changed:
- 'packages/backend/server/src/plugins/copilot/**'
- 'packages/backend/server/tests/copilot.*'
- 'packages/backend/server/tests/copilot*'
- 'tests/affine-cloud-copilot/**'
- name: Setup Node.js
if: ${{ steps.check-blocksuite-update.outputs.skip != 'true' || steps.apifilter.outputs.changed == 'true' }}
@@ -556,7 +557,7 @@ jobs:
- name: Run server tests
if: ${{ steps.check-blocksuite-update.outputs.skip != 'true' || steps.apifilter.outputs.changed == 'true' }}
run: yarn affine @affine/server test:copilot:coverage --forbid-only
run: yarn affine @affine/server test:copilot:spec:coverage --forbid-only
env:
CARGO_TARGET_DIR: '${{ github.workspace }}/target'
COPILOT_OPENAI_API_KEY: ${{ secrets.COPILOT_OPENAI_API_KEY }}

View File

@@ -38,6 +38,16 @@ jobs:
DISTRIBUTION: web
DATABASE_URL: postgresql://affine:affine@localhost:5432/affine
REDIS_SERVER_HOST: localhost
strategy:
fail-fast: false
matrix:
spec:
- {
name: e2e,
package: '@affine-test/affine-cloud-copilot',
type: e2e,
}
- { name: spec, package: '@affine/server', type: copilot:spec }
services:
postgres:
image: postgres
@@ -78,13 +88,14 @@ jobs:
- name: Prepare Server Test Environment
uses: ./.github/actions/server-test-env
- name: Run server tests
run: yarn affine @affine/server test:copilot:coverage --forbid-only
- name: Run copilot api ${{ matrix.spec.name }} tests
run: yarn affine ${{ matrix.spec.package }} test:${{ matrix.spec.type }}:coverage --forbid-only
env:
CARGO_TARGET_DIR: '${{ github.workspace }}/target'
COPILOT_OPENAI_API_KEY: ${{ secrets.COPILOT_OPENAI_API_KEY }}
COPILOT_FAL_API_KEY: ${{ secrets.COPILOT_FAL_API_KEY }}
COPILOT_PERPLEXITY_API_KEY: ${{ secrets.COPILOT_PERPLEXITY_API_KEY }}
COPILOT_E2E_ENDPOINT: ${{ secrets.COPILOT_E2E_ENDPOINT }}
- name: Upload server test coverage results
uses: codecov/codecov-action@v5

View File

@@ -12,9 +12,11 @@
"dev": "nodemon ./src/index.ts",
"dev:mail": "email dev -d src/mails",
"test": "ava --concurrency 1 --serial",
"test:copilot": "ava \"src/__tests__/**/copilot-*.spec.ts\"",
"test:copilot:e2e": "ava \"src/__tests__/**/copilot-*.e2e.ts\"",
"test:copilot:spec": "ava \"src/__tests__/**/copilot-*.spec.ts\"",
"test:coverage": "c8 ava --concurrency 1 --serial",
"test:copilot:coverage": "c8 ava --timeout=5m \"src/__tests__/**/copilot-*.spec.ts\"",
"test:copilot:e2e:coverage": "c8 ava --timeout=5m \"src/__tests__/**/copilot-*.e2e.ts\"",
"test:copilot:spec:coverage": "c8 ava --timeout=5m \"src/__tests__/**/copilot-*.spec.ts\"",
"data-migration": "cross-env NODE_ENV=development r ./src/data/index.ts",
"predeploy": "yarn prisma migrate deploy && node --import ./scripts/register.js ./dist/data/index.js run",
"postinstall": "prisma generate"

View File

@@ -0,0 +1,192 @@
import { randomUUID } from 'node:crypto';
import { createRandomAIUser } from '@affine-test/kit/utils/cloud';
import { PrismaClient } from '@prisma/client';
import type { ExecutionContext, TestFn } from 'ava';
import ava from 'ava';
import { createWorkspace } from './utils';
import {
chatWithImages,
chatWithText,
chatWithWorkflow,
createCopilotMessage,
createCopilotSession,
ProviderActionTestCase,
ProviderWorkflowTestCase,
sse2array,
} from './utils/copilot';
type Tester = {
app: any;
userEmail: string;
workspaceId: string;
};
const test = ava as TestFn<Tester>;
const e2eConfig = {
endpoint: process.env.COPILOT_E2E_ENDPOINT || 'http://localhost:3010',
};
const isCopilotConfigured =
!!process.env.COPILOT_OPENAI_API_KEY &&
!!process.env.COPILOT_FAL_API_KEY &&
process.env.COPILOT_OPENAI_API_KEY !== '1' &&
process.env.COPILOT_FAL_API_KEY !== '1';
const runIfCopilotConfigured = test.macro(
async (
t,
callback: (t: ExecutionContext<Tester>) => Promise<void> | void
) => {
if (isCopilotConfigured) {
await callback(t);
} else {
t.log('Skip test because copilot is not configured');
t.pass();
}
}
);
export const runPrisma = async <T>(
cb: (prisma: PrismaClient) => Promise<T>
): Promise<T> => {
const client = new PrismaClient();
await client.$connect();
try {
return await cb(client);
} finally {
await client.$disconnect();
}
};
test.before(async t => {
if (!isCopilotConfigured) return;
const { endpoint } = e2eConfig;
const { email } = await createRandomAIUser('affine.fail', runPrisma);
const app = { getHttpServer: () => endpoint } as any;
const { id } = await createWorkspace(app);
t.context.app = app;
t.context.userEmail = email;
t.context.workspaceId = id;
});
test.after(async t => {
if (!isCopilotConfigured) return;
await runPrisma(async client => {
await client.user.delete({
where: {
email: t.context.userEmail,
},
});
});
});
const retry = async (
action: string,
t: ExecutionContext<Tester>,
callback: (t: ExecutionContext<Tester>) => void
) => {
let i = 3;
while (i--) {
const ret = await t.try(callback);
if (ret.passed) {
return ret.commit();
} else {
ret.discard();
t.log(ret.errors.map(e => e.message).join('\n'));
t.log(`retrying ${action} ${3 - i}/3 ...`);
}
}
t.fail(`failed to run ${action}`);
};
const makeCopilotChat = async (
t: ExecutionContext<Tester>,
promptName: string,
{ content, attachments, params }: any
) => {
const { app, workspaceId } = t.context;
const sessionId = await createCopilotSession(
app,
workspaceId,
randomUUID(),
promptName
);
const messageId = await createCopilotMessage(
app,
sessionId,
content,
attachments,
undefined,
params
);
return { sessionId, messageId };
};
// ==================== action ====================
for (const { promptName, messages, verifier, type } of ProviderActionTestCase) {
const prompts = Array.isArray(promptName) ? promptName : [promptName];
for (const promptName of prompts) {
test(
`should be able to run action: ${promptName}`,
runIfCopilotConfigured,
async t => {
await retry(`action: ${promptName}`, t, async t => {
const { app } = t.context;
const { sessionId, messageId } = await makeCopilotChat(
t,
promptName,
messages[0]
);
if (type === 'text') {
const result = await chatWithText(app, sessionId, messageId);
t.truthy(result, 'should return result');
verifier?.(t, result);
} else if (type === 'image') {
const result = sse2array(
await chatWithImages(app, sessionId, messageId)
)
.filter(e => e.event !== 'event')
.map(e => e.data)
.filter(Boolean);
t.truthy(result.length, 'should return result');
for (const r of result) {
verifier?.(t, r);
}
} else {
t.fail('unsupported provider type');
}
});
}
);
}
}
// ==================== workflow ====================
for (const { name, content, verifier } of ProviderWorkflowTestCase) {
test(
`should be able to run workflow: ${name}`,
runIfCopilotConfigured,
async t => {
await retry(`workflow: ${name}`, t, async t => {
const { app } = t.context;
const { sessionId, messageId } = await makeCopilotChat(
t,
`workflow:${name}`,
{ content }
);
const r = await chatWithWorkflow(app, sessionId, messageId);
const result = sse2array(r)
.filter(e => e.event !== 'event' && e.data)
.reduce((p, c) => p + c.data, '');
t.truthy(result, 'should return result');
verifier?.(t, result);
});
}
);
}

View File

@@ -25,7 +25,11 @@ import {
CopilotCheckJsonExecutor,
} from '../plugins/copilot/workflow/executor';
import { createTestingModule, TestingModule } from './utils';
import { TestAssets } from './utils/copilot';
import {
checkMDList,
ProviderActionTestCase,
ProviderWorkflowTestCase,
} from './utils/copilot';
type Tester = {
auth: AuthService;
@@ -135,58 +139,6 @@ test.after(async t => {
await t.context.module.close();
});
const assertNotWrappedInCodeBlock = (
t: ExecutionContext<Tester>,
result: string
) => {
t.assert(
!result.replaceAll('\n', '').trim().startsWith('```') &&
!result.replaceAll('\n', '').trim().endsWith('```'),
'should not wrap in code block'
);
};
const checkMDList = (text: string) => {
const lines = text.split('\n');
const listItemRegex = /^( {2})*(-|\u2010-\u2015|\*|\+)? .+$/;
let prevIndent = null;
for (const line of lines) {
if (line.trim() === '') continue;
if (!listItemRegex.test(line)) {
return false;
}
const currentIndent = line.match(/^( *)/)?.[0].length!;
if (Number.isNaN(currentIndent) || currentIndent % 2 !== 0) {
return false;
}
if (prevIndent !== null && currentIndent > 0) {
const indentDiff = currentIndent - prevIndent;
// allow 1 level of indentation difference
if (indentDiff > 2) {
return false;
}
}
if (line.trim().startsWith('-')) {
prevIndent = currentIndent;
}
}
return true;
};
const checkUrl = (url: string) => {
try {
new URL(url);
return true;
} catch {
return false;
}
};
const retry = async (
action: string,
t: ExecutionContext<Tester>,
@@ -268,140 +220,7 @@ test('should validate markdown list', t => {
// ==================== action ====================
const actions = [
{
promptName: [
'Summary',
'Explain this',
'Write an article about this',
'Write a twitter about this',
'Write a poem about this',
'Write a blog post about this',
'Write outline',
'Change tone to',
'Improve writing for it',
'Improve grammar for it',
'Fix spelling for it',
'Create headings',
'Make it longer',
'Make it shorter',
'Continue writing',
'Chat With AFFiNE AI',
'Search With AFFiNE AI',
],
messages: [{ role: 'user' as const, content: TestAssets.SSOT }],
verifier: (t: ExecutionContext<Tester>, result: string) => {
assertNotWrappedInCodeBlock(t, result);
t.assert(
result.toLowerCase().includes('single source of truth'),
'should include original keyword'
);
},
type: 'text' as const,
},
{
promptName: ['Brainstorm ideas about this', 'Brainstorm mindmap'],
messages: [{ role: 'user' as const, content: TestAssets.SSOT }],
verifier: (t: ExecutionContext<Tester>, result: string) => {
assertNotWrappedInCodeBlock(t, result);
t.assert(checkMDList(result), 'should be a markdown list');
},
type: 'text' as const,
},
{
promptName: 'Expand mind map',
messages: [{ role: 'user' as const, content: '- Single source of truth' }],
verifier: (t: ExecutionContext<Tester>, result: string) => {
assertNotWrappedInCodeBlock(t, result);
t.assert(checkMDList(result), 'should be a markdown list');
},
type: 'text' as const,
},
{
promptName: 'Find action items from it',
messages: [{ role: 'user' as const, content: TestAssets.TODO }],
verifier: (t: ExecutionContext<Tester>, result: string) => {
assertNotWrappedInCodeBlock(t, result);
t.assert(checkMDList(result), 'should be a markdown list');
},
type: 'text' as const,
},
{
promptName: ['Explain this code', 'Check code error'],
messages: [{ role: 'user' as const, content: TestAssets.Code }],
verifier: (t: ExecutionContext<Tester>, result: string) => {
assertNotWrappedInCodeBlock(t, result);
t.assert(
result.toLowerCase().includes('distance'),
'explain code result should include keyword'
);
},
type: 'text' as const,
},
{
promptName: 'Translate to',
messages: [
{
role: 'user' as const,
content: TestAssets.SSOT,
params: { language: 'Simplified Chinese' },
},
],
verifier: (t: ExecutionContext<Tester>, result: string) => {
assertNotWrappedInCodeBlock(t, result);
t.assert(
result.toLowerCase().includes('单一事实来源'),
'explain code result should include keyword'
);
},
type: 'text' as const,
},
{
promptName: ['Generate a caption', 'Explain this image'],
messages: [
{
role: 'user' as const,
content: '',
attachments: [
'https://cdn.affine.pro/copilot-test/Qgqy9qZT3VGIEuMIotJYoCCH.jpg',
],
},
],
verifier: (t: ExecutionContext<Tester>, result: string) => {
assertNotWrappedInCodeBlock(t, result);
const content = result.toLowerCase();
t.assert(
content.includes('classroom') ||
content.includes('school') ||
content.includes('sky'),
'explain code result should include keyword'
);
},
type: 'text' as const,
},
{
promptName: [
'debug:action:fal-face-to-sticker',
'debug:action:fal-remove-bg',
'debug:action:fal-sd15',
'debug:action:fal-upscaler',
],
messages: [
{
role: 'user' as const,
content: '',
attachments: [
'https://cdn.affine.pro/copilot-test/Zkas098lkjdf-908231.jpg',
],
},
],
verifier: (t: ExecutionContext<Tester>, link: string) => {
t.truthy(checkUrl(link), 'should be a valid url');
},
type: 'image' as const,
},
];
for (const { promptName, messages, verifier, type } of actions) {
for (const { promptName, messages, verifier, type } of ProviderActionTestCase) {
const prompts = Array.isArray(promptName) ? promptName : [promptName];
for (const promptName of prompts) {
test(
@@ -461,28 +280,7 @@ for (const { promptName, messages, verifier, type } of actions) {
// ==================== workflow ====================
const workflows = [
{
name: 'brainstorm',
content: 'apple company',
verifier: (t: ExecutionContext, result: string) => {
t.assert(checkMDList(result), 'should be a markdown list');
},
},
{
name: 'presentation',
content: 'apple company',
verifier: (t: ExecutionContext, result: string) => {
for (const l of result.split('\n')) {
t.notThrows(() => {
JSON.parse(l.trim());
}, 'should be valid json');
}
},
},
];
for (const { name, content, verifier } of workflows) {
for (const { name, content, verifier } of ProviderWorkflowTestCase) {
test(
`should be able to run workflow: ${name}`,
runIfCopilotConfigured,

File diff suppressed because one or more lines are too long

View File

@@ -6,6 +6,7 @@ import type {
const config: PlaywrightTestConfig = {
testDir: './e2e',
testMatch: '**/*.spec.ts',
fullyParallel: !process.env.CI,
timeout: 120_000,
outputDir: testResultDir,

View File

@@ -156,18 +156,22 @@ export async function createRandomUser(): Promise<{
} as any;
}
export async function createRandomAIUser(): Promise<{
export async function createRandomAIUser(
provider?: string,
connector: typeof runPrisma = runPrisma
): Promise<{
name: string;
email: string;
password: string;
id: string;
sessionId: string;
}> {
const user = {
name: faker.internet.username(),
email: faker.internet.email().toLowerCase(),
email: faker.internet.email({ provider }).toLowerCase(),
password: '123456',
};
const result = await runPrisma(async client => {
const result = await connector(async client => {
const freeFeatureId = await client.feature
.findFirst({
where: { name: 'free_plan_v1' },
@@ -181,7 +185,7 @@ export async function createRandomAIUser(): Promise<{
})
.then(f => f!.id);
await client.user.create({
const { id: userId } = await client.user.create({
data: {
...user,
emailVerifiedAt: new Date(),
@@ -207,11 +211,23 @@ export async function createRandomAIUser(): Promise<{
},
});
return await client.user.findUnique({
where: {
email: user.email,
const { id: sessionId } = await client.session.create({ data: {} });
await client.userSession.create({
data: {
sessionId,
userId,
// half an hour
expiresAt: new Date(Date.now() + 60 * 30 * 1000),
},
});
return await client.user
.findUnique({
where: {
email: user.email,
},
})
.then(r => ({ ...r, sessionId }));
});
cloudUserSchema.parse(result);
return {