Skip to content

Add generated alias client codegen #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pirate wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add generated alias client codegen #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
466b19a
Add generated alias client codegen
pirate Jun 6, 2026
4e2e7f7
Keep generated alias clients lint-clean
pirate Jun 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,7 @@ dist/
client/go/modcdp
client/go/modcdp-go
__pycache__/
testdata/codegen/stagehand_alias_manifest.json
js/test/stagehand_client_generated/stagehand_client_gen.ts
python/tests/stagehand_client_generated/stagehand_client_gen.py
testdata/codegen/stagehand_client_generated_go/stagehand_client_gen.go
198 changes: 193 additions & 5 deletions go/modcdp/client/CDPTypes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ type CDPTypes struct {
CustomCommands map[string]CustomCommand
CustomEvents map[string]CustomEvent
CustomMiddlewares []CustomMiddleware
CustomAliasObjects map[string]CustomAliasObject
commandSchemas map[string]CDPCommandSchema
commandParamsSchemas map[string]map[string]any
commandResultSchemas map[string]map[string]any
Expand Down Expand Up @@ -105,6 +106,47 @@ var modMiddlewareRegistrationSchema = map[string]any{
"additionalProperties": false,
}

var modAliasReturnSchema = map[string]any{
"type": "object",
"properties": map[string]any{
"object": map[string]any{"type": "string"},
"unwrap": map[string]any{"type": "string"},
"array": map[string]any{"type": "boolean"},
"nullable": map[string]any{"type": "boolean"},
},
"additionalProperties": false,
}

var modAliasMethodRegistrationSchema = map[string]any{
"type": "object",
"properties": map[string]any{
"name": map[string]any{"type": "string"},
"command": map[string]any{"type": "string"},
"params_schema": map[string]any{"type": []any{"object", "null"}},
"result_schema": map[string]any{"type": []any{"object", "null"}},
"sticky_param": map[string]any{"type": "string"},
"sticky_params": map[string]any{"type": "array", "items": map[string]any{"type": "string"}},
"sticky_fields": map[string]any{"type": "array", "items": map[string]any{"type": "string"}},
"return": modAliasReturnSchema,
},
"required": []any{"name", "command"},
"additionalProperties": false,
}

var modAliasObjectRegistrationSchema = map[string]any{
"type": "object",
"properties": map[string]any{
"name": map[string]any{"type": "string"},
"type_name": map[string]any{"type": "string"},
"root": map[string]any{"type": "boolean"},
"sticky_schema": map[string]any{"type": []any{"object", "null"}},
"sticky_fields": map[string]any{"type": "array", "items": map[string]any{"type": "string"}},
"methods": map[string]any{"type": "array", "items": modAliasMethodRegistrationSchema},
},
"required": []any{"name"},
"additionalProperties": false,
}

var modConfigureParamsSchema = map[string]any{
"type": "object",
"properties": map[string]any{
Expand Down Expand Up @@ -149,6 +191,7 @@ var modConfigureParamsSchema = map[string]any{
"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_alias_objects": map[string]any{"type": "array", "items": modAliasObjectRegistrationSchema},
},
"additionalProperties": false,
}
Expand Down Expand Up @@ -327,11 +370,12 @@ var defaultBuiltinEvents = []CustomEvent{
},
}

func NewCDPTypes(customCommands []CustomCommand, customEvents []CustomEvent, customMiddlewares []CustomMiddleware) *CDPTypes {
func NewCDPTypes(customCommands []CustomCommand, customEvents []CustomEvent, customMiddlewares []CustomMiddleware, customAliasObjectGroups ...[]CustomAliasObject) *CDPTypes {
types := &CDPTypes{
CustomCommands: map[string]CustomCommand{},
CustomEvents: map[string]CustomEvent{},
CustomMiddlewares: []CustomMiddleware{},
CustomAliasObjects: map[string]CustomAliasObject{},
commandSchemas: map[string]CDPCommandSchema{},
commandParamsSchemas: map[string]map[string]any{},
commandResultSchemas: map[string]map[string]any{},
Expand Down Expand Up @@ -375,6 +419,13 @@ func NewCDPTypes(customCommands []CustomCommand, customEvents []CustomEvent, cus
panic(err)
}
}
for _, customAliasObjects := range customAliasObjectGroups {
for _, object := range customAliasObjects {
if _, err := types.AddCustomAliasObject(object); err != nil {
panic(err)
}
}
}
return types
}

Expand All @@ -389,11 +440,16 @@ func (types *CDPTypes) Update(config CDPTypesConfig) *CDPTypes {
customEvents = append(customEvents, event)
}
customMiddlewares := append([]CustomMiddleware{}, types.CustomMiddlewares...)
customAliasObjects := make([]CustomAliasObject, 0, len(types.CustomAliasObjects)+len(config.CustomAliasObjects))
for _, object := range types.CustomAliasObjects {
customAliasObjects = append(customAliasObjects, object)
}
types.mu.RUnlock()
customCommands = append(customCommands, config.CustomCommands...)
customEvents = append(customEvents, config.CustomEvents...)
customMiddlewares = append(customMiddlewares, config.CustomMiddlewares...)
return NewCDPTypes(customCommands, customEvents, customMiddlewares)
customAliasObjects = append(customAliasObjects, config.CustomAliasObjects...)
return NewCDPTypes(customCommands, customEvents, customMiddlewares, customAliasObjects)
}

func (types *CDPTypes) ToJSON() map[string]any {
Expand All @@ -410,21 +466,24 @@ func (types *CDPTypes) ToJSON() map[string]any {
}
customMiddlewares = append(customMiddlewares, registration)
}
customAliasObjects := types.CustomAliasObjectWireRegistrations()
types.mu.RLock()
state := map[string]any{
"custom_commands": len(types.CustomCommands),
"custom_events": len(types.CustomEvents),
"custom_middlewares": len(types.CustomMiddlewares),
"custom_alias_objects": len(types.CustomAliasObjects),
"command_params_schemas": len(types.commandParamsSchemas),
"command_result_schemas": len(types.commandResultSchemas),
"event_schemas": len(types.eventSchemas),
}
types.mu.RUnlock()
return modtypes.ModCDPToJSON(types, modtypes.ModCDPJSONConfig{
Config: map[string]any{
"custom_commands": customCommands,
"custom_events": types.CustomEventWireRegistrations(),
"custom_middlewares": customMiddlewares,
"custom_commands": customCommands,
"custom_events": types.CustomEventWireRegistrations(),
"custom_middlewares": customMiddlewares,
"custom_alias_objects": customAliasObjects,
},
State: state,
})
Expand Down Expand Up @@ -695,15 +754,21 @@ func (types *CDPTypes) AddCustomMiddleware(middleware CustomMiddleware) (string,
return "", fmt.Errorf("phase must be request, response, or event")
}
middleware.Name = name
types.mu.Lock()
defer types.mu.Unlock()
types.CustomMiddlewares = append(types.CustomMiddlewares, middleware)
return name, nil
}

func (types *CDPTypes) CustomMiddlewareWireRegistrations() []CustomMiddleware {
types.mu.RLock()
defer types.mu.RUnlock()
return append([]CustomMiddleware{}, types.CustomMiddlewares...)
}

func (types *CDPTypes) CustomMiddlewareRegistrations(phase string, name string) []CustomMiddleware {
types.mu.RLock()
defer types.mu.RUnlock()
middlewares := []CustomMiddleware{}
for _, middleware := range types.CustomMiddlewares {
middlewareName := middleware.Name
Expand All @@ -717,6 +782,129 @@ func (types *CDPTypes) CustomMiddlewareRegistrations(phase string, name string)
return middlewares
}

func (types *CDPTypes) AddCustomAliasObject(object CustomAliasObject) (string, error) {
name := strings.TrimSpace(object.Name)
if name == "" {
return "", fmt.Errorf("custom alias object name is required")
}
normalized := CustomAliasObject{
Name: name,
TypeName: strings.TrimSpace(object.TypeName),
StickyFields: append([]string{}, object.StickyFields...),
Methods: make([]AliasMethod, 0, len(object.Methods)),
}
if object.StickySchema != nil {
normalized.StickySchema = cloneSchema(object.StickySchema)
}
for _, method := range object.Methods {
methodName := strings.TrimSpace(method.Name)
if methodName == "" {
return "", fmt.Errorf("%s alias method name is required", name)
}
commandName := ""
if strings.TrimSpace(method.Command) != "" {
normalizedCommandName, err := normalizeModCDPName(method.Command)
if err != nil {
return "", fmt.Errorf("%s.%s command: %w", name, methodName, err)
}
commandName = normalizedCommandName
}
normalizedMethod := AliasMethod{
Name: methodName,
Command: commandName,
SDKMethodName: strings.TrimSpace(method.SDKMethodName),
StickyParam: strings.TrimSpace(method.StickyParam),
StickyParams: append([]string{}, method.StickyParams...),
StickyFields: append([]string{}, method.StickyFields...),
}
if method.ParamsSchema != nil {
normalizedMethod.ParamsSchema = cloneSchema(method.ParamsSchema)
}
if method.ResultSchema != nil {
normalizedMethod.ResultSchema = cloneSchema(method.ResultSchema)
}
if method.Return != nil {
normalizedMethod.Return = &AliasReturn{
Object: strings.TrimSpace(method.Return.Object),
Unwrap: strings.TrimSpace(method.Return.Unwrap),
Array: method.Return.Array,
Nullable: method.Return.Nullable,
}
}
normalized.Methods = append(normalized.Methods, normalizedMethod)
}
types.mu.Lock()
defer types.mu.Unlock()
for _, method := range normalized.Methods {
if method.Command == "" {
continue
}
if method.ParamsSchema != nil {
if schema := cloneSchema(method.ParamsSchema); schema != nil {
types.commandParamsSchemas[method.Command] = schema
}
}
if method.ResultSchema != nil {
if _, exists := types.commandResultSchemas[method.Command]; exists {
continue
}
if schema := cloneSchema(method.ResultSchema); schema != nil {
types.commandResultSchemas[method.Command] = schema
}
}
}
types.CustomAliasObjects[name] = normalized
return name, nil
}

func (types *CDPTypes) CustomAliasObjectWireRegistrations() []CustomAliasObject {
types.mu.RLock()
objects := make([]CustomAliasObject, 0, len(types.CustomAliasObjects))
for _, object := range types.CustomAliasObjects {
objects = append(objects, object)
}
types.mu.RUnlock()
registrations := make([]CustomAliasObject, 0, len(objects))
for _, object := range objects {
registration := CustomAliasObject{
Name: object.Name,
TypeName: object.TypeName,
StickyFields: append([]string{}, object.StickyFields...),
Methods: make([]AliasMethod, 0, len(object.Methods)),
}
if object.StickySchema != nil {
registration.StickySchema = cloneSchema(object.StickySchema)
}
for _, method := range object.Methods {
methodRegistration := AliasMethod{
Name: method.Name,
Command: method.Command,
SDKMethodName: method.SDKMethodName,
StickyParam: method.StickyParam,
StickyParams: append([]string{}, method.StickyParams...),
StickyFields: append([]string{}, method.StickyFields...),
}
if method.ParamsSchema != nil {
methodRegistration.ParamsSchema = cloneSchema(method.ParamsSchema)
}
if method.ResultSchema != nil {
methodRegistration.ResultSchema = cloneSchema(method.ResultSchema)
}
if method.Return != nil {
methodRegistration.Return = &AliasReturn{
Object: method.Return.Object,
Unwrap: method.Return.Unwrap,
Array: method.Return.Array,
Nullable: method.Return.Nullable,
}
}
registration.Methods = append(registration.Methods, methodRegistration)
}
registrations = append(registrations, registration)
}
return registrations
}

func (types *CDPTypes) ServiceWorkerCommandStep(method string, params map[string]any, cdpSessionID string, executionContextID int) (modtypes.TranslatedStep, error) {
if params == nil {
params = map[string]any{}
Expand Down
13 changes: 9 additions & 4 deletions go/modcdp/client/ModCDPClient.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,9 @@ type AutoSessionRouter = router.AutoSessionRouter
type CustomCommand = types.ModCDPAddCustomCommandParams
type CustomEvent = types.ModCDPAddCustomEventObjectParams
type CustomMiddleware = types.ModCDPAddMiddlewareParams
type CustomAliasObject = types.ModCDPAliasObject
type AliasMethod = types.ModCDPAliasMethod
type AliasReturn = types.ModCDPAliasReturn

var NewLocalBrowserLauncher = launcher.NewLocalBrowserLauncher
var NewRemoteBrowserLauncher = launcher.NewRemoteBrowserLauncher
Expand Down Expand Up @@ -163,9 +166,10 @@ func freePort() (int, error) {
}

type CDPTypesConfig struct {
CustomCommands []CustomCommand `json:"custom_commands,omitempty"`
CustomEvents []CustomEvent `json:"custom_events,omitempty"`
CustomMiddlewares []CustomMiddleware `json:"custom_middlewares,omitempty"`
CustomCommands []CustomCommand `json:"custom_commands,omitempty"`
CustomEvents []CustomEvent `json:"custom_events,omitempty"`
CustomMiddlewares []CustomMiddleware `json:"custom_middlewares,omitempty"`
CustomAliasObjects []CustomAliasObject `json:"custom_alias_objects,omitempty"`
}

type ServerConfig struct {
Expand All @@ -177,6 +181,7 @@ type ServerConfig struct {
CustomCommands []CustomCommand `json:"custom_commands,omitempty"`
CustomEvents []CustomEvent `json:"custom_events,omitempty"`
CustomMiddlewares []CustomMiddleware `json:"custom_middlewares,omitempty"`
CustomAliasObjects []CustomAliasObject `json:"custom_alias_objects,omitempty"`
disabled bool
}

Expand Down Expand Up @@ -406,7 +411,7 @@ func New(config Config) *ModCDPClient {
upstream := NewWSUpstreamTransport(config.Upstream)
client := &ModCDPClient{
Config: config,
Types: NewCDPTypes(typesConfig.CustomCommands, typesConfig.CustomEvents, typesConfig.CustomMiddlewares),
Types: NewCDPTypes(typesConfig.CustomCommands, typesConfig.CustomEvents, typesConfig.CustomMiddlewares, typesConfig.CustomAliasObjects),
Upstream: upstream,
handlers: map[string][]handlerEntry{},
}
Expand Down
Loading
Loading