Skip to content

✨ Support additionalProperties schema for structured map fields #886

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

✨ Support additionalProperties schema for structured map fields #886

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
88 changes: 48 additions & 40 deletions cyclops-ctrl/internal/mapper/helm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,50 +57,58 @@ func HelmSchemaToFields(name string, schema helm.Property, defs map[string]helm.
}

fields = append(fields, models.Field{
Name: dependency.Name,
Description: dependency.RootField.Description,
Type: dependency.RootField.Type,
DisplayName: mapTitle(dependency.Name, dependency.RootField.DisplayName),
ManifestKey: dependency.RootField.ManifestKey,
Value: dependency.RootField.Value,
Properties: dependency.RootField.Properties,
Items: dependency.RootField.Items,
Enum: dependency.RootField.Enum,
Suggestions: dependency.RootField.Suggestions,
Required: dependency.RootField.Required,
FileExtension: dependency.RootField.FileExtension,
Minimum: dependency.RootField.Minimum,
Maximum: dependency.RootField.Maximum,
MultipleOf: dependency.RootField.MultipleOf,
ExclusiveMinimum: dependency.RootField.ExclusiveMinimum,
ExclusiveMaximum: dependency.RootField.ExclusiveMaximum,
MinLength: dependency.RootField.MinLength,
MaxLength: dependency.RootField.MaxLength,
Pattern: dependency.RootField.Pattern,
Immutable: dependency.RootField.Immutable,
Name: dependency.Name,
Description: dependency.RootField.Description,
Type: dependency.RootField.Type,
DisplayName: mapTitle(dependency.Name, dependency.RootField.DisplayName),
ManifestKey: dependency.RootField.ManifestKey,
Value: dependency.RootField.Value,
Properties: dependency.RootField.Properties,
AdditionalProperties: dependency.RootField.AdditionalProperties,
Items: dependency.RootField.Items,
Enum: dependency.RootField.Enum,
Suggestions: dependency.RootField.Suggestions,
Required: dependency.RootField.Required,
FileExtension: dependency.RootField.FileExtension,
Minimum: dependency.RootField.Minimum,
Maximum: dependency.RootField.Maximum,
MultipleOf: dependency.RootField.MultipleOf,
ExclusiveMinimum: dependency.RootField.ExclusiveMinimum,
ExclusiveMaximum: dependency.RootField.ExclusiveMaximum,
MinLength: dependency.RootField.MinLength,
MaxLength: dependency.RootField.MaxLength,
Pattern: dependency.RootField.Pattern,
Immutable: dependency.RootField.Immutable,
})
}

var additionalProps *models.Field
if ap := schema.GetAdditionalProperties(); ap != nil {
apField := HelmSchemaToFields("", *ap, defs, nil)
additionalProps = &apField
}

return models.Field{
Name: name,
Description: schema.Description,
Type: mapHelmPropertyTypeToFieldType(schema),
DisplayName: mapTitle(name, schema.Title),
ManifestKey: name,
Properties: fields,
Enum: schema.Enum,
Suggestions: schema.Suggestions,
Required: schema.Required,
FileExtension: schema.FileExtension,
Minimum: schema.Minimum,
Maximum: schema.Maximum,
ExclusiveMinimum: schema.ExclusiveMinimum,
ExclusiveMaximum: schema.ExclusiveMaximum,
MultipleOf: schema.MultipleOf,
MinLength: schema.MinLength,
MaxLength: schema.MaxLength,
Pattern: schema.Pattern,
Immutable: schema.Immutable,
Name: name,
Description: schema.Description,
Type: mapHelmPropertyTypeToFieldType(schema),
DisplayName: mapTitle(name, schema.Title),
ManifestKey: name,
Properties: fields,
AdditionalProperties: additionalProps,
Enum: schema.Enum,
Suggestions: schema.Suggestions,
Required: schema.Required,
FileExtension: schema.FileExtension,
Minimum: schema.Minimum,
Maximum: schema.Maximum,
ExclusiveMinimum: schema.ExclusiveMinimum,
ExclusiveMaximum: schema.ExclusiveMaximum,
MultipleOf: schema.MultipleOf,
MinLength: schema.MinLength,
MaxLength: schema.MaxLength,
Pattern: schema.Pattern,
Immutable: schema.Immutable,
}
}

Expand Down
63 changes: 50 additions & 13 deletions cyclops-ctrl/internal/models/helm/helmschema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,40 @@ import (
json "github.com/json-iterator/go"
)

// RawJSON captures any JSON value (object, boolean, string, etc.) without
// failing on type mismatches.
type RawJSON []byte

func (r *RawJSON) UnmarshalJSON(data []byte) error {
if data == nil {
return nil
}
*r = append((*r)[0:0], data...)
return nil
}

func (r RawJSON) MarshalJSON() ([]byte, error) {
if r == nil {
return []byte("null"), nil
}
return r, nil
}

type Property struct {
Title string `json:"title"`
Type PropertyType `json:"type"`
Description string `json:"description"`
Order []string `json:"order"`
Properties map[string]Property `json:"properties"`
Items *Property `json:"items"`
Enum []interface{} `json:"enum"`
Suggestions []interface{} `json:"x-suggestions"`
Required []string `json:"required"`
FileExtension string `json:"fileExtension"`
Reference string `json:"$ref"`
Definitions map[string]Property `json:"$defs"`
Immutable bool `json:"immutable"`
Title string `json:"title"`
Type PropertyType `json:"type"`
Description string `json:"description"`
Order []string `json:"order"`
Properties map[string]Property `json:"properties"`
AdditionalProperties RawJSON `json:"additionalProperties,omitempty"`
Items *Property `json:"items"`
Enum []interface{} `json:"enum"`
Suggestions []interface{} `json:"x-suggestions"`
Required []string `json:"required"`
FileExtension string `json:"fileExtension"`
Reference string `json:"$ref"`
Definitions map[string]Property `json:"$defs"`
Immutable bool `json:"immutable"`

// number validation
Minimum *float64 `json:"minimum"`
Expand All @@ -37,6 +57,23 @@ type Property struct {
AnyOf []Property `json:"anyOf"`
}

// GetAdditionalProperties attempts to parse additionalProperties as a schema
// object. Returns nil when the value is absent, a boolean, or otherwise not a
// valid Property (e.g. additionalProperties: false).
func (p Property) GetAdditionalProperties() *Property {
if len(p.AdditionalProperties) == 0 {
return nil
}
var prop Property
if err := json.Unmarshal(p.AdditionalProperties, &prop); err != nil {
return nil
}
if len(prop.Type) == 0 && len(prop.Properties) == 0 {
return nil
}
return &prop
}

type PropertyType string

func (t *PropertyType) UnmarshalJSON(data []byte) error {
Expand Down
27 changes: 14 additions & 13 deletions cyclops-ctrl/internal/models/templates.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,20 @@ type Template struct {
}

type Field struct {
Name string `json:"name"`
Description string `json:"description"`
Type string `json:"type"`
DisplayName string `json:"display_name"`
ManifestKey string `json:"manifest_key"`
Value string `json:"value"`
Properties []Field `json:"properties"`
Items *Field `json:"items"`
Enum []interface{} `json:"enum"`
Suggestions []interface{} `json:"x-suggestions"`
Required []string `json:"required"`
FileExtension string `json:"fileExtension"`
Immutable bool `json:"immutable"`
Name string `json:"name"`
Description string `json:"description"`
Type string `json:"type"`
DisplayName string `json:"display_name"`
ManifestKey string `json:"manifest_key"`
Value string `json:"value"`
Properties []Field `json:"properties"`
AdditionalProperties *Field `json:"additionalProperties,omitempty"`
Items *Field `json:"items"`
Enum []interface{} `json:"enum"`
Suggestions []interface{} `json:"x-suggestions"`
Required []string `json:"required"`
FileExtension string `json:"fileExtension"`
Immutable bool `json:"immutable"`

// number validation
Minimum *float64 `json:"minimum"`
Expand Down
3 changes: 3 additions & 0 deletions cyclops-ui/src/components/form/TemplateFormFields.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,9 @@ export function mapFields(
level={level}
formItemName={formItemName}
isRequired={isRequired}
initialValues={initialValues}
uniqueFieldName={uniqueFieldName}
isModuleEdit={isModuleEdit}
/>,
);
}
Expand Down
Loading