Generate root client that uses implementation of subrouter clients

Author: maddy-jo

clients/go/gengo.go

@@ -15,8 +15,8 @@ import (
 )
 
 // Generate generates a client
-func Generate(packageName, basePath, outputPath string, s spec.Swagger, isSubrouter bool) error {
-	if err := generateClient(packageName, basePath, outputPath, s, isSubrouter); err != nil {
+func Generate(packageName, basePath, outputPath string, s spec.Swagger) error {
+	if err := generateClient(packageName, basePath, outputPath, s); err != nil {
 		return err
 	}
 	return generateInterface(packageName, basePath, outputPath, &s, s.Info.InfoProps.Title, s.Paths)
@@ -31,29 +31,34 @@ type clientCodeTemplate struct {
 	Operations           []string
 	Version              string
 	VersionSuffix        string
+	Subrouters           []swagger.Subrouter
 }
 
 var clientCodeTemplateStr = `
 package client
 
 import (
-		"context"
-		"strings"
-		"bytes"
-		"net/http"
-		"strconv"
-		"encoding/json"
-		"strconv"
-		"time"
-		"fmt"
-		"io/ioutil"
-		"crypto/md5"
-
-		"{{.ModuleName}}{{.OutputPath}}/models{{.VersionSuffix}}"
-
-		discovery "github.com/Clever/discovery-go"
-		wcl "github.com/Clever/wag/logging/wagclientlogger"
-
+	"context"
+	"strings"
+	"bytes"
+	"net/http"
+	"strconv"
+	"encoding/json"
+	"strconv"
+	"time"
+	"fmt"
+	"io/ioutil"
+	"crypto/md5"
+
+	"{{.ModuleName}}{{.OutputPath}}/models{{.VersionSuffix}}"
+{{- if .Subrouters }}
+{{ range $i, $val := .Subrouters -}}
+	{{$val.Key}}client "{{$.ModuleName}}/routers/{{$val.Key}}/gen-go/client{{$.VersionSuffix}}"
+	{{$val.Key}}models "{{$.ModuleName}}/routers/{{$val.Key}}/gen-go/models{{$.VersionSuffix}}"
+{{ end }}
+{{ end }}
+	discovery "github.com/Clever/discovery-go"
+	wcl "github.com/Clever/wag/logging/wagclientlogger"
 )
 
 var _ = json.Marshal
@@ -76,6 +81,13 @@ type WagClient struct {
 	retryDoer *retryDoer
 	defaultTimeout time.Duration
 	logger      wcl.WagClientLogger
+{{- if .Subrouters }}
+
+	// Subrouters
+{{ range $i, $val := .Subrouters -}}
+	{{camelcase $val.Key}}Client {{$val.Key}}client.Client
+{{ end }}
+{{ end -}}
 }
 
 var _ Client = (*WagClient)(nil)
@@ -85,7 +97,6 @@ var _ Client = (*WagClient)(nil)
 // provide an instrumented transport using the wag clientconfig module. If no tracing is required, pass nil to use
 // the default transport.
 func New(basePath string, logger wcl.WagClientLogger, transport *http.RoundTripper) *WagClient {
-
 	t := http.DefaultTransport
 	if transport != nil {
 		t = *transport
@@ -106,6 +117,9 @@ func New(basePath string, logger wcl.WagClientLogger, transport *http.RoundTripp
 		retryDoer: &retry,
 		defaultTimeout: 5 * time.Second,
 		logger: logger,
+{{ range $i, $val := .Subrouters -}}
+		{{camelcase $val.Key}}Client: {{$val.Key}}client.New(basePath, logger, transport),
+{{ end }}
 	}
 	return client
 }
@@ -151,9 +165,14 @@ func shortHash(s string) string {
 }
 `
 
-func generateClient(packageName, basePath, outputPath string, s spec.Swagger, isSubrouter bool) error {
+func generateClient(packageName, basePath, outputPath string, s spec.Swagger) error {
 	outputPath = strings.TrimPrefix(outputPath, ".")
 	moduleName, versionSuffix := utils.ExtractModuleNameAndVersionSuffix(packageName, outputPath)
+	subrouters, err := swagger.ParseSubrouters(s)
+	if err != nil {
+		return err
+	}
+
 	codeTemplate := clientCodeTemplate{
 		PackageName:          packageName,
 		OutputPath:           outputPath,
@@ -162,6 +181,7 @@ func generateClient(packageName, basePath, outputPath string, s spec.Swagger, is
 		FormattedServiceName: strings.ToUpper(strings.Replace(s.Info.InfoProps.Title, "-", "_", -1)),
 		Version:              s.Info.InfoProps.Version,
 		VersionSuffix:        versionSuffix,
+		Subrouters:           subrouters,
 	}
 
 	for _, path := range swagger.SortedPathItemKeys(s.Paths.Paths) {
@@ -180,6 +200,29 @@ func generateClient(packageName, basePath, outputPath string, s spec.Swagger, is
 		}
 	}
 
+	for _, router := range subrouters {
+		routerSpec, err := swagger.LoadSubrouterSpec(router)
+		if err != nil {
+			return err
+		}
+
+		for _, path := range swagger.SortedPathItemKeys(routerSpec.Paths.Paths) {
+			pathItem := routerSpec.Paths.Paths[path]
+			pathItemOps := swagger.PathItemOperations(pathItem)
+			for _, method := range swagger.SortedOperationsKeys(pathItemOps) {
+				op := pathItemOps[method]
+				if op.Deprecated {
+					continue
+				}
+				code, err := subrouterOperationCode(routerSpec, op, router)
+				if err != nil {
+					return err
+				}
+				codeTemplate.Operations = append(codeTemplate.Operations, code)
+			}
+		}
+	}
+
 	clientCode, err := templates.WriteTemplate(clientCodeTemplateStr, codeTemplate)
 	if err != nil {
 		return err
@@ -192,11 +235,20 @@ func generateClient(packageName, basePath, outputPath string, s spec.Swagger, is
 		return err
 	}
 
-	return CreateModFile("client/go.mod", basePath, codeTemplate)
+	return CreateModFile("client/go.mod", basePath, codeTemplate, s)
 }
 
 // CreateModFile creates a go.mod file for the client module.
-func CreateModFile(path string, basePath string, codeTemplate clientCodeTemplate) error {
+func CreateModFile(
+	path, basePath string,
+	codeTemplate clientCodeTemplate,
+	s spec.Swagger,
+) error {
+	subrouters, err := swagger.ParseSubrouters(s)
+	if err != nil {
+		return err
+	}
+
 	absPath := basePath + "/" + path
 	f, err := os.Create(absPath)
 	if err != nil {
@@ -214,8 +266,35 @@ require (
 	github.com/Clever/wag/logging/wagclientlogger v0.0.0-20221024182247-2bf828ef51be
 	github.com/donovanhide/eventsource v0.0.0-20171031113327-3ed64d21fb0b
 )
+
 //Replace directives will work locally but mess up imports.
-replace ` + codeTemplate.ModuleName + codeTemplate.OutputPath + `/models` + codeTemplate.VersionSuffix + ` => ../models `
+`
+
+	if subrouters != nil {
+		replaceString := fmt.Sprintf(
+			`replace (
+	%s%s/models%s => ../models
+`,
+			codeTemplate.ModuleName,
+			codeTemplate.OutputPath,
+			codeTemplate.VersionSuffix,
+		)
+
+		for _, router := range subrouters {
+			replaceString += fmt.Sprintf(
+				"\t%s/routers/%s/gen-go/client => ../../routers/%s/gen-go/client\n",
+				codeTemplate.ModuleName,
+				router.Key,
+				router.Key,
+			)
+		}
+
+		replaceString += ")\n"
+		modFileString += replaceString
+	} else {
+		modFileString += `replace ` + codeTemplate.ModuleName + codeTemplate.OutputPath + `/models` + codeTemplate.VersionSuffix + ` => ../models
+`
+	}
 
 	_, err = f.WriteString(modFileString)
 	if err != nil {
@@ -241,12 +320,36 @@ func IsBinaryParam(param spec.Parameter, definitions map[string]spec.Schema) boo
 	return definitions[definitionName].Format == "binary"
 }
 
-func generateInterface(packageName, basePath, outputPath string, s *spec.Swagger, serviceName string, paths *spec.Paths) error {
+func generateInterface(
+	packageName, basePath, outputPath string,
+	s *spec.Swagger,
+	serviceName string,
+	paths *spec.Paths,
+) error {
 	outputPath = strings.TrimPrefix(outputPath, ".")
 	g := swagger.Generator{BasePath: basePath}
-	g.Print("package client\n\n")
+	subrouters, err := swagger.ParseSubrouters(*s)
+	if err != nil {
+		return err
+	}
+
 	moduleName, versionSuffix := utils.ExtractModuleNameAndVersionSuffix(packageName, outputPath)
-	g.Print(swagger.ImportStatements([]string{"context", moduleName + outputPath + "/models" + versionSuffix}))
+	imports := []string{"context", moduleName + outputPath + "/models" + versionSuffix}
+	for _, router := range subrouters {
+		imports = append(
+			imports,
+			fmt.Sprintf(
+				"%sclient \"%s/routers/%s/gen-go/client%s\"",
+				router.Key,
+				moduleName,
+				router.Key,
+				versionSuffix,
+			),
+		)
+	}
+
+	g.Print("package client\n\n")
+	g.Print(swagger.ImportStatements(imports))
 	g.Print("//go:generate mockgen -source=$GOFILE -destination=mock_client.go -package client --build_flags=--mod=mod -imports=models=" + moduleName + outputPath + "/models" + versionSuffix + "\n\n")
 
 	if err := generateClientInterface(s, &g, serviceName, paths); err != nil {
@@ -259,10 +362,24 @@ func generateInterface(packageName, basePath, outputPath string, s *spec.Swagger
 	return g.WriteFile("client/interface.go")
 }
 
-func generateClientInterface(s *spec.Swagger, g *swagger.Generator, serviceName string, paths *spec.Paths) error {
+func generateClientInterface(
+	s *spec.Swagger,
+	g *swagger.Generator,
+	serviceName string,
+	paths *spec.Paths,
+) error {
 	g.Printf("// Client defines the methods available to clients of the %s service.\n", serviceName)
 	g.Print("type Client interface {\n\n")
 
+	subrouters, err := swagger.ParseSubrouters(*s)
+	if err != nil {
+		return err
+	}
+
+	for _, router := range subrouters {
+		g.Printf("\t%sclient.Client\n", router.Key)
+	}
+
 	for _, pathKey := range swagger.SortedPathItemKeys(paths.Paths) {
 		path := paths.Paths[pathKey]
 		pathItemOps := swagger.PathItemOperations(path)
@@ -736,12 +853,13 @@ func iterCode(s *spec.Swagger, op *spec.Operation, basePath, methodPath, method
 		resourceAccessString = resourceAccessString + "." + utils.CamelCase(pathComponent, true)
 	}
 
+	operationInput, _ := swagger.OperationInput(op)
 	return templates.WriteTemplate(
 		iterTmplStr,
 		iterTmpl{
 			OpID:                 op.ID,
 			CapOpID:              capOpID,
-			Input:                swagger.OperationInput(op),
+			Input:                operationInput,
 			BuildPathCode:        buildPathCode(s, op, basePath, methodPath),
 			BuildHeadersCode:     buildHeadersCode(s, op),
 			BuildBodyCode:        buildBodyCode(s, op, method),

clients/go/subrouters.go

@@ -0,0 +1,39 @@
+package goclient
+
+import (
+	"strings"
+
+	"github.com/Clever/wag/v9/swagger"
+	"github.com/Clever/wag/v9/templates"
+	"github.com/go-openapi/spec"
+	"github.com/iancoleman/strcase"
+)
+
+func subrouterOperationCode(
+	s *spec.Swagger,
+	op *spec.Operation,
+	subrouter swagger.Subrouter,
+) (string, error) {
+	_, param := swagger.OperationInput(op)
+	templateArgs := struct {
+		ClientOperation string
+		InputParamName  string
+		OperationID     string
+		SubrouterClient string
+	}{
+		ClientOperation: strings.ReplaceAll(
+			swagger.ClientInterface(s, op),
+			"models",
+			subrouter.Key+"models",
+		),
+		InputParamName:  param,
+		OperationID:     op.ID,
+		SubrouterClient: strcase.ToLowerCamel(subrouter.Key) + "Client",
+	}
+
+	templateStr := `func (c *WagClient) {{.ClientOperation}} {
+	return c.{{.SubrouterClient}}.{{pascalcase .OperationID}}(ctx, {{.InputParamName}})
+}`
+
+	return templates.WriteTemplate(templateStr, templateArgs)
+}

go.mod

@@ -13,6 +13,7 @@ require (
 	github.com/go-openapi/swag v0.22.3
 	github.com/go-openapi/validate v0.19.15
 	github.com/go-swagger/go-swagger v0.23.0
+	github.com/iancoleman/strcase v0.3.0
 	github.com/stretchr/testify v1.8.2
 )
 

go.sum

@@ -144,6 +144,8 @@ github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0/go.mod h1:8NvIoxWQoOIhqOTXgf
 github.com/grpc-ecosystem/grpc-gateway v1.9.0/go.mod h1:vNeuVxBJEsws4ogUvrchl83t/GYV9WGTSLVdBhOQFDY=
 github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4=
 github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
+github.com/iancoleman/strcase v0.3.0 h1:nTXanmYxhfFAMjZL34Ov6gkzEsSJZ5DbhxWjvSASxEI=
+github.com/iancoleman/strcase v0.3.0/go.mod h1:iwCmte+B7n89clKwxIoIXy/HfoL7AsD47ZCWhYzw7ho=
 github.com/imdario/mergo v0.3.6/go.mod h1:2EnlNZ0deacrJVfApfmtdGgDfMuh/nq6Ok1EcJh5FfA=
 github.com/inconshreveable/mousetrap v1.0.0/go.mod h1:PxqpIevigyE2G7u3NXJIT2ANytuPF1OarO4DADm73n8=
 github.com/jessevdk/go-flags v1.4.0 h1:4IU2WS7AumrZ/40jfhf4QVDMsQwqA7VEHozFRrGARJA=

main.go

@@ -145,7 +145,6 @@ func main() {
 			conf.goAbsolutePackagePath,
 			*conf.outputPath,
 			swaggerSpec,
-			*conf.subrouter,
 		); err != nil {
 			log.Fatal(err.Error())
 		}
@@ -214,12 +213,11 @@ func generateDynamo(dynamoPath, goPackageName, basePath, relativeDynamoPath, Out
 func generateGoClient(
 	goPackageName, basePath, outputPath string,
 	swaggerSpec spec.Swagger,
-	subrouter bool,
 ) error {
 	if err := prepareDir(filepath.Join(basePath, "client")); err != nil {
 		return err
 	}
-	if err := goclient.Generate(goPackageName, basePath, outputPath, swaggerSpec, subrouter); err != nil {
+	if err := goclient.Generate(goPackageName, basePath, outputPath, swaggerSpec); err != nil {
 		return fmt.Errorf("Failed generating go client %s", err)
 	}
 	doerGenerator := swagger.Generator{BasePath: basePath}

swagger/ext_subrouters.go

@@ -3,7 +3,9 @@ package swagger
 import (
 	"encoding/json"
 	"log"
+	"path/filepath"
 
+	"github.com/go-openapi/loads"
 	"github.com/go-openapi/spec"
 )
 
@@ -34,3 +36,12 @@ func ParseSubrouters(s spec.Swagger) ([]Subrouter, error) {
 
 	return subrouterConfig, nil
 }
+
+func LoadSubrouterSpec(router Subrouter) (*spec.Swagger, error) {
+	doc, err := loads.Spec(filepath.Join("routers", router.Key, "swagger.yml"))
+	if err != nil {
+		return nil, err
+	}
+
+	return doc.Spec(), nil
+}