Release ModCDP 0.0.13

pirate · pirate · commit f5c6b7fad96b · 2026-05-13T03:29:18.000-07:00
diff --git a/go/modcdp/client/ModCDPClient.go b/go/modcdp/client/ModCDPClient.go
@@ -1385,14 +1385,14 @@ func handlerPointer(handler Handler) uintptr {
 }
 
 func (c *ModCDPClient) Close() {
-	if c.transport != nil {
-		_ = c.transport.Close()
-		c.transport = nil
-	}
 	if c.launchedBrowser != nil {
 		c.launchedBrowser.Close()
 		c.launchedBrowser = nil
 	}
+	if c.transport != nil {
+		_ = c.transport.Close()
+		c.transport = nil
+	}
 	for _, injector := range c.extensionInjectors {
 		_ = injector.Close()
 	}
diff --git a/go/modcdp/injector/ExtensionInjector_test.go b/go/modcdp/injector/ExtensionInjector_test.go
@@ -256,7 +256,7 @@ func TestExtensionInjectorKeepsModCDPServiceWorkerAliveThroughOffscreenKeepalive
 		t.Fatal(err)
 	}
 	versionResult, _ := version["result"].(map[string]any)
-	if versionResult["value"] != float64(1) {
+	if versionResult["value"] != float64(2) {
 		t.Fatalf("ModCDP server version = %#v", versionResult["value"])
 	}
 }
diff --git a/go/modcdp/translate/translate.go b/go/modcdp/translate/translate.go
@@ -165,6 +165,7 @@ func wrapServiceWorkerCommand(method string, params map[string]any, sessionID st
 		}
 	}
 	runtimeParams := map[string]any{}
+	unwrap := "runtime"
 	switch method {
 	case "Mod.evaluate":
 		runtimeParams = wrapModCDPEvaluate(params, targetSessionID)
@@ -178,10 +179,7 @@ func wrapServiceWorkerCommand(method string, params map[string]any, sessionID st
 			cdpSessionID = targetSessionID
 		}
 		runtimeParams = wrapCustomCommand(method, params, cdpSessionID)
-	}
-	unwrap := "runtime_json"
-	if strings.HasPrefix(method, "Mod.") {
-		unwrap = "runtime"
+		unwrap = "runtime_json"
 	}
 	return []rawStep{{Method: "Runtime.callFunctionOn", Params: runtimeParams, Unwrap: unwrap}}
 }
diff --git a/go/modcdp/translate/translate_test.go b/go/modcdp/translate/translate_test.go
@@ -44,6 +44,14 @@ func TestTranslateRoutesWrapsAndUnwrapsModCDPProtocolMessagesDeterministically(t
 		t.Fatalf("unwrap = %q", wrapped.Steps[0].Unwrap)
 	}
 
+	configured, err := wrapCommandIfNeeded("Mod.configure", map[string]any{"server": map[string]any{"server_routes": map[string]any{"*.*": "loopback_cdp"}}}, DefaultClientRoutes(), "session-1")
+	if err != nil {
+		t.Fatal(err)
+	}
+	if configured.Steps[0].Unwrap != "runtime_json" {
+		t.Fatalf("configure unwrap = %q", configured.Steps[0].Unwrap)
+	}
+
 	unwrapped, err := unwrapResponseIfNeeded(map[string]any{"result": map[string]any{"type": "object", "value": map[string]any{"ok": true}}}, "runtime")
 	if err != nil {
 		t.Fatal(err)
diff --git a/js/src/client/ModCDPClient.ts b/js/src/client/ModCDPClient.ts
@@ -29,11 +29,7 @@ import {
   type UpstreamTransport,
 } from "../transport/UpstreamTransport.js";
 import type { BrowserLauncher, BrowserLaunchOptions, LaunchedBrowser } from "../launcher/BrowserLauncher.js";
-import {
-  type ExtensionInjectorConfig,
-  type ExtensionInjector,
-  type SendCDP,
-} from "../injector/ExtensionInjector.js";
+import { type ExtensionInjectorConfig, type ExtensionInjector, type SendCDP } from "../injector/ExtensionInjector.js";
 import { AutoSessionRouter } from "../router/AutoSessionRouter.js";
 import type {
   CdpCommandMessage,
@@ -811,9 +807,7 @@ export class ModCDPClient extends ModCDPEventEmitter {
         return new WebSocketUpstreamTransport();
       }
       case "pipe": {
-        const { PipeUpstreamTransport } = await import(
-          /* @vite-ignore */ "../transport/PipeUpstreamTransport.js"
-        );
+        const { PipeUpstreamTransport } = await import(/* @vite-ignore */ "../transport/PipeUpstreamTransport.js");
         return new PipeUpstreamTransport();
       }
       case "reversews": {
@@ -990,10 +984,10 @@ export class ModCDPClient extends ModCDPEventEmitter {
   async close() {
     for (const cleanup of this.event_wait_cleanups) cleanup();
     this.event_wait_cleanups.clear();
-    await this.transport?.close();
-    this.transport = null;
     if (this._launched) await this._launched.close();
     this._launched = null;
+    await this.transport?.close();
+    this.transport = null;
     for (const injector of this._injectors) await injector.close();
     this._injectors = [];
   }
diff --git a/js/src/translate/translate.ts b/js/src/translate/translate.ts
@@ -199,6 +199,7 @@ function wrapServiceWorkerCommand(method: string, params: ProtocolParams = {}, c
   }
 
   let runtimeParams;
+  let unwrap: "runtime" | "runtime_json" = "runtime";
   if (method === "Mod.evaluate") {
     const evaluateParams = params as ModCDPEvaluateParams;
     runtimeParams = wrapModCDPEvaluate({
@@ -215,13 +216,14 @@ function wrapServiceWorkerCommand(method: string, params: ProtocolParams = {}, c
       params,
       ((params as ModCDPCustomPayload).cdpSessionId as string) ?? cdpSessionId,
     );
+    unwrap = "runtime_json";
   }
 
   return [
     {
       method: "Runtime.callFunctionOn",
       params: runtimeParams,
-      unwrap: method.startsWith("Mod.") ? ("runtime" as const) : ("runtime_json" as const),
+      unwrap,
     },
   ];
 }
diff --git a/js/test/test.ExtensionInjector.ts b/js/test/test.ExtensionInjector.ts
@@ -135,7 +135,7 @@ test("ExtensionInjector keeps the ModCDP service worker alive through offscreen
       { expression: "globalThis.ModCDP?.__ModCDPServerVersion", returnByValue: true },
       session_id,
     );
-    assert.equal((version.result as { value?: unknown }).value, 1);
+    assert.equal((version.result as { value?: unknown }).value, 2);
   } finally {
     await cdp.close();
     await injector.close();
diff --git a/js/test/test.ModCDPClient.ts b/js/test/test.ModCDPClient.ts
@@ -293,19 +293,19 @@ test("ModCDPClient defaults launched ModCDP-server upstreams to extension auto",
   }
 });
 
-test("ModCDPClient rejects unknown component modes at their owning factory boundary", () => {
-  assert.throws(
+test("ModCDPClient rejects unknown component modes at their owning factory boundary", async () => {
+  await assert.rejects(
     () =>
       new ModCDPClient({
         upstream: { upstream_mode: "bogus" as any },
       })._upstreamTransport(),
     /unknown upstream\.upstream_mode=bogus/,
   );
-  assert.throws(
+  await assert.rejects(
     () => new ModCDPClient({ launcher: { launcher_mode: "bogus" as any } })._browserLauncher(),
     /unknown launcher\.launcher_mode=bogus/,
   );
-  assert.throws(
+  await assert.rejects(
     () => new ModCDPClient({ injector: { injector_mode: "bogus" as any } })._injectorsForConfig(),
     /unknown injector\.injector_mode=bogus/,
   );
diff --git a/js/test/test.ReverseWebSocketUpstreamTransport.ts b/js/test/test.ReverseWebSocketUpstreamTransport.ts
@@ -135,7 +135,10 @@ test("reversews upstream accepts a real extension reverse connection and routes
   const reverse = new ModCDPClient({
     launcher: {
       launcher_mode: "local",
-      launcher_options: { headless: true, sandbox: process.platform !== "linux" },
+      launcher_options: {
+        headless: process.platform === "linux" && !process.env.DISPLAY,
+        sandbox: process.platform !== "linux",
+      },
     },
     upstream: { upstream_mode: "reversews", upstream_reversews_bind: reverse_bind },
     injector: {
diff --git a/js/test/test.translate.ts b/js/test/test.translate.ts
@@ -28,6 +28,9 @@ test("translate routes, wraps, and unwraps ModCDP protocol messages deterministi
   assert.match(String(wrapped.steps[0]?.params.functionDeclaration), /attachToSession\("session-1"\)/);
   assert.equal(wrapped.steps[0]?.unwrap, "runtime");
 
+  const configured = wrapCommandIfNeeded("Mod.configure", { server: { server_routes: { "*.*": "loopback_cdp" } } });
+  assert.equal(configured.steps[0]?.unwrap, "runtime_json");
+
   assert.deepEqual(unwrapResponseIfNeeded({ result: { type: "object", value: { ok: true } } }, "runtime"), {
     ok: true,
   });
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "modcdp",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/pirate/modcdp.git"
diff --git a/python/modcdp/client/ModCDPClient.py b/python/modcdp/client/ModCDPClient.py
@@ -655,15 +655,15 @@ def close(self) -> None:
         if self._closed:
             return
         self._closed = True
+        if self._launched_browser is not None:
+            self._launched_browser["close"]()
+            self._launched_browser = None
         try:
             if self.transport:
                 self.transport.close()
         except Exception:
             pass
         self.transport = None
-        if self._launched_browser is not None:
-            self._launched_browser["close"]()
-            self._launched_browser = None
         for injector in self._extension_injectors:
             try:
                 injector.close()
diff --git a/python/modcdp/translate/translate.py b/python/modcdp/translate/translate.py
@@ -175,6 +175,7 @@ def _wrap_service_worker_command(
                 "unwrap": "runtime",
             },
         ]
+    unwrap = "runtime"
     if method == "Mod.evaluate":
         runtime_params = _wrap_modcdp_evaluate(params, session_id, target_session_id)
     elif method == "Mod.addCustomCommand":
@@ -183,7 +184,7 @@ def _wrap_service_worker_command(
         runtime_params = _wrap_modcdp_add_middleware(params)
     else:
         runtime_params = _wrap_custom_command(method, params, target_session_id or _optional_string(params, "cdpSessionId") or session_id)
-    unwrap = "runtime" if method.startswith("Mod.") else "runtime_json"
+        unwrap = "runtime_json"
     return [{"method": "Runtime.callFunctionOn", "params": runtime_params, "unwrap": unwrap}]
 
 
diff --git a/python/pyproject.toml b/python/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "modcdp"
-version = "0.0.12"
+version = "0.0.13"
 description = "Python client for ModCDP."
 readme = "README.md"
 requires-python = ">=3.11"
diff --git a/python/tests/test_ExtensionInjector.py b/python/tests/test_ExtensionInjector.py
@@ -190,7 +190,7 @@ def attach_to_target(target_id: str) -> str | None:
                 {"expression": "globalThis.ModCDP?.__ModCDPServerVersion", "returnByValue": True},
                 cast(str, session_id),
             )
-            self.assertEqual(cast(dict[str, Any], version.get("result") or {}).get("value"), 1)
+            self.assertEqual(cast(dict[str, Any], version.get("result") or {}).get("value"), 2)
         finally:
             injector.close()
             ws.close()
diff --git a/python/tests/test_ReverseWebSocketUpstreamTransport.py b/python/tests/test_ReverseWebSocketUpstreamTransport.py
@@ -1,7 +1,9 @@
 from __future__ import annotations
 
 import json
+import os
 import socket
+import sys
 import threading
 import time
 import unittest
@@ -134,7 +136,10 @@ def test_accepts_replacement_peer_after_disconnect(self) -> None:
 
     def test_accepts_real_extension_reverse_connection_and_routes_cdp_through_loopback(self) -> None:
         cdp = ModCDPClient(
-            launcher={"launcher_mode": "local", "launcher_options": {"headless": True, "sandbox": False}},
+            launcher={
+                "launcher_mode": "local",
+                "launcher_options": {"headless": sys.platform.startswith("linux") and not os.environ.get("DISPLAY"), "sandbox": False},
+            },
             upstream={"upstream_mode": "reversews"},
             injector={
                 "injector_mode": "auto",
diff --git a/python/tests/test_translate.py b/python/tests/test_translate.py
@@ -31,6 +31,13 @@ def test_routes_wraps_and_unwraps_modcdp_protocol_messages_deterministically(sel
         self.assertIn('attachToSession("session-1")', str(wrapped["steps"][0].get("params", {}).get("functionDeclaration")))
         self.assertEqual(wrapped["steps"][0].get("unwrap"), "runtime")
 
+        configured = wrap_command_if_needed(
+            "Mod.configure",
+            {"server": {"server_routes": {"*.*": "loopback_cdp"}}},
+            cdp_session_id="session-1",
+        )
+        self.assertEqual(configured["steps"][0].get("unwrap"), "runtime_json")
+
         self.assertEqual(unwrap_response_if_needed({"result": {"type": "object", "value": {"ok": True}}}, "runtime"), {"ok": True})
         self.assertEqual(unwrap_response_if_needed({"product": "Chrome/1"}, None), {"product": "Chrome/1"})
 
diff --git a/python/uv.lock b/python/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -1385,14 +1385,14 @@ func handlerPointer(handler Handler) uintptr {`
`1385`	`1385`	`}`
`1386`	`1386`
`1387`	`1387`	`func (c *ModCDPClient) Close() {`
`1388`		`- if c.transport != nil {`
`1389`		`- _ = c.transport.Close()`
`1390`		`- c.transport = nil`
`1391`		`- }`
`1392`	`1388`	`if c.launchedBrowser != nil {`
`1393`	`1389`	`c.launchedBrowser.Close()`
`1394`	`1390`	`c.launchedBrowser = nil`
`1395`	`1391`	`}`
	`1392`	`+ if c.transport != nil {`
	`1393`	`+ _ = c.transport.Close()`
	`1394`	`+ c.transport = nil`
	`1395`	`+ }`
`1396`	`1396`	`for _, injector := range c.extensionInjectors {`
`1397`	`1397`	`_ = injector.Close()`
`1398`	`1398`	`}`
Original file line number	Diff line number	Diff line change
`@@ -256,7 +256,7 @@ func TestExtensionInjectorKeepsModCDPServiceWorkerAliveThroughOffscreenKeepalive`
`256`	`256`	`t.Fatal(err)`
`257`	`257`	`}`
`258`	`258`	`versionResult, _ := version["result"].(map[string]any)`
`259`		`- if versionResult["value"] != float64(1) {`
	`259`	`+ if versionResult["value"] != float64(2) {`
`260`	`260`	`t.Fatalf("ModCDP server version = %#v", versionResult["value"])`
`261`	`261`	`}`
`262`	`262`	`}`
Original file line number	Diff line number	Diff line change
`@@ -165,6 +165,7 @@ func wrapServiceWorkerCommand(method string, params map[string]any, sessionID st`
`165`	`165`	`}`
`166`	`166`	`}`
`167`	`167`	`runtimeParams := map[string]any{}`
	`168`	`+ unwrap := "runtime"`
`168`	`169`	`switch method {`
`169`	`170`	`case "Mod.evaluate":`
`170`	`171`	`runtimeParams = wrapModCDPEvaluate(params, targetSessionID)`
`@@ -178,10 +179,7 @@ func wrapServiceWorkerCommand(method string, params map[string]any, sessionID st`
`178`	`179`	`cdpSessionID = targetSessionID`
`179`	`180`	`}`
`180`	`181`	`runtimeParams = wrapCustomCommand(method, params, cdpSessionID)`
`181`		`- }`
`182`		`- unwrap := "runtime_json"`
`183`		`- if strings.HasPrefix(method, "Mod.") {`
`184`		`- unwrap = "runtime"`
	`182`	`+ unwrap = "runtime_json"`
`185`	`183`	`}`
`186`	`184`	`return []rawStep{{Method: "Runtime.callFunctionOn", Params: runtimeParams, Unwrap: unwrap}}`
`187`	`185`	`}`
Original file line number	Diff line number	Diff line change
`@@ -199,6 +199,7 @@ function wrapServiceWorkerCommand(method: string, params: ProtocolParams = {}, c`
`199`	`199`	`}`
`200`	`200`
`201`	`201`	`let runtimeParams;`
	`202`	`+ let unwrap: "runtime" \| "runtime_json" = "runtime";`
`202`	`203`	`if (method === "Mod.evaluate") {`
`203`	`204`	`const evaluateParams = params as ModCDPEvaluateParams;`
`204`	`205`	`runtimeParams = wrapModCDPEvaluate({`
`@@ -215,13 +216,14 @@ function wrapServiceWorkerCommand(method: string, params: ProtocolParams = {}, c`
`215`	`216`	`params,`
`216`	`217`	`((params as ModCDPCustomPayload).cdpSessionId as string) ?? cdpSessionId,`
`217`	`218`	`);`
	`219`	`+ unwrap = "runtime_json";`
`218`	`220`	`}`
`219`	`221`
`220`	`222`	`return [`
`221`	`223`	`{`
`222`	`224`	`method: "Runtime.callFunctionOn",`
`223`	`225`	`params: runtimeParams,`
`224`		`- unwrap: method.startsWith("Mod.") ? ("runtime" as const) : ("runtime_json" as const),`
	`226`	`+ unwrap,`
`225`	`227`	`},`
`226`	`228`	`];`
`227`	`229`	`}`