feat(server): add real-world prompt test for copilot apis (#8629)

fix AF-1432, PD-1176
This commit is contained in:
darkskygit
2024-11-01 07:05:12 +00:00
parent 1c22fdd371
commit 7a201984e9
32 changed files with 1928 additions and 58 deletions
+36
View File
@@ -0,0 +1,36 @@
name: 'Run Copilot E2E Test'
description: 'Run Copilot E2E Test'
inputs:
script:
description: 'Script to run'
default: 'yarn workspace @affine-test/affine-cloud-copilot e2e --forbid-only'
required: false
openai-key:
description: 'OpenAI secret key'
required: true
fal-key:
description: 'Fal secret key'
required: true
runs:
using: 'composite'
steps:
- name: Prepare Server Test Environment
uses: ./.github/actions/server-test-env
- name: Server Copilot E2E Test
shell: bash
run: ${{ inputs.script }}
env:
COPILOT: true
DEV_SERVER_URL: http://localhost:8080
COPILOT_OPENAI_API_KEY: ${{ inputs.openai-key }}
COPILOT_FAL_API_KEY: ${{ inputs.fal-key }}
- name: Upload test results
if: ${{ failure() }}
uses: actions/upload-artifact@v4
with:
name: test-results-e2e-server-copilot
path: ./test-results
if-no-files-found: ignore
@@ -0,0 +1,21 @@
name: 'Prepare Server Test Environment'
description: 'Prepare Server Test Environment'
runs:
using: 'composite'
steps:
- name: Initialize database
shell: bash
run: |
psql -h localhost -U postgres -c "CREATE DATABASE affine;"
psql -h localhost -U postgres -c "CREATE USER affine WITH PASSWORD 'affine';"
psql -h localhost -U postgres -c "ALTER USER affine WITH SUPERUSER;"
env:
PGPASSWORD: affine
- name: Run init-db script
shell: bash
run: |
yarn workspace @affine/server exec prisma generate
yarn workspace @affine/server exec prisma db push
yarn workspace @affine/server data-migration run
+9
View File
@@ -17,6 +17,10 @@ inputs:
description: 'Download the Electron binary'
required: false
default: 'true'
corepack-install:
description: 'Install CorePack'
required: false
default: 'false'
hard-link-nm:
description: 'set nmMode to hardlinks-local in .yarnrc.yml'
required: false
@@ -42,6 +46,11 @@ runs:
registry-url: https://npm.pkg.github.com
scope: '@toeverything'
- name: Init CorePack
if: ${{ inputs.corepack-install == 'true' }}
shell: bash
run: corepack enable
- name: Set nmMode
if: ${{ inputs.hard-link-nm == 'false' }}
shell: bash
+133 -29
View File
@@ -328,6 +328,7 @@ jobs:
env:
NODE_ENV: test
DISTRIBUTION: web
DATABASE_URL: postgresql://affine:affine@localhost:5432/affine
services:
postgres:
image: postgres
@@ -360,27 +361,13 @@ jobs:
name: server-native.node
path: ./packages/backend/server
- name: Initialize database
run: |
psql -h localhost -U postgres -c "CREATE DATABASE affine;"
psql -h localhost -U postgres -c "CREATE USER affine WITH PASSWORD 'affine';"
psql -h localhost -U postgres -c "ALTER USER affine WITH SUPERUSER;"
env:
PGPASSWORD: affine
- name: Run init-db script
run: |
yarn workspace @affine/server exec prisma generate
yarn workspace @affine/server exec prisma db push
yarn workspace @affine/server data-migration run
env:
DATABASE_URL: postgresql://affine:affine@localhost:5432/affine
- name: Prepare Server Test Environment
uses: ./.github/actions/server-test-env
- name: Run server tests
run: yarn workspace @affine/server test:coverage
env:
CARGO_TARGET_DIR: '${{ github.workspace }}/target'
DATABASE_URL: postgresql://affine:affine@localhost:5432/affine
COPILOT_OPENAI_API_KEY: 'use_fake_openai_api_key'
- name: Upload server test coverage results
@@ -392,6 +379,133 @@ jobs:
name: affine
fail_ci_if_error: false
copilot-api-test:
name: Server Copilot Api Test
runs-on: ubuntu-latest
needs:
- build-server-native
env:
NODE_ENV: test
DISTRIBUTION: web
DATABASE_URL: postgresql://affine:affine@localhost:5432/affine
services:
postgres:
image: postgres
env:
POSTGRES_PASSWORD: affine
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
ports:
- 5432:5432
mailer:
image: mailhog/mailhog
ports:
- 1025:1025
- 8025:8025
steps:
- uses: actions/checkout@v4
- name: Setup Node.js
uses: ./.github/actions/setup-node
with:
electron-install: false
full-cache: true
- name: Download server-native.node
uses: actions/download-artifact@v4
with:
name: server-native.node
path: ./packages/backend/server
- name: Prepare Server Test Environment
uses: ./.github/actions/server-test-env
- name: Run server tests
run: yarn workspace @affine/server test:copilot: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 }}
- name: Upload server test coverage results
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: ./packages/backend/server/.coverage/lcov.info
flags: server-test
name: affine
fail_ci_if_error: false
copilot-e2e-test:
name: Server Copilot E2E Test
runs-on: ubuntu-latest
env:
DISTRIBUTION: web
DATABASE_URL: postgresql://affine:affine@localhost:5432/affine
IN_CI_TEST: true
strategy:
fail-fast: false
matrix:
shardIndex: [1, 2, 3]
shardTotal: [3]
needs:
- build-server-native
services:
postgres:
image: postgres
env:
POSTGRES_PASSWORD: affine
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
ports:
- 5432:5432
steps:
- uses: actions/checkout@v4
- name: Check blocksuite update
id: check-blocksuite-update
env:
BASE_REF: ${{ github.base_ref }}
run: |
if [ -n "$BASE_REF" ]; then
if node ./scripts/detect-blocksuite-update.mjs "$BASE_REF"; then
echo "skip=false" >> $GITHUB_OUTPUT
else
echo "skip=true" >> $GITHUB_OUTPUT
fi
else
echo "skip=true" >> $GITHUB_OUTPUT
fi
- name: Setup Node.js
if: ${{ steps.check-blocksuite-update.outputs.skip == 'true' }}
uses: ./.github/actions/setup-node
with:
playwright-install: true
electron-install: false
hard-link-nm: false
- name: Download server-native.node
if: ${{ steps.check-blocksuite-update.outputs.skip == 'true' }}
uses: actions/download-artifact@v4
with:
name: server-native.node
path: ./packages/backend/server
- name: Run Copilot E2E Test ${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
if: ${{ steps.check-blocksuite-update.outputs.skip == 'true' }}
uses: ./.github/actions/copilot-test
with:
script: yarn workspace @affine-test/affine-cloud-copilot e2e --forbid-only --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
openai-key: ${{ secrets.COPILOT_OPENAI_API_KEY }}
fal-key: ${{ secrets.COPILOT_FAL_API_KEY }}
server-e2e-test:
name: ${{ matrix.tests.name }}
runs-on: ubuntu-latest
@@ -458,19 +572,8 @@ jobs:
name: affine.linux-x64-gnu.node
path: ./packages/frontend/native
- name: Initialize database
run: |
psql -h localhost -U postgres -c "CREATE DATABASE affine;"
psql -h localhost -U postgres -c "CREATE USER affine WITH PASSWORD 'affine';"
psql -h localhost -U postgres -c "ALTER USER affine WITH SUPERUSER;"
env:
PGPASSWORD: affine
- name: Run init-db script
run: |
yarn workspace @affine/server exec prisma generate
yarn workspace @affine/server exec prisma db push
yarn workspace @affine/server data-migration run
- name: Prepare Server Test Environment
uses: ./.github/actions/server-test-env
- name: ${{ matrix.tests.name }}
run: |
@@ -633,6 +736,7 @@ jobs:
- build-server-native
- build-electron-renderer
- server-test
- copilot-e2e-test
- server-e2e-test
- desktop-test
- test-build-mobile-app
@@ -0,0 +1,29 @@
name: Copilot Test Automatically
on:
push:
tags:
- 'v[0-9]+.[0-9]+.[0-9]+-canary.[0-9]+'
schedule:
- cron: '0 8 * * *'
workflow_dispatch:
permissions:
actions: write
jobs:
dispatch-test:
runs-on: ubuntu-latest
name: Setup Test
steps:
- name: dispatch test by tag
if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }}
uses: benc-uk/workflow-dispatch@v1
with:
workflow: copilot-test.yml
- name: dispatch test by schedule
if: ${{ github.event_name == 'schedule' }}
uses: benc-uk/workflow-dispatch@v1
with:
workflow: copilot-test.yml
ref: canary
+190
View File
@@ -0,0 +1,190 @@
name: Copilot Cron Test
on:
workflow_dispatch:
env:
NX_CLOUD_ACCESS_TOKEN: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }}
PLAYWRIGHT_BROWSERS_PATH: ${{ github.workspace }}/node_modules/.cache/ms-playwright
jobs:
build-server-native:
name: Build Server native
runs-on: ubuntu-latest
env:
CARGO_PROFILE_RELEASE_DEBUG: '1'
steps:
- uses: actions/checkout@v4
- name: Setup Node.js
uses: ./.github/actions/setup-node
with:
extra-flags: workspaces focus @affine/server-native
electron-install: false
- name: Build Rust
uses: ./.github/actions/build-rust
with:
target: 'x86_64-unknown-linux-gnu'
package: '@affine/server-native'
nx_token: ${{ secrets.NX_CLOUD_ACCESS_TOKEN }}
- name: Upload server-native.node
uses: actions/upload-artifact@v4
with:
name: server-native.node
path: ./packages/backend/native/server-native.node
if-no-files-found: error
copilot-api-test:
name: Server Copilot Api Test
runs-on: ubuntu-latest
needs:
- build-server-native
env:
NODE_ENV: test
DISTRIBUTION: web
DATABASE_URL: postgresql://affine:affine@localhost:5432/affine
services:
postgres:
image: postgres
env:
POSTGRES_PASSWORD: affine
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
ports:
- 5432:5432
mailer:
image: mailhog/mailhog
ports:
- 1025:1025
- 8025:8025
steps:
- uses: actions/checkout@v4
- name: Setup Node.js
uses: ./.github/actions/setup-node
with:
playwright-install: true
electron-install: false
full-cache: true
- name: Download server-native.node
uses: actions/download-artifact@v4
with:
name: server-native.node
path: ./packages/backend/server
- name: Prepare Server Test Environment
uses: ./.github/actions/server-test-env
- name: Run server tests
run: yarn workspace @affine/server test:copilot: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 }}
- name: Upload server test coverage results
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: ./packages/backend/server/.coverage/lcov.info
flags: server-test
name: affine
fail_ci_if_error: false
copilot-e2e-test:
name: Server Copilot E2E Test
runs-on: ubuntu-latest
env:
DISTRIBUTION: web
DATABASE_URL: postgresql://affine:affine@localhost:5432/affine
IN_CI_TEST: true
strategy:
fail-fast: false
matrix:
shardIndex: [1, 2, 3]
shardTotal: [3]
needs:
- build-server-native
services:
postgres:
image: postgres
env:
POSTGRES_PASSWORD: affine
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
ports:
- 5432:5432
steps:
- uses: actions/checkout@v4
- name: Setup Node.js
uses: ./.github/actions/setup-node
with:
playwright-install: true
electron-install: false
hard-link-nm: false
- name: Download server-native.node
uses: actions/download-artifact@v4
with:
name: server-native.node
path: ./packages/backend/server
- name: Run Copilot E2E Test ${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
uses: ./.github/actions/copilot-test
with:
script: yarn workspace @affine-test/affine-cloud-copilot e2e --forbid-only --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
openai-key: ${{ secrets.COPILOT_OPENAI_API_KEY }}
fal-key: ${{ secrets.COPILOT_FAL_API_KEY }}
test-done:
needs:
- copilot-api-test
- copilot-e2e-test
if: always()
runs-on: ubuntu-latest
name: Post test result message
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Node.js
uses: ./.github/actions/setup-node
with:
extra-flags: 'workspaces focus @affine/copilot-result'
electron-install: false
- name: Post Success event to a Slack channel
if: ${{ always() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled') }}
run: node ./tools/copilot-result/index.js
env:
CHANNEL_ID: ${{ secrets.RELEASE_SLACK_CHNNEL_ID }}
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
BRANCH_SHA: ${{ github.sha }}
BRANCH_NAME: ${{ github.ref }}
COPILOT_RESULT: success
- name: Post Failed event to a Slack channel
id: failed-slack
if: ${{ always() && contains(needs.*.result, 'failure') }}
run: node ./tools/copilot-result/index.js
env:
CHANNEL_ID: ${{ secrets.RELEASE_SLACK_CHNNEL_ID }}
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
BRANCH_SHA: ${{ github.sha }}
BRANCH_NAME: ${{ github.ref }}
COPILOT_RESULT: failed
- name: Post Cancel event to a Slack channel
id: cancel-slack
if: ${{ always() && contains(needs.*.result, 'cancelled') && !contains(needs.*.result, 'failure') }}
run: node ./tools/copilot-result/index.js
env:
CHANNEL_ID: ${{ secrets.RELEASE_SLACK_CHNNEL_ID }}
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
BRANCH_SHA: ${{ github.sha }}
BRANCH_NAME: ${{ github.ref }}
COPILOT_RESULT: canceled
+2
View File
@@ -12,7 +12,9 @@
"start": "node --loader ts-node/esm/transpile-only.mjs ./src/index.ts",
"dev": "nodemon ./src/index.ts",
"test": "ava --concurrency 1 --serial",
"test:copilot": "ava --concurrency 1 --serial \"tests/**/copilot-*.e2e.ts\"",
"test:coverage": "c8 ava --concurrency 1 --serial",
"test:copilot:coverage": "c8 ava --timeout=5m --concurrency 1 --serial \"tests/**/copilot-*.e2e.ts\"",
"postinstall": "prisma generate",
"data-migration": "node --loader ts-node/esm/transpile-only.mjs ./src/data/index.ts",
"predeploy": "yarn prisma migrate deploy && node --import ./scripts/register.js ./dist/data/index.js run",
@@ -522,7 +522,7 @@ Rules to follow:
messages: [
{
role: 'system',
content: `You are a creative blog writer specializing in producing captivating and informative content. Your task is to write a blog post based on the content provided by user in its original language. The blog post should be between 500-700 words, engaging, and well-structured, with an inviting introduction that hooks the reader, concise and informative body paragraphs, and a compelling conclusion that encourages readers to engage with the content, whether it's through commenting, sharing, or exploring the topics further. Please ensure the blog post is optimized for SEO with relevant keywords, includes at least 2-3 subheadings for better readability, and whenever possible, provides actionable insights or takeaways for the reader. Integrate a friendly and approachable tone throughout the post that reflects the voice of someone knowledgeable yet relatable. And ultimately output the content in Markdown format. Do not put everything into a single code block unless everything is code.`,
content: `You are a creative blog writer specializing in producing captivating and informative content. Your task is to write a blog post based on the content provided by user in its original language. The blog post should be between 500-700 words, engaging, and well-structured, with an inviting introduction that hooks the reader, concise and informative body paragraphs, and a compelling conclusion that encourages readers to engage with the content, whether it's through commenting, sharing, or exploring the topics further. Please ensure the blog post is optimized for SEO with relevant keywords, includes at least 2-3 subheadings for better readability, and whenever possible, provides actionable insights or takeaways for the reader. Integrate a friendly and approachable tone throughout the post that reflects the voice of someone knowledgeable yet relatable. And ultimately output the content in Markdown format. You should not place the entire article in a code block.`,
},
{
role: 'user',
@@ -0,0 +1,492 @@
/// <reference types="../src/global.d.ts" />
import { TestingModule } from '@nestjs/testing';
import type { ExecutionContext, TestFn } from 'ava';
import ava from 'ava';
import { AuthService } from '../src/core/auth';
import { QuotaModule } from '../src/core/quota';
import { ConfigModule } from '../src/fundamentals/config';
import { CopilotModule } from '../src/plugins/copilot';
import { prompts, PromptService } from '../src/plugins/copilot/prompt';
import {
CopilotProviderService,
FalProvider,
OpenAIProvider,
registerCopilotProvider,
unregisterCopilotProvider,
} from '../src/plugins/copilot/providers';
import {
CopilotChatTextExecutor,
CopilotWorkflowService,
GraphExecutorState,
} from '../src/plugins/copilot/workflow';
import {
CopilotChatImageExecutor,
CopilotCheckHtmlExecutor,
CopilotCheckJsonExecutor,
} from '../src/plugins/copilot/workflow/executor';
import { createTestingModule } from './utils';
import { TestAssets } from './utils/copilot';
type Tester = {
auth: AuthService;
module: TestingModule;
prompt: PromptService;
provider: CopilotProviderService;
workflow: CopilotWorkflowService;
executors: {
image: CopilotChatImageExecutor;
text: CopilotChatTextExecutor;
html: CopilotCheckHtmlExecutor;
json: CopilotCheckJsonExecutor;
};
};
const test = ava as TestFn<Tester>;
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();
}
}
);
test.beforeEach(async t => {
const module = await createTestingModule({
imports: [
ConfigModule.forRoot({
plugins: {
copilot: {
openai: {
apiKey: process.env.COPILOT_OPENAI_API_KEY,
},
fal: {
apiKey: process.env.COPILOT_FAL_API_KEY,
},
},
},
}),
QuotaModule,
CopilotModule,
],
});
const auth = module.get(AuthService);
const prompt = module.get(PromptService);
const provider = module.get(CopilotProviderService);
const workflow = module.get(CopilotWorkflowService);
t.context.module = module;
t.context.auth = auth;
t.context.prompt = prompt;
t.context.provider = provider;
t.context.workflow = workflow;
t.context.executors = {
image: module.get(CopilotChatImageExecutor),
text: module.get(CopilotChatTextExecutor),
html: module.get(CopilotCheckHtmlExecutor),
json: module.get(CopilotCheckJsonExecutor),
};
});
test.beforeEach(async t => {
const { prompt, executors } = t.context;
executors.image.register();
executors.text.register();
executors.html.register();
executors.json.register();
registerCopilotProvider(OpenAIProvider);
registerCopilotProvider(FalProvider);
for (const name of await prompt.listNames()) {
await prompt.delete(name);
}
for (const p of prompts) {
await prompt.set(p.name, p.model, p.messages, p.config);
}
});
test.afterEach.always(async _ => {
unregisterCopilotProvider(OpenAIProvider.type);
unregisterCopilotProvider(FalProvider.type);
});
test.afterEach.always(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})*(-|\*|\+) .+$/;
let prevIndent = null;
for (const line of lines) {
if (line.trim() === '') continue;
if (!listItemRegex.test(line)) {
return false;
}
// eslint-disable-next-line @typescript-eslint/no-non-null-asserted-optional-chain
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;
}
}
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>,
callback: (t: ExecutionContext<Tester>) => void
) => {
let i = 3;
while (i--) {
const ret = await t.try(callback);
if (ret.passed) {
ret.commit();
break;
} else {
ret.discard();
t.log(ret.errors.map(e => e.message).join('\n'));
t.log(`retrying ${action} ${3 - i}/3 ...`);
}
}
};
// ==================== utils ====================
test('should validate markdown list', t => {
t.true(
checkMDList(`
- item 1
- item 2
`)
);
t.true(
checkMDList(`
- item 1
- item 1.1
- item 2
`)
);
t.true(
checkMDList(`
- item 1
- item 1.1
- item 1.1.1
- item 2
`)
);
t.true(
checkMDList(`
- item 1
- item 1.1
- item 1.1.1
- item 1.1.2
- item 2
`)
);
t.true(
checkMDList(`
- item 1
- item 1.1
- item 1.1.1
- item 1.2
`)
);
t.false(
checkMDList(`
- item 1
- item 1.1
- item 1.1.1.1
`)
);
});
// ==================== 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',
],
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) {
const prompts = Array.isArray(promptName) ? promptName : [promptName];
for (const promptName of prompts) {
test(
`should be able to run action: ${promptName}`,
runIfCopilotConfigured,
async t => {
const { provider: providerService, prompt: promptService } = t.context;
const prompt = (await promptService.get(promptName))!;
t.truthy(prompt, 'should have prompt');
const provider = (await providerService.getProviderByModel(
prompt.model
))!;
t.truthy(provider, 'should have provider');
await retry(`action: ${promptName}`, t, async t => {
if (type === 'text' && 'generateText' in provider) {
const result = await provider.generateText(
[
...prompt.finish(
messages.reduce(
// @ts-expect-error
(acc, m) => Object.assign(acc, m.params),
{}
)
),
...messages,
],
prompt.model
);
t.truthy(result, 'should return result');
verifier?.(t, result);
} else if (type === 'image' && 'generateImages' in provider) {
const result = await provider.generateImages(
[
...prompt.finish(
messages.reduce(
// @ts-expect-error
(acc, m) => Object.assign(acc, m.params),
{}
)
),
...messages,
],
prompt.model
);
t.truthy(result.length, 'should return result');
for (const r of result) {
verifier?.(t, r);
}
} else {
t.fail('unsupported provider type');
}
});
}
);
}
}
// ==================== workflow ====================
const workflows = [
{
name: 'brainstorm',
content: 'apple company',
verifier: (t: ExecutionContext<Tester>, result: string) => {
t.assert(checkMDList(result), 'should be a markdown list');
},
},
{
name: 'presentation',
content: 'apple company',
verifier: (t: ExecutionContext<Tester>, 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) {
test(
`should be able to run workflow: ${name}`,
runIfCopilotConfigured,
async t => {
const { workflow } = t.context;
await retry(`workflow: ${name}`, t, async t => {
let result = '';
for await (const ret of workflow.runGraph({ content }, name)) {
if (ret.status === GraphExecutorState.EnterNode) {
console.log('enter node:', ret.node.name);
} else if (ret.status === GraphExecutorState.ExitNode) {
console.log('exit node:', ret.node.name);
} else if (ret.status === GraphExecutorState.EmitAttachment) {
console.log('stream attachment:', ret);
} else {
result += ret.content;
}
}
t.truthy(result, 'should return result');
verifier?.(t, result);
});
}
);
}
File diff suppressed because one or more lines are too long
@@ -153,6 +153,9 @@ export class ChatActionList extends LitElement {
});
}
}}
data-testid="action-${action.title
.toLowerCase()
.replaceAll(' ', '-')}"
>
${action.title}
</div>
@@ -178,13 +178,17 @@ export class ChatCopyMore extends WithDisposable(LitElement) {
this._notifySuccess('Copied to clipboard');
}
}}
data-testid="action-copy-button"
>
${CopyIcon}
<affine-tooltip>Copy</affine-tooltip>
</div>`
: nothing}
${isLast
? html`<div @click=${() => this.retry()}>
? html`<div
@click=${() => this.retry()}
data-testid="action-retry-button"
>
${RetryIcon}
<affine-tooltip>Retry</affine-tooltip>
</div>`
@@ -371,6 +371,7 @@ export class ChatPanelInput extends WithDisposable(LitElement) {
}
}
}}
data-testid="chat-panel-input"
></textarea>
<div class="chat-panel-input-actions">
<div
@@ -378,6 +379,7 @@ export class ChatPanelInput extends WithDisposable(LitElement) {
@click=${async () => {
await this.cleanupHistories();
}}
data-testid="chat-panel-clear"
>
${ChatClearIcon}
</div>
@@ -410,6 +412,7 @@ export class ChatPanelInput extends WithDisposable(LitElement) {
@click="${this.send}"
class="chat-panel-send"
aria-disabled=${this.isInputEmpty}
data-testid="chat-panel-send"
>
${ChatSendIcon}
</div>`}
@@ -379,7 +379,7 @@ export class ChatPanelMessages extends WithDisposable(ShadowlessElement) {
: html`<div class="avatar"></div>`}
</div>`
: AffineAvatarIcon}
${isUser ? 'You' : 'AFFINE AI'}
${isUser ? 'You' : 'AFFiNE AI'}
</div>`;
}
@@ -244,7 +244,7 @@ export class ChatPanel extends WithDisposable(ShadowlessElement) {
override render() {
return html` <div class="chat-panel-container">
<div class="chat-panel-title">
<div>AFFINE AI</div>
<div>AFFiNE AI</div>
<div
@click=${() => {
AIProvider.toggleGeneralAIOnboarding?.(true);
@@ -34,6 +34,7 @@ const ToggleButton = ({
onClick={onToggle}
className={className}
data-show={show}
data-testid="right-sidebar-toggle"
>
<RightSidebarIcon />
</IconButton>
@@ -40,6 +40,7 @@ export const SidebarContainer = ({
styles.sidebarBodyTarget,
!BUILD_CONFIG.isElectron && styles.borderTop
)}
data-testid={`sidebar-tab-content-${sidebar.id}`}
/>
))
) : (
@@ -22,6 +22,7 @@ export const SidebarHeaderSwitcher = () => {
tabId={tab.id}
/>
),
testId: `sidebar-tab-${tab.id}`,
style: { padding: 0, fontSize: 20, width: 24 },
}));
+105
View File
@@ -0,0 +1,105 @@
const { exec } = await import('node:child_process');
const { fileURLToPath } = await import('node:url');
const { readdir } = await import('node:fs/promises');
const { join } = await import('node:path');
async function readJsonFromCommit(commit, file) {
function readFile(commit, file) {
return new Promise((resolve, reject) => {
exec(`git show ${commit}:${file}`, (error, stdout, stderr) => {
if (error) {
reject(stderr);
} else {
resolve(stdout);
}
});
});
}
try {
const content = await readFile(commit, file);
return JSON.parse(content);
} catch {}
}
function checkBlocksuiteChanged(oldPkg, newPkg) {
const changed = new Set();
const keys = ['dependencies', 'devDependencies'];
keys.forEach(key => {
const oldDeps = oldPkg[key] || {};
const newDeps = newPkg[key] || {};
Object.keys(newDeps).forEach(dep => {
if (newDeps[dep] !== oldDeps[dep] && dep.startsWith('@blocksuite/')) {
changed.add(dep);
}
});
});
return changed;
}
async function findPackageJson(root) {
const packages = new Set();
async function walk(dir) {
const files = await readdir(dir, { withFileTypes: true });
for (const file of files) {
if (file.isDirectory() && file.name !== 'node_modules') {
await walk(join(dir, file.name));
} else if (file.name === 'package.json') {
let path = join(dir.replace(root, ''), file.name);
if (path.startsWith('/')) {
path = path.slice(1);
}
packages.add(path);
}
}
}
await walk(root);
return packages;
}
async function main() {
if (process.argv.length < 3) {
console.error('Usage: node script.js <commit-hash>');
process.exit(1);
}
const commitHash = process.argv[2];
const currentHead = process.argv[3] || 'HEAD';
const changedPackages = new Set();
const folders = await findPackageJson(
join(fileURLToPath(import.meta.url), '..', '..')
);
for (const packagePath of folders) {
const old = await readJsonFromCommit(commitHash, packagePath);
const current = await readJsonFromCommit(currentHead, packagePath);
console.log('checking:', packagePath);
if (
old &&
current &&
typeof old === 'object' &&
typeof current === 'object'
) {
for (const p of checkBlocksuiteChanged(old, current)) {
changedPackages.add(p);
}
}
}
if (changedPackages.size > 0) {
console.log('Blocksuite packages have been updated.', changedPackages);
process.exit(1);
} else {
console.log('No changes to Blocksuite packages.');
process.exit(0);
}
}
main().catch(console.error);
@@ -0,0 +1,591 @@
import { test } from '@affine-test/kit/playwright';
import {
createRandomAIUser,
loginUser,
loginUserDirectly,
} from '@affine-test/kit/utils/cloud';
import { openHomePage, setCoreUrl } from '@affine-test/kit/utils/load-page';
import {
clickNewPageButton,
getBlockSuiteEditorTitle,
waitForEditorLoad,
} from '@affine-test/kit/utils/page-logic';
import { clickSideBarAllPageButton } from '@affine-test/kit/utils/sidebar';
import { createLocalWorkspace } from '@affine-test/kit/utils/workspace';
import { expect, type Page } from '@playwright/test';
test.describe.configure({ mode: 'parallel' });
const ONE_SECOND = 1000;
const TEN_SECONDS = 10 * ONE_SECOND;
const ONE_MINUTE = 60 * ONE_SECOND;
let isProduction = process.env.NODE_ENV === 'production';
if (
process.env.PLAYWRIGHT_USER_AGENT &&
process.env.PLAYWRIGHT_EMAIL &&
!process.env.PLAYWRIGHT_PASSWORD
) {
test.use({
userAgent: process.env.PLAYWRIGHT_USER_AGENT || 'affine-tester',
});
setCoreUrl(process.env.PLAYWRIGHT_CORE_URL || 'http://localhost:8080');
isProduction = true;
}
function getUser() {
if (
!isProduction ||
!process.env.PLAYWRIGHT_EMAIL ||
!process.env.PLAYWRIGHT_PASSWORD
) {
return createRandomAIUser();
}
return {
email: process.env.PLAYWRIGHT_EMAIL,
password: process.env.PLAYWRIGHT_PASSWORD,
};
}
test.skip(
() =>
!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',
'skip test if no copilot api key'
);
test('can open chat side panel', async ({ page }) => {
await openHomePage(page);
await waitForEditorLoad(page);
await clickNewPageButton(page);
await page.getByTestId('right-sidebar-toggle').click({
delay: 200,
});
await page.getByTestId('sidebar-tab-chat').click();
await expect(page.getByTestId('sidebar-tab-content-chat')).toBeVisible();
});
const makeChat = async (page: Page, content: string) => {
if (await page.getByTestId('sidebar-tab-chat').isHidden()) {
await page.getByTestId('right-sidebar-toggle').click({
delay: 200,
});
}
await page.getByTestId('sidebar-tab-chat').click();
await page.getByTestId('chat-panel-input').focus();
await page.keyboard.type(content);
await page.keyboard.press('Enter');
};
const clearChat = async (page: Page) => {
await page.getByTestId('chat-panel-clear').click();
await page.getByTestId('confirm-modal-confirm').click();
};
const collectChat = async (page: Page) => {
const chatPanel = await page.waitForSelector('.chat-panel-messages');
if (await chatPanel.$('.chat-panel-messages-placeholder')) {
return [];
}
// wait ai response
await page.waitForSelector('.chat-panel-messages .message chat-copy-more');
const lastMessage = await chatPanel.$$('.message').then(m => m[m.length - 1]);
await lastMessage.waitForSelector('chat-copy-more');
await page.waitForTimeout(ONE_SECOND);
return Promise.all(
Array.from(await chatPanel.$$('.message')).map(async m => ({
name: await m.$('.user-info').then(i => i?.innerText()),
content: await m
.$('chat-text')
.then(t => t?.$('editor-host'))
.then(e => e?.innerText()),
}))
);
};
const focusToEditor = async (page: Page) => {
const title = getBlockSuiteEditorTitle(page);
await title.focus();
await page.keyboard.press('Enter');
};
const getEditorContent = async (page: Page) => {
const lines = await page.$$('page-editor .inline-editor');
const contents = await Promise.all(lines.map(el => el.innerText()));
return (
contents
// cleanup zero width space
.map(c => c.replace(/\u200B/g, '').trim())
.filter(c => !!c)
.join('\n')
);
};
const switchToEdgelessMode = async (page: Page) => {
const editor = await page.waitForSelector('page-editor');
await page.getByTestId('switch-edgeless-mode-button').click();
// wait for new editor
editor.waitForElementState('hidden');
await page.waitForSelector('edgeless-editor');
};
test('can trigger login at chat side panel', async ({ page }) => {
await openHomePage(page);
await waitForEditorLoad(page);
await clickNewPageButton(page);
await makeChat(page, 'hello');
const loginTips = await page.waitForSelector('ai-error-wrapper');
expect(await loginTips.innerText()).toBe('Login');
});
test('can chat after login at chat side panel', async ({ page }) => {
await openHomePage(page);
await waitForEditorLoad(page);
await clickNewPageButton(page);
await makeChat(page, 'hello');
const loginTips = await page.waitForSelector('ai-error-wrapper');
(await loginTips.$('div'))!.click();
// login
const user = await getUser();
await loginUserDirectly(page, user);
// after login
await makeChat(page, 'hello');
const history = await collectChat(page);
expect(history[0]).toEqual({ name: 'You', content: 'hello' });
expect(history[1].name).toBe('AFFiNE AI');
});
test.describe('chat panel', () => {
let user: {
email: string;
password: string;
};
test.beforeEach(async ({ page }) => {
user = await getUser();
await loginUser(page, user);
});
test('basic chat', async ({ page }) => {
await page.reload();
await clickSideBarAllPageButton(page);
await page.waitForTimeout(200);
await createLocalWorkspace({ name: 'test' }, page);
await clickNewPageButton(page);
await makeChat(page, 'hello');
const history = await collectChat(page);
expect(history[0]).toEqual({ name: 'You', content: 'hello' });
expect(history[1].name).toBe('AFFiNE AI');
await clearChat(page);
expect((await collectChat(page)).length).toBe(0);
});
test('chat actions', async ({ page }) => {
await page.reload();
await clickSideBarAllPageButton(page);
await page.waitForTimeout(200);
await createLocalWorkspace({ name: 'test' }, page);
await clickNewPageButton(page);
await makeChat(page, 'hello');
const content = (await collectChat(page))[1].content;
await page.getByTestId('action-copy-button').click();
await page.waitForTimeout(500);
expect(await page.evaluate(() => navigator.clipboard.readText())).toBe(
content
);
await page.getByTestId('action-retry-button').click();
expect((await collectChat(page))[1].content).not.toBe(content);
});
test('can be insert below', async ({ page }) => {
await page.reload();
await clickSideBarAllPageButton(page);
await page.waitForTimeout(200);
await createLocalWorkspace({ name: 'test' }, page);
await clickNewPageButton(page);
await makeChat(page, 'hello');
const content = (await collectChat(page))[1].content;
await focusToEditor(page);
// insert below
await page.getByTestId('action-insert-below').click();
await page.waitForSelector('affine-format-bar-widget editor-toolbar');
const editorContent = await getEditorContent(page);
expect(editorContent).toBe(content);
});
test('can be add to edgeless as node', async ({ page }) => {
await page.reload();
await clickSideBarAllPageButton(page);
await page.waitForTimeout(200);
await createLocalWorkspace({ name: 'test' }, page);
await clickNewPageButton(page);
await makeChat(page, 'hello');
const content = (await collectChat(page))[1].content;
await switchToEdgelessMode(page);
// delete default note
await (await page.waitForSelector('affine-edgeless-note')).click();
page.keyboard.press('Delete');
// insert note
await page.getByTestId('action-add-to-edgeless-as-note').click();
const edgelessNode = await page.waitForSelector('affine-edgeless-note');
expect(await edgelessNode.innerText()).toBe(content);
});
test('can be create as a doc', async ({ page }) => {
await page.reload();
await clickSideBarAllPageButton(page);
await page.waitForTimeout(200);
await createLocalWorkspace({ name: 'test' }, page);
await clickNewPageButton(page);
await makeChat(page, 'hello');
const content = (await collectChat(page))[1].content;
const editor = await page.waitForSelector('page-editor');
await page.getByTestId('action-create-as-a-doc').click();
// wait for new editor
editor.waitForElementState('hidden');
await page.waitForSelector('page-editor');
const editorContent = await getEditorContent(page);
expect(editorContent).toBe(content);
});
// feature not launched yet
test.skip('can be save chat to block', async ({ page }) => {
await page.reload();
await clickSideBarAllPageButton(page);
await page.waitForTimeout(200);
await createLocalWorkspace({ name: 'test' }, page);
await clickNewPageButton(page);
await makeChat(page, 'hello');
const contents = (await collectChat(page)).map(m => m.content);
await switchToEdgelessMode(page);
await page.getByTestId('action-save-chat-to-block').click();
const chatBlock = await page.waitForSelector('affine-edgeless-ai-chat');
expect(
await Promise.all(
(await chatBlock.$$('.ai-chat-user-message')).map(m => m.innerText())
)
).toBe(contents);
});
test('can be chat and insert below in page mode', async ({ page }) => {
await page.reload();
await clickSideBarAllPageButton(page);
await page.waitForTimeout(200);
await createLocalWorkspace({ name: 'test' }, page);
await clickNewPageButton(page);
await focusToEditor(page);
await page.keyboard.type('/');
await page.getByTestId('sub-menu-0').getByText('Ask AI').click();
const input = await page.waitForSelector('ai-panel-input textarea');
await input.fill('hello');
await input.press('Enter');
const resp = await page.waitForSelector(
'ai-panel-answer .response-list-container'
); // wait response
const content = await (
await page.waitForSelector('ai-panel-answer editor-host')
).innerText();
await (await resp.waitForSelector('.ai-item-insert-below')).click();
const editorContent = await getEditorContent(page);
expect(editorContent).toBe(content);
});
test('can be retry or discard chat in page mode', async ({ page }) => {
await page.reload();
await clickSideBarAllPageButton(page);
await page.waitForTimeout(200);
await createLocalWorkspace({ name: 'test' }, page);
await clickNewPageButton(page);
await focusToEditor(page);
await page.keyboard.type('/');
await page.getByTestId('sub-menu-0').getByText('Ask AI').click();
const input = await page.waitForSelector('ai-panel-input textarea');
await input.fill('hello');
await input.press('Enter');
// regenerate
{
const resp = await page.waitForSelector(
'ai-panel-answer .response-list-container:last-child'
);
const answerEditor = await page.waitForSelector(
'ai-panel-answer editor-host'
);
const content = await answerEditor.innerText();
await (await resp.waitForSelector('.ai-item-regenerate')).click();
await page.waitForSelector('ai-panel-answer .response-list-container'); // wait response
expect(
await (
await (
await page.waitForSelector('ai-panel-answer')
).waitForSelector('editor-host')
).innerText()
).not.toBe(content);
}
// discard
{
const resp = await page.waitForSelector(
'ai-panel-answer .response-list-container:last-child'
);
await (await resp.waitForSelector('.ai-item-discard')).click();
await page.getByTestId('confirm-modal-confirm').click();
const editorContent = await getEditorContent(page);
expect(editorContent).toBe('');
}
});
});
test.describe('chat with block', () => {
let user: {
email: string;
password: string;
};
test.beforeEach(async ({ page }) => {
user = await getUser();
await loginUser(page, user);
});
const collectTextAnswer = async (page: Page) => {
// wait ai response
await page.waitForSelector(
'affine-ai-panel-widget .response-list-container',
{ timeout: ONE_MINUTE }
);
const answer = await page.waitForSelector(
'affine-ai-panel-widget ai-panel-answer editor-host'
);
return answer.innerText();
};
const collectImageAnswer = async (page: Page, timeout = TEN_SECONDS) => {
// wait ai response
await page.waitForSelector(
'affine-ai-panel-widget .response-list-container',
{ timeout }
);
const answer = await page.waitForSelector(
'affine-ai-panel-widget .ai-answer-image img'
);
return answer.getAttribute('src');
};
const disableEditorBlank = async (page: Page) => {
// hide blank element, this may block the click
const blank = page.getByTestId('page-editor-blank');
if (await blank.isVisible()) {
await blank.evaluate(node => (node.style.pointerEvents = 'none'));
} else {
console.warn('blank element not found');
}
};
test.describe('chat with text', () => {
const pasteTextToPageEditor = async (page: Page, content: string) => {
await focusToEditor(page);
await page.keyboard.type(content);
};
test.beforeEach(async ({ page }) => {
await page.reload();
await clickSideBarAllPageButton(page);
await page.waitForTimeout(200);
await createLocalWorkspace({ name: 'test' }, page);
await clickNewPageButton(page);
await pasteTextToPageEditor(page, 'hello');
});
test.beforeEach(async ({ page }) => {
await page.waitForSelector('affine-paragraph').then(i => i.click());
await page.keyboard.press('ControlOrMeta+A');
await page
.waitForSelector('page-editor editor-toolbar ask-ai-button')
.then(b => b.click());
});
const options = [
// review with ai
'Fix spelling',
'Fix Grammar',
// edit with ai
'Explain selection',
'Improve writing',
'Make it longer',
'Make it shorter',
'Continue writing',
// generate with ai
'Summarize',
'Generate headings',
'Generate outline',
'Find actions',
// draft with ai
'Write an article about this',
'Write a tweet about this',
'Write a poem about this',
'Write a blog post about this',
'Brainstorm ideas about this',
];
for (const option of options) {
test(option, async ({ page }) => {
await disableEditorBlank(page);
await page
.waitForSelector(
`.ai-item-${option.replaceAll(' ', '-').toLowerCase()}`
)
.then(i => i.click());
expect(await collectTextAnswer(page)).toBeTruthy();
});
}
});
test.describe('chat with image block', () => {
const pasteImageToPageEditor = async (page: Page) => {
await page.evaluate(async () => {
const canvas = document.createElement('canvas');
canvas.width = 100;
canvas.height = 100;
const blob = await new Promise<Blob>(resolve =>
canvas.toBlob(blob => resolve(blob!), 'image/png')
);
await navigator.clipboard.write([
new ClipboardItem({ [blob.type]: blob }),
]);
});
await focusToEditor(page);
await page.keyboard.press('ControlOrMeta+V');
};
test.beforeEach(async ({ page }) => {
await page.reload();
await clickSideBarAllPageButton(page);
await page.waitForTimeout(200);
await createLocalWorkspace({ name: 'test' }, page);
await clickNewPageButton(page);
await pasteImageToPageEditor(page);
});
test.describe('page mode', () => {
test.beforeEach(async ({ page }) => {
await disableEditorBlank(page);
await page.waitForSelector('affine-image').then(i => i.click());
await page
.waitForSelector('affine-image editor-toolbar ask-ai-button')
.then(b => b.click());
});
test('explain this image', async ({ page }) => {
await page
.waitForSelector('.ai-item-explain-this-image')
.then(i => i.click());
expect(await collectTextAnswer(page)).toBeTruthy();
});
test('generate a caption', async ({ page }) => {
await page
.waitForSelector('.ai-item-generate-a-caption')
.then(i => i.click());
expect(await collectTextAnswer(page)).toBeTruthy();
});
test('continue with ai', async ({ page }) => {
await page
.waitForSelector('.ai-item-continue-with-ai')
.then(i => i.click());
await page
.waitForSelector('chat-panel-input .chat-panel-images')
.then(el => el.waitForElementState('visible'));
});
test('open ai chat', async ({ page }) => {
await page
.waitForSelector('.ai-item-open-ai-chat')
.then(i => i.click());
const cards = await page.waitForSelector('chat-panel chat-cards');
await cards.waitForElementState('visible');
const cardTitles = await Promise.all(
await cards
.$$('.card-wrapper .card-title')
.then(els => els.map(async el => await el.innerText()))
);
expect(cardTitles).toContain('Start with this Image');
});
});
// TODO(@darkskygit): block by BS-1709, enable this after bug fix
test.describe.skip('edgeless mode', () => {
test.beforeEach(async ({ page }) => {
await switchToEdgelessMode(page);
const note = await page.waitForSelector('affine-edgeless-note');
{
// move note to avoid menu overlap
const box = (await note.boundingBox())!;
page.mouse.move(box.x + box.width / 2, box.y + box.height / 2);
page.mouse.down();
// sleep to avoid flicker
await page.waitForTimeout(500);
page.mouse.move(box.x + box.width / 2, box.y + box.height / 2 - 200);
await page.waitForTimeout(500);
page.mouse.up();
note.click();
}
await disableEditorBlank(page);
await page.waitForSelector('affine-image').then(i => i.click());
await page
.waitForSelector('affine-image editor-toolbar ask-ai-button')
.then(b => b.click());
});
// skip by default, dalle is very slow
test.skip('generate an image', async ({ page }) => {
await page
.waitForSelector('.ai-item-generate-an-image')
.then(i => i.click());
await page.keyboard.type('a cat');
await page.keyboard.press('Enter');
expect(await collectImageAnswer(page)).toBeTruthy();
});
const processes = [
'Clearer',
'Remove background',
// skip by default, need a face in image
// 'Convert to sticker',
];
for (const process of processes) {
test(`image processing ${process}`, async ({ page }) => {
await page
.waitForSelector('.ai-item-image-processing')
.then(i => i.hover());
await page.getByText(process).click();
{
// to be remove
await page.keyboard.type(',');
await page.keyboard.press('Enter');
}
expect(await collectImageAnswer(page, ONE_MINUTE * 2)).toBeTruthy();
});
}
const filters = ['Clay', 'Sketch', 'Anime', 'Pixel'];
for (const filter of filters) {
test(`ai image ${filter.toLowerCase()} filter`, async ({ page }) => {
await page
.waitForSelector('.ai-item-ai-image-filter')
.then(i => i.hover());
await page.getByText(`${filter} style`).click();
{
// to be remove
await page.keyboard.type(',');
await page.keyboard.press('Enter');
}
expect(await collectImageAnswer(page, ONE_MINUTE * 2)).toBeTruthy();
});
}
});
});
});
+12
View File
@@ -0,0 +1,12 @@
{
"name": "@affine-test/affine-cloud-copilot",
"private": true,
"scripts": {
"e2e": "yarn playwright test"
},
"devDependencies": {
"@affine-test/kit": "workspace:*",
"@playwright/test": "=1.47.2"
},
"version": "0.17.0"
}
@@ -0,0 +1,79 @@
import { testResultDir } from '@affine-test/kit/playwright';
import type {
PlaywrightTestConfig,
PlaywrightWorkerOptions,
} from '@playwright/test';
const config: PlaywrightTestConfig = {
testDir: './e2e',
fullyParallel: !process.env.CI,
timeout: 120_000,
outputDir: testResultDir,
use: {
baseURL: 'http://localhost:8080/',
browserName:
(process.env.BROWSER as PlaywrightWorkerOptions['browserName']) ??
'chromium',
permissions: ['clipboard-read', 'clipboard-write'],
viewport: { width: 1440, height: 800 },
actionTimeout: 10 * 1000,
locale: 'en-US',
trace: 'on',
video: 'on',
},
forbidOnly: !!process.env.CI,
workers: 4,
retries: 3,
reporter: process.env.CI ? 'github' : 'list',
webServer: [
{
command: 'yarn run serve:test-static',
port: 8081,
timeout: 120 * 1000,
reuseExistingServer: !process.env.CI,
env: {
COVERAGE: process.env.COVERAGE || 'false',
ENABLE_DEBUG_PAGE: '1',
},
},
// Intentionally not building the web, reminds you to run it by yourself.
{
command: 'yarn -T run start:web-static',
port: 8080,
timeout: 120 * 1000,
reuseExistingServer: !process.env.CI,
env: {
COVERAGE: process.env.COVERAGE || 'false',
},
},
{
command: 'yarn workspace @affine/server start',
port: 3010,
timeout: 120 * 1000,
reuseExistingServer: !process.env.CI,
stdout: 'pipe',
stderr: 'pipe',
env: {
DATABASE_URL:
process.env.DATABASE_URL ??
'postgresql://affine:affine@localhost:5432/affine',
NODE_ENV: 'development',
AFFINE_ENV: process.env.AFFINE_ENV ?? 'dev',
DEBUG: 'affine:*',
FORCE_COLOR: 'true',
DEBUG_COLORS: 'true',
MAILER_HOST: '0.0.0.0',
MAILER_PORT: '1025',
MAILER_SENDER: 'noreply@toeverything.info',
MAILER_USER: 'noreply@toeverything.info',
MAILER_PASSWORD: 'affine',
},
},
],
};
if (process.env.CI) {
config.retries = 3;
}
export default config;
+16
View File
@@ -0,0 +1,16 @@
{
"extends": "../../tsconfig.json",
"compilerOptions": {
"esModuleInterop": true,
"outDir": "lib"
},
"include": ["e2e"],
"references": [
{
"path": "../../tests/kit"
},
{
"path": "../../tests/fixtures"
}
]
}
+2 -2
View File
@@ -22,8 +22,8 @@ const config: PlaywrightTestConfig = {
video: 'on',
},
forbidOnly: !!process.env.CI,
workers: process.env.CI ? 1 : 4,
retries: 1,
workers: process.env.CI && !process.env.COPILOT ? 1 : 4,
retries: process.env.COPILOT ? 1 : 3,
reporter: process.env.CI ? 'github' : 'list',
webServer: [
{
+1 -19
View File
@@ -16,32 +16,14 @@ import { openHomePage } from '@affine-test/kit/utils/load-page';
import {
clickNewPageButton,
clickPageMoreActions,
getAllPage,
getBlockSuiteEditorTitle,
waitForAllPagesLoad,
waitForEditorLoad,
} from '@affine-test/kit/utils/page-logic';
import { clickSideBarAllPageButton } from '@affine-test/kit/utils/sidebar';
import type { Page } from '@playwright/test';
import { expect } from '@playwright/test';
function getAllPage(page: Page) {
const newPageButton = page.getByTestId('new-page-button-trigger');
const newPageDropdown = newPageButton.locator('svg');
const edgelessBlockCard = page.getByTestId('new-edgeless-button-in-all-page');
async function clickNewPageButton() {
const newPageButton = page.getByTestId('new-page-button-trigger');
return await newPageButton.click();
}
async function clickNewEdgelessDropdown() {
await newPageDropdown.click();
await edgelessBlockCard.click();
}
return { clickNewPageButton, clickNewEdgelessDropdown };
}
test('all page', async ({ page }) => {
await openHomePage(page);
await waitForEditorLoad(page);
+84 -3
View File
@@ -150,6 +150,68 @@ export async function createRandomUser(): Promise<{
} as any;
}
export async function createRandomAIUser(): Promise<{
name: string;
email: string;
password: string;
id: string;
}> {
const user = {
name: faker.internet.userName(),
email: faker.internet.email().toLowerCase(),
password: '123456',
};
const result = await runPrisma(async client => {
const freeFeatureId = await client.feature
.findFirst({
where: { feature: 'free_plan_v1' },
select: { id: true },
orderBy: { version: 'desc' },
})
.then(f => f!.id);
const aiFeatureId = await client.feature
.findFirst({
where: { feature: 'unlimited_copilot' },
select: { id: true },
orderBy: { version: 'desc' },
})
.then(f => f!.id);
await client.user.create({
data: {
...user,
emailVerifiedAt: new Date(),
password: await hash(user.password),
features: {
create: [
{
reason: 'created by test case',
activated: true,
featureId: freeFeatureId,
},
{
reason: 'created by test case',
activated: true,
featureId: aiFeatureId,
},
],
},
},
});
return await client.user.findUnique({
where: {
email: user.email,
},
});
});
cloudUserSchema.parse(result);
return {
...result,
password: user.password,
} as any;
}
export async function deleteUser(email: string) {
await runPrisma(async client => {
await client.user.delete({
@@ -178,7 +240,24 @@ export async function loginUser(
}
await clickSideBarCurrentWorkspaceBanner(page);
await page.getByTestId('cloud-signin-button').click();
await page.getByTestId('cloud-signin-button').click({
delay: 200,
});
await loginUserDirectly(page, user, config);
}
export async function loginUserDirectly(
page: Page,
user: {
email: string;
password: string;
},
config?: {
isElectron?: boolean;
beforeLogin?: () => Promise<void>;
afterLogin?: () => Promise<void>;
}
) {
await page.getByPlaceholder('Enter your email address').fill(user.email);
await page.getByTestId('continue-login-button').click({
delay: 200,
@@ -188,8 +267,10 @@ export async function loginUser(
await config.beforeLogin();
}
await page.waitForTimeout(200);
await page.getByTestId('sign-in-button').click();
await page.waitForTimeout(500);
const signIn = page.getByTestId('sign-in-button');
await signIn.click();
await signIn.waitFor({ state: 'detached' });
await page.waitForTimeout(200);
if (config?.afterLogin) {
await config.afterLogin();
}
+5 -1
View File
@@ -1,7 +1,11 @@
import type { Page } from '@playwright/test';
import { expect } from '@playwright/test';
export const coreUrl = 'http://localhost:8080';
export let coreUrl = 'http://localhost:8080';
export function setCoreUrl(url: string) {
coreUrl = url;
}
export async function openHomePage(page: Page) {
await page.goto(coreUrl);
+18
View File
@@ -1,6 +1,24 @@
import type { Locator, Page } from '@playwright/test';
import { expect } from '@playwright/test';
export function getAllPage(page: Page) {
const newPageButton = page.getByTestId('new-page-button-trigger');
const newPageDropdown = newPageButton.locator('svg');
const edgelessBlockCard = page.getByTestId('new-edgeless-button-in-all-page');
async function clickNewPageButton() {
const newPageButton = page.getByTestId('new-page-button-trigger');
return await newPageButton.click();
}
async function clickNewEdgelessDropdown() {
await newPageDropdown.click();
await edgelessBlockCard.click();
}
return { clickNewPageButton, clickNewEdgelessDropdown };
}
export async function waitForEditorLoad(page: Page) {
await page.waitForSelector('v-line', {
timeout: 20000,
+19
View File
@@ -0,0 +1,19 @@
import { WebClient } from '@slack/web-api';
import { render } from './markdown.js';
const { CHANNEL_ID, SLACK_BOT_TOKEN, COPILOT_RESULT, BRANCH_SHA, BRANCH_NAME } =
process.env;
const { ok } = await new WebClient(SLACK_BOT_TOKEN).chat.postMessage({
channel: CHANNEL_ID,
text: `AFFiNE Copilot Test ${COPILOT_RESULT}`,
blocks: render(
`# AFFiNE Copilot Test ${COPILOT_RESULT}
- [${BRANCH_NAME?.replace('refs/heads/', '') || BRANCH_SHA}](https://github.com/toeverything/AFFiNE/commit/${BRANCH_SHA})
`
),
});
console.assert(ok, 'Failed to send a message to Slack');
+25
View File
@@ -0,0 +1,25 @@
import { jsxslack } from 'jsx-slack';
import { marked, Renderer } from 'marked';
export const render = markdown => {
const rendered = marked(markdown, {
renderer: new (class CustomRenderer extends Renderer {
heading({ tokens }) {
return `
<Fragment>
<Section><b>${tokens[0].text}</b></Section>
<Divider />
</Fragment>`;
}
list(token) {
return `<Section>${super.list(token)}</Section>`;
}
hr() {
return `<Divider />`;
}
})(),
});
return jsxslack([`<Blocks>${rendered}</Blocks>`]);
};
+16
View File
@@ -0,0 +1,16 @@
{
"name": "@affine/copilot-result",
"version": "0.17.0",
"type": "module",
"main": "index.js",
"private": true,
"description": "Send copilot result to slack",
"dependencies": {
"@slack/web-api": "^7.3.4",
"jsx-slack": "^6.1.1",
"marked": "^14.0.0"
},
"devDependencies": {
"@types/node": "^20.14.12"
}
}
+20
View File
@@ -67,6 +67,15 @@ __metadata:
languageName: unknown
linkType: soft
"@affine-test/affine-cloud-copilot@workspace:tests/affine-cloud-copilot":
version: 0.0.0-use.local
resolution: "@affine-test/affine-cloud-copilot@workspace:tests/affine-cloud-copilot"
dependencies:
"@affine-test/kit": "workspace:*"
"@playwright/test": "npm:=1.47.2"
languageName: unknown
linkType: soft
"@affine-test/affine-cloud@workspace:tests/affine-cloud":
version: 0.0.0-use.local
resolution: "@affine-test/affine-cloud@workspace:tests/affine-cloud"
@@ -377,6 +386,17 @@ __metadata:
languageName: unknown
linkType: soft
"@affine/copilot-result@workspace:tools/copilot-result":
version: 0.0.0-use.local
resolution: "@affine/copilot-result@workspace:tools/copilot-result"
dependencies:
"@slack/web-api": "npm:^7.3.4"
"@types/node": "npm:^20.14.12"
jsx-slack: "npm:^6.1.1"
marked: "npm:^14.0.0"
languageName: unknown
linkType: soft
"@affine/core@workspace:*, @affine/core@workspace:packages/frontend/core":
version: 0.0.0-use.local
resolution: "@affine/core@workspace:packages/frontend/core"