feat(web-integration): agent support override report name (#998)

Author: quanru

packages/core/tests/unit-test/utils.test.ts

@@ -13,7 +13,11 @@ import {
   safeParseJson,
 } from '@/ai-model/service-caller';
 import { getMidsceneRunSubDir } from '@midscene/shared/common';
-import { getAIConfig, overrideAIConfig } from '@midscene/shared/env';
+import {
+  getAIConfig,
+  overrideAIConfig,
+  vlLocateMode,
+} from '@midscene/shared/env';
 import { describe, expect, it } from 'vitest';
 import { reportHTMLContent, writeDumpReport } from '../../dist/es/utils'; // use modules from dist, otherwise we will miss the template file
 import {
@@ -565,14 +569,17 @@ describe('search area', () => {
       { left: 100, top: 100, width: 100, height: 100 },
       { width: 1000, height: 1000 },
     );
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "height": 300,
-        "left": 0,
-        "top": 0,
-        "width": 300,
-      }
-    `);
+
+    // Dynamic expectation based on vlLocateMode
+    const isDoubaoVision = vlLocateMode() === 'doubao-vision';
+    const expectedSize = isDoubaoVision ? 500 : 300;
+
+    expect(result).toEqual({
+      height: expectedSize,
+      left: 0,
+      top: 0,
+      width: expectedSize,
+    });
   });
 
   it('expandSearchArea with a big rect', () => {
@@ -595,14 +602,27 @@ describe('search area', () => {
       { left: 951, top: 800, width: 50, height: 50 },
       { width: 1000, height: 1000 },
     );
-    expect(result).toMatchInlineSnapshot(`
-      {
-        "height": 300,
-        "left": 826,
-        "top": 675,
-        "width": 174,
-      }
-    `);
+
+    // Dynamic expectation based on vlLocateMode
+    const isDoubaoVision = vlLocateMode() === 'doubao-vision';
+
+    if (isDoubaoVision) {
+      // minEdgeSize = 500, paddingSize = 225
+      expect(result).toEqual({
+        height: 425, // min(50 + 225*2, 1000 - 575) = min(500, 425) = 425
+        left: 726, // max(0, 951 - 225) = 726
+        top: 575, // max(0, 800 - 225) = 575
+        width: 274, // min(50 + 225*2, 1000 - 726) = min(500, 274) = 274
+      });
+    } else {
+      // minEdgeSize = 300, paddingSize = 125
+      expect(result).toEqual({
+        height: 300, // min(50 + 125*2, 1000 - 675) = min(300, 325) = 300
+        left: 826, // max(0, 951 - 125) = 826
+        top: 675, // max(0, 800 - 125) = 675
+        width: 174, // min(50 + 125*2, 1000 - 826) = min(300, 174) = 174
+      });
+    }
   });
 });
 

packages/web-integration/src/common/agent.ts

@@ -90,6 +90,8 @@ export interface PageAgentOpt {
   autoPrintReportMsg?: boolean;
   onTaskStartTip?: OnTaskStartTip;
   aiActionContext?: string;
+  /* custom report file name */
+  reportFileName?: string;
 }
 
 export type WebPageAgentOpt = PageAgentOpt & WebPageOpt;
@@ -176,9 +178,9 @@ export class PageAgent<PageType extends WebPage = WebPage> {
       onTaskStart: this.callbackOnTaskStartTip.bind(this),
     });
     this.dump = this.resetDump();
-    this.reportFileName = getReportFileName(
-      opts?.testId || this.page.pageType || 'web',
-    );
+    this.reportFileName =
+      opts?.reportFileName ||
+      getReportFileName(opts?.testId || this.page.pageType || 'web');
   }
 
   async getUIContext(action?: InsightAction): Promise<WebUIContext> {

packages/web-integration/tests/ai/web/static/static-page.test.ts

@@ -3,7 +3,8 @@ import { join } from 'node:path';
 import { StaticPageAgent } from '@/playground/agent';
 import PlaygroundServer from '@/playground/server';
 import StaticPage from '@/playground/static-page';
-import { describe, expect, it } from 'vitest';
+import { allConfigFromEnv } from '@midscene/shared/env';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 
 const dumpFilePath = join(__dirname, '../../fixtures/ui-context.json');
 const context = readFileSync(dumpFilePath, { encoding: 'utf-8' });
@@ -12,6 +13,16 @@ const contextJson = JSON.parse(context);
 describe(
   'static page agent',
   () => {
+    let server: PlaygroundServer | null = null;
+    
+    afterEach(() => {
+      // Clean up server if it exists
+      if (server) {
+        server.close();
+        server = null;
+      }
+    });
+    
     it('agent should work', async () => {
       const page = new StaticPage(contextJson);
 
@@ -23,7 +34,17 @@ describe(
     });
 
     it('server should work', async () => {
-      const server = new PlaygroundServer(StaticPage, StaticPageAgent);
+      // Save current config before creating server
+      const currentConfig = (globalThis as any).midsceneGlobalConfig;
+      
+      server = new PlaygroundServer(StaticPage, StaticPageAgent);
+      
+      // Restore config after server creation in case it was cleared
+      if (!(globalThis as any).midsceneGlobalConfig || 
+          Object.keys((globalThis as any).midsceneGlobalConfig || {}).length === 0) {
+        (globalThis as any).midsceneGlobalConfig = currentConfig || allConfigFromEnv();
+      }
+      
       await server.launch();
 
       const port = server.port;
@@ -46,7 +67,6 @@ describe(
       const data = await res.json();
       expect(data.result).toBeDefined();
       expect(data.error).toBeFalsy();
-      server.close();
     });
   },
   {

packages/web-integration/tests/unit-test/agent.test.ts

@@ -11,6 +11,38 @@ vi.mock('@/common/plan-builder', () => ({
   buildPlans: vi.fn(),
 }));
 
+// Mock only the necessary parts to avoid side effects
+vi.mock('@midscene/core/utils', () => ({
+  writeLogFile: vi.fn(() => null),
+  reportHTMLContent: vi.fn(() => ''),
+  stringifyDumpData: vi.fn(() => '{}'),
+  groupedActionDumpFileExt: '.json',
+}));
+
+vi.mock('@midscene/shared/logger', () => ({
+  getDebug: vi.fn(() => vi.fn()),
+  logMsg: vi.fn(),
+}));
+
+vi.mock('@midscene/core', async () => {
+  const actual = await vi.importActual('@midscene/core');
+  return {
+    ...actual,
+    Insight: vi.fn().mockImplementation(() => ({})),
+  };
+});
+
+// Partial mock for utils - only mock the async functions that need mocking
+vi.mock('@/common/utils', async () => {
+  const actual = await vi.importActual('@/common/utils');
+  return {
+    ...actual,
+    parseContextFromWebPage: vi.fn().mockResolvedValue({}),
+    trimContextByViewport: vi.fn((execution) => execution),
+    printReportMsg: vi.fn(),
+  };
+});
+
 // Mock page implementation
 const mockPage = {
   pageType: 'puppeteer',
@@ -19,6 +51,8 @@ const mockPage = {
   },
   screenshotBase64: vi.fn().mockResolvedValue('mock-screenshot'),
   evaluateJavaScript: vi.fn(),
+  size: vi.fn().mockResolvedValue({ dpr: 1 }),
+  destroy: vi.fn(),
 } as unknown as WebPage;
 
 // Mock task executor
@@ -205,3 +239,65 @@ describe('PageAgent logContent', () => {
     expect(agent.dump.executions[0].tasks[0].log).toBeDefined();
   });
 });
+
+describe('PageAgent reportFileName', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('should use external reportFileName when provided', () => {
+    const customReportName = 'my-custom-report-name';
+    const agent = new PageAgent(mockPage, {
+      reportFileName: customReportName,
+    });
+
+    expect(agent.reportFileName).toBe(customReportName);
+  });
+
+  it('should generate reportFileName when not provided', () => {
+    const agent = new PageAgent(mockPage);
+
+    // The generated name should contain puppeteer and follow the pattern
+    // Note: uuid() generates base-36 strings (0-9, a-z)
+    expect(agent.reportFileName).toMatch(
+      /puppeteer-\d{4}-\d{2}-\d{2}_\d{2}-\d{2}-\d{2}-[a-z0-9]{8}/,
+    );
+  });
+
+  it('should use testId for generated reportFileName when provided', () => {
+    const agent = new PageAgent(mockPage, {
+      testId: 'test-123',
+    });
+
+    // The generated name should contain test-123 and follow the pattern
+    // Note: uuid() generates base-36 strings (0-9, a-z)
+    expect(agent.reportFileName).toMatch(
+      /test-123-\d{4}-\d{2}-\d{2}_\d{2}-\d{2}-\d{2}-[a-z0-9]{8}/,
+    );
+  });
+
+  it('should prioritize external reportFileName over testId', () => {
+    const customReportName = 'my-custom-report';
+    const agent = new PageAgent(mockPage, {
+      reportFileName: customReportName,
+      testId: 'test-456',
+    });
+
+    expect(agent.reportFileName).toBe(customReportName);
+  });
+
+  it('should fallback to "web" when pageType is not available', () => {
+    const mockPageWithoutType = {
+      ...mockPage,
+      pageType: undefined,
+    } as unknown as WebPage;
+
+    const agent = new PageAgent(mockPageWithoutType);
+
+    // The generated name should contain web and follow the pattern
+    // Note: uuid() generates base-36 strings (0-9, a-z)
+    expect(agent.reportFileName).toMatch(
+      /web-\d{4}-\d{2}-\d{2}_\d{2}-\d{2}-\d{2}-[a-z0-9]{8}/,
+    );
+  });
+});