@midscene/cli 1.10.2 → 1.10.3

package/dist/es/index.mjs

@@ -1,7 +1,7 @@
 /*! For license information please see index.mjs.LICENSE.txt */
-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 { ReportMergingTool, createReportCliCommands } from "@midscene/core";
+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 { getDebug } from "@midscene/shared/logger";
 import { fileURLToPath, pathToFileURL } from "node:url";
 import { lstat, readdir, readlink, realpath } from "node:fs/promises";
@@ -23,6 +23,7 @@ import { processCacheConfig } from "@midscene/core/utils";
 import { AgentOverChromeBridge } from "@midscene/web/bridge-mode";
 import { stripVTControlCharacters } from "node:util";
 import { createRequire } from "node:module";
+import { globalModelConfigManager } from "@midscene/shared/env";
 import * as __rspack_external_assert from "assert";
 import * as __rspack_external_crypto from "crypto";
 import * as __rspack_external_fs from "fs";
@@ -3024,10 +3025,8 @@ 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 main = __webpack_require__("../../node_modules/.pnpm/dotenv@16.4.5/node_modules/dotenv/lib/main.js");
-        var main_default = /*#__PURE__*/ __webpack_require__.n(main);
         var package_namespaceObject = {
-            rE: "1.10.2"
+            rE: "1.10.3"
         };
         var brace_expansion = __webpack_require__("../../node_modules/.pnpm/brace-expansion@2.0.1/node_modules/brace-expansion/index.js");
         const MAX_PATTERN_LENGTH = 65536;
@@ -10889,7 +10888,7 @@ Usage:
                     type: 'boolean',
                     description: `Turn on logging to help debug why certain keys or values are not being set as you expect, default is ${config_factory_defaultConfig.dotenvDebug}`
                 }
-            }).version('version', 'Show version number', "1.10.2").help().epilogue(`For complete list of configuration options, please visit:
+            }).version('version', 'Show version number', "1.10.3").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
   • iOS options: https://midscenejs.com/automate-with-scripts-in-yaml#the-ios-part
@@ -10937,6 +10936,18 @@ Examples:
             });
             return files.filter((file)=>file.endsWith('.yml') || file.endsWith('.yaml')).sort();
         }
+        var main = __webpack_require__("../../node_modules/.pnpm/dotenv@16.4.5/node_modules/dotenv/lib/main.js");
+        var main_default = /*#__PURE__*/ __webpack_require__.n(main);
+        function loadDotenvConfig(options = {}) {
+            const dotEnvConfigFile = join(options.cwd ?? process.cwd(), '.env');
+            if (!(0, __rspack_external_node_fs_5ea92f0c.existsSync)(dotEnvConfigFile)) return;
+            options.log?.(`   Env file: ${dotEnvConfigFile}`);
+            main_default().config({
+                path: dotEnvConfigFile,
+                debug: options.dotenvDebug,
+                override: options.dotenvOverride
+            });
+        }
         const warnRetryReport = getDebug('execution-summary', {
             console: true
         });
@@ -12609,6 +12620,172 @@ defineYamlBatchTest(test, testOptions);
             const success = printExecutionSummary(results, summaryPath);
             return success ? exitCode : 1;
         }
+        const DEFAULT_OPENAI_BASE_URL = 'https://api.openai.com/v1';
+        const MODEL_VERIFY_SEPARATOR = '────────────────────────────────────────';
+        const MODEL_COMMAND_USAGE = `Usage:
+  midscene model verify
+  midscene model eval
+`;
+        function assertNoModelVerifyOptions(args) {
+            for (const arg of args)throw new Error(`Unknown option for midscene model verify: ${arg}`);
+        }
+        function shellSingleQuote(value) {
+            return `'${value.replace(/'/g, "'\\''")}'`;
+        }
+        function buildChatCompletionsUrl(baseURL) {
+            const normalizedBaseURL = (baseURL || DEFAULT_OPENAI_BASE_URL).replace(/\/+$/, '');
+            if (normalizedBaseURL.endsWith('/chat/completions')) return normalizedBaseURL;
+            return `${normalizedBaseURL}/chat/completions`;
+        }
+        function buildCurlCommand(modelConfig) {
+            const payload = {
+                model: modelConfig.modelName,
+                messages: [
+                    {
+                        role: 'user',
+                        content: 'What is 1+1?'
+                    }
+                ]
+            };
+            return [
+                `curl -X POST ${shellSingleQuote(buildChatCompletionsUrl(modelConfig.openaiBaseURL))} \\`,
+                `  -H ${shellSingleQuote(`Authorization: Bearer ${modelConfig.openaiApiKey || ''}`)} \\`,
+                `  -H ${shellSingleQuote('Content-Type: application/json')} \\`,
+                `  -d ${shellSingleQuote(JSON.stringify(payload, null, 2))}`
+            ].join('\n');
+        }
+        function buildCurlDedupKey(modelConfig) {
+            return JSON.stringify({
+                baseURL: modelConfig.openaiBaseURL || DEFAULT_OPENAI_BASE_URL,
+                apiKey: modelConfig.openaiApiKey || '',
+                modelName: modelConfig.modelName
+            });
+        }
+        function buildModelVerifyCurlCommands(configs) {
+            const commandMap = new Map();
+            for (const item of configs){
+                const key = buildCurlDedupKey(item.modelConfig);
+                const existing = commandMap.get(key);
+                if (existing) {
+                    existing.intents.push(item.intent);
+                    continue;
+                }
+                commandMap.set(key, {
+                    intents: [
+                        item.intent
+                    ],
+                    curl: buildCurlCommand(item.modelConfig),
+                    usesDefaultBaseURL: !item.modelConfig.openaiBaseURL
+                });
+            }
+            return [
+                ...commandMap.values()
+            ];
+        }
+        function formatModelVerifyFailureOutput(message, curlCommands) {
+            const details = message?.trim() || 'No failure details were generated.';
+            const curlSection = curlCommands.map((item)=>{
+                const baseUrlNote = item.usesDefaultBaseURL ? ' (base URL not configured; using OpenAI SDK default)' : '';
+                return source_default().gray(`# ${item.intents.join(', ')}${baseUrlNote}\n${item.curl}`);
+            }).join('\n\n');
+            return [
+                source_default().red.bold('❌ Model verify failed with messages:'),
+                MODEL_VERIFY_SEPARATOR,
+                '',
+                details,
+                '',
+                MODEL_VERIFY_SEPARATOR,
+                'Generated curl requests for basic API connectivity:',
+                'If the error is a basic connectivity issue, use these requests to test the base URL, API key, and model name directly.',
+                'These commands contain your API key. Do not share them publicly.',
+                '',
+                curlSection
+            ].join('\n');
+        }
+        function getDefaultDeps(io) {
+            return {
+                loadDotenv: ()=>{
+                    loadDotenvConfig({
+                        dotenvDebug: true,
+                        dotenvOverride: true,
+                        log: io.stdout
+                    });
+                },
+                getModelConfig: (intent)=>globalModelConfigManager.getModelConfig(intent),
+                verifyModel: runConnectivityTest
+            };
+        }
+        async function runModelVerifyCommand(args, deps, io) {
+            try {
+                if (args.includes('--help') || args.includes('-h')) {
+                    io.stdout(MODEL_COMMAND_USAGE);
+                    return 0;
+                }
+                assertNoModelVerifyOptions(args);
+                io.stdout('Model verify started. This usually takes about 5 seconds.\n');
+                deps.loadDotenv();
+                io.stdout('');
+                const defaultModelConfig = deps.getModelConfig('default');
+                const planningModelConfig = deps.getModelConfig('planning');
+                const insightModelConfig = deps.getModelConfig('insight');
+                const curlCommands = buildModelVerifyCurlCommands([
+                    {
+                        intent: 'default',
+                        modelConfig: defaultModelConfig
+                    },
+                    {
+                        intent: 'planning',
+                        modelConfig: planningModelConfig
+                    },
+                    {
+                        intent: 'insight',
+                        modelConfig: insightModelConfig
+                    }
+                ]);
+                const result = await deps.verifyModel({
+                    defaultModelConfig,
+                    planningModelConfig,
+                    insightModelConfig
+                });
+                if (result.passed) {
+                    io.stdout('✅ Model verify passed.');
+                    return 0;
+                }
+                io.stderr(formatModelVerifyFailureOutput(result.message, curlCommands));
+                return 1;
+            } catch (error) {
+                const message = error instanceof Error ? error.message : String(error);
+                io.stderr([
+                    MODEL_VERIFY_SEPARATOR,
+                    '❌ Model verify failed with messages:',
+                    '',
+                    message,
+                    MODEL_VERIFY_SEPARATOR
+                ].join('\n'));
+                return 1;
+            }
+        }
+        async function runModelCommand(rawArgs, deps, io = {
+            stdout: console.log,
+            stderr: console.error
+        }) {
+            const [, action, ...restArgs] = rawArgs;
+            const mergedDeps = {
+                ...getDefaultDeps(io),
+                ...deps
+            };
+            if (!action || '--help' === action || '-h' === action) {
+                io.stdout(MODEL_COMMAND_USAGE);
+                return 0;
+            }
+            if ('verify' === action) return runModelVerifyCommand(restArgs, mergedDeps, io);
+            if ('eval' === action) {
+                io.stderr('midscene model eval is not implemented yet. It is reserved for future model evaluation suites.');
+                return 1;
+            }
+            io.stderr(`Unknown midscene model command: ${action}\n\n${MODEL_COMMAND_USAGE}`);
+            return 1;
+        }
         Promise.resolve((async ()=>{
             const rawArgs = process.argv.slice(2);
             const [firstArg] = rawArgs;
@@ -12621,6 +12798,11 @@ defineYamlBatchTest(test, testOptions);
                 version: package_namespaceObject.rE,
                 extraCommands: createReportCliCommands()
             });
+            if ('model' === firstArg) {
+                const exitCode = await runModelCommand(rawArgs);
+                process.exit(exitCode);
+                return;
+            }
             const { options, path, files: cmdFiles } = await parseProcessArgs();
             const welcome = `\nWelcome to @midscene/cli v${package_namespaceObject.rE}\n`;
             console.log(welcome);
@@ -12669,15 +12851,11 @@ defineYamlBatchTest(test, testOptions);
                 console.error('Could not create a valid configuration.');
                 process.exit(1);
             }
-            const dotEnvConfigFile = join(process.cwd(), '.env');
-            if ((0, __rspack_external_node_fs_5ea92f0c.existsSync)(dotEnvConfigFile)) {
-                console.log(`   Env file: ${dotEnvConfigFile}`);
-                main_default().config({
-                    path: dotEnvConfigFile,
-                    debug: config.dotenvDebug,
-                    override: config.dotenvOverride
-                });
-            }
+            loadDotenvConfig({
+                dotenvDebug: config.dotenvDebug,
+                dotenvOverride: config.dotenvOverride,
+                log: console.log
+            });
             const exitCode = await runFrameworkTestConfig(config);
             if (config.keepWindow) setInterval(()=>{
                 console.log('browser is still running, use ctrl+c to stop it');