@midscene/web 0.19.1 → 0.20.0

package/dist/lib/playground.js

@@ -38,11 +38,11 @@ module.exports = __toCommonJS(playground_exports);
 
 // src/common/utils.ts
 var import_ai_model = require("@midscene/core/ai-model");
-var import_utils = require("@midscene/core/utils");
+var import_utils3 = require("@midscene/core/utils");
 var import_env = require("@midscene/shared/env");
 var import_extractor = require("@midscene/shared/extractor");
 var import_img = require("@midscene/shared/img");
-var import_utils2 = require("@midscene/shared/utils");
+var import_utils4 = require("@midscene/shared/utils");
 var import_dayjs = __toESM(require("dayjs"));
 
 // src/web-element.ts
@@ -70,14 +70,189 @@ var WebElementInfo = class {
   }
 };
 
+// src/common/task-cache.ts
+var import_node_assert = __toESM(require("assert"));
+var import_node_fs = require("fs");
+var import_node_path = require("path");
+var import_common = require("@midscene/shared/common");
+var import_logger = require("@midscene/shared/logger");
+var import_utils = require("@midscene/shared/utils");
+var import_js_yaml = __toESM(require("js-yaml"));
+var import_semver = __toESM(require("semver"));
+
+// package.json
+var version = "0.20.0";
+
+// src/common/task-cache.ts
+var debug = (0, import_logger.getDebug)("cache");
+var lowestSupportedMidsceneVersion = "0.16.10";
+var cacheFileExt = ".cache.yaml";
+var TaskCache = class {
+  // Track matched records
+  constructor(cacheId, isCacheResultUsed, cacheFilePath) {
+    this.matchedCacheIndices = /* @__PURE__ */ new Set();
+    (0, import_node_assert.default)(cacheId, "cacheId is required");
+    this.cacheId = replaceIllegalPathCharsAndSpace(cacheId);
+    this.cacheFilePath = import_utils.ifInBrowser ? void 0 : cacheFilePath || (0, import_node_path.join)((0, import_common.getMidsceneRunSubDir)("cache"), `${this.cacheId}${cacheFileExt}`);
+    this.isCacheResultUsed = isCacheResultUsed;
+    let cacheContent;
+    if (this.cacheFilePath) {
+      cacheContent = this.loadCacheFromFile();
+    }
+    if (!cacheContent) {
+      cacheContent = {
+        midsceneVersion: version,
+        cacheId: this.cacheId,
+        caches: []
+      };
+    }
+    this.cache = cacheContent;
+    this.cacheOriginalLength = this.cache.caches.length;
+  }
+  matchCache(prompt, type) {
+    for (let i = 0; i < this.cacheOriginalLength; i++) {
+      const item = this.cache.caches[i];
+      const key = `${type}:${prompt}:${i}`;
+      if (item.type === type && item.prompt === prompt && !this.matchedCacheIndices.has(key)) {
+        this.matchedCacheIndices.add(key);
+        debug(
+          "cache found and marked as used, type: %s, prompt: %s, index: %d",
+          type,
+          prompt,
+          i
+        );
+        return {
+          cacheContent: item,
+          updateFn: (cb) => {
+            debug(
+              "will call updateFn to update cache, type: %s, prompt: %s, index: %d",
+              type,
+              prompt,
+              i
+            );
+            cb(item);
+            debug(
+              "cache updated, will flush to file, type: %s, prompt: %s, index: %d",
+              type,
+              prompt,
+              i
+            );
+            this.flushCacheToFile();
+          }
+        };
+      }
+    }
+    debug("no unused cache found, type: %s, prompt: %s", type, prompt);
+    return void 0;
+  }
+  matchPlanCache(prompt) {
+    return this.matchCache(prompt, "plan");
+  }
+  matchLocateCache(prompt) {
+    return this.matchCache(prompt, "locate");
+  }
+  appendCache(cache) {
+    debug("will append cache", cache);
+    this.cache.caches.push(cache);
+    this.flushCacheToFile();
+  }
+  loadCacheFromFile() {
+    const cacheFile = this.cacheFilePath;
+    (0, import_node_assert.default)(cacheFile, "cache file path is required");
+    if (!(0, import_node_fs.existsSync)(cacheFile)) {
+      debug("no cache file found, path: %s", cacheFile);
+      return void 0;
+    }
+    const jsonTypeCacheFile = cacheFile.replace(cacheFileExt, ".json");
+    if ((0, import_node_fs.existsSync)(jsonTypeCacheFile) && this.isCacheResultUsed) {
+      console.warn(
+        `An outdated cache file from an earlier version of Midscene has been detected. Since version 0.17, we have implemented an improved caching strategy. Please delete the old file located at: ${jsonTypeCacheFile}.`
+      );
+      return void 0;
+    }
+    try {
+      const data = (0, import_node_fs.readFileSync)(cacheFile, "utf8");
+      const jsonData = import_js_yaml.default.load(data);
+      if (!version) {
+        debug("no midscene version info, will not read cache from file");
+        return void 0;
+      }
+      if (import_semver.default.lt(jsonData.midsceneVersion, lowestSupportedMidsceneVersion) && !jsonData.midsceneVersion.includes("beta")) {
+        console.warn(
+          `You are using an old version of Midscene cache file, and we cannot match any info from it. Starting from Midscene v0.17, we changed our strategy to use xpath for cache info, providing better performance.
+Please delete the existing cache and rebuild it. Sorry for the inconvenience.
+cache file: ${cacheFile}`
+        );
+        return void 0;
+      }
+      debug(
+        "cache loaded from file, path: %s, cache version: %s, record length: %s",
+        cacheFile,
+        jsonData.midsceneVersion,
+        jsonData.caches.length
+      );
+      jsonData.midsceneVersion = version;
+      return jsonData;
+    } catch (err) {
+      debug(
+        "cache file exists but load failed, path: %s, error: %s",
+        cacheFile,
+        err
+      );
+      return void 0;
+    }
+  }
+  flushCacheToFile() {
+    if (!version) {
+      debug("no midscene version info, will not write cache to file");
+      return;
+    }
+    if (!this.cacheFilePath) {
+      debug("no cache file path, will not write cache to file");
+      return;
+    }
+    try {
+      const dir = (0, import_node_path.dirname)(this.cacheFilePath);
+      if (!(0, import_node_fs.existsSync)(dir)) {
+        (0, import_node_fs.mkdirSync)(dir, { recursive: true });
+        debug("created cache directory: %s", dir);
+      }
+      const yamlData = import_js_yaml.default.dump(this.cache);
+      (0, import_node_fs.writeFileSync)(this.cacheFilePath, yamlData);
+      debug("cache flushed to file: %s", this.cacheFilePath);
+    } catch (err) {
+      debug(
+        "write cache to file failed, path: %s, error: %s",
+        this.cacheFilePath,
+        err
+      );
+    }
+  }
+  updateOrAppendCacheRecord(newRecord, cachedRecord) {
+    if (cachedRecord) {
+      if (newRecord.type === "plan") {
+        cachedRecord.updateFn((cache) => {
+          cache.yamlWorkflow = newRecord.yamlWorkflow;
+        });
+      } else {
+        cachedRecord.updateFn((cache) => {
+          cache.xpaths = newRecord.xpaths;
+        });
+      }
+    } else {
+      this.appendCache(newRecord);
+    }
+  }
+};
+
 // src/common/utils.ts
 async function parseContextFromWebPage(page, _opt) {
-  (0, import_utils2.assert)(page, "page is required");
+  (0, import_utils4.assert)(page, "page is required");
   if (page._forceUsePageContext) {
     return await page._forceUsePageContext();
   }
   const url = await page.url();
-  (0, import_utils.uploadTestInfoToServer)({ testUrl: url });
+  (0, import_utils3.uploadTestInfoToServer)({ testUrl: url });
   let screenshotBase64;
   let tree;
   await Promise.all([
@@ -99,7 +274,7 @@ async function parseContextFromWebPage(page, _opt) {
       isVisible
     });
   });
-  (0, import_utils2.assert)(screenshotBase64, "screenshotBase64 is required");
+  (0, import_utils4.assert)(screenshotBase64, "screenshotBase64 is required");
   const size = await page.size();
   if (size.dpr && size.dpr > 1) {
     screenshotBase64 = await (0, import_img.resizeImgBase64)(screenshotBase64, {
@@ -117,11 +292,11 @@ async function parseContextFromWebPage(page, _opt) {
 function reportFileName(tag = "web") {
   const reportTagName = (0, import_env.getAIConfig)(import_env.MIDSCENE_REPORT_TAG_NAME);
   const dateTimeInFileName = (0, import_dayjs.default)().format("YYYY-MM-DD_HH-mm-ss");
-  const uniqueId = (0, import_utils2.uuid)().substring(0, 8);
+  const uniqueId = (0, import_utils4.uuid)().substring(0, 8);
   return `${reportTagName || tag}-${dateTimeInFileName}-${uniqueId}`;
 }
 function printReportMsg(filepath) {
-  (0, import_utils2.logMsg)(`Midscene - report file updated: ${filepath}`);
+  (0, import_utils4.logMsg)(`Midscene - report file updated: ${filepath}`);
 }
 var ERROR_CODE_NOT_IMPLEMENTED_AS_DESIGNED = "NOT_IMPLEMENTED_AS_DESIGNED";
 function replaceIllegalPathCharsAndSpace(str) {
@@ -147,6 +322,28 @@ function matchElementFromPlan(planLocateParam, tree) {
   }
   return void 0;
 }
+async function matchElementFromCache(taskExecutor, xpaths, cachePrompt, cacheable) {
+  try {
+    if (xpaths?.length && taskExecutor.taskCache?.isCacheResultUsed && cacheable !== false) {
+      for (let i = 0; i < xpaths.length; i++) {
+        const element = await taskExecutor.page.getElementInfoByXpath(
+          xpaths[i]
+        );
+        if (element?.id) {
+          debug("cache hit, prompt: %s", cachePrompt);
+          debug(
+            "found a new new element with same xpath, xpath: %s, id: %s",
+            xpaths[i],
+            element?.id
+          );
+          return element;
+        }
+      }
+    }
+  } catch (error) {
+    debug("get element info by xpath error: ", error);
+  }
+}
 function trimContextByViewport(execution) {
   function filterVisibleTree(node) {
     if (!node)
@@ -189,10 +386,10 @@ var import_core2 = require("@midscene/core");
 var import_js_yaml4 = __toESM(require("js-yaml"));
 
 // src/yaml/player.ts
-var import_node_fs = require("fs");
-var import_node_path = require("path");
-var import_utils3 = require("@midscene/shared/utils");
-var import_common = require("@midscene/shared/common");
+var import_node_fs2 = require("fs");
+var import_node_path2 = require("path");
+var import_utils5 = require("@midscene/shared/utils");
+var import_common2 = require("@midscene/shared/common");
 var ScriptPlayer = class {
   constructor(script, setupAgent, onTaskStatusChange) {
     this.script = script;
@@ -204,23 +401,23 @@ var ScriptPlayer = class {
     this.pageAgent = null;
     this.result = {};
     this.target = script.target || script.web || script.android;
-    if (import_utils3.ifInBrowser) {
+    if (import_utils5.ifInBrowser) {
       this.output = void 0;
     } else if (this.target?.output) {
-      this.output = (0, import_node_path.resolve)(process.cwd(), this.target.output);
+      this.output = (0, import_node_path2.resolve)(process.cwd(), this.target.output);
     } else {
-      this.output = (0, import_node_path.join)((0, import_common.getMidsceneRunSubDir)("output"), `${process.pid}.json`);
+      this.output = (0, import_node_path2.join)((0, import_common2.getMidsceneRunSubDir)("output"), `${process.pid}.json`);
     }
-    if (import_utils3.ifInBrowser) {
+    if (import_utils5.ifInBrowser) {
       this.unstableLogContent = void 0;
     } else if (typeof this.target?.unstableLogContent === "string") {
-      this.unstableLogContent = (0, import_node_path.resolve)(
+      this.unstableLogContent = (0, import_node_path2.resolve)(
         process.cwd(),
         this.target.unstableLogContent
       );
     } else if (this.target?.unstableLogContent === true) {
-      this.unstableLogContent = (0, import_node_path.join)(
-        (0, import_common.getMidsceneRunSubDir)("output"),
+      this.unstableLogContent = (0, import_node_path2.join)(
+        (0, import_common2.getMidsceneRunSubDir)("output"),
         "unstableLogContent.json"
       );
     }
@@ -265,28 +462,28 @@ var ScriptPlayer = class {
   }
   flushResult() {
     if (Object.keys(this.result).length && this.output) {
-      const output = (0, import_node_path.resolve)(process.cwd(), this.output);
-      const outputDir = (0, import_node_path.dirname)(output);
-      if (!(0, import_node_fs.existsSync)(outputDir)) {
-        (0, import_node_fs.mkdirSync)(outputDir, { recursive: true });
+      const output = (0, import_node_path2.resolve)(process.cwd(), this.output);
+      const outputDir = (0, import_node_path2.dirname)(output);
+      if (!(0, import_node_fs2.existsSync)(outputDir)) {
+        (0, import_node_fs2.mkdirSync)(outputDir, { recursive: true });
       }
-      (0, import_node_fs.writeFileSync)(output, JSON.stringify(this.result, void 0, 2));
+      (0, import_node_fs2.writeFileSync)(output, JSON.stringify(this.result, void 0, 2));
     }
   }
   flushUnstableLogContent() {
     if (this.unstableLogContent) {
       const content = this.pageAgent?._unstableLogContent();
-      const filePath = (0, import_node_path.resolve)(process.cwd(), this.unstableLogContent);
-      const outputDir = (0, import_node_path.dirname)(filePath);
-      if (!(0, import_node_fs.existsSync)(outputDir)) {
-        (0, import_node_fs.mkdirSync)(outputDir, { recursive: true });
+      const filePath = (0, import_node_path2.resolve)(process.cwd(), this.unstableLogContent);
+      const outputDir = (0, import_node_path2.dirname)(filePath);
+      if (!(0, import_node_fs2.existsSync)(outputDir)) {
+        (0, import_node_fs2.mkdirSync)(outputDir, { recursive: true });
       }
-      (0, import_node_fs.writeFileSync)(filePath, JSON.stringify(content, null, 2));
+      (0, import_node_fs2.writeFileSync)(filePath, JSON.stringify(content, null, 2));
     }
   }
   async playTask(taskStatus, agent) {
     const { flow } = taskStatus;
-    (0, import_utils3.assert)(flow, "missing flow in task");
+    (0, import_utils5.assert)(flow, "missing flow in task");
     for (const flowItemIndex in flow) {
       const currentStep = Number.parseInt(flowItemIndex, 10);
       taskStatus.currentStep = currentStep;
@@ -294,8 +491,8 @@ var ScriptPlayer = class {
       if ("aiAction" in flowItem || "ai" in flowItem) {
         const actionTask = flowItem;
         const prompt = actionTask.aiAction || actionTask.ai;
-        (0, import_utils3.assert)(prompt, "missing prompt for ai (aiAction)");
-        (0, import_utils3.assert)(
+        (0, import_utils5.assert)(prompt, "missing prompt for ai (aiAction)");
+        (0, import_utils5.assert)(
           typeof prompt === "string",
           "prompt for aiAction must be a string"
         );
@@ -306,8 +503,8 @@ var ScriptPlayer = class {
         const assertTask = flowItem;
         const prompt = assertTask.aiAssert;
         const msg = assertTask.errorMessage;
-        (0, import_utils3.assert)(prompt, "missing prompt for aiAssert");
-        (0, import_utils3.assert)(
+        (0, import_utils5.assert)(prompt, "missing prompt for aiAssert");
+        (0, import_utils5.assert)(
           typeof prompt === "string",
           "prompt for aiAssert must be a string"
         );
@@ -319,8 +516,8 @@ var ScriptPlayer = class {
           domIncluded: queryTask.domIncluded,
           screenshotIncluded: queryTask.screenshotIncluded
         };
-        (0, import_utils3.assert)(prompt, "missing prompt for aiQuery");
-        (0, import_utils3.assert)(
+        (0, import_utils5.assert)(prompt, "missing prompt for aiQuery");
+        (0, import_utils5.assert)(
           typeof prompt === "string",
           "prompt for aiQuery must be a string"
         );
@@ -333,8 +530,8 @@ var ScriptPlayer = class {
           domIncluded: numberTask.domIncluded,
           screenshotIncluded: numberTask.screenshotIncluded
         };
-        (0, import_utils3.assert)(prompt, "missing prompt for number");
-        (0, import_utils3.assert)(
+        (0, import_utils5.assert)(prompt, "missing prompt for aiNumber");
+        (0, import_utils5.assert)(
           typeof prompt === "string",
           "prompt for number must be a string"
         );
@@ -347,8 +544,8 @@ var ScriptPlayer = class {
           domIncluded: stringTask.domIncluded,
           screenshotIncluded: stringTask.screenshotIncluded
         };
-        (0, import_utils3.assert)(prompt, "missing prompt for string");
-        (0, import_utils3.assert)(
+        (0, import_utils5.assert)(prompt, "missing prompt for aiNumber");
+        (0, import_utils5.assert)(
           typeof prompt === "string",
           "prompt for string must be a string"
         );
@@ -361,28 +558,35 @@ var ScriptPlayer = class {
           domIncluded: booleanTask.domIncluded,
           screenshotIncluded: booleanTask.screenshotIncluded
         };
-        (0, import_utils3.assert)(prompt, "missing prompt for boolean");
-        (0, import_utils3.assert)(
+        (0, import_utils5.assert)(prompt, "missing prompt for aiBoolean");
+        (0, import_utils5.assert)(
           typeof prompt === "string",
           "prompt for boolean must be a string"
         );
         const booleanResult = await agent.aiBoolean(prompt, options);
         this.setResult(booleanTask.name, booleanResult);
+      } else if ("aiAsk" in flowItem) {
+        const askTask = flowItem;
+        const prompt = askTask.aiAsk;
+        (0, import_utils5.assert)(prompt, "missing prompt for aiAsk");
+        (0, import_utils5.assert)(typeof prompt === "string", "prompt for aiAsk must be a string");
+        const askResult = await agent.aiAsk(prompt);
+        this.setResult(askTask.name, askResult);
       } else if ("aiLocate" in flowItem) {
         const locateTask = flowItem;
         const prompt = locateTask.aiLocate;
-        (0, import_utils3.assert)(prompt, "missing prompt for aiLocate");
-        (0, import_utils3.assert)(
+        (0, import_utils5.assert)(prompt, "missing prompt for aiLocate");
+        (0, import_utils5.assert)(
           typeof prompt === "string",
           "prompt for aiLocate must be a string"
         );
-        const locateResult = await agent.aiLocate(prompt);
+        const locateResult = await agent.aiLocate(prompt, locateTask);
         this.setResult(locateTask.name, locateResult);
       } else if ("aiWaitFor" in flowItem) {
         const waitForTask = flowItem;
         const prompt = waitForTask.aiWaitFor;
-        (0, import_utils3.assert)(prompt, "missing prompt for aiWaitFor");
-        (0, import_utils3.assert)(
+        (0, import_utils5.assert)(prompt, "missing prompt for aiWaitFor");
+        (0, import_utils5.assert)(
           typeof prompt === "string",
           "prompt for aiWaitFor must be a string"
         );
@@ -395,7 +599,7 @@ var ScriptPlayer = class {
         if (typeof ms === "string") {
           msNumber = Number.parseInt(ms, 10);
         }
-        (0, import_utils3.assert)(
+        (0, import_utils5.assert)(
           msNumber && msNumber > 0,
           `ms for sleep must be greater than 0, but got ${ms}`
         );
@@ -514,11 +718,11 @@ var ScriptPlayer = class {
 };
 
 // src/yaml/builder.ts
-var import_js_yaml = __toESM(require("js-yaml"));
+var import_js_yaml2 = __toESM(require("js-yaml"));
 
 // src/yaml/utils.ts
-var import_utils4 = require("@midscene/shared/utils");
-var import_js_yaml2 = __toESM(require("js-yaml"));
+var import_utils6 = require("@midscene/shared/utils");
+var import_js_yaml3 = __toESM(require("js-yaml"));
 function interpolateEnvVars(content) {
   return content.replace(/\$\{([^}]+)\}/g, (_, envVar) => {
     const value = process.env[envVar.trim()];
@@ -544,31 +748,31 @@ function parseYamlScript(content, filePath, ignoreCheckingTarget) {
     );
   }
   const interpolatedContent = interpolateEnvVars(processedContent);
-  const obj = import_js_yaml2.default.load(interpolatedContent, {
-    schema: import_js_yaml2.default.JSON_SCHEMA
+  const obj = import_js_yaml3.default.load(interpolatedContent, {
+    schema: import_js_yaml3.default.JSON_SCHEMA
   });
   const pathTip = filePath ? `, failed to load ${filePath}` : "";
   const android = typeof obj.android !== "undefined" ? Object.assign({}, obj.android || {}) : void 0;
   const webConfig = obj.web || obj.target;
   const web = typeof webConfig !== "undefined" ? Object.assign({}, webConfig || {}) : void 0;
   if (!ignoreCheckingTarget) {
-    (0, import_utils4.assert)(
+    (0, import_utils6.assert)(
       web || android,
       `at least one of "target", "web", or "android" properties is required in yaml script${pathTip}`
     );
-    (0, import_utils4.assert)(
+    (0, import_utils6.assert)(
       web && !android || !web && android,
       `only one of "target", "web", or "android" properties is allowed in yaml script${pathTip}`
     );
     if (web || android) {
-      (0, import_utils4.assert)(
+      (0, import_utils6.assert)(
         typeof web === "object" || typeof android === "object",
         `property "target/web/android" must be an object${pathTip}`
       );
     }
   }
-  (0, import_utils4.assert)(obj.tasks, `property "tasks" is required in yaml script ${pathTip}`);
-  (0, import_utils4.assert)(
+  (0, import_utils6.assert)(obj.tasks, `property "tasks" is required in yaml script ${pathTip}`);
+  (0, import_utils6.assert)(
     Array.isArray(obj.tasks),
     `property "tasks" must be an array in yaml script, but got ${obj.tasks}`
   );
@@ -585,10 +789,10 @@ var import_utils12 = require("@midscene/shared/utils");
 // src/common/tasks.ts
 var import_core = require("@midscene/core");
 var import_ai_model2 = require("@midscene/core/ai-model");
-var import_utils5 = require("@midscene/core/utils");
+var import_utils7 = require("@midscene/core/utils");
 var import_constants = require("@midscene/shared/constants");
-var import_logger = require("@midscene/shared/logger");
-var import_utils6 = require("@midscene/shared/utils");
+var import_logger2 = require("@midscene/shared/logger");
+var import_utils8 = require("@midscene/shared/utils");
 
 // src/common/ui-utils.ts
 function typeStr(task) {
@@ -664,7 +868,7 @@ function paramStr(task) {
 }
 
 // src/common/tasks.ts
-var debug = (0, import_logger.getDebug)("page-task-executor");
+var debug2 = (0, import_logger2.getDebug)("page-task-executor");
 var replanningCountLimit = 10;
 var isAndroidPage = (page) => {
   return page.pageType === "android";
@@ -705,7 +909,7 @@ var PageTaskExecutor = class {
       if (info?.id) {
         elementId = info.id;
       } else {
-        debug(
+        debug2(
           "no element id found for position node, will not update cache",
           element
         );
@@ -718,7 +922,7 @@ var PageTaskExecutor = class {
       const result = await this.page.getXpathsById(elementId);
       return result;
     } catch (error) {
-      debug("getXpathsById error: ", error);
+      debug2("getXpathsById error: ", error);
     }
   }
   prependExecutorWithScreenshot(taskApply, appendAfterExecution = false) {
@@ -734,7 +938,7 @@ var PageTaskExecutor = class {
         if (taskApply.type === "Action") {
           await Promise.all([
             (async () => {
-              await (0, import_utils5.sleep)(100);
+              await (0, import_utils7.sleep)(100);
               if (this.page.waitUntilNetworkIdle) {
                 try {
                   await this.page.waitUntilNetworkIdle();
@@ -742,7 +946,7 @@ var PageTaskExecutor = class {
                 }
               }
             })(),
-            (0, import_utils5.sleep)(200)
+            (0, import_utils7.sleep)(200)
           ]);
         }
         if (appendAfterExecution) {
@@ -772,7 +976,7 @@ var PageTaskExecutor = class {
           locate: plan2.locate,
           executor: async (param, taskContext) => {
             const { task } = taskContext;
-            (0, import_utils6.assert)(
+            (0, import_utils8.assert)(
               param?.prompt || param?.id || param?.bbox,
               "No prompt or id or position or bbox to locate"
             );
@@ -797,39 +1001,29 @@ var PageTaskExecutor = class {
               timing: "before Insight"
             };
             task.recorder = [recordItem];
-            let cacheHitFlag = false;
+            const elementFromXpath = param.xpath ? await this.page.getElementInfoByXpath(param.xpath) : void 0;
+            const userExpectedPathHitFlag = !!elementFromXpath;
             const cachePrompt = param.prompt;
             const locateCacheRecord = this.taskCache?.matchLocateCache(cachePrompt);
             const xpaths = locateCacheRecord?.cacheContent?.xpaths;
-            let elementFromCache = null;
-            try {
-              if (xpaths?.length && this.taskCache?.isCacheResultUsed && param?.cacheable !== false) {
-                for (let i = 0; i < xpaths.length; i++) {
-                  const element2 = await this.page.getElementInfoByXpath(
-                    xpaths[i]
-                  );
-                  if (element2?.id) {
-                    elementFromCache = element2;
-                    debug("cache hit, prompt: %s", cachePrompt);
-                    cacheHitFlag = true;
-                    debug(
-                      "found a new new element with same xpath, xpath: %s, id: %s",
-                      xpaths[i],
-                      element2?.id
-                    );
-                    break;
-                  }
-                }
-              }
-            } catch (error) {
-              debug("get element info by xpath error: ", error);
-            }
-            const startTime = Date.now();
-            const element = elementFromCache || // try to match element from cache
-            matchElementFromPlan(param, pageContext.tree) || // try to match element from plan
-            (await this.insight.locate(param, {
+            const elementFromCache = userExpectedPathHitFlag ? null : await matchElementFromCache(
+              this,
+              xpaths,
+              cachePrompt,
+              param.cacheable
+            );
+            const cacheHitFlag = !!elementFromCache;
+            const elementFromPlan = !userExpectedPathHitFlag && !cacheHitFlag ? matchElementFromPlan(param, pageContext.tree) : void 0;
+            const planHitFlag = !!elementFromPlan;
+            const elementFromAiLocate = !userExpectedPathHitFlag && !cacheHitFlag && !planHitFlag ? (await this.insight.locate(param, {
+              // fallback to ai locate
               context: pageContext
-            })).element;
+            })).element : void 0;
+            const aiLocateHitFlag = !!elementFromAiLocate;
+            const element = elementFromXpath || // highest priority
+            elementFromCache || // second priority
+            elementFromPlan || // third priority
+            elementFromAiLocate;
             let currentXpaths;
             if (element && this.taskCache && !cacheHitFlag && param?.cacheable !== false) {
               const elementXpaths = await this.getElementXpath(
@@ -847,7 +1041,7 @@ var PageTaskExecutor = class {
                   locateCacheRecord
                 );
               } else {
-                debug(
+                debug2(
                   "no xpaths found, will not update cache",
                   cachePrompt,
                   elementXpaths
@@ -857,16 +1051,44 @@ var PageTaskExecutor = class {
             if (!element) {
               throw new Error(`Element not found: ${param.prompt}`);
             }
+            let hitBy;
+            if (userExpectedPathHitFlag) {
+              hitBy = {
+                from: "User expected path",
+                context: {
+                  xpath: param.xpath
+                }
+              };
+            } else if (cacheHitFlag) {
+              hitBy = {
+                from: "Cache",
+                context: {
+                  xpathsFromCache: xpaths,
+                  xpathsToSave: currentXpaths
+                }
+              };
+            } else if (planHitFlag) {
+              hitBy = {
+                from: "Planning",
+                context: {
+                  id: elementFromPlan?.id,
+                  bbox: elementFromPlan?.bbox
+                }
+              };
+            } else if (aiLocateHitFlag) {
+              hitBy = {
+                from: "AI model",
+                context: {
+                  prompt: param.prompt
+                }
+              };
+            }
             return {
               output: {
                 element
               },
               pageContext,
-              cache: {
-                hit: cacheHitFlag,
-                originalXpaths: xpaths,
-                currentXpaths
-              }
+              hitBy
             };
           }
         };
@@ -962,7 +1184,7 @@ var PageTaskExecutor = class {
           thought: plan2.thought,
           locate: plan2.locate,
           executor: async (param, { element }) => {
-            (0, import_utils6.assert)(element, "Element not found, cannot tap");
+            (0, import_utils8.assert)(element, "Element not found, cannot tap");
             await this.page.mouse.click(element.center[0], element.center[1]);
           }
         };
@@ -974,7 +1196,7 @@ var PageTaskExecutor = class {
           thought: plan2.thought,
           locate: plan2.locate,
           executor: async (param, { element }) => {
-            (0, import_utils6.assert)(element, "Element not found, cannot right click");
+            (0, import_utils8.assert)(element, "Element not found, cannot right click");
             await this.page.mouse.click(
               element.center[0],
               element.center[1],
@@ -991,7 +1213,7 @@ var PageTaskExecutor = class {
           thought: plan2.thought,
           locate: plan2.locate,
           executor: async (taskParam) => {
-            (0, import_utils6.assert)(
+            (0, import_utils8.assert)(
               taskParam?.start_box && taskParam?.end_box,
               "No start_box or end_box to drag"
             );
@@ -1006,7 +1228,7 @@ var PageTaskExecutor = class {
           thought: plan2.thought,
           locate: plan2.locate,
           executor: async (param, { element }) => {
-            (0, import_utils6.assert)(element, "Element not found, cannot hover");
+            (0, import_utils8.assert)(element, "Element not found, cannot hover");
             await this.page.mouse.move(element.center[0], element.center[1]);
           }
         };
@@ -1058,7 +1280,7 @@ var PageTaskExecutor = class {
                   `Unknown scroll direction: ${taskParam.direction}`
                 );
               }
-              await (0, import_utils5.sleep)(500);
+              await (0, import_utils7.sleep)(500);
             } else {
               throw new Error(
                 `Unknown scroll event type: ${scrollToEventName}, taskParam: ${JSON.stringify(
@@ -1077,7 +1299,7 @@ var PageTaskExecutor = class {
           thought: plan2.thought,
           locate: plan2.locate,
           executor: async (taskParam) => {
-            await (0, import_utils5.sleep)(taskParam?.timeMs || 3e3);
+            await (0, import_utils7.sleep)(taskParam?.timeMs || 3e3);
           }
         };
         tasks.push(taskActionSleep);
@@ -1125,7 +1347,7 @@ var PageTaskExecutor = class {
           thought: plan2.thought,
           locate: plan2.locate,
           executor: async (param) => {
-            (0, import_utils6.assert)(
+            (0, import_utils8.assert)(
               isAndroidPage(this.page),
               "Cannot use home button on non-Android devices"
             );
@@ -1141,7 +1363,7 @@ var PageTaskExecutor = class {
           thought: plan2.thought,
           locate: plan2.locate,
           executor: async (param) => {
-            (0, import_utils6.assert)(
+            (0, import_utils8.assert)(
               isAndroidPage(this.page),
               "Cannot use back button on non-Android devices"
             );
@@ -1157,7 +1379,7 @@ var PageTaskExecutor = class {
           thought: plan2.thought,
           locate: plan2.locate,
           executor: async (param) => {
-            (0, import_utils6.assert)(
+            (0, import_utils8.assert)(
               isAndroidPage(this.page),
               "Cannot use recent apps button on non-Android devices"
             );
@@ -1308,7 +1530,7 @@ var PageTaskExecutor = class {
           }
         }
         if (finalActions.length === 0) {
-          (0, import_utils6.assert)(
+          (0, import_utils8.assert)(
             !more_actions_needed_by_instruction || sleep2,
             error ? `Failed to plan: ${error}` : planParsingError || "No plan found"
           );
@@ -1546,7 +1768,7 @@ var PageTaskExecutor = class {
         );
         let outputResult = data;
         if (ifTypeRestricted) {
-          (0, import_utils6.assert)(data?.result !== void 0, "No result in query data");
+          (0, import_utils8.assert)(data?.result !== void 0, "No result in query data");
           outputResult = data.result;
         }
         return {
@@ -1642,9 +1864,9 @@ var PageTaskExecutor = class {
       onTaskStart: this.onTaskStartCallback
     });
     const { timeoutMs, checkIntervalMs } = opt;
-    (0, import_utils6.assert)(assertion, "No assertion for waitFor");
-    (0, import_utils6.assert)(timeoutMs, "No timeoutMs for waitFor");
-    (0, import_utils6.assert)(checkIntervalMs, "No checkIntervalMs for waitFor");
+    (0, import_utils8.assert)(assertion, "No assertion for waitFor");
+    (0, import_utils8.assert)(timeoutMs, "No timeoutMs for waitFor");
+    (0, import_utils8.assert)(checkIntervalMs, "No checkIntervalMs for waitFor");
     const overallStartTime = Date.now();
     let startTime = Date.now();
     let errorThought = "";
@@ -1698,9 +1920,9 @@ var PageTaskExecutor = class {
 };
 
 // src/common/plan-builder.ts
-var import_logger2 = require("@midscene/shared/logger");
-var import_utils8 = require("@midscene/shared/utils");
-var debug2 = (0, import_logger2.getDebug)("plan-builder");
+var import_logger3 = require("@midscene/shared/logger");
+var import_utils10 = require("@midscene/shared/utils");
+var debug3 = (0, import_logger3.getDebug)("plan-builder");
 function buildPlans(type, locateParam, param) {
   let returnPlans = [];
   const locatePlan = locateParam ? {
@@ -1710,8 +1932,8 @@ function buildPlans(type, locateParam, param) {
     thought: ""
   } : null;
   if (type === "Tap" || type === "Hover" || type === "RightClick") {
-    (0, import_utils8.assert)(locateParam, `missing locate info for action "${type}"`);
-    (0, import_utils8.assert)(locatePlan, `missing locate info for action "${type}"`);
+    (0, import_utils10.assert)(locateParam, `missing locate info for action "${type}"`);
+    (0, import_utils10.assert)(locatePlan, `missing locate info for action "${type}"`);
     const tapPlan = {
       type,
       param: null,
@@ -1722,9 +1944,9 @@ function buildPlans(type, locateParam, param) {
   }
   if (type === "Input" || type === "KeyboardPress") {
     if (type === "Input") {
-      (0, import_utils8.assert)(locateParam, `missing locate info for action "${type}"`);
+      (0, import_utils10.assert)(locateParam, `missing locate info for action "${type}"`);
     }
-    (0, import_utils8.assert)(param, `missing param for action "${type}"`);
+    (0, import_utils10.assert)(param, `missing param for action "${type}"`);
     const inputPlan = {
       type,
       param,
@@ -1738,7 +1960,7 @@ function buildPlans(type, locateParam, param) {
     }
   }
   if (type === "Scroll") {
-    (0, import_utils8.assert)(param, `missing param for action "${type}"`);
+    (0, import_utils10.assert)(param, `missing param for action "${type}"`);
     const scrollPlan = {
       type,
       param,
@@ -1752,7 +1974,7 @@ function buildPlans(type, locateParam, param) {
     }
   }
   if (type === "Sleep") {
-    (0, import_utils8.assert)(param, `missing param for action "${type}"`);
+    (0, import_utils10.assert)(param, `missing param for action "${type}"`);
     const sleepPlan = {
       type,
       param,
@@ -1762,7 +1984,7 @@ function buildPlans(type, locateParam, param) {
     returnPlans = [sleepPlan];
   }
   if (type === "Locate") {
-    (0, import_utils8.assert)(locateParam, `missing locate info for action "${type}"`);
+    (0, import_utils10.assert)(locateParam, `missing locate info for action "${type}"`);
     const locatePlan2 = {
       type,
       param: locateParam,
@@ -1772,187 +1994,12 @@ function buildPlans(type, locateParam, param) {
     returnPlans = [locatePlan2];
   }
   if (returnPlans) {
-    debug2("buildPlans", returnPlans);
+    debug3("buildPlans", returnPlans);
     return returnPlans;
   }
   throw new Error(`Not supported type: ${type}`);
 }
 
-// src/common/task-cache.ts
-var import_node_assert = __toESM(require("assert"));
-var import_node_fs2 = require("fs");
-var import_node_path2 = require("path");
-var import_common2 = require("@midscene/shared/common");
-var import_logger3 = require("@midscene/shared/logger");
-var import_utils9 = require("@midscene/shared/utils");
-var import_js_yaml3 = __toESM(require("js-yaml"));
-var import_semver = __toESM(require("semver"));
-
-// package.json
-var version = "0.19.1";
-
-// src/common/task-cache.ts
-var debug3 = (0, import_logger3.getDebug)("cache");
-var lowestSupportedMidsceneVersion = "0.16.10";
-var cacheFileExt = ".cache.yaml";
-var TaskCache = class {
-  // Track matched records
-  constructor(cacheId, isCacheResultUsed, cacheFilePath) {
-    this.matchedCacheIndices = /* @__PURE__ */ new Set();
-    (0, import_node_assert.default)(cacheId, "cacheId is required");
-    this.cacheId = replaceIllegalPathCharsAndSpace(cacheId);
-    this.cacheFilePath = import_utils9.ifInBrowser ? void 0 : cacheFilePath || (0, import_node_path2.join)((0, import_common2.getMidsceneRunSubDir)("cache"), `${this.cacheId}${cacheFileExt}`);
-    this.isCacheResultUsed = isCacheResultUsed;
-    let cacheContent;
-    if (this.cacheFilePath) {
-      cacheContent = this.loadCacheFromFile();
-    }
-    if (!cacheContent) {
-      cacheContent = {
-        midsceneVersion: version,
-        cacheId: this.cacheId,
-        caches: []
-      };
-    }
-    this.cache = cacheContent;
-    this.cacheOriginalLength = this.cache.caches.length;
-  }
-  matchCache(prompt, type) {
-    for (let i = 0; i < this.cacheOriginalLength; i++) {
-      const item = this.cache.caches[i];
-      const key = `${type}:${prompt}:${i}`;
-      if (item.type === type && item.prompt === prompt && !this.matchedCacheIndices.has(key)) {
-        this.matchedCacheIndices.add(key);
-        debug3(
-          "cache found and marked as used, type: %s, prompt: %s, index: %d",
-          type,
-          prompt,
-          i
-        );
-        return {
-          cacheContent: item,
-          updateFn: (cb) => {
-            debug3(
-              "will call updateFn to update cache, type: %s, prompt: %s, index: %d",
-              type,
-              prompt,
-              i
-            );
-            cb(item);
-            debug3(
-              "cache updated, will flush to file, type: %s, prompt: %s, index: %d",
-              type,
-              prompt,
-              i
-            );
-            this.flushCacheToFile();
-          }
-        };
-      }
-    }
-    debug3("no unused cache found, type: %s, prompt: %s", type, prompt);
-    return void 0;
-  }
-  matchPlanCache(prompt) {
-    return this.matchCache(prompt, "plan");
-  }
-  matchLocateCache(prompt) {
-    return this.matchCache(prompt, "locate");
-  }
-  appendCache(cache) {
-    debug3("will append cache", cache);
-    this.cache.caches.push(cache);
-    this.flushCacheToFile();
-  }
-  loadCacheFromFile() {
-    const cacheFile = this.cacheFilePath;
-    (0, import_node_assert.default)(cacheFile, "cache file path is required");
-    if (!(0, import_node_fs2.existsSync)(cacheFile)) {
-      debug3("no cache file found, path: %s", cacheFile);
-      return void 0;
-    }
-    const jsonTypeCacheFile = cacheFile.replace(cacheFileExt, ".json");
-    if ((0, import_node_fs2.existsSync)(jsonTypeCacheFile) && this.isCacheResultUsed) {
-      console.warn(
-        `An outdated cache file from an earlier version of Midscene has been detected. Since version 0.17, we have implemented an improved caching strategy. Please delete the old file located at: ${jsonTypeCacheFile}.`
-      );
-      return void 0;
-    }
-    try {
-      const data = (0, import_node_fs2.readFileSync)(cacheFile, "utf8");
-      const jsonData = import_js_yaml3.default.load(data);
-      if (!version) {
-        debug3("no midscene version info, will not read cache from file");
-        return void 0;
-      }
-      if (import_semver.default.lt(jsonData.midsceneVersion, lowestSupportedMidsceneVersion) && !jsonData.midsceneVersion.includes("beta")) {
-        console.warn(
-          `You are using an old version of Midscene cache file, and we cannot match any info from it. Starting from Midscene v0.17, we changed our strategy to use xpath for cache info, providing better performance.
-Please delete the existing cache and rebuild it. Sorry for the inconvenience.
-cache file: ${cacheFile}`
-        );
-        return void 0;
-      }
-      debug3(
-        "cache loaded from file, path: %s, cache version: %s, record length: %s",
-        cacheFile,
-        jsonData.midsceneVersion,
-        jsonData.caches.length
-      );
-      jsonData.midsceneVersion = version;
-      return jsonData;
-    } catch (err) {
-      debug3(
-        "cache file exists but load failed, path: %s, error: %s",
-        cacheFile,
-        err
-      );
-      return void 0;
-    }
-  }
-  flushCacheToFile() {
-    if (!version) {
-      debug3("no midscene version info, will not write cache to file");
-      return;
-    }
-    if (!this.cacheFilePath) {
-      debug3("no cache file path, will not write cache to file");
-      return;
-    }
-    try {
-      const dir = (0, import_node_path2.dirname)(this.cacheFilePath);
-      if (!(0, import_node_fs2.existsSync)(dir)) {
-        (0, import_node_fs2.mkdirSync)(dir, { recursive: true });
-        debug3("created cache directory: %s", dir);
-      }
-      const yamlData = import_js_yaml3.default.dump(this.cache);
-      (0, import_node_fs2.writeFileSync)(this.cacheFilePath, yamlData);
-      debug3("cache flushed to file: %s", this.cacheFilePath);
-    } catch (err) {
-      debug3(
-        "write cache to file failed, path: %s, error: %s",
-        this.cacheFilePath,
-        err
-      );
-    }
-  }
-  updateOrAppendCacheRecord(newRecord, cachedRecord) {
-    if (cachedRecord) {
-      if (newRecord.type === "plan") {
-        cachedRecord.updateFn((cache) => {
-          cache.yamlWorkflow = newRecord.yamlWorkflow;
-        });
-      } else {
-        cachedRecord.updateFn((cache) => {
-          cache.xpaths = newRecord.xpaths;
-        });
-      }
-    } else {
-      this.appendCache(newRecord);
-    }
-  }
-};
-
 // src/common/agent.ts
 var debug4 = (0, import_logger4.getDebug)("web-integration");
 var distanceOfTwoPoints = (p1, p2) => {
@@ -2081,10 +2128,12 @@ ${errorTask?.errorStack}`);
       const prompt = opt.prompt ?? locatePrompt;
       const deepThink = opt.deepThink ?? false;
       const cacheable = opt.cacheable ?? true;
+      const xpath = opt.xpath;
       return {
         prompt,
         deepThink,
-        cacheable
+        cacheable,
+        xpath
       };
     }
     return {
@@ -2242,6 +2291,9 @@ ${errorTask?.errorStack}`);
     this.afterTaskRunning(executor);
     return output;
   }
+  async aiAsk(prompt, opt = defaultInsightExtractOption) {
+    return this.aiString(prompt, opt);
+  }
   async describeElementAtPoint(center, opt) {
     const { verifyPrompt = true, retryLimit = 3 } = opt || {};
     let success = false;