Count types referenced from resources and warn about excessive ones #68
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,66 @@ | ||||||||
| // Copyright 2016-2024, Pulumi Corporation. | ||||||||
|
|
||||||||
| package cmd | ||||||||
|
|
||||||||
| import ( | ||||||||
| "strings" | ||||||||
|
|
||||||||
| "github.com/pulumi/pulumi/pkg/v3/codegen/schema" | ||||||||
| "github.com/pulumi/schema-tools/internal/util/diagtree" | ||||||||
| ) | ||||||||
|
|
||||||||
| // Navigate through each resource in the schema and find how many types are referenced from that resource, | ||||||||
| // recursively. If the count increased for a resource and is above 200, emit a warning. | ||||||||
| func concerningTypeStructure(provider string, oldSchema *schema.PackageSpec, | ||||||||
| newSchema *schema.PackageSpec, violations *diagtree.Node) { | ||||||||
| oldTypeCounts := typeCountPerResource(oldSchema) | ||||||||
| newTypeCounts := typeCountPerResource(newSchema) | ||||||||
| section := violations.Label("Max Type Count per Resource") | ||||||||
| for resName, newCount := range newTypeCounts { | ||||||||
| oldCount, _ := oldTypeCounts[resName] | ||||||||
| if newCount > oldCount && newCount > 200 { | ||||||||
| msg := section.Value(formatName(provider, resName)) | ||||||||
| msg.SetDescription(diagtree.Warn, "number of types increased from %d to %d", oldCount, newCount) | ||||||||
| } | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| func typeCountPerResource(schema *schema.PackageSpec) map[string]int { | ||||||||
| res := make(map[string]int) | ||||||||
| for name, r := range schema.Resources { | ||||||||
| visitedTypes := make(map[string]bool) | ||||||||
| countTypes(schema, r.InputProperties, visitedTypes) | ||||||||
| countTypes(schema, r.Properties, visitedTypes) | ||||||||
| res[name] = len(visitedTypes) | ||||||||
| } | ||||||||
| return res | ||||||||
| } | ||||||||
|
|
||||||||
| func countTypes(schema *schema.PackageSpec, props map[string]schema.PropertySpec, visitedTypes map[string]bool) { | ||||||||
| for _, prop := range props { | ||||||||
| countType(schema, &prop.TypeSpec, visitedTypes) | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| func countType(schema *schema.PackageSpec, ts *schema.TypeSpec, visitedTypes map[string]bool) { | ||||||||
| if ts.AdditionalProperties != nil { | ||||||||
| countType(schema, ts.AdditionalProperties, visitedTypes) | ||||||||
| } | ||||||||
| if ts.Items != nil { | ||||||||
| countType(schema, ts.Items, visitedTypes) | ||||||||
| } | ||||||||
| if len(ts.OneOf) > 0 { | ||||||||
| for _, t := range ts.OneOf { | ||||||||
| countType(schema, &t, visitedTypes) | ||||||||
| } | ||||||||
| } | ||||||||
| if strings.HasPrefix(ts.Ref, "#/types/") { | ||||||||
| typeName := strings.TrimPrefix(ts.Ref, "#/types/") | ||||||||
|
Comment on lines
+57
to
+58
There was a problem hiding this comment. The standard library has a function for exactly this purpose.
Suggested change
|
||||||||
| if _, ok := visitedTypes[typeName]; ok { | ||||||||
| return | ||||||||
| } | ||||||||
| visitedTypes[typeName] = true | ||||||||
| typ := schema.Types[typeName] | ||||||||
| countTypes(schema, typ.Properties, visitedTypes) | ||||||||
| } | ||||||||
| } | ||||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a pointless check, since it is safe to range over
[]T{}and[]T(nil).