Align Python and Go supported ModCDP surface

Author: pirate

go/examples/demo/main.go

@@ -4,7 +4,6 @@
 //   --live       Use the running Google Chrome enabled via chrome://inspect.
 //   --direct     *.* -> direct_cdp on the client.
 //   --loopback   *.* -> service_worker on client; *.* -> loopback_cdp on server. Default.
-//   --debugger   *.* -> service_worker on client; *.* -> chromedebugger on server.
 //   --upstream   ws. Defaults to ws.
 
 package main
@@ -91,8 +90,6 @@ func serverRoutesFor(mode, upstreamMode string) map[string]string {
 	serverRoute := "auto"
 	if mode == "loopback" {
 		serverRoute = "loopback_cdp"
-	} else if mode == "debugger" {
-		serverRoute = "chromedebugger"
 	}
 	routes := map[string]string{
 		"Mod.*":    "service_worker",
@@ -170,9 +167,7 @@ func parseArgs(argv []string) (string, string, bool, error) {
 	}
 	live := flags["live"]
 	mode := "loopback"
-	if flags["debugger"] {
-		mode = "debugger"
-	} else if flags["direct"] {
+	if flags["direct"] {
 		mode = "direct"
 	} else if flags["loopback"] {
 		mode = "loopback"

go/modcdp/client/CDPTypes.go

@@ -26,13 +26,15 @@ type CDPCommandSchema struct {
 }
 
 type CDPTypes struct {
-	CustomCommands    map[string]CustomCommand
-	CustomEvents      map[string]CustomEvent
-	CustomMiddlewares []CustomMiddleware
-	commandSchemas    map[string]CDPCommandSchema
-	nativeCommands    map[string]bool
-	eventSchemas      map[string]map[string]any
-	mu                sync.RWMutex
+	CustomCommands       map[string]CustomCommand
+	CustomEvents         map[string]CustomEvent
+	CustomMiddlewares    []CustomMiddleware
+	commandSchemas       map[string]CDPCommandSchema
+	commandParamsSchemas map[string]map[string]any
+	commandResultSchemas map[string]map[string]any
+	nativeCommands       map[string]bool
+	eventSchemas         map[string]map[string]any
+	mu                   sync.RWMutex
 }
 
 var jsonSchemaObject = map[string]any{"type": "object"}
@@ -109,15 +111,8 @@ var modConfigureParamsSchema = map[string]any{
 		"upstream": map[string]any{
 			"type": "object",
 			"properties": map[string]any{
-				"upstream_mode":                               map[string]any{"enum": []any{"ws", "pipe", "nativemessaging", "reversews", "nats", "chromedebugger"}},
-				"upstream_ws_cdp_url":                         map[string]any{"type": "string"},
-				"upstream_nats_url":                           map[string]any{"type": "string"},
-				"upstream_nats_subject_prefix":                map[string]any{"type": "string"},
-				"upstream_nats_role":                          map[string]any{"enum": []any{"client", "browser"}},
-				"upstream_nats_wait_timeout_ms":               map[string]any{"type": "number"},
-				"upstream_reversews_bind":                     map[string]any{"type": "string"},
-				"upstream_reversews_wait_timeout_ms":          map[string]any{"type": "number"},
-				"upstream_nativemessaging_host_name":          map[string]any{"type": "string"},
+				"upstream_mode":       map[string]any{"enum": []any{"ws"}},
+				"upstream_ws_cdp_url": map[string]any{"type": "string"},
 				"upstream_ws_connect_error_settle_timeout_ms": map[string]any{"type": "number"},
 				"upstream_cdp_send_timeout_ms":                map[string]any{"type": "number"},
 			},
@@ -142,18 +137,9 @@ var modConfigureParamsSchema = map[string]any{
 			},
 			"additionalProperties": false,
 		},
-		"downstream": map[string]any{
-			"type": "object",
-			"properties": map[string]any{
-				"downstream_client_timeout_ms":           map[string]any{"type": "number"},
-				"downstream_close_browser_on_disconnect": map[string]any{"type": "boolean"},
-			},
-			"additionalProperties": false,
-		},
-		"server_browser_token": map[string]any{"type": "string"},
-		"custom_commands":      map[string]any{"type": "array", "items": modCommandRegistrationSchema},
-		"custom_events":        map[string]any{"type": "array", "items": modEventRegistrationSchema},
-		"custom_middlewares":   map[string]any{"type": "array", "items": modMiddlewareRegistrationSchema},
+		"custom_commands":    map[string]any{"type": "array", "items": modCommandRegistrationSchema},
+		"custom_events":      map[string]any{"type": "array", "items": modEventRegistrationSchema},
+		"custom_middlewares": map[string]any{"type": "array", "items": modMiddlewareRegistrationSchema},
 	},
 	"additionalProperties": false,
 }
@@ -334,17 +320,25 @@ var defaultBuiltinEvents = []CustomEvent{
 
 func NewCDPTypes(customCommands []CustomCommand, customEvents []CustomEvent, customMiddlewares []CustomMiddleware) *CDPTypes {
 	types := &CDPTypes{
-		CustomCommands:    map[string]CustomCommand{},
-		CustomEvents:      map[string]CustomEvent{},
-		CustomMiddlewares: []CustomMiddleware{},
-		commandSchemas:    map[string]CDPCommandSchema{},
-		nativeCommands:    map[string]bool{},
-		eventSchemas:      map[string]map[string]any{},
+		CustomCommands:       map[string]CustomCommand{},
+		CustomEvents:         map[string]CustomEvent{},
+		CustomMiddlewares:    []CustomMiddleware{},
+		commandSchemas:       map[string]CDPCommandSchema{},
+		commandParamsSchemas: map[string]map[string]any{},
+		commandResultSchemas: map[string]map[string]any{},
+		nativeCommands:       map[string]bool{},
+		eventSchemas:         map[string]map[string]any{},
 	}
 	types.hydrateNativeProtocolSchemas()
 	types.mu.Lock()
-	for method := range types.commandSchemas {
+	for method, schema := range types.commandSchemas {
 		types.nativeCommands[method] = true
+		if schema.Params != nil {
+			types.commandParamsSchemas[method] = schema.Params
+		}
+		if schema.Result != nil {
+			types.commandResultSchemas[method] = schema.Result
+		}
 	}
 	types.mu.Unlock()
 	for _, command := range defaultBuiltinCommands {
@@ -412,8 +406,8 @@ func (types *CDPTypes) ToJSON() map[string]any {
 		"custom_commands":        len(types.CustomCommands),
 		"custom_events":          len(types.CustomEvents),
 		"custom_middlewares":     len(types.CustomMiddlewares),
-		"command_params_schemas": len(types.commandSchemas),
-		"command_result_schemas": len(types.commandSchemas),
+		"command_params_schemas": len(types.commandParamsSchemas),
+		"command_result_schemas": len(types.commandResultSchemas),
 		"event_schemas":          len(types.eventSchemas),
 	}
 	types.mu.RUnlock()
@@ -497,31 +491,32 @@ func (types *CDPTypes) NativeCommandSchema(method string) map[string]any {
 	if !types.nativeCommands[method] {
 		return nil
 	}
-	schema, ok := types.commandSchemas[method]
-	if !ok {
+	params := types.commandParamsSchemas[method]
+	result := types.commandResultSchemas[method]
+	if params == nil && result == nil {
 		return nil
 	}
-	return map[string]any{"params": schema.Params, "result": schema.Result}
+	return map[string]any{"params": params, "result": result}
 }
 
 func (types *CDPTypes) CommandParamsSchema(method string) (map[string]any, bool) {
 	types.mu.RLock()
 	defer types.mu.RUnlock()
-	schema, ok := types.commandSchemas[method]
-	if !ok || schema.Params == nil {
+	schema, ok := types.commandParamsSchemas[method]
+	if !ok || schema == nil {
 		return nil, false
 	}
-	return schema.Params, true
+	return schema, true
 }
 
 func (types *CDPTypes) CommandResultSchema(method string) (map[string]any, bool) {
 	types.mu.RLock()
 	defer types.mu.RUnlock()
-	schema, ok := types.commandSchemas[method]
-	if !ok || schema.Result == nil {
+	schema, ok := types.commandResultSchemas[method]
+	if !ok || schema == nil {
 		return nil, false
 	}
-	return schema.Result, true
+	return schema, true
 }
 
 func (types *CDPTypes) EventPayloadSchema(event string) (map[string]any, bool) {
@@ -570,18 +565,16 @@ func (types *CDPTypes) AddCustomCommand(command CustomCommand) (string, bool, er
 	}
 	types.mu.Lock()
 	defer types.mu.Unlock()
-	existing := types.commandSchemas[name]
 	if command.ParamsSchema != nil {
 		if schema := cloneSchema(command.ParamsSchema); schema != nil {
-			existing.Params = schema
+			types.commandParamsSchemas[name] = schema
 		}
 	}
 	if command.ResultSchema != nil {
 		if schema := cloneSchema(command.ResultSchema); schema != nil {
-			existing.Result = schema
+			types.commandResultSchemas[name] = schema
 		}
 	}
-	types.commandSchemas[name] = existing
 	command.Name = name
 	if command.ParamsSchema != nil {
 		command.ParamsSchema = cloneSchema(command.ParamsSchema)

go/modcdp/client/CDPTypes_payload_schema_normalization_test.go

@@ -64,10 +64,7 @@ func TestCDPTypesSerializesBuiltinModCommandSchemasThroughTheSameWirePath(t *tes
 
 	parsedConfig, err := types.ParseCommandParams("Mod.configure", map[string]any{
 		"client_config": map[string]any{"client_hydrate_aliases": false},
-		"downstream": map[string]any{
-			"downstream_client_timeout_ms":           1234,
-			"downstream_close_browser_on_disconnect": true,
-		},
+		"upstream":      map[string]any{"upstream_mode": "ws", "upstream_ws_cdp_url": "ws://127.0.0.1:9222/devtools/browser/test"},
 	})
 	if err != nil {
 		t.Fatal(err)
@@ -76,19 +73,19 @@ func TestCDPTypesSerializesBuiltinModCommandSchemasThroughTheSameWirePath(t *tes
 	if !ok || clientConfig["client_hydrate_aliases"] != false {
 		t.Fatalf("client_config = %#v", parsedConfig["client_config"])
 	}
-	downstream, ok := parsedConfig["downstream"].(map[string]any)
+	upstream, ok := parsedConfig["upstream"].(map[string]any)
 	if !ok {
-		t.Fatalf("downstream = %#v", parsedConfig["downstream"])
+		t.Fatalf("upstream = %#v", parsedConfig["upstream"])
 	}
-	if downstream["downstream_client_timeout_ms"] != 1234 || downstream["downstream_close_browser_on_disconnect"] != true {
-		t.Fatalf("downstream = %#v", downstream)
+	if upstream["upstream_mode"] != "ws" || upstream["upstream_ws_cdp_url"] != "ws://127.0.0.1:9222/devtools/browser/test" {
+		t.Fatalf("upstream = %#v", upstream)
 	}
 	_, err = types.ParseCommandParams("Mod.configure", map[string]any{
-		"downstream": map[string]any{
-			"closeBrowser": "not allowed over the wire",
+		"upstream": map[string]any{
+			"upstream_mode": "nats",
 		},
 	})
-	if err == nil || !strings.Contains(err.Error(), "closeBrowser") {
-		t.Fatalf("expected closeBrowser to be rejected, got %v", err)
+	if err == nil || !strings.Contains(err.Error(), "enum") {
+		t.Fatalf("expected unsupported upstream mode to be rejected, got %v", err)
 	}
 }