feat(core): allow running in worker (#967)

Author: yuyutaotao

packages/core/src/ai-model/action-executor.ts

@@ -152,7 +152,8 @@ export class Executor {
         taskIndex++;
       } catch (e: any) {
         successfullyCompleted = false;
-        task.error =
+        task.error = e;
+        task.errorMessage =
           e?.message || (typeof e === 'string' ? e : 'error-without-message');
         task.errorStack = e.stack;
 

packages/core/src/types.ts

@@ -430,7 +430,8 @@ export type ExecutionTask<
       : unknown
   > & {
     status: 'pending' | 'running' | 'finished' | 'failed' | 'cancelled';
-    error?: string;
+    error?: Error;
+    errorMessage?: string;
     errorStack?: string;
     timing?: {
       start: number;

packages/core/src/utils.ts

@@ -16,7 +16,12 @@ import {
 } from '@midscene/shared/env';
 import { getRunningPkgInfo } from '@midscene/shared/fs';
 import { assert, logMsg } from '@midscene/shared/utils';
-import { escapeScriptTag, ifInBrowser, uuid } from '@midscene/shared/utils';
+import {
+  escapeScriptTag,
+  ifInBrowser,
+  ifInWorker,
+  uuid,
+} from '@midscene/shared/utils';
 import type { Rect, ReportDumpWithAttributes } from './types';
 
 let logEnvReady = false;
@@ -132,7 +137,7 @@ export function writeDumpReport(
   dumpData: string | ReportDumpWithAttributes,
   appendReport?: boolean,
 ): string | null {
-  if (ifInBrowser) {
+  if (ifInBrowser || ifInWorker) {
     console.log('will not write report in browser');
     return null;
   }
@@ -179,7 +184,7 @@ export function writeLogFile(opts: {
   generateReport?: boolean;
   appendReport?: boolean;
 }) {
-  if (ifInBrowser) {
+  if (ifInBrowser || ifInWorker) {
     return '/mock/report.html';
   }
   const { fileName, fileExt, fileContent, type = 'dump' } = opts;
@@ -242,7 +247,7 @@ export function getTmpDir(): string | null {
 }
 
 export function getTmpFile(fileExtWithoutDot: string): string | null {
-  if (ifInBrowser) {
+  if (ifInBrowser || ifInWorker) {
     return null;
   }
   const tmpDir = getTmpDir();

packages/shared/src/img/get-jimp.ts

@@ -1,14 +1,12 @@
 // @ts-ignore
-import type Jimp from 'jimp/browser/lib/jimp.js';
+import Jimp from 'jimp';
+import { ifInBrowser, ifInWorker } from '../utils';
 
-const ifInBrowser = typeof window !== 'undefined';
 export default async function getJimp(): Promise<typeof Jimp> {
-  if (ifInBrowser) {
+  if (ifInBrowser || ifInWorker) {
     // @ts-ignore
     await import('jimp/browser/lib/jimp.js');
-    return (window as any).Jimp;
+    return (typeof window !== 'undefined' ? window : (self as any)).Jimp;
   }
-  // return Jimp;
-  // @ts-ignore
-  return (await import('jimp')).default;
+  return Jimp;
 }

packages/shared/src/node/fs.ts

@@ -1,6 +1,6 @@
 import { existsSync, readFileSync } from 'node:fs';
 import { dirname, join } from 'node:path';
-import { ifInBrowser } from '../utils';
+import { ifInBrowser, ifInWorker } from '../utils';
 
 declare const __HTML_ELEMENT_SCRIPT__: string;
 
@@ -13,7 +13,7 @@ interface PkgInfo {
 const pkgCacheMap: Record<string, PkgInfo> = {};
 
 export function getRunningPkgInfo(dir?: string): PkgInfo | null {
-  if (ifInBrowser) {
+  if (ifInBrowser || ifInWorker) {
     return null;
   }
   const dirToCheck = dir || process.cwd();
@@ -71,7 +71,7 @@ export function getElementInfosScriptContent() {
 }
 
 export async function getExtraReturnLogic(tree = false) {
-  if (ifInBrowser) {
+  if (ifInBrowser || ifInWorker) {
     return null;
   }
 

packages/shared/src/utils.ts

@@ -1,6 +1,9 @@
 import { sha256 } from 'js-sha256';
 
+declare const WorkerGlobalScope: any;
+
 export const ifInBrowser = typeof window !== 'undefined';
+export const ifInWorker = typeof WorkerGlobalScope !== 'undefined';
 
 export function uuid(): string {
   return Math.random().toString(36).substring(2, 15);

packages/visualizer/src/component/replay-scripts.tsx

@@ -415,7 +415,7 @@ export const generateAnimationScripts = (
     if (task.status !== 'finished') {
       errorStateFlag = true;
       const errorTitle = typeStr(task);
-      const errorMsg = task.error || 'unknown error';
+      const errorMsg = task.errorMessage || 'unknown error';
       const errorSubTitle =
         errorMsg.indexOf('NOT_IMPLEMENTED_AS_DESIGNED') > 0
           ? 'Further actions cannot be performed in the current environment'

packages/web-integration/src/chrome-extension/dynamic-scripts.ts

@@ -1,13 +1,13 @@
 import fs from 'node:fs';
-import { ifInBrowser } from '@midscene/shared/utils';
+import { ifInBrowser, ifInWorker } from '@midscene/shared/utils';
 
 // remember to include this file into extension's package
 // extract html element from page
 let scriptFileContentCache: string | null = null;
 export const getHtmlElementScript = async () => {
   const scriptFileToRetrieve = chrome.runtime.getURL('scripts/htmlElement.js');
   if (scriptFileContentCache) return scriptFileContentCache;
-  if (ifInBrowser) {
+  if (ifInBrowser || ifInWorker) {
     const script = await fetch(scriptFileToRetrieve);
     scriptFileContentCache = await script.text();
     return scriptFileContentCache;
@@ -22,7 +22,7 @@ export const injectWaterFlowAnimation = async () => {
     'scripts/water-flow.js',
   );
   if (waterFlowScriptFileContentCache) return waterFlowScriptFileContentCache;
-  if (ifInBrowser) {
+  if (ifInBrowser || ifInWorker) {
     const script = await fetch(waterFlowScriptFileToRetrieve);
     waterFlowScriptFileContentCache = await script.text();
     return waterFlowScriptFileContentCache;
@@ -38,7 +38,7 @@ export const injectStopWaterFlowAnimation = async () => {
   );
   if (stopWaterFlowScriptFileContentCache)
     return stopWaterFlowScriptFileContentCache;
-  if (ifInBrowser) {
+  if (ifInBrowser || ifInWorker) {
     const script = await fetch(stopWaterFlowScriptFileToRetrieve);
     stopWaterFlowScriptFileContentCache = await script.text();
     return stopWaterFlowScriptFileContentCache;

packages/web-integration/src/chrome-extension/page.ts

@@ -44,6 +44,8 @@ export default class ChromeExtensionProxyPage implements AbstractPage {
 
   private isMobileEmulation: boolean | null = null;
 
+  public _continueWhenFailedToAttachDebugger = false;
+
   constructor(forceSameTabNavigation: boolean) {
     this.forceSameTabNavigation = forceSameTabNavigation;
   }
@@ -143,7 +145,19 @@ export default class ChromeExtensionProxyPage implements AbstractPage {
 
         // detach any debugger attached to the tab
         console.log('attaching debugger', currentTabId);
-        await chrome.debugger.attach({ tabId: currentTabId }, '1.3');
+        try {
+          await chrome.debugger.attach({ tabId: currentTabId }, '1.3');
+        } catch (e) {
+          if (this._continueWhenFailedToAttachDebugger) {
+            console.warn(
+              'Failed to attach debugger, but the script will continue as if the debugger is attached since the _continueWhenFailedToAttachDebugger is true',
+              e,
+            );
+          } else {
+            throw e;
+          }
+        }
+
         // wait util the debugger banner in Chrome appears
         await sleep(500);
 

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

@@ -265,7 +265,9 @@ export class PageAgent<PageType extends WebPage = WebPage> {
 
     if (executor.isInErrorState() && !doNotThrowError) {
       const errorTask = executor.latestErrorTask();
-      throw new Error(`${errorTask?.error}\n${errorTask?.errorStack}`);
+      throw new Error(`${errorTask?.errorMessage}\n${errorTask?.errorStack}`, {
+        cause: errorTask?.error,
+      });
     }
   }