feat(codegen): Add flag to ignore string format for type generation (#…

…257) Co-authored-by: Gildas Lebel <[email protected]>
lerenn · Sep 12, 2024 · 890481d · 890481d
1 parent 4a71edd
commit 890481d
Show file tree

Hide file tree

Showing 18 changed files with 1,455 additions and 32 deletions.
diff --git a/cmd/asyncapi-codegen/config.go b/cmd/asyncapi-codegen/config.go
@@ -43,6 +43,9 @@ type Flags struct {
 	// NamingScheme defines the naming case for generated golang structs
 	// Supported values: camel, none
 	NamingScheme string
+
+	// IgnoreStringFormat states whether the properties' format (date, date-time) should impact the type in types
+	IgnoreStringFormat bool
 }
 
 // SetToCommand adds the flags to a cobra command.
@@ -58,16 +61,19 @@ func (f *Flags) SetToCommand(cmd *cobra.Command) {
 		"Schema property key names conversion strategy.\nSupported values: snake, camel, kebab, none.")
 	cmd.Flags().StringVarP(&f.NamingScheme, "naming-scheme", "n", "none",
 		"Naming scheme for generated golang elements.\nSupported values: camel, none.")
+	cmd.Flags().BoolVar(&f.IgnoreStringFormat, "ignore-string-format", false,
+		"Ignores the format (date, date-time) on string properties, generating golang string, instead of dates")
 }
 
 // ToCodegenOptions processes command line flags structure to code generation tool options.
 func (f Flags) ToCodegenOptions() (options.Options, error) {
 	opt := options.Options{
-		OutputPath:        f.OutputPath,
-		PackageName:       f.PackageName,
-		DisableFormatting: f.DisableFormatting,
-		ConvertKeys:       f.ConvertKeys,
-		NamingScheme:      f.NamingScheme,
+		OutputPath:         f.OutputPath,
+		PackageName:        f.PackageName,
+		DisableFormatting:  f.DisableFormatting,
+		ConvertKeys:        f.ConvertKeys,
+		NamingScheme:       f.NamingScheme,
+		IgnoreStringFormat: f.IgnoreStringFormat,
 	}
 
 	if f.Generate != "" {

diff --git a/pkg/codegen/codegen.go b/pkg/codegen/codegen.go
@@ -88,6 +88,10 @@ func (cg CodeGen) Generate(opt options.Options) error {
 		return err
 	}
 
+	if opt.IgnoreStringFormat {
+		template.DisableDateOrTimeGeneration()
+	}
+
 	// Process specification
 	if err := cg.specification.Process(); err != nil {
 		return err

diff --git a/pkg/codegen/generators/v2/templates/message.tmpl b/pkg/codegen/generators/v2/templates/message.tmpl
@@ -54,7 +54,7 @@ func brokerMessageTo{{namify .Name}}(bMsg extensions.BrokerMessage) ({{namify .N
     {{- /* Handle payload based on type */}}
     {{- if eq $payload.Type "string"}}
         // Convert to string
-        {{- if and $payload.Format (or (eq $payload.Format "date") (eq $payload.Format "date-time"))}}
+        {{- if isDateOrDateTimeGenerated $payload.Format }}
             t, err := time.Parse(time.RFC3339, string(bMsg.Payload))
             if err != nil {
                 return {{namify .Name}}{}, err
@@ -115,7 +115,7 @@ func brokerMessageTo{{namify .Name}}(bMsg extensions.BrokerMessage) ({{namify .N
                         if err != nil {
                             return msg, err
                         }
-                    {{- else if or (eq $value.Format "date") (eq $value.Format "date-time")}}
+                    {{- else if isDateOrDateTimeGenerated $value.Format }}
                         t, err := time.Parse(time.RFC3339, string(v))
                         if err != nil {
                             return msg, err
@@ -130,7 +130,7 @@ func brokerMessageTo{{namify .Name}}(bMsg extensions.BrokerMessage) ({{namify .N
                         if err != nil {
                             return msg, err
                         }
-                    {{- else if or (eq $value.Format "date") (eq $value.Format "date-time")}}
+                    {{- else if isDateOrDateTimeGenerated $value.Format }}
                         t, err := time.Parse(time.RFC3339, string(v))
                         if err != nil {
                             return msg, err
@@ -188,7 +188,7 @@ func (msg {{namify .Name}}) toBrokerMessage() (extensions.BrokerMessage, error)
             payload := make([]byte, 8)
             binary.BigEndian.PutUint64(payload, math.Float64bits(msg.Payload))
         {{- end}}
-    {{- else if and (eq $payload.Type "string") (and $payload.Format (or (eq $payload.Format "date") (eq $payload.Format "date-time")))}}
+    {{- else if and (eq $payload.Type "string") (isDateOrDateTimeGenerated $payload.Format) }}
         // Convert to RFC3339 and to []byte
         payload := []byte(msg.Payload.Format(time.RFC3339))
     {{- else}}
@@ -218,7 +218,7 @@ func (msg {{namify .Name}}) toBrokerMessage() (extensions.BrokerMessage, error)
                         return extensions.BrokerMessage{}, err
                     }
                     headers["{{$key}}"] = h
-                {{- else if or (eq $value.Format "date") (eq $value.Format "date-time")}}
+                {{- else if isDateOrDateTimeGenerated $value.Format }}
                     headers["{{$key}}"] = []byte(msg.Headers.{{namify $key}}.Format(time.RFC3339))
                 {{- else }}
                     headers["{{$key}}"] = []byte(msg.Headers.{{namify $key}})
@@ -231,7 +231,7 @@ func (msg {{namify .Name}}) toBrokerMessage() (extensions.BrokerMessage, error)
                             return extensions.BrokerMessage{}, err
                         }
                         headers["{{$key}}"] = h
-                    {{- else if or (eq $value.Format "date") (eq $value.Format "date-time")}}
+                    {{- else if isDateOrDateTimeGenerated $value.Format }}
                         headers["{{$key}}"] = []byte(msg.Headers.{{namify $key}}.Format(time.RFC3339))
                     {{- else }}
                         headers["{{$key}}"] = []byte(*msg.Headers.{{namify $key}})

diff --git a/pkg/codegen/generators/v2/templates/schema_definition.tmpl b/pkg/codegen/generators/v2/templates/schema_definition.tmpl
@@ -35,7 +35,7 @@ type {{ namify .Name }} struct {
 type {{ .Name }} {{template "schema-name" .}}
 
 {{/* Create specific marshaling for time */ -}}
-{{- if or (eq .Format "date") (eq .Format "date-time") -}}
+{{- if isDateOrDateTimeGenerated .Format -}}
     {{template "marshaling-time" .}}
 {{- end -}}
 

diff --git a/pkg/codegen/generators/v2/templates/schema_name.tmpl b/pkg/codegen/generators/v2/templates/schema_name.tmpl
@@ -16,9 +16,9 @@ bool
 
 {{- /* --------------------------- Type String -------------------------- */ -}}
 {{- else if eq .Type "string" -}}
-{{- if and .Format (eq .Format "date") -}}
+{{- if and (isDateOrDateTimeGenerated .Format) (eq .Format "date") -}}
 civil.Date
-{{- else if and .Format (eq .Format "date-time") -}}
+{{- else if and (isDateOrDateTimeGenerated .Format) (eq .Format "date-time") -}}
 time.Time
 {{- else -}}
 string

diff --git a/pkg/codegen/generators/v3/templates/message.tmpl b/pkg/codegen/generators/v3/templates/message.tmpl
@@ -63,7 +63,7 @@ func brokerMessageTo{{namify .Name}}(bMsg extensions.BrokerMessage) ({{namify .N
     {{- /* Handle payload based on type */}}
     {{- if eq $payload.Type "string"}}
         // Convert to string
-        {{- if and $payload.Format (or (eq $payload.Format "date") (eq $payload.Format "date-time"))}}
+        {{- if isDateOrDateTimeGenerated $payload.Format }}
             t, err := time.Parse(time.RFC3339, string(bMsg.Payload))
             if err != nil {
                 return {{namify .Name}}{}, err
@@ -124,7 +124,7 @@ func brokerMessageTo{{namify .Name}}(bMsg extensions.BrokerMessage) ({{namify .N
                         if err != nil {
                             return msg, err
                         }
-                    {{- else if or (eq $value.Format "date") (eq $value.Format "date-time")}}
+                    {{- else if isDateOrDateTimeGenerated $value.Format }}
                         t, err := time.Parse(time.RFC3339, string(v))
                         if err != nil {
                             return msg, err
@@ -143,7 +143,7 @@ func brokerMessageTo{{namify .Name}}(bMsg extensions.BrokerMessage) ({{namify .N
                         if err != nil {
                             return msg, err
                         }
-                    {{- else if or (eq $value.Format "date") (eq $value.Format "date-time")}}
+                    {{- else if isDateOrDateTimeGenerated $value.Format }}
                         t, err := time.Parse(time.RFC3339, string(v))
                         if err != nil {
                             return msg, err
@@ -205,7 +205,7 @@ func (msg {{namify .Name}}) toBrokerMessage() (extensions.BrokerMessage, error)
             payload := make([]byte, 8)
             binary.BigEndian.PutUint64(payload, math.Float64bits(msg.Payload))
         {{- end}}
-    {{- else if and (eq $payload.Type "string") (and $payload.Format (or (eq $payload.Format "date") (eq $payload.Format "date-time")))}}
+    {{- else if and (eq $payload.Type "string") (isDateOrDateTimeGenerated $payload.Format) }}
         // Convert to RFC3339 and to []byte
         payload := []byte(msg.Payload.Format(time.RFC3339))
     {{- else}}
@@ -235,7 +235,7 @@ func (msg {{namify .Name}}) toBrokerMessage() (extensions.BrokerMessage, error)
                         return extensions.BrokerMessage{}, err
                     }
                     headers["{{$key}}"] = h
-                {{- else if or (eq $value.Format "date") (eq $value.Format "date-time")}}
+                {{- else if isDateOrDateTimeGenerated $value.Format }}
                     headers["{{$key}}"] = []byte(msg.Headers.{{namify $key}}.Format(time.RFC3339))
                 {{- else }}
                     headers["{{$key}}"] = []byte(msg.Headers.{{namify $key}})
@@ -248,7 +248,7 @@ func (msg {{namify .Name}}) toBrokerMessage() (extensions.BrokerMessage, error)
                             return extensions.BrokerMessage{}, err
                         }
                         headers["{{$key}}"] = h
-                    {{- else if or (eq $value.Format "date") (eq $value.Format "date-time")}}
+                    {{- else if isDateOrDateTimeGenerated $value.Format }}
                         headers["{{$key}}"] = []byte(msg.Headers.{{namify $key}}.Format(time.RFC3339))
                     {{- else }}
                         headers["{{$key}}"] = []byte(*msg.Headers.{{namify $key}})

diff --git a/pkg/codegen/generators/v3/templates/schema_definition.tmpl b/pkg/codegen/generators/v3/templates/schema_definition.tmpl
@@ -35,7 +35,7 @@ type {{ namify .Name }} struct {
 type {{ .Name }} {{template "schema-name" .}}
 
 {{/* Create specific marshaling for time */ -}}
-{{- if or (eq .Format "date") (eq .Format "date-time") -}}
+{{- if isDateOrDateTimeGenerated .Format -}}
     {{template "marshaling-time" .}}
 {{- end -}}
 

diff --git a/pkg/codegen/generators/v3/templates/schema_name.tmpl b/pkg/codegen/generators/v3/templates/schema_name.tmpl
@@ -16,9 +16,9 @@ bool
 
 {{- /* --------------------------- Type String -------------------------- */ -}}
 {{- else if eq .Type "string" -}}
-{{- if and .Format (eq .Format "date") -}}
+{{- if and (isDateOrDateTimeGenerated .Format) (eq .Format "date") -}}
 civil.Date
-{{- else if and .Format (eq .Format "date-time") -}}
+{{- else if and (isDateOrDateTimeGenerated .Format) (eq .Format "date-time") -}}
 time.Time
 {{- else -}}
 string

diff --git a/pkg/codegen/options/options.go b/pkg/codegen/options/options.go
@@ -32,4 +32,7 @@ type Options struct {
 	// NamingScheme defines the naming scheme for generated golang structs
 	// Supported values: camel, none
 	NamingScheme string
+
+	// IgnoreStringFormat states whether the properties' format (date, date-time) should impact the type in types
+	IgnoreStringFormat bool
 }
diff --git a/pkg/utils/template/helpers.go b/pkg/utils/template/helpers.go
@@ -144,18 +144,28 @@ func CutSuffix(s, suffix string) string {
 	return s
 }
 
+var isDateOrDateTimeGenerated = func(format string) bool {
+	return format == "date" || format == "date-time"
+}
+
+// DisableDateOrTimeGeneration is used to disable the generation of date/date-time formats within types.
+func DisableDateOrTimeGeneration() {
+	isDateOrDateTimeGenerated = func(_ string) bool { return false }
+}
+
 // HelpersFunctions returns the functions that can be used as helpers
 // in a golang template.
 func HelpersFunctions() template.FuncMap {
 	return template.FuncMap{
-		"namifyWithoutParam": NamifyWithoutParams,
-		"namify":             Namify,
-		"convertKey":         ConvertKey,
-		"snakeCase":          strcase.ToSnake,
-		"hasField":           HasField,
-		"describeStruct":     DescribeStruct,
-		"multiLineComment":   MultiLineComment,
-		"cutSuffix":          CutSuffix,
-		"args":               Args,
+		"namifyWithoutParam":        NamifyWithoutParams,
+		"namify":                    Namify,
+		"isDateOrDateTimeGenerated": isDateOrDateTimeGenerated,
+		"convertKey":                ConvertKey,
+		"snakeCase":                 strcase.ToSnake,
+		"hasField":                  HasField,
+		"describeStruct":            DescribeStruct,
+		"multiLineComment":          MultiLineComment,
+		"cutSuffix":                 CutSuffix,
+		"args":                      Args,
 	}
 }
diff --git a/test/v2/issues/255/asyncapi.yaml b/test/v2/issues/255/asyncapi.yaml
@@ -0,0 +1,17 @@
+asyncapi: 2.6.0
+info:
+  title: Sample App
+  version: 1.2.3
+
+components:
+  messages:
+    Test:
+      payload:
+        type: object
+        properties:
+          DateProp:
+            type: string
+            format: date
+          DateTimeProp:
+            type: string
+            format: date-time