Serialize custom command results

Author: pirate

go/modcdp/translate/translate.go

@@ -138,7 +138,7 @@ func wrapCustomCommand(method string, params map[string]any, sessionID string) m
 	m, _ := json.Marshal(method)
 	p, _ := json.Marshal(params)
 	sid, _ := json.Marshal(sessionID)
-	return callFunctionParams(fmt.Sprintf(`async function() { return await globalThis.ModCDP.handleCommand(%s, %s, %s); }`, string(m), string(p), string(sid)))
+	return callFunctionParams(fmt.Sprintf(`async function() { return JSON.stringify(await globalThis.ModCDP.handleCommand(%s, %s, %s)); }`, string(m), string(p), string(sid)))
 }
 
 func wrapServiceWorkerCommand(method string, params map[string]any, sessionID string, targetSessionID string) []rawStep {
@@ -179,7 +179,11 @@ func wrapServiceWorkerCommand(method string, params map[string]any, sessionID st
 		}
 		runtimeParams = wrapCustomCommand(method, params, cdpSessionID)
 	}
-	return []rawStep{{Method: "Runtime.callFunctionOn", Params: runtimeParams, Unwrap: "runtime"}}
+	unwrap := "runtime_json"
+	if strings.HasPrefix(method, "Mod.") {
+		unwrap = "runtime"
+	}
+	return []rawStep{{Method: "Runtime.callFunctionOn", Params: runtimeParams, Unwrap: unwrap}}
 }
 
 func WrapCommandIfNeeded(method string, params map[string]any, routes map[string]string, sessionID string, targetSessionID ...string) (rawCommand, error) {
@@ -198,7 +202,7 @@ func WrapCommandIfNeeded(method string, params map[string]any, routes map[string
 }
 
 func UnwrapResponseIfNeeded(result map[string]any, unwrap string) (any, error) {
-	if unwrap != "runtime" {
+	if unwrap != "runtime" && unwrap != "runtime_json" {
 		return result, nil
 	}
 	if ex, ok := result["exceptionDetails"].(map[string]any); ok {
@@ -219,7 +223,17 @@ func UnwrapResponseIfNeeded(result map[string]any, unwrap string) (any, error) {
 		return nil, fmt.Errorf("%s", msg)
 	}
 	inner, _ := result["result"].(map[string]any)
-	return inner["value"], nil
+	value := inner["value"]
+	if unwrap == "runtime_json" {
+		if raw, ok := value.(string); ok {
+			var decoded any
+			if err := json.Unmarshal([]byte(raw), &decoded); err != nil {
+				return nil, err
+			}
+			return decoded, nil
+		}
+	}
+	return value, nil
 }
 
 func UnwrapEventIfNeeded(method string, params map[string]any, sessionID string, ourSessionID string) (string, any, bool) {

js/src/translate/translate.ts

@@ -175,7 +175,7 @@ export function wrapCustomCommand(
   cdpSessionId: string | null = null,
 ): cdp.types.ts.Runtime.EvaluateParams {
   return {
-    functionDeclaration: `async function() { return await globalThis.ModCDP.handleCommand(${JSON.stringify(method)}, ${JSON.stringify(params)}, ${JSON.stringify(cdpSessionId)}); }`,
+    functionDeclaration: `async function() { return JSON.stringify(await globalThis.ModCDP.handleCommand(${JSON.stringify(method)}, ${JSON.stringify(params)}, ${JSON.stringify(cdpSessionId)})); }`,
     awaitPromise: true,
     returnByValue: true,
   };
@@ -221,7 +221,7 @@ function wrapServiceWorkerCommand(method: string, params: ProtocolParams = {}, c
     {
       method: "Runtime.callFunctionOn",
       params: runtimeParams,
-      unwrap: "runtime" as const,
+      unwrap: method.startsWith("Mod.") ? ("runtime" as const) : ("runtime_json" as const),
     },
   ];
 }
@@ -260,10 +260,16 @@ function unwrapRuntimeResponse(result: cdp.types.ts.Runtime.EvaluateResult) {
   return result?.result?.value;
 }
 
+function unwrapRuntimeJsonResponse(result: cdp.types.ts.Runtime.EvaluateResult) {
+  const value = unwrapRuntimeResponse(result);
+  return typeof value === "string" ? JSON.parse(value) : value;
+}
+
 export function unwrapResponseIfNeeded(
   result: ProtocolResult | cdp.types.ts.Runtime.EvaluateResult,
   unwrap: string | null = null,
 ) {
+  if (unwrap === "runtime_json") return unwrapRuntimeJsonResponse(result as cdp.types.ts.Runtime.EvaluateResult);
   return unwrap === "runtime" ? unwrapRuntimeResponse(result as cdp.types.ts.Runtime.EvaluateResult) : (result ?? {});
 }
 

js/src/types/modcdp.ts

@@ -387,7 +387,7 @@ export const TranslatedStepSchema = z
     method: z.string(),
     params: ProtocolParamsSchema.optional(),
     sessionId: z.string().nullable().optional(),
-    unwrap: z.literal("runtime").optional(),
+    unwrap: z.enum(["runtime", "runtime_json"]).optional(),
   })
   .passthrough();
 export type TranslatedStep = z.infer<typeof TranslatedStepSchema>;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "modcdp",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/pirate/modcdp.git"

python/modcdp/translate/translate.py

@@ -153,8 +153,8 @@ def _wrap_modcdp_add_middleware(params: ProtocolParams) -> RuntimeCallFunctionOn
 
 def _wrap_custom_command(method: str, params: ProtocolParams, session_id: str) -> RuntimeCallFunctionOnParams:
     return _call_function_params(
-        "async function() { return await globalThis.ModCDP.handleCommand("
-        f"{json.dumps(method)}, {json.dumps(params)}, {json.dumps(session_id)}); }}"
+        "async function() { return JSON.stringify(await globalThis.ModCDP.handleCommand("
+        f"{json.dumps(method)}, {json.dumps(params)}, {json.dumps(session_id)})); }}"
     )
 
 
@@ -183,7 +183,8 @@ 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)
-    return [{"method": "Runtime.callFunctionOn", "params": runtime_params, "unwrap": "runtime"}]
+    unwrap = "runtime" if method.startswith("Mod.") else "runtime_json"
+    return [{"method": "Runtime.callFunctionOn", "params": runtime_params, "unwrap": unwrap}]
 
 
 def wrap_command_if_needed(
@@ -231,6 +232,9 @@ def _unwrap_evaluate_response(result: ProtocolResult) -> JsonValue:
 
 
 def unwrap_response_if_needed(result: ProtocolResult, unwrap: str | None = None) -> JsonValue:
+    if unwrap == "runtime_json":
+        value = _unwrap_evaluate_response(result)
+        return cast(JsonValue, json.loads(value)) if isinstance(value, str) else value
     return _unwrap_evaluate_response(result) if unwrap == "runtime" else (result or {})
 
 

python/modcdp/types/modcdp.py

@@ -108,7 +108,7 @@ class _TranslatedStepRequired(TypedDict):
 class TranslatedStep(_TranslatedStepRequired, total=False):
     params: MessageParams
     sessionId: str | None
-    unwrap: Literal["runtime"]
+    unwrap: Literal["runtime", "runtime_json"]
 
 
 class TranslatedCommand(TypedDict):

python/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "modcdp"
-version = "0.0.11"
+version = "0.0.12"
 description = "Python client for ModCDP."
 readme = "README.md"
 requires-python = ">=3.11"