Add test cases for structs with optional fields

grafana · Sep 13, 2023 · 666c010 · 666c010
1 parent d86b5b6
commit 666c010
Show file tree

Hide file tree

Showing 4 changed files with 151 additions and 3 deletions.
diff --git a/internal/jennies/typescript/rawtypes.go b/internal/jennies/typescript/rawtypes.go
@@ -133,8 +133,6 @@ func formatField(def ast.StructField, typesPkg string) []byte {
 }
 
 func formatType(def ast.Type, typesPkg string) string {
-	// todo: handle nullable
-	// maybe if nullable, append | null to the type?
 	switch def.Kind {
 	case ast.KindDisjunction:
 		return formatDisjunction(def.AsDisjunction(), typesPkg)
@@ -236,7 +234,6 @@ func formatScalar(val any) string {
 			items = append(items, formatScalar(item))
 		}
 
-		// TODO: we can't assume a list of strings
 		return fmt.Sprintf("[%s]", strings.Join(items, ", "))
 	}
 

diff --git a/testdata/jennies/rawtypes/disjunctions.txtar b/testdata/jennies/rawtypes/disjunctions.txtar
@@ -23,6 +23,25 @@
             }
         },
 
+        {
+            "Name": "StringOrNull",
+            "Type": {
+                "Kind": "disjunction",
+                "Disjunction": {
+                    "Branches": [
+                        {
+                            "Kind": "scalar",
+                            "Scalar": {"ScalarKind": "string"}
+                        },
+                        {
+                            "Kind": "scalar",
+                            "Scalar": {"ScalarKind": "null"}
+                        }
+                    ]
+                }
+            }
+        },
+
         {
             "Name": "SomeStruct",
             "Type": {
@@ -124,6 +143,8 @@
 // Refresh rate or disabled.
 export type StringOrBool = string | boolean;
 
+export type StringOrNull = string | null;
+
 export interface SomeStruct {
 	fieldAny: any;
 }

diff --git a/testdata/jennies/rawtypes/struct_with_optional_fields.txtar b/testdata/jennies/rawtypes/struct_with_optional_fields.txtar
@@ -0,0 +1,127 @@
+# Basic struct with scalar fields, all required.
+-- ir.json --
+{
+    "Package": "struct_optional_fields",
+    "Definitions": [
+        {
+            "Name": "SomeStruct",
+            "Type": {
+                "Kind": "struct",
+                "Struct": {
+                    "Fields": [
+                        {
+                            "Name": "FieldRef",
+                            "Required": false,
+                            "Type": {
+                                "Kind": "ref",
+                                "Ref": {"ReferredType": "SomeOtherStruct"}
+                            }
+                        },
+                        {
+                            "Name": "FieldString",
+                            "Required": false,
+                            "Type": {
+                                "Kind": "scalar",
+                                "Scalar": {"ScalarKind": "string"}
+                            }
+                        },
+                        {
+                            "Name": "FieldAnonymousEnum",
+                            "Required": false,
+                            "Type": {
+                                "Kind": "enum",
+                                "Enum": {
+                                    "Values": [
+                                        {
+                                            "Name": "GreaterThan",
+                                            "Type": {
+                                                "Kind": "scalar",
+                                                "Scalar": {"ScalarKind": "string"}
+                                            },
+                                            "Value": ">"
+                                        },
+                                        {
+                                            "Name": "LessThan",
+                                            "Type": {
+                                                "Kind": "scalar",
+                                                "Scalar": {"ScalarKind": "string"}
+                                            },
+                                            "Value": "<"
+                                        }
+                                    ]
+                                }
+                            }
+                        },
+                        {
+                            "Name": "FieldArrayOfStrings",
+                            "Required": false,
+                            "Type": {
+                                "Kind": "array",
+                                "Array": {
+                                    "ValueType": {
+                                        "Kind": "scalar",
+                                        "Scalar": {"ScalarKind": "string"}
+                                    }
+                                }
+                            }
+                        },
+                        {
+                            "Name": "FieldAnonymousStruct",
+                            "Required": false,
+                            "Type": {
+                                "Kind": "struct",
+                                "Struct": {
+                                    "Fields": [
+                                        {
+                                            "Name": "FieldAny",
+                                            "Required": true,
+                                            "Type": {
+                                                "Kind": "scalar",
+                                                "Scalar": {"ScalarKind": "any"}
+                                            }
+                                        }
+                                    ]
+                                }
+                            }
+                        }
+                    ]
+                }
+            }
+        },
+
+        {
+            "Name": "SomeOtherStruct",
+            "Type": {
+                "Kind": "struct",
+                "Struct": {
+                    "Fields": [
+                        {
+                            "Name": "FieldAny",
+                            "Required": true,
+                            "Type": {
+                                "Kind": "scalar",
+                                "Scalar": {"ScalarKind": "any"}
+                            }
+                        }
+                    ]
+                }
+            }
+        }
+    ]
+}
+-- out/jennies/TypescriptRawTypes --
+== types/struct_optional_fields/types_gen.ts
+export interface SomeStruct {
+	fieldRef?: SomeOtherStruct;
+	fieldString?: string;
+	fieldAnonymousEnum?: ">" | "<";
+	fieldArrayOfStrings?: string[];
+	fieldAnonymousStruct?: {
+		fieldAny: any;
+	};
+}
+
+export interface SomeOtherStruct {
+	fieldAny: any;
+}
+
diff --git a/testdata/jennies/rawtypes/struct_with_scalar_fields.txtar b/testdata/jennies/rawtypes/struct_with_scalar_fields.txtar
@@ -13,6 +13,7 @@
                         {
                             "Name": "FieldAny",
                             "Required": true,
+                            "Comments": ["Anything can go in there.", "Really, anything."],
                             "Type": {
                                 "Kind": "scalar",
                                 "Scalar": {"ScalarKind": "any"}
@@ -139,6 +140,8 @@
 // a
 // comment
 export interface SomeStruct {
+	// Anything can go in there.
+	// Really, anything.
 	fieldAny: any;
 	fieldBool: boolean;
 	fieldBytes: string;