Dev (#283)

* update oapi codegen and notes for simpler rest server types gen

* ignoring db struct gen in rest server gen

* use db models in oapi server code

* user fixture with joins and update test

* notes

* update project config

* api key expiration check

* update gen and notes for query parameters in pagination

Author: danicc097

README.md

@@ -105,7 +105,7 @@ cp openapi-go.code-workspace.example openapi-go.code-workspace # edit as desired
 project bootstrap # dependency and tools interactive installation
 project gen
 project recreate-shared-services
-project run-dev
+project run.all
 ```
 
 For first test run:

bin/project

@@ -340,7 +340,7 @@ x.gen.pregen() {
     # NOTE: swaggest won't generate for arrays of structs. use a struct with array fields instead.
     generate_structs_map # structs might have been removed in the meantime
 
-    go build -o $BUILD_DIR/codegen cmd/codegen/main.go || touch "$failed_tool_build_marker" # xo gen may create/update models.
+    go build -o $BUILD_DIR/codegen cmd/codegen/main.go || mark_failed_tool_build # xo gen may create/update models.
 
     local rest_structs=() refs=() spec_schemas=()
     declare -A rest_schema_lookup spec_schema_lookup
@@ -849,18 +849,21 @@ x.gen.client-server() {
     sed "s/\$ref: '\#\//\$ref: '$SPEC_PATH\#\//g" $SPEC_PATH >"$paths_file"
 
     # yq e 'del(.components)' -i "$paths_file" # dont delete since recent oapi-codegen does some checks even if we are not generating types
-    go build -o $BUILD_DIR/oapi-codegen cmd/oapi-codegen/main.go || touch "$failed_tool_build_marker" # templates are embedded, required rebuild
+    go build -o $BUILD_DIR/oapi-codegen cmd/oapi-codegen/main.go || mark_failed_tool_build # templates are embedded, required rebuild
 
-    # Generated types in models pkg will be used in services, repos, db, but rest package must use original
-    # models from rest/models.go (source of generated spec schemas)
-    # and not the generated ones to avoid (a lot of) unnecessary conversions.
     oapi-codegen --config internal/models/oapi-codegen-types.yaml "$SPEC_PATH" || err "Failed types generation" &
     oapi-codegen --config internal/rest/oapi-codegen-server.yaml --models-pkg models --server-types "$server_types_list" --types "$types_list" "$paths_file" || err "Failed server generation" &
     oapi-codegen --config internal/rest/oapi-codegen-test-client.yaml "$SPEC_PATH" || err "Failed client generation" &
-    oapi-codegen --config internal/client/oapi-codegen-client.yaml "$SPEC_PATH" || err "Failed client generation" &
+    # not used now. may be useful for a cli at some point
+    # oapi-codegen --config internal/client/oapi-codegen-client.yaml "$SPEC_PATH" || err "Failed client generation" &
 
     wait_without_error
 
+    sed -i 's/ \*Db\([A-Z]\)/ \*db\.\1/g; s/\[\]Db\([A-Z]\)/\[\]db\.\1/g; s/ Db\([A-Z]\)/ db\.\1/g; s/ \(\(externalRef0\.\)\?Db\)\([A-Z]\)/ db\.\3/g' internal/rest/openapi_server.gen.go
+    sed -i 's/ \*Db\([A-Z]\)/ \*db\.\1/g; s/\[\]Db\([A-Z]\)/\[\]db\.\1/g; s/ Db\([A-Z]\)/ db\.\1/g; s/ \(\(externalRef0\.\)\?Db\)\([A-Z]\)/ db\.\3/g' internal/rest/openapi_client_gen_test.go
+    # db already imports models pkg
+    # sed -i 's/ \*Db\([A-Z]\)/ \*db\.\1/g; s/\[\]Db\([A-Z]\)/\[\]db\.\1/g; s/ Db\([A-Z]\)/ db\.\1/g; s/ \(\(externalRef0\.\)\?Db\)\([A-Z]\)/ db\.\3/g' internal/models/openapi_types.gen.go
+
     # local configs=(
     #   "internal/models/oapi-codegen-types.yaml"
     #   "internal/rest/oapi-codegen-server.yaml"
@@ -1048,7 +1051,7 @@ x.gen() {
     { retry 5 go generate ./...; } &
     { retry 5 x.gen.xo; } &
     { retry 5 x.gen.sqlc; } &
-    x.gen.jet &
+    x.gen.jet >/dev/null &
     generate_repo_constructor &
 
     wait_without_error || err Failed jobs
@@ -1087,11 +1090,11 @@ x.gen.build-tools() {
     mkdir -p $out_dir
     for cmd in jet oapi-codegen codegen ast-parser; do
       echo "Building $cmd..."
-      { go build -o $out_dir/$cmd cmd/$cmd/main.go || touch "$failed_tool_build_marker"; } &
+      { go build -o $out_dir/$cmd cmd/$cmd/main.go || mark_failed_tool_build; } &
     done
 
     wait_without_error --no-kill || {
-      touch "$failed_tool_build_marker"
+      mark_failed_tool_build
     }
   } 2>&4 | xlog >&3; } 4>&1 | xerr >&3; } 3>&1
 }
@@ -2250,6 +2253,10 @@ $formatted_string
 " "$SPEC_PATH"
 }
 
+mark_failed_tool_build() {
+  touch "$failed_tool_build_marker"
+}
+
 # generate db structs for use with swaggest/openapi-go.
 generate_structs_map() {
   # cached most of the time. building here since it must be called before tools build
@@ -2440,7 +2447,7 @@ $(join_by $'\n' "${invalid_schemas[@]}")"
   # always compile and run since we need new PublicStructs that were just changed
   codegen gen-schema --struct-names $struct_names_arg --existing-structs $existing_structs_arg | yq '
     with_entries(select(.key == "components"))' \
-    >$gen_schema_spec_path || touch "$failed_tool_build_marker"
+    >$gen_schema_spec_path || mark_failed_tool_build
 
   local clashes=()
   for custom_schema in $(yq ".components.schemas[] | select((.x-is-generated == true) | not) | key" $SPEC_PATH); do

cmd/oapi-codegen/main.go

@@ -12,6 +12,7 @@ import (
 	"slices"
 	"strings"
 	"text/template"
+	"unicode"
 
 	"github.com/deepmap/oapi-codegen/v2/pkg/codegen"
 	"github.com/deepmap/oapi-codegen/v2/pkg/util"
@@ -27,7 +28,9 @@ type configuration struct {
 	OutputFile       string `yaml:"output,omitempty"`
 	ExcludeRestTypes bool   `yaml:"exclude-rest-types,omitempty"`
 	// TestClient defines whether the generated code is a client for testing purposes.
-	TestClient bool `yaml:"test-client,omitempty"`
+	TestClient             bool `yaml:"test-client,omitempty"`
+	SkipDiscriminatorUtils bool `yaml:"skip-discriminator-utils,omitempty"`
+	IsRestServerGen        bool `yaml:"is-rest-server-gen,omitempty"`
 }
 
 //go:embed oapi-templates
@@ -119,6 +122,12 @@ func generate(spec *openapi3.T, config configuration, templates embed.FS, models
 
 			return false
 		},
+		"is_rest_server_gen": func() bool {
+			return config.IsRestServerGen
+		},
+		"skip_discriminator_utils": func() bool {
+			return config.SkipDiscriminatorUtils
+		},
 		"is_test_client": func() bool {
 			return config.TestClient
 		},
@@ -128,6 +137,9 @@ func generate(spec *openapi3.T, config configuration, templates embed.FS, models
 		"models_pkg": func() string {
 			return modelsPkg + "."
 		},
+		"is_db_struct": func(t string) bool {
+			return strings.HasPrefix(t, "Db") && unicode.IsUpper([]rune(t)[2])
+		},
 		"should_exclude_type": func(t string) bool {
 			stName := strings.TrimPrefix(t, "externalRef0.")
 			if slices.Contains(serverTypes, stName) {

cmd/oapi-codegen/oapi-templates/request-bodies.tmpl

@@ -4,9 +4,8 @@
 {{$contentType := .ContentType -}}
 {{with .TypeDef $opid}}
 
-// {{.TypeName}} defines body for {{$opid}} for {{$contentType}} ContentType.
 {{- /* cannot import rest in types gen package, circ. {{if is_rest_type .Schema.TypeDecl}}rest.{{end}} */}}
-
+// {{.TypeName}} defines body for {{$opid}} for {{$contentType}} ContentType.
 type {{.TypeName}} {{if .IsAlias}}={{end}}{{if (exclude_rest_types)}}{{rest_type .Schema.TypeDecl}}{{else}}{{.Schema.TypeDecl}}{{end}}
 {{end}}
 {{end}}

cmd/oapi-codegen/oapi-templates/typedef.tmpl

@@ -1,8 +1,11 @@
 {{range .Types}}
-{{/* IMPORTANT: changed */}}
-{{if and ((should_exclude_type .TypeName)) (exclude_rest_types)}}/* Ignoring existing rest struct{{end}}
+{{ if and ((should_exclude_type .TypeName)) (exclude_rest_types) -}}
+/* Ignoring existing struct (rest/models.go) {{.TypeName}} */
+{{ else if and (is_rest_server_gen) (is_db_struct .TypeName) -}}
+/* Skipping definition of db struct {{.TypeName}} */
+{{ else -}}
 {{ if .Schema.Description }}{{ toGoComment .Schema.Description .TypeName  }}{{ else }}// {{.TypeName}} defines the model for {{.JsonName}}.{{ end }}
 type {{.TypeName}} {{if .IsAlias }}={{end}} {{.Schema.TypeDecl}}
-{{if and ((should_exclude_type .TypeName)) (exclude_rest_types)}}*/{{end}}
-{{end}}
+{{ end }}
+{{ end }}
 

cmd/oapi-codegen/oapi-templates/union.tmpl

@@ -65,7 +65,7 @@
         */}}
     {{end}}
 
-    {{if $discriminator}}
+    {{if and ($discriminator) (not skip_discriminator_utils) }}
         func (t {{.TypeName}}) Discriminator() (string, error) {
             var discriminator struct {
                 Discriminator string {{$discriminator.JSONTag}}

e2e/client/gen/model/dbCacheDemoWorkItemJoins.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v6.23.0 🍺
+ * Do not edit manually.
+ * OpenAPI openapi-go-gin-postgres-sqlc
+ * openapi-go-gin-postgres-sqlc
+ * OpenAPI spec version: 2.0.0
+ */
+
+export interface DbCacheDemoWorkItemJoins {
+  assignees: boolean
+  kanbanStep: boolean
+  team: boolean
+  timeEntries: boolean
+  workItemComments: boolean
+  workItemTags: boolean
+  workItemType: boolean
+}

e2e/client/gen/model/dbUserJoins.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v6.23.0 🍺
+ * Do not edit manually.
+ * OpenAPI openapi-go-gin-postgres-sqlc
+ * openapi-go-gin-postgres-sqlc
+ * OpenAPI spec version: 2.0.0
+ */
+
+export interface DbUserJoins {
+  assigneeWorkItems: boolean
+  memberProjects: boolean
+  memberTeams: boolean
+  receiverNotifications: boolean
+  senderNotifications: boolean
+  timeEntries: boolean
+  userAPIKey: boolean
+  userNotifications: boolean
+  workItemComments: boolean
+}

e2e/client/gen/model/getCacheDemoWorkItemQueryParameters.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v6.23.0 🍺
+ * Do not edit manually.
+ * OpenAPI openapi-go-gin-postgres-sqlc
+ * openapi-go-gin-postgres-sqlc
+ * OpenAPI spec version: 2.0.0
+ */
+import type { DbCacheDemoWorkItemJoins } from './dbCacheDemoWorkItemJoins'
+
+export interface GetCacheDemoWorkItemQueryParameters {
+  joins?: DbCacheDemoWorkItemJoins
+}

e2e/client/gen/model/getCurrentUserQueryParameters.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v6.23.0 🍺
+ * Do not edit manually.
+ * OpenAPI openapi-go-gin-postgres-sqlc
+ * openapi-go-gin-postgres-sqlc
+ * OpenAPI spec version: 2.0.0
+ */
+import type { DbUserJoins } from './dbUserJoins'
+
+export interface GetCurrentUserQueryParameters {
+  joins?: DbUserJoins
+}