support all other extensions and with ref

paulmach · paulmach · commit 2abd46112953 · 2025-01-09T13:45:38.000-08:00
diff --git a/internal/test/extensions/x-go-type-skip-optional-pointer/config.yaml b/internal/test/extensions/x-go-type-skip-optional-pointer/config.yaml
@@ -0,0 +1,7 @@
+# yaml-language-server: $schema=../../../../configuration-schema.json
+package: xgotypeskipoptionalpointer
+generate:
+  models: true
+output: issue.gen.go
+output-options:
+  skip-prune: true
diff --git a/internal/test/extensions/x-go-type-skip-optional-pointer/generate.go b/internal/test/extensions/x-go-type-skip-optional-pointer/generate.go
@@ -0,0 +1,3 @@
+package xgotypeskipoptionalpointer
+
+//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=config.yaml spec.yaml
diff --git a/internal/test/extensions/x-go-type-skip-optional-pointer/issue.gen.go b/internal/test/extensions/x-go-type-skip-optional-pointer/issue.gen.go
diff --git a/internal/test/extensions/x-go-type-skip-optional-pointer/spec.yaml b/internal/test/extensions/x-go-type-skip-optional-pointer/spec.yaml
@@ -0,0 +1,18 @@
+components:
+  schemas:
+    Default:
+      type: integer
+    SkipOptionalTrue:
+      type: integer
+      x-go-type-skip-optional-pointer: true
+    SomeObject:
+      type: object
+      properties:
+        skip_optional:
+          $ref: '#/components/schemas/SkipOptionalTrue'
+        skip_optional_override_to_false:
+          $ref: '#/components/schemas/SkipOptionalTrue'
+          x-go-type-skip-optional-pointer: false
+        skip_optional_next_to_ref:
+          $ref: '#/components/schemas/Default'
+          x-go-type-skip-optional-pointer: true
diff --git a/internal/test/extensions/x-oapi-codegen-extra-tags/config.yaml b/internal/test/extensions/x-oapi-codegen-extra-tags/config.yaml
@@ -0,0 +1,7 @@
+# yaml-language-server: $schema=../../../../configuration-schema.json
+package: xextratags
+generate:
+  models: true
+output: issue.gen.go
+output-options:
+  skip-prune: true
diff --git a/internal/test/extensions/x-oapi-codegen-extra-tags/generate.go b/internal/test/extensions/x-oapi-codegen-extra-tags/generate.go
@@ -0,0 +1,3 @@
+package xextratags
+
+//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=config.yaml spec.yaml
diff --git a/internal/test/extensions/x-oapi-codegen-extra-tags/issue.gen.go b/internal/test/extensions/x-oapi-codegen-extra-tags/issue.gen.go
diff --git a/internal/test/extensions/x-oapi-codegen-extra-tags/spec.yaml b/internal/test/extensions/x-oapi-codegen-extra-tags/spec.yaml
@@ -0,0 +1,22 @@
+components:
+  schemas:
+    Port:
+      type: integer
+      x-oapi-codegen-extra-tags:
+        bson: port
+    SomeObject:
+      type: object
+      properties:
+        port:
+          $ref: '#/components/schemas/Port'
+          x-order: 1
+        start_port:
+          $ref: '#/components/schemas/Port'
+          x-order: 2
+          x-oapi-codegen-extra-tags:
+            bson: start_port
+        end_port:
+          $ref: '#/components/schemas/Port'
+          x-order: 3
+          x-oapi-codegen-extra-tags:
+            bson: end_port
diff --git a/internal/test/extensions/x-omitempty/config.yaml b/internal/test/extensions/x-omitempty/config.yaml
@@ -0,0 +1,7 @@
+# yaml-language-server: $schema=../../../../configuration-schema.json
+package: xomitempty
+generate:
+  models: true
+output: issue.gen.go
+output-options:
+  skip-prune: true
diff --git a/internal/test/extensions/x-omitempty/generate.go b/internal/test/extensions/x-omitempty/generate.go
@@ -0,0 +1,3 @@
+package xomitempty
+
+//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=config.yaml spec.yaml
diff --git a/internal/test/extensions/x-omitempty/issue.gen.go b/internal/test/extensions/x-omitempty/issue.gen.go
diff --git a/internal/test/extensions/x-omitempty/spec.yaml b/internal/test/extensions/x-omitempty/spec.yaml
@@ -0,0 +1,18 @@
+components:
+  schemas:
+    Default:
+      type: integer
+    OmitemptyTrue:
+      type: integer
+      x-omitempty: true
+    SomeObject:
+      type: object
+      properties:
+        omitempty:
+          $ref: '#/components/schemas/OmitemptyTrue'
+        omitempty_override_to_false:
+          $ref: '#/components/schemas/OmitemptyTrue'
+          x-omitempty: false
+        omitempty_next_to_ref:
+          $ref: '#/components/schemas/Default'
+          x-omitempty: true
diff --git a/internal/test/go.mod b/internal/test/go.mod
@@ -9,6 +9,7 @@ require (
 	github.com/gin-gonic/gin v1.9.1
 	github.com/go-chi/chi/v5 v5.0.10
 	github.com/gofiber/fiber/v2 v2.49.1
+	github.com/google/uuid v1.4.0
 	github.com/gorilla/mux v1.8.1
 	github.com/kataras/iris/v12 v12.2.6-0.20230908161203-24ba4e8933b9
 	github.com/labstack/echo/v4 v4.11.3
@@ -17,6 +18,7 @@ require (
 	github.com/oapi-codegen/runtime v1.1.0
 	github.com/oapi-codegen/testutil v1.0.0
 	github.com/stretchr/testify v1.10.0
+	golang.org/x/time v0.3.0
 	gopkg.in/yaml.v2 v2.4.0
 )
 
@@ -47,7 +49,6 @@ require (
 	github.com/golang-jwt/jwt v3.2.2+incompatible // indirect
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/gomarkdown/markdown v0.0.0-20230716120725-531d2d74bc12 // indirect
-	github.com/google/uuid v1.4.0 // indirect
 	github.com/gorilla/css v1.0.0 // indirect
 	github.com/invopop/yaml v0.3.1 // indirect
 	github.com/iris-contrib/schema v0.0.6 // indirect
@@ -98,7 +99,6 @@ require (
 	golang.org/x/net v0.25.0 // indirect
 	golang.org/x/sys v0.20.0 // indirect
 	golang.org/x/text v0.20.0 // indirect
-	golang.org/x/time v0.3.0 // indirect
 	golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d // indirect
 	google.golang.org/protobuf v1.31.0 // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
diff --git a/pkg/codegen/schema.go b/pkg/codegen/schema.go
@@ -253,6 +253,20 @@ func GenerateGoSchema(sref *openapi3.SchemaRef, path []string) (Schema, error) {
 	}
 
 	schema := sref.Value
+	extensions := combinedschemaextensions(sref)
+
+	// read extensions
+
+	// Check x-go-type-skip-optional-pointer, which will override if the type
+	// should be a pointer or not when the field is optional.
+	skipOptionalPointer := false
+	if extension, ok := extensions[extPropGoTypeSkipOptionalPointer]; ok {
+		var err error
+		skipOptionalPointer, err = extParsePropGoTypeSkipOptionalPointer(extension)
+		if err != nil {
+			return Schema{}, fmt.Errorf("invalid value for %q: %w", extPropGoTypeSkipOptionalPointer, err)
+		}
+	}
 
 	// If Ref is set on the SchemaRef, it means that this type is actually a reference to
 	// another type. We're not de-referencing, so simply use the referenced type.
@@ -276,17 +290,20 @@ func GenerateGoSchema(sref *openapi3.SchemaRef, path []string) (Schema, error) {
 					sref.Ref, err)
 			}
 		}
+
 		return Schema{
-			GoType:         refType,
-			Description:    schema.Description,
-			DefineViaAlias: true,
-			OAPISchema:     schema,
+			GoType:              refType,
+			Description:         schema.Description,
+			DefineViaAlias:      true,
+			SkipOptionalPointer: skipOptionalPointer,
+			OAPISchema:          schema,
 		}, nil
 	}
 
 	outSchema := Schema{
-		Description: schema.Description,
-		OAPISchema:  schema,
+		Description:         schema.Description,
+		SkipOptionalPointer: skipOptionalPointer,
+		OAPISchema:          schema,
 	}
 
 	// AllOf is interesting, and useful. It's the union of a number of other
@@ -315,16 +332,6 @@ func GenerateGoSchema(sref *openapi3.SchemaRef, path []string) (Schema, error) {
 		return outSchema, nil
 	}
 
-	// Check x-go-type-skip-optional-pointer, which will override if the type
-	// should be a pointer or not when the field is optional.
-	if extension, ok := schema.Extensions[extPropGoTypeSkipOptionalPointer]; ok {
-		skipOptionalPointer, err := extParsePropGoTypeSkipOptionalPointer(extension)
-		if err != nil {
-			return outSchema, fmt.Errorf("invalid value for %q: %w", extPropGoTypeSkipOptionalPointer, err)
-		}
-		outSchema.SkipOptionalPointer = skipOptionalPointer
-	}
-
 	// Schema type and format, eg. string / binary
 	t := schema.Type
 	// Handle objects and empty schemas first as a special case
@@ -432,6 +439,7 @@ func GenerateGoSchema(sref *openapi3.SchemaRef, path []string) (Schema, error) {
 				if p.Value != nil {
 					description = p.Value.Description
 				}
+
 				prop := Property{
 					JsonFieldName: pName,
 					Schema:        pSchema,
@@ -440,7 +448,7 @@ func GenerateGoSchema(sref *openapi3.SchemaRef, path []string) (Schema, error) {
 					Nullable:      p.Value.Nullable,
 					ReadOnly:      p.Value.ReadOnly,
 					WriteOnly:     p.Value.WriteOnly,
-					Extensions:    p.Value.Extensions,
+					Extensions:    combinedschemaextensions(p),
 					Deprecated:    p.Value.Deprecated,
 				}
 				outSchema.Properties = append(outSchema.Properties, prop)
@@ -466,7 +474,7 @@ func GenerateGoSchema(sref *openapi3.SchemaRef, path []string) (Schema, error) {
 		// Check for x-go-type-name. It behaves much like x-go-type, however, it will
 		// create a type definition for the named type, and use the named type in place
 		// of this schema.
-		if extension, ok := schema.Extensions[extGoTypeName]; ok {
+		if extension, ok := extensions[extGoTypeName]; ok {
 			typeName, err := extTypeName(extension)
 			if err != nil {
 				return outSchema, fmt.Errorf("invalid value for %q: %w", extGoTypeName, err)
@@ -502,7 +510,7 @@ func GenerateGoSchema(sref *openapi3.SchemaRef, path []string) (Schema, error) {
 
 		enumNames := enumValues
 		for _, key := range []string{extEnumVarNames, extEnumNames} {
-			if extension, ok := schema.Extensions[key]; ok {
+			if extension, ok := extensions[key]; ok {
 				if extEnumNames, err := extParseEnumVarNames(extension); err == nil {
 					enumNames = extEnumNames
 					break
@@ -530,7 +538,7 @@ func GenerateGoSchema(sref *openapi3.SchemaRef, path []string) (Schema, error) {
 			// Allow overriding autogenerated enum type names, since these may
 			// cause conflicts - see https://github.com/oapi-codegen/oapi-codegen/issues/832
 			var typeName string
-			if extension, ok := schema.Extensions[extGoTypeName]; ok {
+			if extension, ok := extensions[extGoTypeName]; ok {
 				typeName, err = extString(extension)
 				if err != nil {
 					return outSchema, fmt.Errorf("invalid value for %q: %w", extGoTypeName, err)
@@ -908,3 +916,22 @@ func generateUnion(outSchema *Schema, elements openapi3.SchemaRefs, discriminato
 
 	return nil
 }
+
+// combinedSchemaExtensions returns one set of extensions taking
+// those from next to the $ref and the referenced schema itself.
+// Extensions next to the $ref take precedence.
+func combinedschemaextensions(r *openapi3.SchemaRef) map[string]any {
+	combined := map[string]any{}
+
+	if r.Value != nil {
+		for k, v := range r.Value.Extensions {
+			combined[k] = v
+		}
+	}
+
+	for k, v := range r.Extensions {
+		combined[k] = v
+	}
+
+	return combined
+}
diff --git a/pkg/codegen/utils.go b/pkg/codegen/utils.go
@@ -1045,7 +1045,7 @@ func ParseGoImportExtension(v *openapi3.SchemaRef) (*goImport, error) {
 	// values next to $ref will be used before those in the actual schema
 	if v.Extensions[extPropGoImport] != nil {
 		goTypeImportExt = v.Extensions[extPropGoImport]
-	} else if v.Value.Extensions[extPropGoImport] != nil {
+	} else if v.Value != nil && v.Value.Extensions[extPropGoImport] != nil {
 		goTypeImportExt = v.Value.Extensions[extPropGoImport]
 	} else {
 		return nil, nil

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+package xgotypeskipoptionalpointer`
	`2`	`+`
	`3`	`+//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=config.yaml spec.yaml`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+package xextratags`
	`2`	`+`
	`3`	`+//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=config.yaml spec.yaml`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+package xomitempty`
	`2`	`+`
	`3`	`+//go:generate go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen --config=config.yaml spec.yaml`