René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"feat(client): 160,000 -> 85,000 LOC improvement for query-param heavy openapi specs","articleBody":"Unable at the moment to submit a PR, but we've pulled in `client.tmpl` locally as of commit d232e9efa9f54ee20ca60df885595bd23dc86759, and have applied the following patch of changes to the `client.tmpl` template.\r\n\r\n```patch\r\ndiff --git a/templates/client.tmpl b/templates/client.tmpl\r\nindex 10ee564..54da21f 100644\r\n--- a/templates/client.tmpl\r\n+++ b/templates/client.tmpl\r\n@@ -123,6 +123,26 @@ func (c *{{ $clientTypeName }}) {{$opid}}{{.Suffix}}(ctx context.Context{{genPar\r\n {{end}}{{/* range .Bodies */}}\r\n {{end}}\r\n\r\n+func addParamToQuery(values url.Values, style string, explode bool, paramName string, value any) error {\r\n+\tqueryFrag, err := runtime.StyleParamWithLocation(style, explode, paramName, runtime.ParamLocationQuery, value)\r\n+\tif err != nil {\r\n+\t\treturn  err\r\n+\t}\r\n+\r\n+\tparsed, err := url.ParseQuery(queryFrag)\r\n+\tif err != nil {\r\n+\t\treturn err\r\n+\t}\r\n+\r\n+\tfor k, v := range parsed {\r\n+\t\tfor _, v2 := range v {\r\n+\t\t\tvalues.Add(k, v2)\r\n+\t\t}\r\n+\t}\r\n+\r\n+\treturn nil\r\n+}\r\n+\r\n {{/* Generate request builders */}}\r\n {{range .}}\r\n {{$hasParams := .RequiresParamObject -}}\r\n@@ -196,32 +216,23 @@ func New{{$opid}}Request{{if .HasBody}}WithBody{{end}}(server string{{genParamAr\r\n {{if .QueryParams}}\r\n     if params != nil {\r\n         queryValues := queryURL.Query()\r\n-            {{range $paramIdx, $param := .QueryParams}}\r\n+        {{range $paramIdx, $param := .QueryParams -}}\r\n             {{if not .Required}} if params.{{.GoName}} != nil { {{end}}\r\n-            {{if .IsPassThrough}}\r\n+            {{- if .IsPassThrough}}\r\n             queryValues.Add(\"{{.ParamName}}\", {{if not .Required}}*{{end}}params.{{.GoName}})\r\n-            {{end}}\r\n-            {{if .IsJson}}\r\n+            {{- end}}\r\n+            {{- if .IsJson}}\r\n             if queryParamBuf, err := json.Marshal({{if not .Required}}*{{end}}params.{{.GoName}}); err != nil {\r\n                 return nil, err\r\n             } else {\r\n                 queryValues.Add(\"{{.ParamName}}\", string(queryParamBuf))\r\n             }\r\n-\r\n-            {{end}}\r\n-            {{if .IsStyled}}\r\n-            if queryFrag, err := runtime.StyleParamWithLocation(\"{{.Style}}\", {{.Explode}}, \"{{.ParamName}}\", runtime.ParamLocationQuery, {{if not .Required}}*{{end}}params.{{.GoName}}); err != nil {\r\n+            {{- end}}\r\n+            {{- if .IsStyled}}\r\n+            if err := addParamToQuery(queryValues, \"{{.Style}}\", {{.Explode}}, \"{{.ParamName}}\", {{if not .Required}}*{{end}}params.{{.GoName}}); err != nil {\r\n                 return nil, err\r\n-            } else if parsed, err := url.ParseQuery(queryFrag); err != nil {\r\n-               return nil, err\r\n-            } else {\r\n-               for k, v := range parsed {\r\n-                   for _, v2 := range v {\r\n-                       queryValues.Add(k, v2)\r\n-                   }\r\n-               }\r\n             }\r\n-            {{end}}\r\n+            {{- end}}\r\n             {{if not .Required}}}{{end}}\r\n         {{end}}\r\n         queryURL.RawQuery = queryValues.Encode()\r\n```\r\n\r\nCould likely be further improved if this were further extracted into runtime.\r\n\r\nIn the case of our OpenAPI spec, which is very query-param heavy, it cuts the LOC for the generated code from **~160,000** to **~85,000**. Without this, it would take Go over 10 seconds to even parse the AST/compile due to the amount of generated code. With this change, it's near instant again.\r\n\r\nWe generate query params to add various forms of filtering to our paginated endpoints, though most requests don't actually use most query parameters.","author":{"url":"https://github.com/lrstanley","@type":"Person","name":"lrstanley"},"datePublished":"2024-08-30T03:16:14Z","url":"https://github.com/oapi-codegen/oapi-codegen/issues/1744"}