Fix populating any type (#947)

* Fix populating any type Strcuts with fields of any type were always sending a JSON null as the address of the field was never nil. Reverted rawjson-as-bytes for some test cases to see and test changes. * improve test * further test refinement * bump version for upcoming release
Azure · Apr 10, 2023 · 959ddb7 · 959ddb7
1 parent 7ab7dc3
commit 959ddb7
Show file tree

Hide file tree

Showing 13 changed files with 1,863 additions and 1,787 deletions.
diff --git a/.scripts/regeneration.js b/.scripts/regeneration.js
@@ -100,7 +100,7 @@ const network = 'https://raw.githubusercontent.com/Azure/azure-rest-api-specs/22
 generateFromReadme("armnetwork", network, 'package-2020-03', 'test/network/2020-03-01/armnetwork', '--module=armnetwork --azure-arm=true --remove-unreferenced-types');
 
 const compute = 'https://raw.githubusercontent.com/Azure/azure-rest-api-specs/228cf296647f6e41182cee7d1a403990e6a8fe3c/specification/compute/resource-manager/readme.md';
-generateFromReadme("armcompute", compute, 'package-2019-12-01', 'test/compute/2019-12-01/armcompute', '--module=armcompute --azure-arm=true --remove-unreferenced-types --rawjson-as-bytes');
+generateFromReadme("armcompute", compute, 'package-2019-12-01', 'test/compute/2019-12-01/armcompute', '--module=armcompute --azure-arm=true --remove-unreferenced-types');
 
 const synapseArtifacts = 'https://raw.githubusercontent.com/Azure/azure-rest-api-specs/228cf296647f6e41182cee7d1a403990e6a8fe3c/specification/synapse/data-plane/readme.md';
 generateFromReadme("azartifacts", synapseArtifacts, 'package-artifacts-2019-06-01-preview', 'test/synapse/2019-06-01/azartifacts', '--security=AADToken --security-scopes="https://dev.azuresynapse.net/.default" --module="azartifacts" --openapi-type="data-plane"');
@@ -123,7 +123,7 @@ generateFromReadme("armdataboxedge", databoxedge, 'package-2021-02-01', 'test/da
 const acr = 'https://github.com/Azure/azure-rest-api-specs/blob/195cd610db0accd0422c3e00a72df739ab4de677/specification/containerregistry/data-plane/Azure.ContainerRegistry/stable/2021-07-01/containerregistry.json';
 generate("azacr", acr, 'test/acr/2021-07-01/azacr', '--module="azacr" --openapi-type="data-plane" --rawjson-as-bytes');
 
-generate("azalias", 'test/swagger/alias.json', 'test/maps/azalias', '--security=AzureKey --module="azalias" --openapi-type="data-plane" --rawjson-as-bytes');
+generate("azalias", 'test/swagger/alias.json', 'test/maps/azalias', '--security=AzureKey --module="azalias" --openapi-type="data-plane"');
 
 function should_generate(name) {
     if (filter !== undefined) {

diff --git a/src/generator/models.ts b/src/generator/models.ts
@@ -37,6 +37,7 @@ export async function generateModels(session: Session<CodeModel>): Promise<model
   let needsJSONPopulate = false;
   let needsJSONUnpopulate = false;
   let needsJSONPopulateByteArray = false;
+  let needsJSONPopulateAny = false;
   let serdeTextBody = '';
   structs.sort((a: StructDef, b: StructDef) => { return sortAscending(a.Language.name, b.Language.name) });
   for (const struct of values(structs)) {
@@ -65,6 +66,9 @@ export async function generateModels(session: Session<CodeModel>): Promise<model
     if (struct.HasJSONByteArray) {
       needsJSONPopulateByteArray = true;
     }
+    if (struct.HasAny) {
+      needsJSONPopulateAny = true;
+    }
   }
   if (needsJSONPopulate) {
     serdeTextBody += 'func populate(m map[string]any, k string, v any) {\n';
@@ -77,6 +81,17 @@ export async function generateModels(session: Session<CodeModel>): Promise<model
     serdeTextBody += '\t}\n';
     serdeTextBody += '}\n\n';
   }
+  if (needsJSONPopulateAny) {
+    serdeTextBody += 'func populateAny(m map[string]any, k string, v any) {\n';
+    serdeTextBody += '\tif v == nil {\n';
+    serdeTextBody += '\t\treturn\n';
+    serdeTextBody += '\t} else if azcore.IsNullValue(v) {\n';
+    serdeTextBody += '\t\tm[k] = nil\n';
+    serdeTextBody += '\t} else {\n';
+    serdeTextBody += '\t\tm[k] = v\n';
+    serdeTextBody += '\t}\n';
+    serdeTextBody += '}\n\n';
+  }
   if (needsJSONPopulateByteArray) {
     serdeImports.add('github.com/Azure/azure-sdk-for-go/sdk/azcore/runtime');
     serdeTextBody += 'func populateByteArray(m map[string]any, k string, b []byte, f runtime.Base64Encoding) {\n';
@@ -262,14 +277,12 @@ function generateJSONMarshallerBody(obj: ObjectSchema, structDef: StructDef, imp
         marshaller += `\tif ${receiver}.${prop.language.go!.name} == nil {\n\t\t${receiver}.${prop.language.go!.name} = to.Ptr(${getClientDefaultValue(prop)})\n\t}\n`;
       }
       let populate = 'populate';
-      let addr = '';
       if (prop.schema.language.go!.internalTimeType) {
         populate += capitalize(prop.schema.language.go!.internalTimeType);
       } else if (prop.schema.type === SchemaType.Any) {
-        // for fields that are any we pass their address so populate() IsNil() doesn't panic
-        addr = '&';
+        populate += 'Any';
       }
-      marshaller += `\t${populate}(objectMap, "${prop.serializedName}", ${addr}${receiver}.${prop.language.go!.name})\n`;
+      marshaller += `\t${populate}(objectMap, "${prop.serializedName}", ${receiver}.${prop.language.go!.name})\n`;
     }
   }
   if (addlProps) {

diff --git a/src/generator/structs.ts b/src/generator/structs.ts
@@ -26,6 +26,7 @@ export class StructDef {
   readonly Methods: StructMethod[];
   readonly ComposedOf: string[];
   HasJSONByteArray: boolean;
+  HasAny: boolean;
 
   constructor(language: Language, props?: Property[], params?: Parameter[]) {
     this.Language = language;
@@ -41,6 +42,7 @@ export class StructDef {
     this.Methods = new Array<StructMethod>();
     this.ComposedOf = new Array<string>();
     this.HasJSONByteArray = false;
+    this.HasAny = false;
   }
 
   text(): string {
@@ -167,6 +169,8 @@ export function generateStruct(imports: ImportManager, lang: Language, props?: P
     imports.addImportForSchemaType(prop.schema);
     if (prop.language.go!.embeddedType) {
       st.ComposedOf.push(prop.schema.language.go!.name);
+    } else if (prop.schema.type === SchemaType.Any && !prop.schema.language.go!.rawJSONAsBytes) {
+      st.HasAny = true;
     }
   }
   return st;

diff --git a/src/package.json b/src/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@autorest/go",
-  "version": "4.0.0-preview.47",
+  "version": "4.0.0-preview.48",
   "description": "AutoRest Go Generator",
   "main": "dist/exports.js",
   "typings": "dist/exports.d.ts",

diff --git a/test/compute/2019-12-01/armcompute/zz_models.go b/test/compute/2019-12-01/armcompute/zz_models.go
diff --git a/test/compute/2019-12-01/armcompute/zz_models_serde.go b/test/compute/2019-12-01/armcompute/zz_models_serde.go
diff --git a/test/maps/azalias/models_test.go b/test/maps/azalias/models_test.go
@@ -15,16 +15,13 @@ func TestPolicyAssignmentProperties(t *testing.T) {
 		t.Fatal(err)
 	}
 	var s string
-	if err := json.Unmarshal(paprops.Parameters["effect"].Value, &s); err != nil {
-		t.Fatal(err)
-	}
+	s, ok := paprops.Parameters["effect"].Value.(string)
+	require.True(t, ok)
 	if s != "Audit" {
 		t.Fatalf("got %s, want Audit", s)
 	}
-	sl := []string{}
-	if err := json.Unmarshal(paprops.Parameters["listOfResourceTypesNotAllowed"].Value, &sl); err != nil {
-		t.Fatal(err)
-	}
+	sl, ok := paprops.Parameters["listOfResourceTypesNotAllowed"].Value.([]any)
+	require.True(t, ok)
 	if len(sl) != 1 {
 		t.Fatal("unexpected slice len")
 	}
@@ -35,10 +32,8 @@ func TestPolicyAssignmentProperties(t *testing.T) {
 	if !ok {
 		t.Fatal("missing one")
 	}
-	mm := map[string]any{}
-	if err := json.Unmarshal(m.Value, &mm); err != nil {
-		t.Fatal(err)
-	}
+	mm, ok := m.Value.(map[string]any)
+	require.True(t, ok)
 	if v := mm["key"]; v != "value" {
 		t.Fatalf("got %s want value", v)
 	}

diff --git a/test/maps/azalias/polymorphic_helpers_test.go b/test/maps/azalias/polymorphic_helpers_test.go
@@ -6,7 +6,9 @@ import (
 	"testing"
 	"time"
 
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
+	"github.com/stretchr/testify/require"
 )
 
 func TestGeoObjectNamedCollectionRoundTrip(t *testing.T) {
@@ -96,7 +98,7 @@ func TestInterfaceRoundTrip(t *testing.T) {
 	props1 := ScheduleCreateOrUpdateProperties{
 		Aliases:     []*string{to.Ptr("foo")},
 		Description: to.Ptr("funky"),
-		Interval:    []byte("false"),
+		Interval:    false,
 		StartTime:   to.Ptr(time.Now().UTC()),
 	}
 	b, err := json.Marshal(props1)
@@ -114,8 +116,10 @@ func TestInterfaceRoundTrip(t *testing.T) {
 	if *props1.Description != *props2.Description {
 		t.Fatalf("expected %v, got %v", *props1.Description, *props2.Description)
 	}
-	i1 := string(props1.Interval)
-	i2 := string(props2.Interval)
+	i1, ok := props1.Interval.(bool)
+	require.True(t, ok)
+	i2, ok := props2.Interval.(bool)
+	require.True(t, ok)
 	if i1 != i2 {
 		t.Fatalf("expected %v, got %v", props1.Interval, props2.Interval)
 	}
@@ -154,3 +158,13 @@ func TestInterfaceNil(t *testing.T) {
 		t.Fatal("expected nil Aliases")
 	}
 }
+
+func TestInterfaceJSONNull(t *testing.T) {
+	props1 := TypeWithRawJSON{
+		AnyObject: azcore.NullValue[*any](),
+	}
+	b, err := json.Marshal(props1)
+	require.NoError(t, err)
+	require.Contains(t, string(b), `"anyObject":null`)
+	require.NotContains(t, string(b), "anything")
+}