diff --git a/codegen/internal/generator/model.go b/codegen/internal/generator/model.go index 2f5d192c..759a9f0b 100644 --- a/codegen/internal/generator/model.go +++ b/codegen/internal/generator/model.go @@ -28,6 +28,14 @@ type clientModel struct { FieldName string Package string Methods []operationModel + Nested bool + Children []childClient + AccessPath string +} + +type childClient struct { + ClassName string + AccessorName string } // operationModel stores the derived metadata for one OpenAPI operation. @@ -147,6 +155,10 @@ func buildModel(doc *v3.Document, params Params) (sdkModel, error) { } } groups := map[string][]operationModel{} + parents, err := readResourceParents(doc) + if err != nil { + return sdkModel{}, err + } if doc.Paths != nil && doc.Paths.PathItems != nil && doc.Paths.PathItems.Len() > 0 { for path, item := range doc.Paths.PathItems.FromOldest() { if item == nil { @@ -163,6 +175,12 @@ func buildModel(doc *v3.Document, params Params) (sdkModel, error) { opModel := convertOperation(method, path, item, operation, resolver) tag := opModel.TagName groups[tag] = append(groups[tag], opModel) + for parent := parents[tag].tag; parent != ""; parent = parents[parent].tag { + if _, exists := groups[parent]; exists { + break + } + groups[parent] = nil + } } } } @@ -198,7 +216,7 @@ func buildModel(doc *v3.Document, params Params) (sdkModel, error) { className += suffix } - clients = append(clients, clientModel{ + client := clientModel{ TagName: tag, TagDescriptionLines: tagDescriptions[tag], ClassName: className, @@ -206,7 +224,29 @@ func buildModel(doc *v3.Document, params Params) (sdkModel, error) { FieldName: fieldName, Package: params.clientPackage(), Methods: ops, - }) + } + if parent := parents[tag]; parent.tag != "" { + client.Nested = true + client.AccessorName = camelCase(parent.label, "client") + } + clients = append(clients, client) + } + byTag := make(map[string]*clientModel, len(clients)) + for i := range clients { + byTag[clients[i].TagName] = &clients[i] + } + for i := range clients { + client := &clients[i] + path := client.AccessorName + "()" + for ancestor := parents[client.TagName].tag; ancestor != ""; ancestor = parents[ancestor].tag { + path = byTag[ancestor].AccessorName + "()." + path + } + client.AccessPath = path + if parent := byTag[parents[client.TagName].tag]; parent != nil { + parent.Children = append(parent.Children, childClient{ + ClassName: client.ClassName, AccessorName: client.AccessorName, + }) + } } schemas := buildSchemas(doc, params, resolver) diff --git a/codegen/internal/generator/render.go b/codegen/internal/generator/render.go index a8c5f901..5fa3e86c 100644 --- a/codegen/internal/generator/render.go +++ b/codegen/internal/generator/render.go @@ -5,6 +5,7 @@ import ( "fmt" "os" "path/filepath" + "slices" "sort" "strconv" "strings" @@ -162,19 +163,26 @@ type operationTemplateData struct { // clientTemplateData contains the data required to render a single client // class. type clientTemplateData struct { - Package string - ClassName string - TagName string + Children []childClient + Package string + ClassName string + TagName string TagDescriptionLines []string - Imports []string - Operations []operationTemplateData - QueryStructs []*parameterGroupModel - HeaderStructs []*parameterGroupModel + Imports []string + Operations []operationTemplateData + QueryStructs []*parameterGroupModel + HeaderStructs []*parameterGroupModel } // prepareClientTemplateData converts an internal client model into a richer // structure that is easier for templates to consume. func prepareClientTemplateData(client clientModel, className string, async bool) clientTemplateData { + children := slices.Clone(client.Children) + if async { + for i := range children { + children[i].ClassName = asyncClientClassName(children[i].ClassName) + } + } importSet := map[string]struct{}{ "com.sumup.sdk.core.ApiClient": {}, "com.sumup.sdk.core.ApiException": {}, @@ -318,6 +326,7 @@ func prepareClientTemplateData(client clientModel, className string, async bool) sort.Strings(imports) return clientTemplateData{ + Children: children, Package: client.Package, ClassName: className, TagName: client.TagName, @@ -339,6 +348,9 @@ func prepareSumUpClientData(model sdkModel, className string, async bool) map[st } clientInfos := make([]map[string]string, 0, len(model.Clients)) for _, client := range model.Clients { + if client.Nested { + continue + } clientClass := client.ClassName if async { clientClass = asyncClientClassName(clientClass) diff --git a/codegen/internal/generator/samples.go b/codegen/internal/generator/samples.go index fb356982..004768a9 100644 --- a/codegen/internal/generator/samples.go +++ b/codegen/internal/generator/samples.go @@ -143,7 +143,7 @@ func (r javaSampleRenderer) render(client clientModel, operation operationModel, } className := pascalCase(operation.OperationID+" "+example.name, "Sample") - call := "client." + client.AccessorName + "()." + operation.MethodName + "(" + call := "client." + client.AccessPath + "." + operation.MethodName + "(" if len(args) > 0 { call += "\n" for i, arg := range args { diff --git a/codegen/internal/generator/tag_hierarchy.go b/codegen/internal/generator/tag_hierarchy.go new file mode 100644 index 00000000..bcc3751d --- /dev/null +++ b/codegen/internal/generator/tag_hierarchy.go @@ -0,0 +1,60 @@ +package generator + +import ( + "cmp" + "fmt" + + v3 "github.com/pb33f/libopenapi/datamodel/high/v3" +) + +type resourceParent struct { + tag string + label string +} + +func readResourceParents(doc *v3.Document) (map[string]resourceParent, error) { + if doc.Extensions == nil { + return nil, nil + } + node, ok := doc.Extensions.Get("x-tagGroups") + if !ok { + return nil, nil + } + var groups []struct { + Name string `yaml:"name"` + Tags []string `yaml:"tags"` + } + if err := node.Decode(&groups); err != nil { + return nil, fmt.Errorf("decode x-tagGroups: %w", err) + } + labels := make(map[string]string, len(doc.Tags)) + for _, tag := range doc.Tags { + var displayName string + if tag.Extensions != nil { + if label, ok := tag.Extensions.Get("x-displayName"); ok { + if err := label.Decode(&displayName); err != nil { + return nil, fmt.Errorf("decode x-displayName for %s: %w", tag.Name, err) + } + } + } + labels[tag.Name] = cmp.Or(displayName, tag.Name) + } + parents := map[string]resourceParent{} + for _, group := range groups { + if labels[group.Name] == "" { + continue + } + for _, child := range group.Tags { + if child == group.Name || labels[child] == "" || parents[child].tag != "" { + continue + } + for ancestor := group.Name; ancestor != ""; ancestor = parents[ancestor].tag { + if ancestor == child { + return nil, fmt.Errorf("tag hierarchy contains a cycle at %s", child) + } + } + parents[child] = resourceParent{tag: group.Name, label: labels[child]} + } + } + return parents, nil +} diff --git a/codegen/internal/generator/tag_hierarchy_test.go b/codegen/internal/generator/tag_hierarchy_test.go new file mode 100644 index 00000000..318c3384 --- /dev/null +++ b/codegen/internal/generator/tag_hierarchy_test.go @@ -0,0 +1,64 @@ +package generator + +import ( + "testing" + + "github.com/pb33f/libopenapi" +) + +func TestNestedReaderResources(t *testing.T) { + t.Parallel() + + doc, err := libopenapi.NewDocument([]byte(` +openapi: 3.1.0 +info: {title: Readers, version: 1.0.0} +tags: + - name: Readers + - name: ReaderCheckouts + x-displayName: Checkouts +x-tagGroups: + - name: Readers + tags: [ReaderCheckouts] +paths: + /readers/checkouts: + get: + operationId: ListReaders + tags: [Readers] + responses: + '204': {description: OK} + post: + operationId: CreateReaderCheckout + tags: [ReaderCheckouts] + x-codegen: {method_name: create} + responses: + '204': {description: OK} +components: {schemas: {}} +`)) + if err != nil { + t.Fatal(err) + } + model, err := doc.BuildV3Model() + if err != nil { + t.Fatal(err) + } + + sdk, err := buildModel(&model.Model, Params{BasePackage: "com.sumup.sdk"}) + if err != nil { + t.Fatal(err) + } + for _, client := range sdk.Clients { + switch client.TagName { + case "Readers": + if len(client.Children) != 1 || client.Children[0].AccessorName != "checkouts" || len(client.Methods) != 1 || client.Methods[0].MethodName != "listReaders" { + t.Fatalf("expected Checkouts and the parent operation: %+v", client) + } + case "ReaderCheckouts": + if client.AccessPath != "readers().checkouts()" || len(client.Methods) != 1 || client.Methods[0].MethodName != "create" { + t.Fatalf("expected only the checkout operation on the nested client: %+v", client) + } + } + } + if len(sdk.Clients) != 2 { + t.Fatalf("expected two clients, got %d", len(sdk.Clients)) + } +} diff --git a/codegen/internal/generator/templates/client.tmpl b/codegen/internal/generator/templates/client.tmpl index bfbe438b..d699c0b3 100644 --- a/codegen/internal/generator/templates/client.tmpl +++ b/codegen/internal/generator/templates/client.tmpl @@ -15,6 +15,9 @@ import {{ . }}; */ public final class {{ .ClassName }} { private final ApiClient apiClient; +{{- range .Children }} + private final {{ .ClassName }} {{ .AccessorName }}; +{{- end }} /** * Creates a new {{ .ClassName }} instance backed by the provided ApiClient. @@ -23,7 +26,17 @@ public final class {{ .ClassName }} { */ public {{ .ClassName }}(ApiClient apiClient) { this.apiClient = Objects.requireNonNull(apiClient, "apiClient"); +{{- range .Children }} + this.{{ .AccessorName }} = new {{ .ClassName }}(apiClient); +{{- end }} } +{{- range .Children }} + + /** @return the {{ .AccessorName }} client. */ + public {{ .ClassName }} {{ .AccessorName }}() { + return {{ .AccessorName }}; + } +{{- end }} {{- range .Operations }} {{- $reqDecl := join .RequiredParamDecls ", " -}} diff --git a/codegen/internal/generator/templates/client_async.tmpl b/codegen/internal/generator/templates/client_async.tmpl index 335d1b83..04610361 100644 --- a/codegen/internal/generator/templates/client_async.tmpl +++ b/codegen/internal/generator/templates/client_async.tmpl @@ -15,6 +15,9 @@ import {{ . }}; */ public final class {{ .ClassName }} { private final ApiClient apiClient; +{{- range .Children }} + private final {{ .ClassName }} {{ .AccessorName }}; +{{- end }} /** * Creates a new {{ .ClassName }} instance backed by the provided ApiClient. @@ -23,7 +26,17 @@ public final class {{ .ClassName }} { */ public {{ .ClassName }}(ApiClient apiClient) { this.apiClient = Objects.requireNonNull(apiClient, "apiClient"); +{{- range .Children }} + this.{{ .AccessorName }} = new {{ .ClassName }}(apiClient); +{{- end }} } +{{- range .Children }} + + /** @return the {{ .AccessorName }} client. */ + public {{ .ClassName }} {{ .AccessorName }}() { + return {{ .AccessorName }}; + } +{{- end }} {{- range .Operations }} {{- $reqDecl := join .RequiredParamDecls ", " -}}