@weapp-vite/miniprogram-automator 1.2.0 → 1.2.2

package/dist/index.d.mts

@@ -277,6 +277,10 @@ declare class MiniProgram extends EventEmitter {
   on(event: string | symbol, listener: (...args: any[]) => void): this;
   exposeFunction(name: string, bindingFunction: AutomatorCallable): Promise<void>;
   checkVersion(): Promise<void>;
+  /**
+   * @description 等待小程序 App 域协议可用，避免返回半就绪自动化会话。
+   */
+  waitForAppReady(timeout?: number): Promise<void>;
   screenshot(options?: IScreenshotOptions): Promise<any>;
   testAccounts(): Promise<any>;
   /**

package/dist/index.mjs

@@ -683,7 +683,7 @@ async function acquireAutomatorPortLease(preferredPort) {
 }
 //#endregion
 //#region package.json
-var version = "1.2.0";
+var version = "1.2.2";
 //#endregion
 //#region src/Native.ts
 /** Native 的实现。 */
@@ -880,6 +880,9 @@ const CHANGE_ROUTE_CONTEXT_TIMEOUT = 12e3;
 const CHANGE_ROUTE_CALL_TIMEOUT = 12e3;
 const CHANGE_ROUTE_READY_TIMEOUT = 15e3;
 const CHANGE_ROUTE_POLL_DELAY = 500;
+const APP_READY_TIMEOUT = 2e4;
+const APP_READY_PROBE_TIMEOUT = 3e3;
+const APP_READY_POLL_DELAY = 500;
 const CHANGE_ROUTE_DEBUG_ENABLED = process.env.WEAPP_VITE_E2E_CHANGE_ROUTE_DEBUG === "1";
 function sleep(ms) {
 	return new Promise((resolve) => setTimeout(resolve, ms));
@@ -1107,6 +1110,21 @@ var MiniProgram = class extends EventEmitter {
 		const sdkVersion = (await this.send("Tool.getInfo")).SDKVersion;
 		if (sdkVersion !== "dev" && cmpVersion(sdkVersion, "2.7.3") < 0) throw new Error(`SDKVersion is currently ${sdkVersion}, while automator(${version}) requires at least version 2.7.3`);
 	}
+	/**
+	* @description 等待小程序 App 域协议可用，避免返回半就绪自动化会话。
+	*/
+	async waitForAppReady(timeout = APP_READY_TIMEOUT) {
+		const startedAt = Date.now();
+		let lastError;
+		while (Date.now() - startedAt <= timeout) try {
+			await this.send("App.captureScreenshot", {}, { timeout: APP_READY_PROBE_TIMEOUT });
+			return;
+		} catch (error) {
+			lastError = error;
+			await sleep(APP_READY_POLL_DELAY);
+		}
+		throw lastError instanceof Error ? lastError : /* @__PURE__ */ new Error(`Timed out waiting App domain readiness after ${timeout}ms`);
+	}
 	async screenshot(options = {}) {
 		const { data } = await this.send("App.captureScreenshot");
 		if (!options.path) return data;
@@ -1688,7 +1706,7 @@ const AUTOMATOR_LAUNCH_RETRIES = 3;
 const DEFAULT_RUNTIME_PROVIDER_ENV = "WEAPP_VITE_AUTOMATOR_RUNTIME_PROVIDER";
 const LEGACY_RUNTIME_PROVIDER_ENV = "WEAPP_VITE_E2E_RUNTIME_PROVIDER";
 const EXTENSION_CONTEXT_INVALIDATED_RE = /Extension context invalidated/i;
-const RETRYABLE_LAUNCH_PORT_RE = /Wait timed out after \d+ ms|Failed connecting to ws:\/\/127\.0\.0\.1:\d+|Failed connecting to devtools websocket endpoint/i;
+const RETRYABLE_LAUNCH_PORT_RE = /Wait timed out after \d+ ms|Failed connecting to ws:\/\/127\.0\.0\.1:\d+|Failed connecting to devtools websocket endpoint|Failed to launch wechat web devTools, please make sure cliPath is correctly specified/i;
 const WINDOWS_BATCH_CLI_RE = /\.(?:bat|cmd)$/i;
 let localhostListenPatched = false;
 function isExtensionContextInvalidatedError(error) {
@@ -1697,6 +1715,33 @@ function isExtensionContextInvalidatedError(error) {
 function isRetryableAutomatorPortLaunchError(error) {
 	return error instanceof Error && RETRYABLE_LAUNCH_PORT_RE.test(error.message);
 }
+function retainPortLeaseUntilSessionClose(miniProgram, portLease) {
+	let released = false;
+	const release = async () => {
+		if (released) return;
+		released = true;
+		await portLease.release();
+	};
+	const target = miniProgram;
+	const rawClose = target.close;
+	const rawDisconnect = target.disconnect;
+	if (typeof rawClose !== "function" && typeof rawDisconnect !== "function") return false;
+	if (typeof rawDisconnect === "function") target.disconnect = function disconnectWithPortLeaseRelease() {
+		try {
+			return rawDisconnect.call(this);
+		} finally {
+			release();
+		}
+	};
+	if (typeof rawClose === "function") target.close = async function closeWithPortLeaseRelease() {
+		try {
+			return await rawClose.call(this);
+		} finally {
+			await release();
+		}
+	};
+	return true;
+}
 function patchNetListenToLoopback() {
 	if (localhostListenPatched) return;
 	localhostListenPatched = true;
@@ -1759,6 +1804,7 @@ var Launcher = class {
 		const { cliPath = await this.resolveCliPath(), timeout = DEFAULT_TIMEOUT, projectConfig = {}, ticket = "", cwd = "", account = "", trustProject = false } = options;
 		let { args = [], projectPath } = options;
 		const portLease = await acquireAutomatorPortLease(options.port);
+		let releasePortLeaseOnExit = true;
 		try {
 			const port = portLease.port;
 			if (!cliPath) throw new Error("Wechat web devTools not found, please specify cliPath option");
@@ -1815,6 +1861,7 @@ var Launcher = class {
 					const candidate = await this.connectTool({ wsEndpoint: `ws://127.0.0.1:${port}` });
 					try {
 						await candidate.checkVersion();
+						if (typeof candidate.waitForAppReady === "function") await candidate.waitForAppReady(timeout);
 					} catch (error) {
 						candidate.disconnect();
 						lastConnectError = error;
@@ -1840,10 +1887,11 @@ var Launcher = class {
 				projectPath: resolvedProjectPath,
 				wsEndpoint: `ws://127.0.0.1:${port}`
 			});
+			releasePortLeaseOnExit = !retainPortLeaseUntilSessionClose(resolvedMiniProgram, portLease);
 			await sleep$1(5e3);
 			return resolvedMiniProgram;
 		} finally {
-			await portLease.release();
+			if (releasePortLeaseOnExit) await portLease.release();
 		}
 	}
 	async connect(options) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@weapp-vite/miniprogram-automator",
   "type": "module",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "完全兼容微信 miniprogram-automator 的现代化替代实现",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",