Skip to content

feat: support reset_on_change parameter schema #801

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
zyqzyq wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: support reset_on_change parameter schema #801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 14 additions & 13 deletions pkg/entities/plugin_entities/agent_declaration.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,19 +58,20 @@ func init() {
}

type AgentStrategyParameter struct {
Name string `json:"name" yaml:"name" validate:"required,gt=0,lt=1024"`
Label I18nObject `json:"label" yaml:"label" validate:"required"`
Help I18nObject `json:"help" yaml:"help" validate:"omitempty"`
Type AgentStrategyParameterType `json:"type" yaml:"type" validate:"required,agent_strategy_parameter_type"`
AutoGenerate *ParameterAutoGenerate `json:"auto_generate" yaml:"auto_generate" validate:"omitempty"`
Template *ParameterTemplate `json:"template" yaml:"template" validate:"omitempty"`
Scope *string `json:"scope" yaml:"scope" validate:"omitempty,max=1024,is_scope"`
Required bool `json:"required" yaml:"required"`
Default any `json:"default" yaml:"default" validate:"omitempty,is_basic_type"`
Min *float64 `json:"min" yaml:"min" validate:"omitempty"`
Max *float64 `json:"max" yaml:"max" validate:"omitempty"`
Precision *int `json:"precision" yaml:"precision" validate:"omitempty"`
Options []ParameterOption `json:"options" yaml:"options" validate:"omitempty,dive"`
Name string `json:"name" yaml:"name" validate:"required,gt=0,lt=1024"`
Label I18nObject `json:"label" yaml:"label" validate:"required"`
Help I18nObject `json:"help" yaml:"help" validate:"omitempty"`
Type AgentStrategyParameterType `json:"type" yaml:"type" validate:"required,agent_strategy_parameter_type"`
AutoGenerate *ParameterAutoGenerate `json:"auto_generate" yaml:"auto_generate" validate:"omitempty"`
Template *ParameterTemplate `json:"template" yaml:"template" validate:"omitempty"`
Scope *string `json:"scope" yaml:"scope" validate:"omitempty,max=1024,is_scope"`
Required bool `json:"required" yaml:"required"`
Default any `json:"default" yaml:"default" validate:"omitempty,is_basic_type"`
Min *float64 `json:"min" yaml:"min" validate:"omitempty"`
Max *float64 `json:"max" yaml:"max" validate:"omitempty"`
Precision *int `json:"precision" yaml:"precision" validate:"omitempty"`
Options []ParameterOption `json:"options" yaml:"options" validate:"omitempty,dive"`
ResetOnChange []string `json:"reset_on_change,omitempty" yaml:"reset_on_change,omitempty" validate:"omitempty,lte=16,dive,gt=0,lt=1024"`
}

type AgentStrategyOutputSchema map[string]any
Expand Down
23 changes: 12 additions & 11 deletions pkg/entities/plugin_entities/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,17 +281,18 @@ func init() {
}

type ProviderConfig struct {
Name string `json:"name" validate:"omitempty,gt=0,lt=1024"`
Type ConfigType `json:"type" validate:"required,credential_type"`
Scope *string `json:"scope" validate:"omitempty,is_scope"`
Required bool `json:"required"`
Default any `json:"default" validate:"omitempty,is_basic_type"`
Options []ConfigOption `json:"options" validate:"omitempty,lt=128,dive"`
Multiple bool `json:"multiple" validate:"omitempty"`
Label I18nObject `json:"label" validate:"required"`
Help *I18nObject `json:"help" validate:"omitempty"`
URL *string `json:"url" validate:"omitempty"`
Placeholder *I18nObject `json:"placeholder" validate:"omitempty"`
Name string `json:"name" validate:"omitempty,gt=0,lt=1024"`
Type ConfigType `json:"type" validate:"required,credential_type"`
Scope *string `json:"scope" validate:"omitempty,is_scope"`
Required bool `json:"required"`
Default any `json:"default" validate:"omitempty,is_basic_type"`
Options []ConfigOption `json:"options" validate:"omitempty,lt=128,dive"`
Multiple bool `json:"multiple" validate:"omitempty"`
Label I18nObject `json:"label" validate:"required"`
Help *I18nObject `json:"help" validate:"omitempty"`
URL *string `json:"url" validate:"omitempty"`
Placeholder *I18nObject `json:"placeholder" validate:"omitempty"`
ResetOnChange []string `json:"reset_on_change,omitempty" yaml:"reset_on_change,omitempty" validate:"omitempty,lte=16,dive,gt=0,lt=1024"`
}

func init() {
Expand Down
27 changes: 14 additions & 13 deletions pkg/entities/plugin_entities/datasource_declaration.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,19 +67,20 @@ func init() {
}

type DatasourceParameter struct {
Name string `json:"name" yaml:"name" validate:"required,gt=0,lt=1024"`
Label I18nObject `json:"label" yaml:"label" validate:"required"`
Type DatasourceParameterType `json:"type" yaml:"type" validate:"required,datasource_parameter_type"`
Scope *string `json:"scope" yaml:"scope" validate:"omitempty,max=1024,is_scope"`
Required bool `json:"required" yaml:"required"`
AutoGenerate *ParameterAutoGenerate `json:"auto_generate" yaml:"auto_generate" validate:"omitempty"`
Template *ParameterTemplate `json:"template" yaml:"template" validate:"omitempty"`
Default any `json:"default" yaml:"default" validate:"omitempty,is_basic_type"`
Min *float64 `json:"min" yaml:"min" validate:"omitempty"`
Max *float64 `json:"max" yaml:"max" validate:"omitempty"`
Precision *int `json:"precision" yaml:"precision" validate:"omitempty"`
Options []ParameterOption `json:"options" yaml:"options" validate:"omitempty,dive"`
Description I18nObject `json:"description" yaml:"description" validate:"required"`
Name string `json:"name" yaml:"name" validate:"required,gt=0,lt=1024"`
Label I18nObject `json:"label" yaml:"label" validate:"required"`
Type DatasourceParameterType `json:"type" yaml:"type" validate:"required,datasource_parameter_type"`
Scope *string `json:"scope" yaml:"scope" validate:"omitempty,max=1024,is_scope"`
Required bool `json:"required" yaml:"required"`
AutoGenerate *ParameterAutoGenerate `json:"auto_generate" yaml:"auto_generate" validate:"omitempty"`
Template *ParameterTemplate `json:"template" yaml:"template" validate:"omitempty"`
Default any `json:"default" yaml:"default" validate:"omitempty,is_basic_type"`
Min *float64 `json:"min" yaml:"min" validate:"omitempty"`
Max *float64 `json:"max" yaml:"max" validate:"omitempty"`
Precision *int `json:"precision" yaml:"precision" validate:"omitempty"`
Options []ParameterOption `json:"options" yaml:"options" validate:"omitempty,dive"`
ResetOnChange []string `json:"reset_on_change,omitempty" yaml:"reset_on_change,omitempty" validate:"omitempty,lte=16,dive,gt=0,lt=1024"`
Description I18nObject `json:"description" yaml:"description" validate:"required"`
}

type DatasourceOutputSchema map[string]any
Expand Down
23 changes: 12 additions & 11 deletions pkg/entities/plugin_entities/model_declaration.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,17 +551,18 @@ func (m *ModelProviderFormOption) UnmarshalYAML(value *yaml.Node) error {
}

type ModelProviderCredentialFormSchema struct {
Variable string `json:"variable" yaml:"variable" validate:"required,lt=256"`
Label I18nObject `json:"label" yaml:"label" validate:"required"`
Type ModelProviderFormType `json:"type" yaml:"type" validate:"required,model_provider_form_type"`
Required bool `json:"required" yaml:"required"`
Default *string `json:"default" yaml:"default" validate:"omitempty,lt=256"`
Options []ModelProviderFormOption `json:"options" yaml:"options" validate:"omitempty,lte=128,dive"`
Help *I18nObject `json:"help" yaml:"help" validate:"omitempty"`
URL *string `json:"url" yaml:"url" validate:"omitempty"`
Placeholder *I18nObject `json:"placeholder" yaml:"placeholder" validate:"omitempty"`
MaxLength int `json:"max_length" yaml:"max_length"`
ShowOn []ModelProviderFormShowOnObject `json:"show_on" yaml:"show_on" validate:"omitempty,lte=16,dive"`
Variable string `json:"variable" yaml:"variable" validate:"required,lt=256"`
Label I18nObject `json:"label" yaml:"label" validate:"required"`
Type ModelProviderFormType `json:"type" yaml:"type" validate:"required,model_provider_form_type"`
Required bool `json:"required" yaml:"required"`
Default *string `json:"default" yaml:"default" validate:"omitempty,lt=256"`
Options []ModelProviderFormOption `json:"options" yaml:"options" validate:"omitempty,lte=128,dive"`
Help *I18nObject `json:"help" yaml:"help" validate:"omitempty"`
URL *string `json:"url" yaml:"url" validate:"omitempty"`
Placeholder *I18nObject `json:"placeholder" yaml:"placeholder" validate:"omitempty"`
MaxLength int `json:"max_length" yaml:"max_length"`
ShowOn []ModelProviderFormShowOnObject `json:"show_on" yaml:"show_on" validate:"omitempty,lte=16,dive"`
ResetOnChange []string `json:"reset_on_change,omitempty" yaml:"reset_on_change,omitempty" validate:"omitempty,lte=16,dive,gt=0,lt=1024"`
}

func (m *ModelProviderCredentialFormSchema) UnmarshalJSON(data []byte) error {
Expand Down
1 change: 1 addition & 0 deletions pkg/entities/plugin_entities/tool_declaration.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ type ToolParameter struct {
Multiple bool `json:"multiple" yaml:"multiple" validate:"omitempty"`
Precision *int `json:"precision" yaml:"precision" validate:"omitempty"`
Options []ParameterOption `json:"options" yaml:"options" validate:"omitempty,dive"`
ResetOnChange []string `json:"reset_on_change,omitempty" yaml:"reset_on_change,omitempty" validate:"omitempty,lte=16,dive,gt=0,lt=1024"`
}

type ToolDescription struct {
Expand Down
58 changes: 58 additions & 0 deletions pkg/entities/plugin_entities/tool_declaration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1117,6 +1117,64 @@ func TestParameterScope_Validate(t *testing.T) {
}
}

func TestToolParameterResetOnChange(t *testing.T) {
parameter := ToolParameter{
Name: "child",
Label: I18nObject{
EnUS: "Child",
},
HumanDescription: I18nObject{
EnUS: "Child parameter",
},
Type: TOOL_PARAMETER_TYPE_DYNAMIC_SELECT,
Form: TOOL_PARAMETER_FORM_FORM,
ResetOnChange: []string{"parent"},
}

jsonBytes := parser.MarshalJsonBytes(parameter)
jsonParameter, err := parser.UnmarshalJsonBytes[ToolParameter](jsonBytes)
if err != nil {
t.Fatalf("failed to unmarshal JSON parameter: %v", err)
}
if len(jsonParameter.ResetOnChange) != 1 || jsonParameter.ResetOnChange[0] != "parent" {
t.Fatalf("unexpected JSON reset_on_change: %v", jsonParameter.ResetOnChange)
}

yamlBytes := parser.MarshalYamlBytes(parameter)
yamlParameter, err := parser.UnmarshalYamlBytes[ToolParameter](yamlBytes)
if err != nil {
t.Fatalf("failed to unmarshal YAML parameter: %v", err)
}
if len(yamlParameter.ResetOnChange) != 1 || yamlParameter.ResetOnChange[0] != "parent" {
t.Fatalf("unexpected YAML reset_on_change: %v", yamlParameter.ResetOnChange)
}

parameter.ResetOnChange = nil
jsonMap, err := parser.UnmarshalJsonBytes2Map(parser.MarshalJsonBytes(parameter))
if err != nil {
t.Fatalf("failed to inspect JSON parameter: %v", err)
}
if _, ok := jsonMap["reset_on_change"]; ok {
t.Fatalf("reset_on_change should be omitted from JSON when unset: %v", jsonMap)
}

yamlMap, err := parser.UnmarshalYaml2Map(parser.MarshalYamlBytes(parameter))
if err != nil {
t.Fatalf("failed to inspect YAML parameter: %v", err)
}
if _, ok := yamlMap["reset_on_change"]; ok {
t.Fatalf("reset_on_change should be omitted from YAML when unset: %v", yamlMap)
}

parameter.ResetOnChange = make([]string, 17)
for i := range parameter.ResetOnChange {
parameter.ResetOnChange[i] = "parent"
}
if _, err := parser.UnmarshalJsonBytes[ToolParameter](parser.MarshalJsonBytes(parameter)); err == nil {
t.Fatal("expected more than 16 reset_on_change entries to fail validation")
}
}

func TestToolName_Validate(t *testing.T) {
data := parser.MarshalJsonBytes(ToolProviderIdentity{
Author: "author",
Expand Down
Loading