@midscene/cli 1.12.10-beta-20260920072249.0 → 1.13.0

package/dist/es/index.mjs

@@ -1,8 +1,8 @@
 /*! For license information please see index.mjs.LICENSE.txt */
 import { ReportMergingTool, createReportCliCommands, runConnectivityTest } from "@midscene/core";
 import { runToolsCLI } from "@midscene/shared/cli";
-import node_path, { basename, dirname as external_node_path_dirname, extname, join, posix, relative as external_node_path_relative, resolve as external_node_path_resolve, sep as external_node_path_sep, win32 } from "node:path";
-import { ScriptPlayer, interpolateEnvVars, midsceneYamlTargetKeys, parseYamlScript as yaml_parseYamlScript, resolveWebTarget } from "@midscene/core/yaml";
+import { basename, dirname as external_node_path_dirname, extname, join, posix, relative as external_node_path_relative, resolve as external_node_path_resolve, sep as external_node_path_sep, win32 } from "node:path";
+import { interpolateEnvVars, midsceneYamlTargetKeys, parseYamlScript as yaml_parseYamlScript, resolveWebTarget } from "@midscene/core/yaml";
 import { getDebug } from "@midscene/shared/logger";
 import { fileURLToPath, pathToFileURL } from "node:url";
 import { lstat, readdir, readlink, realpath } from "node:fs/promises";
@@ -14,16 +14,13 @@ import node_process, { cwd as external_node_process_cwd } from "node:process";
 import lodash_merge from "lodash.merge";
 import { createHash } from "node:crypto";
 import { getMidsceneRunSubDir } from "@midscene/shared/common";
-import { buildChromeArgs, buildDownloadBehavior, defaultViewportHeight, defaultViewportWidth, puppeteerAgentForTarget } from "@midscene/web/puppeteer-agent-launcher";
+import { buildChromeArgs, buildDownloadBehavior, defaultViewportHeight, defaultViewportWidth } from "@midscene/web/puppeteer-agent-launcher";
 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 as yaml_runtime_createYamlPlayer } from "@midscene/test/internal/yaml-runtime";
 import { stripVTControlCharacters } from "node:util";
 import { createRequire } from "node:module";
 import { globalModelConfigManager } from "@midscene/shared/env";
+import { classifyWorkflowDocumentFormat } from "@midscene/core/internal/test-runner";
 import * as __rspack_external_assert from "assert";
 import * as __rspack_external_crypto from "crypto";
 import * as __rspack_external_fs from "fs";
@@ -3025,7 +3022,9 @@ var __webpack_modules__ = {
         module.exports = (string, columns, options)=>String(string).normalize().replace(/\r\n/g, '\n').split('\n').map((line)=>exec(line, columns, options)).join('\n');
     },
     "./src/index.ts" (__unused_rspack_module, __unused_rspack___webpack_exports__, __webpack_require__) {
-        var package_namespaceObject = JSON.parse('{"rE":"1.12.10-beta-20260920072249.0"}');
+        var package_namespaceObject = {
+            rE: "1.13.0"
+        };
         var brace_expansion = __webpack_require__("../../node_modules/.pnpm/brace-expansion@2.0.1/node_modules/brace-expansion/index.js");
         const MAX_PATTERN_LENGTH = 65536;
         const assertValidPattern = (pattern)=>{
@@ -8630,7 +8629,7 @@ var __webpack_modules__ = {
         const parseProcessArgs = async ()=>{
             const args = yargs(hideBin(process.argv)).parserConfiguration({
                 'dot-notation': true
-            }).usage(`Midscene.js helps you automate browser actions, assertions, and data extraction by AI. 
+            }).usage(`Midscene legacy YAML runner executes tasks/flow scripts with AI.
 Homepage: https://midscenejs.com
 Github: https://github.com/web-infra-dev/midscene
 
@@ -8649,7 +8648,7 @@ Usage:
                 },
                 config: {
                     type: 'string',
-                    description: 'Path to a configuration file. Options in this file are used as defaults.'
+                    description: 'Path to a legacy YAML batch configuration file. Options in this file are used as defaults.'
                 },
                 summary: {
                     type: 'string',
@@ -8691,7 +8690,7 @@ Usage:
                     type: 'boolean',
                     description: 'Whether to dismiss the HarmonyOS keyboard after text input'
                 }
-            }).version('version', 'Show version number', "1.12.10-beta-20260920072249.0").help().epilogue(`For complete list of configuration options, please visit:
+            }).version('version', 'Show version number', "1.13.0").help().epilogue(`For complete list of configuration options, please visit:
   • Web options: https://midscenejs.com/automate-with-scripts-in-yaml#the-web-part
   • Android options: https://midscenejs.com/automate-with-scripts-in-yaml#the-android-part
   • HarmonyOS options: https://midscenejs.com/automate-with-scripts-in-yaml#the-harmony-part
@@ -8702,7 +8701,9 @@ Examples:
   $0 script.yaml --android.device-id emulator-5554 --android.ime-strategy yadb-for-non-ascii
   $0 script.yaml --android.device-id emulator-5554 --android.screenshot-strategy always-yadb
   $0 script.yaml --harmony.device-id 127.0.0.1:5555
-  $0 script.yaml --ios.wda-port 8100 --ios.auto-dismiss-keyboard`).wrap(yargs().terminalWidth());
+  $0 script.yaml --ios.wda-port 8100 --ios.auto-dismiss-keyboard
+
+Native cases/steps Test projects use the midscene-test command.`).wrap(yargs().terminalWidth());
             const argv = await args.argv;
             debug('argv', argv);
             const transformedArgv = {
@@ -10812,6 +10813,7 @@ Examples:
                 throw new Error('Function yaml.' + from + " is removed in js-yaml 4. Use yaml." + to + ' instead, which is now safe by default.');
             };
         }
+        var JSON_SCHEMA = json;
         var load = loader.load;
         loader.loadAll;
         dumper.dump;
@@ -11396,276 +11398,6 @@ Examples:
         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 create_yaml_player_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 create_yaml_player_createYamlPlayer(file, script, options) {
-            const yamlScript = script || yaml_parseYamlScript((0, __rspack_external_node_fs_5ea92f0c.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;
-                        create_yaml_player_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;
-                        create_yaml_player_debug('DeviceClass', DeviceClass, 'with param', interfaceTarget.param);
-                        const device = new DeviceClass(interfaceTarget.param || {});
-                        create_yaml_player_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) {
@@ -12310,7 +12042,7 @@ Examples:
                 const createFilePlayerContext = async (context)=>{
                     const fileContext = {
                         file: context.file,
-                        player: await create_yaml_player_createYamlPlayer(context.file, context.executionConfig, context.options)
+                        player: await yaml_runtime_createYamlPlayer(context.file, context.executionConfig, context.options)
                     };
                     fileContextsByCaseId.set(context.caseId, fileContext);
                     return fileContext;
@@ -12355,7 +12087,7 @@ Examples:
                                 if (attempt > 1) {
                                     if (context.executionConfig.agent?.reportFileName) attempts[attempts.length - 1] = execution_summary_preserveYamlAttemptReport(attempts[attempts.length - 1]);
                                     await beforeRetry?.();
-                                    allFileContext.player = await create_yaml_player_createYamlPlayer(context.file, context.executionConfig, context.options);
+                                    allFileContext.player = await yaml_runtime_createYamlPlayer(context.file, context.executionConfig, context.options);
                                 }
                                 if (onProgress) reportProgressSnapshot(allFileContext, attempt, totalAttempts);
                                 else if (!isTTY) {
@@ -13127,6 +12859,41 @@ defineYamlBatchTest(test, testOptions);
             io.stderr(`Unknown midscene model command: ${action}\n\n${MODEL_COMMAND_USAGE}`);
             return 1;
         }
+        const probeWorkflowFormat = (file)=>{
+            try {
+                const content = (0, __rspack_external_node_fs_5ea92f0c.readFileSync)(file, 'utf8').replace(/\$\{[^}\r\n]*\}/g, 'MIDSCENE_ENV');
+                return classifyWorkflowDocumentFormat(load(content, {
+                    schema: JSON_SCHEMA
+                }));
+            } catch  {
+                return 'unknown';
+            }
+        };
+        const assertLegacyBatchConfigPath = (configPath)=>{
+            if (![
+                '.yaml',
+                '.yml'
+            ].includes(extname(configPath).toLowerCase())) throw new Error(`midscene --config only accepts a legacy YAML batch config: ${configPath}. Run a native Test project config with \`midscene-test --config ${configPath}\`.`);
+        };
+        const assertLegacyWorkflowSelection = (files)=>{
+            const nativeFiles = [];
+            const mixedFiles = [];
+            for (const file of new Set(files.map((item)=>external_node_path_resolve(item)))){
+                const format = probeWorkflowFormat(file);
+                if ('native' === format) nativeFiles.push(file);
+                else if ('mixed' === format) mixedFiles.push(file);
+            }
+            if (0 === nativeFiles.length && 0 === mixedFiles.length) return;
+            const details = [
+                ...nativeFiles.map((file)=>`- native cases/steps: ${file}`),
+                ...mixedFiles.map((file)=>`- mixed tasks/flow and cases/steps: ${file}`)
+            ];
+            throw new Error([
+                'midscene only runs legacy tasks/flow YAML.',
+                ...details,
+                'Run native files with `midscene-test`, and keep legacy and native formats in separate files and command invocations.'
+            ].join('\n'));
+        };
         Promise.resolve((async ()=>{
             const rawArgs = process.argv.slice(2);
             const [firstArg] = rawArgs;
@@ -13172,6 +12939,7 @@ defineYamlBatchTest(test, testOptions);
             };
             let config;
             if (configFile) {
+                assertLegacyBatchConfigPath(configFile);
                 config = await createConfig(configFile, configOptions);
                 console.log(`   Config file: ${configFile}`);
             } else if (cmdFiles && cmdFiles.length > 0) {
@@ -13190,6 +12958,12 @@ defineYamlBatchTest(test, testOptions);
                 console.error('Could not create a valid configuration.');
                 process.exit(1);
             }
+            assertLegacyWorkflowSelection([
+                ...config.setup ? [
+                    config.setup
+                ] : [],
+                ...config.files
+            ]);
             loadDotenvConfig({
                 dotenvDebug: config.dotenvDebug,
                 dotenvOverride: config.dotenvOverride,