@mearl/provider 2.21.0 → 2.22.0

package/README.md

@@ -4,6 +4,8 @@
 Provider 使用相同的 `BrowserProviderDefinition`；区别只在于运行时位于 Native Host 进程内，
 还是通过本地 Provider Socket 接入。
 
+action 清单位于 `src/generated/provider-actions.ts`，由根目录 `pnpm run generate:provider-actions` 从 browser-core 协议生成。
+
 ## 核心模型
 
 控制会话由 Mearl 管理。Provider 继续接收目标实例、页面与普通 action，无需处理控制会话 ID、资源归属或人工交接状态。带 `--session` 的释放只结束 Mearl 任务控制；实例关闭、退出接管与 Cookie 同步仍使用 Provider 的生命周期方法。上传与下载分别按 `capabilities.actions` 中的 `page_upload`、`page_download` 声明使用。
@@ -40,7 +42,7 @@ pnpm add @mearl/provider
     "provider": {
       "providerId": "example-device",
       "name": "Example device provider",
-      "protocolVersion": 2,
+      "protocolVersion": 3,
       "entry": "./dist/runtime.js",
       "browserType": {
         "name": "Device",
@@ -147,7 +149,7 @@ Provider 需要查询设备池、已有会话或动态候选项时，声明 `bro
 初次查询携带静态表单默认值；查询只传入可解析的字段，最终启动仍严格校验全部输入。
 用户在等待期间输入的内容会保留，切换模式或环境会使旧请求失效。
 管理器通过内部
-`browser_provider_launch_form` 请求获取 `ProviderLaunchForm`，不识别 Provider ID 或业务字段：
+`browser_providers` 的 `launch_form` operation 获取 `ProviderLaunchForm`，不识别 Provider ID 或业务字段：
 
 - `inputSchema` 描述当前模式的用户输入，`required` 决定必填标识与提交校验。
 - `variants` 的 `id/title/description` 描述连接方式，`variant` 指定当前方式。
@@ -185,3 +187,17 @@ npx @mearl/setup provider install <package>
 npx @mearl/setup provider update <provider-id>
 npx @mearl/setup provider uninstall <provider-id>
 ```
+
+## Socket 协议
+
+当前 Provider 协议版本为 **3**，请求 envelope 携带 `protocolVersion`。安装元数据、
+运行时 descriptor、运行中进程与调用方必须使用相同协议；不匹配时更新相关包并重启进程。
+
+- `browser_providers`：`operation: "configure"` 携带 `options`，`operation: "launch_form"` 携带 `variant?` 和 `values`。
+- `browser_instances`：`operation: "start" | "detach" | "sync_cookies"`；同步携带 `scope`，目标实例由 envelope 的 `browserId` 选择。
+- `browser_launch`、`browser_close`、`get_browser_access_url` 保留各自职责。
+- `browser_sessions` 由 Mearl 控制进程处理，不转交外部 Provider；会话释放与实例 `detach` 分开执行。
+
+SDK 负责将 Socket 请求分发到 `configure/getLaunchForm/start/detach/syncCookies` 等方法。
+`browser_release` 普通 action 不承担实例解绑；公开 CLI 的无会话释放由 Mearl 转换为 `detach`。
+打包 SDK 的 Provider 必须更新 SDK 并重新构建，修改安装元数据不能替换运行中的旧代码。

package/dist/control-host.d.ts

@@ -3,6 +3,7 @@ export interface ProviderControlHostRecord extends DaemonRecord {
     socketPath: string;
     token: string;
     ready: boolean;
+    protocolVersion: number;
 }
 export declare function providerControlHostFile(): string;
 export declare function providerControlSocketPath(pid: number): string;

package/dist/control-host.js

@@ -2,6 +2,7 @@ import { spawn } from 'node:child_process';
 import { randomUUID } from 'node:crypto';
 import { tmpdir } from 'node:os';
 import { join } from 'node:path';
+import { assertProviderProtocolVersion, MEARL_PROVIDER_PROTOCOL_VERSION } from './protocol.js';
 import { isAlive, keyedConfigFile, claimRecord, readRecord, removeInvalidRecord, removeRecordIfPid, writeRecordIfPid, } from '@mearl/daemon-core';
 export function providerControlHostFile() {
     return keyedConfigFile('control', 'providers');
@@ -13,9 +14,10 @@ export function providerControlSocketPath(pid) {
 }
 export function readProviderControlHost() {
     const record = readRecord(providerControlHostFile());
-    return record?.ready && typeof record.socketPath === 'string' && isAlive(record.pid)
-        ? record
-        : null;
+    if (!record?.ready || typeof record.socketPath !== 'string' || !isAlive(record.pid))
+        return null;
+    assertProviderProtocolVersion(record.protocolVersion, 'Provider control host');
+    return record;
 }
 let startup;
 /** A single host owns Provider sessions across independent CLI and connector processes. */
@@ -36,7 +38,13 @@ export function ensureProviderControlHost(timeoutMs = 10_000) {
                 else
                     removeInvalidRecord(file);
                 const token = randomUUID();
-                if (claimRecord(file, { pid: process.pid, socketPath: '', token, ready: false })) {
+                if (claimRecord(file, {
+                    pid: process.pid,
+                    socketPath: '',
+                    token,
+                    ready: false,
+                    protocolVersion: MEARL_PROVIDER_PROTOCOL_VERSION,
+                })) {
                     try {
                         const entry = process.env.MEARL_NATIVE_HOST_ENTRY;
                         const child = spawn(entry ? process.execPath : 'mearl-native-host', [...(entry ? [entry] : []), '--provider-control', token], { detached: true, stdio: 'ignore', windowsHide: true });
@@ -52,6 +60,7 @@ export function ensureProviderControlHost(timeoutMs = 10_000) {
                             socketPath: providerControlSocketPath(child.pid),
                             token,
                             ready: false,
+                            protocolVersion: MEARL_PROVIDER_PROTOCOL_VERSION,
                         });
                     }
                     catch (error) {

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './types.js';
-export { PROVIDER_ACTIONS, isProviderAction } from './generated-provider-actions.js';
+export { assertProviderProtocolVersion } from './protocol.js';
+export { PROVIDER_ACTIONS, isProviderAction } from './generated/provider-actions.js';
 export { providerDataDir } from './registry.js';
 export { createProviderRuntime, validateProviderBrowser, validateProviderInput, validateProviderLaunchForm, } from './provider-runtime.js';
 export { createProviderServer } from './server.js';

package/dist/index.js

@@ -1,5 +1,6 @@
 export * from './types.js';
-export { PROVIDER_ACTIONS, isProviderAction } from './generated-provider-actions.js';
+export { assertProviderProtocolVersion } from './protocol.js';
+export { PROVIDER_ACTIONS, isProviderAction } from './generated/provider-actions.js';
 export { providerDataDir } from './registry.js';
 export { createProviderRuntime, validateProviderBrowser, validateProviderInput, validateProviderLaunchForm, } from './provider-runtime.js';
 export { createProviderServer } from './server.js';

package/dist/launcher.js

@@ -4,13 +4,18 @@ import { closeSync, existsSync, mkdirSync, openSync } from 'node:fs';
 import { join } from 'node:path';
 import { hashKey, keyedDir, rotateLogIfNeeded } from '@mearl/daemon-core';
 import { PROVIDER_START_TOKEN_ENV, claimProviderStart, listInstalledProviders, listLiveProviders, readLiveProvider, readProviderStart, releaseProviderStart, transferProviderStart, validateInstalledProviderManifest, } from './registry.js';
+import { assertProviderProtocolVersion } from './protocol.js';
 export const PROVIDER_LOGS_SUBDIR = 'providers/logs';
 function providerLogFile(providerId) {
     const hash = hashKey(providerId);
     return join(keyedDir(PROVIDER_LOGS_SUBDIR), `${hash}.log`);
 }
-function liveProviderIds() {
-    return new Set(listLiveProviders().map(record => record.providerId));
+function hasCompatibleLiveProvider(providerId) {
+    const live = readLiveProvider(providerId);
+    if (!live)
+        return false;
+    assertProviderProtocolVersion(live.providerProtocolVersion, providerId);
+    return true;
 }
 function delay(ms) {
     return new Promise(resolve => setTimeout(resolve, ms));
@@ -52,38 +57,39 @@ export async function ensureInstalledProvidersRunning(providerIds) {
     const warnings = [];
     const selected = providerIds ? new Set(providerIds) : undefined;
     const installed = listInstalledProviders().filter(provider => !selected || selected.has(provider.providerId));
-    const live = liveProviderIds();
     const starting = new Map();
     for (const manifest of installed) {
-        if (live.has(manifest.providerId))
-            continue;
         const invalid = validateInstalledProviderManifest(manifest);
         if (invalid) {
             warnings.push(`provider ${manifest.providerId || '(unknown)'}: ${invalid}`);
             continue;
         }
-        const startToken = randomUUID();
-        if (!claimProviderStart(manifest.providerId, startToken)) {
-            if (readLiveProvider(manifest.providerId))
-                continue;
-            if (readProviderStart(manifest.providerId))
-                starting.set(manifest.providerId, null);
-            else
-                warnings.push(`provider ${manifest.providerId}: failed to acquire startup ownership`);
-            continue;
-        }
-        if (readLiveProvider(manifest.providerId)) {
-            releaseProviderStart(manifest.providerId, startToken);
-            continue;
-        }
-        const logFile = providerLogFile(manifest.providerId);
+        let startToken;
         try {
+            if (hasCompatibleLiveProvider(manifest.providerId))
+                continue;
+            startToken = randomUUID();
+            if (!claimProviderStart(manifest.providerId, startToken)) {
+                if (hasCompatibleLiveProvider(manifest.providerId))
+                    continue;
+                if (readProviderStart(manifest.providerId))
+                    starting.set(manifest.providerId, null);
+                else
+                    warnings.push(`provider ${manifest.providerId}: failed to acquire startup ownership`);
+                continue;
+            }
+            if (hasCompatibleLiveProvider(manifest.providerId)) {
+                releaseProviderStart(manifest.providerId, startToken);
+                continue;
+            }
+            const logFile = providerLogFile(manifest.providerId);
             const childPid = await spawnProvider(manifest, logFile, startToken);
             transferProviderStart(manifest.providerId, startToken, childPid);
             starting.set(manifest.providerId, startToken);
         }
         catch (error) {
-            releaseProviderStart(manifest.providerId, startToken);
+            if (startToken)
+                releaseProviderStart(manifest.providerId, startToken);
             warnings.push(`provider ${manifest.providerId}: ${error instanceof Error ? error.message : String(error)}`);
         }
     }
@@ -93,12 +99,20 @@ export async function ensureInstalledProvidersRunning(providerIds) {
     let remaining = [...starting.keys()];
     while (remaining.length > 0 && Date.now() < deadline) {
         await delay(100);
-        const current = liveProviderIds();
+        const current = new Set(listLiveProviders().map(record => record.providerId));
         remaining = remaining.filter(providerId => !current.has(providerId));
     }
     for (const [providerId, token] of starting) {
         if (!remaining.includes(providerId) && token)
             releaseProviderStart(providerId, token);
+        if (!remaining.includes(providerId)) {
+            try {
+                hasCompatibleLiveProvider(providerId);
+            }
+            catch (error) {
+                warnings.push(`provider ${providerId}: ${error instanceof Error ? error.message : String(error)}`);
+            }
+        }
     }
     for (const providerId of remaining) {
         const logFile = providerLogFile(providerId);

package/dist/protocol.d.ts

@@ -0,0 +1,2 @@
+export declare const MEARL_PROVIDER_PROTOCOL_VERSION = 3;
+export declare function assertProviderProtocolVersion(actual: unknown, peer?: string): void;

package/dist/protocol.js

@@ -0,0 +1,6 @@
+export const MEARL_PROVIDER_PROTOCOL_VERSION = 3;
+export function assertProviderProtocolVersion(actual, peer = 'Provider') {
+    if (actual !== MEARL_PROVIDER_PROTOCOL_VERSION) {
+        throw new Error(`PROVIDER_PROTOCOL_MISMATCH: ${peer} uses protocol ${String(actual ?? 'unknown')}; expected ${MEARL_PROVIDER_PROTOCOL_VERSION}. Update Mearl and the Provider package, then restart the services.`);
+    }
+}

package/dist/provider-runtime.js

@@ -1,5 +1,5 @@
 import { MEARL_PROVIDER_PROTOCOL_VERSION } from './types.js';
-import { isProviderAction } from './generated-provider-actions.js';
+import { isProviderAction } from './generated/provider-actions.js';
 const LIFECYCLE_OPERATIONS = new Set([
     'start',
     'close',

package/dist/registry.js

@@ -4,6 +4,7 @@ import { isAbsolute, join, relative, resolve, sep } from 'node:path';
 import { claimRecord, ensureDir, hashKey, isAlive, keyedConfigFile, keyedDir, listRecordFiles, readLiveRecords, readRecord, removeInvalidRecord, removeRecordIfPid, writeRecord, writeRecordIfPid, } from '@mearl/daemon-core';
 import { MEARL_PROVIDER_PROTOCOL_VERSION, } from './types.js';
 import { validateProviderLaunchForm, isProviderInputSchema } from './provider-runtime.js';
+import { assertProviderProtocolVersion } from './protocol.js';
 export const INSTALLED_PROVIDERS_SUBDIR = 'providers/installed';
 export const LIVE_PROVIDERS_SUBDIR = 'providers/live';
 export const STARTING_PROVIDERS_SUBDIR = 'providers/starting';
@@ -93,8 +94,11 @@ export function validateInstalledProviderManifest(manifest) {
         !manifest.version.trim()) {
         return 'manifest is incomplete';
     }
-    if (manifest.protocolVersion !== MEARL_PROVIDER_PROTOCOL_VERSION) {
-        return `protocol ${manifest.protocolVersion} is unsupported`;
+    try {
+        assertProviderProtocolVersion(manifest.protocolVersion, `Installed Provider ${manifest.providerId}`);
+    }
+    catch (error) {
+        return error.message;
     }
     if (RESERVED_PROVIDER_IDS.has(manifest.providerId)) {
         return `providerId ${manifest.providerId} is reserved for a built-in Provider`;

package/dist/server.js

@@ -3,10 +3,11 @@ import { randomUUID } from 'node:crypto';
 import { chmodSync, rmSync } from 'node:fs';
 import { dirname } from 'node:path';
 import { ensureDir } from '@mearl/daemon-core';
-import { isProviderAction } from './generated-provider-actions.js';
+import { isProviderAction } from './generated/provider-actions.js';
 import { createProviderRuntime } from './provider-runtime.js';
 import { PROVIDER_START_TOKEN_ENV, claimProviderStart, providerBrowserKey, providerSocketPath, publishLiveProvider, publishProviderBrowsers, readLiveProvider, releaseProviderStart, removeStaleProviderSocket, touchProviderBrowser, unpublishLiveProvider, unpublishProviderBrowsers, } from './registry.js';
 import { MEARL_PROVIDER_PROTOCOL_VERSION } from './types.js';
+import { assertProviderProtocolVersion } from './protocol.js';
 const MAX_REQUEST_BYTES = 16 * 1024 * 1024;
 const activeProviderIds = new Set();
 function errorMessage(error) {
@@ -29,6 +30,7 @@ function isProviderActionRequest(value) {
         request.id.length > 0 &&
         typeof request.action === 'string' &&
         request.action.length > 0 &&
+        typeof request.protocolVersion === 'number' &&
         (request.data === undefined ||
             (request.data !== null &&
                 typeof request.data === 'object' &&
@@ -84,32 +86,39 @@ export function createProviderServer(options) {
         if (request.controlSessionId)
             throw new Error('CONTROL_SESSION_UNSUPPORTED: this Provider does not implement control sessions');
         const context = providerContext(request);
-        if (request.action === 'browser_provider_launch_form') {
+        if (request.action === 'browser_providers') {
             if (request.browserId)
-                throw new Error('Provider launch form does not accept browserId');
-            return runtime.getLaunchForm({
-                variant: request.data?.variant,
-                values: request.data?.values,
-            }, context);
+                throw new Error('Provider management does not accept browserId');
+            switch (request.data?.operation) {
+                case 'configure':
+                    return runtime.configure(request.data.options, context);
+                case 'launch_form':
+                    return runtime.getLaunchForm({
+                        variant: request.data.variant,
+                        values: request.data.values,
+                    }, context);
+                default:
+                    throw new Error('Invalid browser provider operation');
+            }
         }
         if (request.action === 'browser_launch') {
             if (request.browserId)
                 throw new Error('browser_launch does not accept browserId');
             return runtime.launch(request.data ?? {}, context);
         }
-        if (request.action === 'browser_provider_configure') {
-            if (request.browserId)
-                throw new Error('Provider configuration does not accept browserId');
-            return runtime.configure(request.data ?? {}, context);
-        }
-        if (request.action === 'browser_manager_start') {
-            return runtime.start({ browserId: await providerBrowserId(request.browserId) }, context);
-        }
-        if (request.action === 'browser_manager_sync_cookies') {
-            return runtime.syncCookies({
-                browserId: await providerBrowserId(request.browserId),
-                scope: request.data?.scope,
-            }, context);
+        if (request.action === 'browser_instances') {
+            if (!['start', 'detach', 'sync_cookies'].includes(String(request.data?.operation))) {
+                throw new Error('Invalid browser instance operation');
+            }
+            const browserId = await providerBrowserId(request.browserId);
+            switch (request.data.operation) {
+                case 'start':
+                    return runtime.start({ browserId }, context);
+                case 'detach':
+                    return runtime.detach({ browserId }, context);
+                case 'sync_cookies':
+                    return runtime.syncCookies({ browserId, scope: request.data.scope }, context);
+            }
         }
         if (request.action !== 'get_versions' &&
             request.action !== 'browser_close' &&
@@ -141,12 +150,6 @@ export function createProviderServer(options) {
                 capabilities: found.control.kind === 'provider' ? found.control.capabilities : undefined,
             };
         }
-        if (request.action === 'browser_release') {
-            const found = (await runtime.listBrowsers()).find(browser => browser.browserId === browserId);
-            if (found?.operations.includes('detach')) {
-                return runtime.detach({ browserId }, context);
-            }
-        }
         touchProviderBrowser(providerBrowserKey(descriptor.providerId, browserId));
         return runtime.invokeAction({
             browserId,
@@ -179,12 +182,19 @@ export function createProviderServer(options) {
                 socket.end(`${JSON.stringify({ id: '', success: false, error: 'Invalid JSON request' })}\n`);
                 return;
             }
+            const id = parsed && typeof parsed === 'object' && typeof parsed.id === 'string'
+                ? parsed.id
+                : '';
+            if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) {
+                try {
+                    assertProviderProtocolVersion(parsed.protocolVersion);
+                }
+                catch (error) {
+                    socket.end(`${JSON.stringify({ id, success: false, error: errorMessage(error) })}\n`);
+                    return;
+                }
+            }
             if (!isProviderActionRequest(parsed)) {
-                const id = parsed &&
-                    typeof parsed === 'object' &&
-                    typeof parsed.id === 'string'
-                    ? parsed.id
-                    : '';
                 socket.end(`${JSON.stringify({ id, success: false, error: 'Invalid request envelope' })}\n`);
                 return;
             }

package/dist/types.d.ts

@@ -1,6 +1,6 @@
-import type { ProviderAction } from './generated-provider-actions.js';
-export declare const MEARL_PROVIDER_PROTOCOL_VERSION = 2;
-export type { ProviderAction } from './generated-provider-actions.js';
+import type { ProviderAction } from './generated/provider-actions.js';
+export { MEARL_PROVIDER_PROTOCOL_VERSION } from './protocol.js';
+export type { ProviderAction } from './generated/provider-actions.js';
 export type JsonPrimitive = string | number | boolean | null;
 export type JsonValue = JsonPrimitive | JsonValue[] | JsonObject;
 export interface JsonObject {
@@ -197,6 +197,7 @@ export interface ProviderActionRequest {
     /** Provider-local browser id selected by the Mearl client. */
     browserId?: string;
     version?: string;
+    protocolVersion: number;
     controlSource?: string;
     host?: ProviderHostContextData;
 }

package/dist/types.js

@@ -1 +1 @@
-export const MEARL_PROVIDER_PROTOCOL_VERSION = 2;
+export { MEARL_PROVIDER_PROTOCOL_VERSION } from './protocol.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mearl/provider",
-  "version": "2.21.0",
+  "version": "2.22.0",
   "description": "Unified contracts and runtime utilities for built-in and external Mearl browser providers",
   "type": "module",
   "main": "dist/index.js",
@@ -35,7 +35,7 @@
     "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "@mearl/daemon-core": "2.21.0"
+    "@mearl/daemon-core": "2.22.0"
   },
   "devDependencies": {
     "@types/node": "^24.9.1",