workflow(ci): optimize ai unit test (#56)

.github/workflows/ai.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.19.0]
+
+    env:
+      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+      OPENAI_BASE_URL: ${{ secrets.OPENAI_BASE_URL }}
+      MIDSCENE_MODEL_NAME: ${{ secrets.MIDSCENE_MODEL_NAME }}
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Setup pnpm
+      uses: pnpm/action-setup@v2
+      with:
+        version: 9.3.0
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '18'
+        cache: 'pnpm'
+
+    - name: Install dependencies
+      run: pnpm install --frozen-lockfile
+
+    - name: Build project
+      run: pnpm run build:pkg
+
+    - name: Run tests
+      run: pnpm run test

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: CI
+name: AI test
 
 on:
   push:
@@ -16,8 +16,9 @@ jobs:
         node-version: [18.19.0]
 
     env:
-      MIDSCENE_OPENAI_INIT_CONFIG_JSON: ${{ secrets.MIDSCENE_OPENAI_INIT_CONFIG_JSON }}
-      MIDSCENE_OPENAI_MODEL: ${{ secrets.MIDSCENE_OPENAI_MODEL }}
+      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+      OPENAI_BASE_URL: ${{ secrets.OPENAI_BASE_URL }}
+      MIDSCENE_MODEL_NAME: ${{ secrets.MIDSCENE_MODEL_NAME }}
 
     steps:
     - uses: actions/checkout@v4

CONTRIBUTING.md

@@ -106,7 +106,15 @@ pnpm run build:pkg
 
 ---
 
-## Testing
+### Testing
+
+To change the AI-related code of this repository, you need to create a '.env 'file in the root directory, which reads as follows:
+
+```
+OPENAI_API_KEY="you_token"
+MIDSCENE_MODEL_NAME="gpt-4o-2024-08-06"
+```
+
 
 ### Add New Tests
 
@@ -120,12 +128,16 @@ Before submitting a pull request, it's important to make sure that the changes h
 
 ```sh
 pnpm run test
+# Test with AI-related features, it will need to create a .env file
+pnpm run test:all
 ```
 
 You can also run the unit tests of single package:
 
 ```sh
 npx nx test @midscene/web
+# Test with AI-related features, it will need to create a .env file
+npx nx test:all @midscene/web
 ```
 
 ### Run E2E Tests

package.json

@@ -5,6 +5,7 @@
   "scripts": {
     "build:pkg": "nx run-many --target=build --projects=@midscene/core,@midscene/visualizer,@midscene/web --verbose",
     "test": "nx run-many --target=test --projects=@midscene/core,@midscene/visualizer,@midscene/web --verbose",
+    "test:ai": "nx run-many --target=test:ai --projects=@midscene/core,@midscene/visualizer,@midscene/web --verbose",
     "e2e": "nx run-many --target=e2e --projects=@midscene/core,@midscene/visualizer,@midscene/web --verbose",
     "prepare": "pnpm run build:pkg && simple-git-hooks",
     "check-dependency-version": "check-dependency-version-consistency .",

packages/cli/package.json

@@ -21,7 +21,7 @@
   "dependencies": {
     "@midscene/web": "workspace:*",
     "ora-classic": "5.4.2",
-    "puppeteer": "^22.8.0",
+    "puppeteer": "23.0.2",
     "yargs": "17.7.2"
   },
   "devDependencies": {

packages/midscene/package.json

@@ -54,22 +54,23 @@
     "new": "modern new",
     "upgrade": "modern upgrade",
     "test": "vitest --run",
-    "test:all": "AITEST=true vitest --run",
+    "test:ai": "AITEST=true npm run test",
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
+    "node-fetch": "2.6.7",
     "openai": "4.47.1",
-    "sharp": "0.33.3",
-    "node-fetch": "2.6.7"
+    "optional": "0.1.4",
+    "sharp": "0.33.3"
   },
   "devDependencies": {
-    "@types/node-fetch": "2.6.11",
     "@modern-js/module-tools": "^2.56.1",
     "@types/node": "^18.0.0",
+    "@types/node-fetch": "2.6.11",
+    "dotenv": "16.4.5",
     "langsmith": "0.1.36",
     "typescript": "~5.0.4",
-    "vitest": "^1.6.0",
-    "dotenv": "16.4.5"
+    "vitest": "^1.6.0"
   },
   "engines": {
     "node": ">=16.0.0"

packages/midscene/src/ai-model/coze/index.ts

@@ -59,8 +59,8 @@ export async function callCozeAi<T>(options: {
 
   const aiResponse = await completion.json();
   if (aiResponse.code !== 0) {
-    console.error('CozeAI error response', aiResponse);
-    throw new Error('CozeAI error response', aiResponse);
+    console.error('CozeAI error response', aiResponse.msg);
+    throw new Error(`CozeAI error response ${aiResponse.msg}`);
   }
 
   if (!aiResponse?.messages || !aiResponse?.messages[0]?.content) {

packages/midscene/src/ai-model/openai/index.ts

@@ -53,6 +53,7 @@ export async function call(
     model,
     messages,
     response_format: { type: responseFormat },
+    temperature: 0.2,
   });
 
   const { content } = completion.choices[0].message;