@midscene/cli 1.12.10-beta-20260920072249.0 → 1.13.0

package/dist/es/framework/index.mjs

@@ -1,20 +1,16 @@
 import * as __rspack_external_os from "os";
 import * as __rspack_external_tty from "tty";
 import { copyFileSync, cpSync, existsSync, mkdirSync, readFileSync, rmSync, unlinkSync, writeFileSync } from "node:fs";
-import node_path, { basename, dirname, extname, join, relative, resolve as external_node_path_resolve, sep } from "node:path";
+import { basename, dirname, extname, join, relative, resolve as external_node_path_resolve, sep } from "node:path";
 import { createHash } from "node:crypto";
 import { ReportMergingTool } from "@midscene/core";
 import { getMidsceneRunSubDir } from "@midscene/shared/common";
 import { getDebug } from "@midscene/shared/logger";
-import { ScriptPlayer, parseYamlScript, resolveWebTarget } from "@midscene/core/yaml";
-import { buildChromeArgs, buildDownloadBehavior, defaultViewportHeight, defaultViewportWidth, puppeteerAgentForTarget } from "@midscene/web/puppeteer-agent-launcher";
+import { parseYamlScript, resolveWebTarget } from "@midscene/core/yaml";
+import { buildChromeArgs, buildDownloadBehavior, defaultViewportHeight, defaultViewportWidth } from "@midscene/web/puppeteer-agent-launcher";
 import lodash_merge from "lodash.merge";
 import puppeteer from "puppeteer";
-import { createServer } from "http-server";
-import node_assert from "node:assert";
-import { createAgent, getReportFileName } from "@midscene/core/agent";
-import { processCacheConfig } from "@midscene/core/utils";
-import { AgentOverChromeBridge } from "@midscene/web/bridge-mode";
+import { createYamlPlayer } from "@midscene/test/internal/yaml-runtime";
 import { stripVTControlCharacters } from "node:util";
 import node_process from "node:process";
 import { createRequire } from "node:module";
@@ -2841,276 +2837,6 @@ function pLimit(concurrency) {
 function validateConcurrency(concurrency) {
     if (!((Number.isInteger(concurrency) || concurrency === 1 / 0) && concurrency > 0)) throw new TypeError('Expected `concurrency` to be a number from 1 and up');
 }
-const debug = getDebug('create-yaml-player');
-const cleanupWarning = getDebug('create-yaml-player', {
-    console: true
-});
-async function cleanupFailedPlayerSetup(freeFn) {
-    for (const cleanup of [
-        ...freeFn
-    ].reverse())try {
-        await cleanup.fn();
-    } catch (error) {
-        cleanupWarning(`failed to run ${cleanup.name} after YAML player setup failed`, error);
-    }
-}
-const launchServer = async (dir)=>new Promise((resolve)=>{
-        const server = createServer({
-            root: dir
-        });
-        server.listen(0, '127.0.0.1', ()=>{
-            resolve(server);
-        });
-    });
-function resolveReportFileName(yamlReportFileName, cliTestId, yamlTestId, fileName) {
-    if (void 0 !== yamlReportFileName) return yamlReportFileName;
-    const baseName = cliTestId ?? yamlTestId ?? fileName;
-    return getReportFileName(baseName);
-}
-function buildAgentOptions(yamlAgent, reportFileName, fileName) {
-    return {
-        ...yamlAgent || {},
-        cache: processCacheConfig(yamlAgent?.cache, fileName),
-        reportFileName
-    };
-}
-async function createYamlPlayer(file, script, options) {
-    const yamlScript = script || parseYamlScript(readFileSync(file, 'utf-8'), file);
-    const clonedYamlScript = structuredClone(yamlScript);
-    const fileName = basename(file, extname(file));
-    const preference = {
-        headed: options?.headed,
-        keepWindow: options?.keepWindow,
-        reportFileName: resolveReportFileName(clonedYamlScript.agent?.reportFileName, options?.testId, clonedYamlScript.agent?.testId, fileName)
-    };
-    const player = new ScriptPlayer(clonedYamlScript, async ()=>{
-        const freeFn = [];
-        try {
-            const resolvedWebTarget = resolveWebTarget(clonedYamlScript);
-            const webTarget = resolvedWebTarget?.target;
-            const targetCount = [
-                void 0 !== resolvedWebTarget,
-                void 0 !== clonedYamlScript.android,
-                void 0 !== clonedYamlScript.ios,
-                void 0 !== clonedYamlScript.harmony,
-                void 0 !== clonedYamlScript.computer,
-                void 0 !== clonedYamlScript.interface
-            ].filter(Boolean).length;
-            if (targetCount > 1) {
-                const specifiedTargets = [
-                    resolvedWebTarget?.source ?? null,
-                    void 0 !== clonedYamlScript.android ? 'android' : null,
-                    void 0 !== clonedYamlScript.ios ? 'ios' : null,
-                    void 0 !== clonedYamlScript.harmony ? 'harmony' : null,
-                    void 0 !== clonedYamlScript.computer ? 'computer' : null,
-                    void 0 !== clonedYamlScript.interface ? 'interface' : null
-                ].filter(Boolean);
-                throw new Error(`Only one target type can be specified, but found multiple: ${specifiedTargets.join(', ')}. Please specify only one of: page, browser, web, android, ios, harmony, computer, or interface.`);
-            }
-            if (void 0 !== webTarget) {
-                if (resolvedWebTarget?.source === 'target') console.warn("target is deprecated, please use page or browser instead. See https://midscenejs.com/automate-with-scripts-in-yaml for more information. Sorry for the inconvenience.");
-                let localServer;
-                let urlToVisit;
-                if (webTarget.serve) {
-                    node_assert('string' == typeof webTarget.url, 'url is required in serve mode');
-                    localServer = await launchServer(webTarget.serve);
-                    const serverAddress = localServer.server.address();
-                    freeFn.push({
-                        name: 'local_server',
-                        fn: async ()=>{
-                            if (!localServer) return;
-                            await new Promise((resolve, reject)=>{
-                                localServer?.server.close((error)=>{
-                                    if (error) reject(error);
-                                    else resolve();
-                                });
-                            });
-                        }
-                    });
-                    urlToVisit = webTarget.url.startsWith('/') ? `http://${serverAddress?.address}:${serverAddress?.port}${webTarget.url}` : `http://${serverAddress?.address}:${serverAddress?.port}/${webTarget.url}`;
-                    webTarget.url = urlToVisit;
-                }
-                if (webTarget.cdpEndpoint && webTarget.bridgeMode) throw new Error('cdpEndpoint and bridgeMode are mutually exclusive. Please specify only one.');
-                if ('browser' === webTarget.mode && webTarget.bridgeMode) throw new Error('[midscene] browser mode does not support bridgeMode. Use page: or web.mode: page for bridge mode.');
-                if (webTarget.cdpEndpoint) {
-                    const ownsCdpBrowser = !options?.browser;
-                    const cdpBrowser = options?.browser ?? await puppeteer.connect({
-                        browserWSEndpoint: webTarget.cdpEndpoint,
-                        defaultViewport: null,
-                        downloadBehavior: buildDownloadBehavior(webTarget.downloadPath)
-                    });
-                    if (webTarget.chromeArgs) console.warn('chromeArgs are not supported in CDP mode (browser is already running). They will be ignored.');
-                    let launchedAgent;
-                    try {
-                        launchedAgent = await puppeteerAgentForTarget(webTarget, {
-                            ...preference,
-                            ...buildAgentOptions(clonedYamlScript.agent, preference.reportFileName, fileName)
-                        }, cdpBrowser, options?.page, options?.browserContext);
-                    } catch (error) {
-                        if (ownsCdpBrowser) try {
-                            cdpBrowser.disconnect();
-                        } catch (cleanupError) {
-                            cleanupWarning('failed to disconnect the CDP browser after agent setup failed', cleanupError);
-                        }
-                        throw error;
-                    }
-                    const { agent, freeFn: newFreeFn } = launchedAgent;
-                    const cleanFreeFn = newFreeFn.filter((f)=>'puppeteer_browser' !== f.name);
-                    freeFn.push(...cleanFreeFn);
-                    if (ownsCdpBrowser) freeFn.push({
-                        name: 'cdp_browser_disconnect',
-                        fn: ()=>cdpBrowser.disconnect()
-                    });
-                    return {
-                        agent,
-                        freeFn
-                    };
-                }
-                if (!webTarget.bridgeMode) {
-                    const { agent, freeFn: newFreeFn } = await puppeteerAgentForTarget(webTarget, {
-                        ...preference,
-                        ...buildAgentOptions(clonedYamlScript.agent, preference.reportFileName, fileName)
-                    }, options?.browser, options?.page, options?.browserContext);
-                    freeFn.push(...newFreeFn);
-                    return {
-                        agent,
-                        freeFn
-                    };
-                }
-                node_assert('newTabWithUrl' === webTarget.bridgeMode || 'currentTab' === webTarget.bridgeMode, `bridgeMode config value must be either "newTabWithUrl" or "currentTab", but got ${webTarget.bridgeMode}`);
-                const bridgeUnsupportedKeys = [
-                    'userAgent',
-                    'viewportWidth',
-                    'viewportHeight',
-                    'deviceScaleFactor',
-                    'waitForNetworkIdle',
-                    'cookie',
-                    'extraHTTPHeaders',
-                    'downloadPath',
-                    'chromeArgs'
-                ];
-                const ignoredKeys = bridgeUnsupportedKeys.filter((key)=>null != webTarget[key]);
-                if (ignoredKeys.length > 0) console.warn(`puppeteer options (${ignoredKeys.join(', ')}) are not supported in bridge mode. They will be ignored.`);
-                const agent = new AgentOverChromeBridge({
-                    closeNewTabsAfterDisconnect: webTarget.closeNewTabsAfterDisconnect,
-                    closeConflictServer: true,
-                    ...buildAgentOptions(clonedYamlScript.agent, preference.reportFileName, fileName)
-                });
-                if ('newTabWithUrl' === webTarget.bridgeMode) await agent.connectNewTabWithUrl(webTarget.url);
-                else {
-                    if (webTarget.url) console.warn('url will be ignored in bridge mode with "currentTab"');
-                    await agent.connectCurrentTab();
-                }
-                freeFn.push({
-                    name: 'destroy_agent_over_chrome_bridge',
-                    fn: ()=>agent.destroy()
-                });
-                return {
-                    agent,
-                    freeFn
-                };
-            }
-            if (void 0 !== clonedYamlScript.android) {
-                const androidTarget = clonedYamlScript.android;
-                const { agentFromAdbDevice } = await import("@midscene/android");
-                const agent = await agentFromAdbDevice(androidTarget?.deviceId, {
-                    ...androidTarget,
-                    ...buildAgentOptions(clonedYamlScript.agent, preference.reportFileName, fileName)
-                });
-                if (androidTarget?.launch) await agent.launch(androidTarget.launch);
-                freeFn.push({
-                    name: 'destroy_android_agent',
-                    fn: ()=>agent.destroy()
-                });
-                return {
-                    agent,
-                    freeFn
-                };
-            }
-            if (void 0 !== clonedYamlScript.ios) {
-                const iosTarget = clonedYamlScript.ios;
-                const { agentFromWebDriverAgent } = await import("@midscene/ios");
-                const agent = await agentFromWebDriverAgent({
-                    ...iosTarget,
-                    ...buildAgentOptions(clonedYamlScript.agent, preference.reportFileName, fileName)
-                });
-                if (iosTarget?.launch) await agent.launch(iosTarget.launch);
-                freeFn.push({
-                    name: 'destroy_ios_agent',
-                    fn: ()=>agent.destroy()
-                });
-                return {
-                    agent,
-                    freeFn
-                };
-            }
-            if (void 0 !== clonedYamlScript.harmony) {
-                const harmonyTarget = clonedYamlScript.harmony;
-                const { agentFromHdcDevice } = await import("@midscene/harmony");
-                const agent = await agentFromHdcDevice(harmonyTarget?.deviceId, {
-                    ...harmonyTarget,
-                    ...buildAgentOptions(clonedYamlScript.agent, preference.reportFileName, fileName)
-                });
-                if (harmonyTarget?.launch) await agent.launch(harmonyTarget.launch);
-                freeFn.push({
-                    name: 'destroy_harmony_agent',
-                    fn: ()=>agent.destroy()
-                });
-                return {
-                    agent,
-                    freeFn
-                };
-            }
-            if (void 0 !== clonedYamlScript.computer) {
-                const computerTarget = clonedYamlScript.computer;
-                const { agentForComputer } = await import("@midscene/computer");
-                const agent = await agentForComputer({
-                    ...computerTarget,
-                    ...buildAgentOptions(clonedYamlScript.agent, preference.reportFileName, fileName)
-                });
-                freeFn.push({
-                    name: 'destroy_computer_agent',
-                    fn: ()=>agent.destroy()
-                });
-                return {
-                    agent,
-                    freeFn
-                };
-            }
-            if (void 0 !== clonedYamlScript.interface) {
-                const interfaceTarget = clonedYamlScript.interface;
-                const moduleSpecifier = interfaceTarget.module;
-                let finalModuleSpecifier;
-                if (moduleSpecifier.startsWith('./') || moduleSpecifier.startsWith('../') || node_path.isAbsolute(moduleSpecifier)) {
-                    const resolvedPath = join(process.cwd(), moduleSpecifier);
-                    finalModuleSpecifier = resolvedPath;
-                } else finalModuleSpecifier = moduleSpecifier;
-                debug('importing module config', interfaceTarget.module, 'with export config', interfaceTarget.export, 'final module specifier', finalModuleSpecifier);
-                const importedModule = await import(finalModuleSpecifier);
-                const DeviceClass = interfaceTarget.export ? importedModule[interfaceTarget.export] : importedModule.default || importedModule;
-                debug('DeviceClass', DeviceClass, 'with param', interfaceTarget.param);
-                const device = new DeviceClass(interfaceTarget.param || {});
-                debug('creating agent from device', device);
-                const agent = createAgent(device, buildAgentOptions(clonedYamlScript.agent, preference.reportFileName, fileName));
-                freeFn.push({
-                    name: 'destroy_general_interface_agent',
-                    fn: ()=>{
-                        agent.destroy();
-                    }
-                });
-                return {
-                    agent,
-                    freeFn
-                };
-            }
-            throw new Error('No valid interface configuration found in the yaml script, should be either "web", "android", "ios", "harmony", "computer", or "interface"');
-        } catch (error) {
-            await cleanupFailedPlayerSetup(freeFn);
-            throw error;
-        }
-    }, void 0, file);
-    return player;
-}
 var chalk_source = __webpack_require__("../../node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/source/index.js");
 var source_default = /*#__PURE__*/ __webpack_require__.n(chalk_source);
 function resolveIsTTY(env = process.env, stdoutIsTTY = process.stdout.isTTY) {
@@ -4463,6 +4189,7 @@ const taskErrorMessage = (task)=>{
     if ('error' === task.status) return `Task "${task.name}" failed`;
 };
 const cloneJson = (value)=>JSON.parse(JSON.stringify(value));
+const yaml_case_errorMessageOf = (error)=>error instanceof Error ? error.message : String(error);
 const normalizeTargetConfig = (config)=>{
     if (config.target) {
         config.web = {
@@ -4533,12 +4260,22 @@ const executeYamlCaseResult = async (options, onPlayerSnapshot)=>{
         });
     };
     reportSnapshot();
+    let runError;
     try {
         await player.run();
+    } catch (error) {
+        runError = error;
     } finally{
         reportSnapshot();
     }
-    return createYamlCaseResult(file, player, Date.now() - startTime);
+    const result = createYamlCaseResult(file, player, Date.now() - startTime);
+    if (void 0 === runError) return result;
+    return {
+        ...result,
+        success: false,
+        resultType: 'failed',
+        error: result.error ?? yaml_case_errorMessageOf(runError)
+    };
 };
 function runYamlCaseResultWithSnapshots(options, onPlayerSnapshot) {
     return executeYamlCaseResult(options, onPlayerSnapshot);