Fix nested record traversal

Also updated test fixtures to cover the use case
frankgrimes97 · Dec 6, 2022 · 26776c8 · 26776c8
1 parent 3c9cfcd
commit 26776c8
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 10 deletions.
diff --git a/avrolint.js b/avrolint.js
@@ -104,7 +104,7 @@ let getRecordSchema = function(field) {
 
   const upperCaseFieldType = field.type.type?.toUpperCase();
   if (upperCaseFieldType === "RECORD") {
-    return field;
+    return field.type;
   } else if (upperCaseFieldType === "ARRAY" && field.type.items?.type?.toUpperCase() === "RECORD") {
     return field.type.items;
   } else if (upperCaseFieldType === "MAP" && field.type.values?.type?.toUpperCase() === "RECORD") {

diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/tests/fixtures/invalid-missing-docs.avsc b/tests/fixtures/invalid-missing-docs.avsc
@@ -8,6 +8,20 @@
        "name": "id",
        "type": "int"
       },
+      {
+       "name": "MyNestedRecord",
+       "type": {
+          "type": "record",
+          "name": "NestedRecordA",
+          "fields":
+            [
+              {
+                "name": "nestedId",
+                "type": "int"
+              }
+            ]
+          }
+      },
       {
         "name": "MyArrayOfNestedRecords",
         "type": {
@@ -46,7 +60,7 @@
        "name": "MyUnionNestedRecord",
        "type": [ "null", {
           "type": "record",
-          "name": "NestedRecordA",
+          "name": "NestedRecordD",
           "fields":
             [
               {

diff --git a/tests/fixtures/valid.avsc b/tests/fixtures/valid.avsc
@@ -9,13 +9,30 @@
        "type": "int",
        "doc": "My Record Identifier"
       },
+      {
+       "name": "MyNestedRecord",
+       "type": {
+          "type": "record",
+          "name": "NestedRecordA",
+          "fields":
+            [
+              {
+                "name": "nestedId",
+                "type": "int",
+                "doc": "My Record Identifier"
+              }
+            ],
+            "doc": "My Nested RecordA Identifier"
+          },
+        "doc": "My Nested Record"
+      },
       {
         "name": "MyArrayOfNestedRecords",
         "type": {
             "type": "array",
             "items": {
               "type": "record",
-              "name": "NestedRecordA",
+              "name": "NestedRecordB",
               "fields":
                 [
                   {
@@ -24,7 +41,7 @@
                     "doc": "My Record Identifier"
                   }
                 ],
-              "doc": "My Nested RecordA Identifier"
+              "doc": "My Nested RecordB Identifier"
             }
           },
           "doc": "My Array Of Nested Records"
@@ -35,7 +52,7 @@
             "type": "map",
             "values": {
               "type": "record",
-              "name": "NestedRecordB",
+              "name": "NestedRecordC",
               "fields":
                 [
                   {
@@ -44,7 +61,7 @@
                     "doc": "My Record Identifier"
                   }
                 ],
-              "doc": "My Nested RecordB Identifier"
+              "doc": "My Nested RecordC Identifier"
             }
           },
           "doc": "My Map Of Nested Records"
@@ -53,7 +70,7 @@
        "name": "MyUnionNestedRecord",
        "type": [ "null", {
           "type": "record",
-          "name": "NestedRecordC",
+          "name": "NestedRecordD",
           "fields":
             [
               {
@@ -62,7 +79,7 @@
                 "doc": "My Record Identifier"
               }
             ],
-            "doc": "My Nested RecordC Identifier"
+            "doc": "My Nested RecordD Identifier"
           }],
         "doc": "My Union Of Nested Record"
       }

diff --git a/tests/index.test.js b/tests/index.test.js
@@ -57,6 +57,8 @@ test('throws error on invalid AVSC file with missing docs', async () => {
 
   const expectedErrorMessage = `Invalid Schema at '${fileName}'! The following fields are not documented:
   com.samsung.ads.MyRecord.id
+  com.samsung.ads.MyRecord.MyNestedRecord
+  com.samsung.ads.MyRecord.MyNestedRecord.nestedId
   com.samsung.ads.MyRecord.MyArrayOfNestedRecords
   com.samsung.ads.MyRecord.MyArrayOfNestedRecords.nestedId
   com.samsung.ads.MyRecord.MyMapOfNestedRecords
@@ -75,6 +77,8 @@ test('throws error on multiple invalid AVSC files with missing docs', async () =
 
   const expectedErrorMessage = `Invalid Schema at '${fileName}'! The following fields are not documented:
   com.samsung.ads.MyRecord.id
+  com.samsung.ads.MyRecord.MyNestedRecord
+  com.samsung.ads.MyRecord.MyNestedRecord.nestedId
   com.samsung.ads.MyRecord.MyArrayOfNestedRecords
   com.samsung.ads.MyRecord.MyArrayOfNestedRecords.nestedId
   com.samsung.ads.MyRecord.MyMapOfNestedRecords
@@ -95,6 +99,8 @@ test('throws error on invalid AVSC files, one valid and one with missing docs',
 
   const expectedErrorMessage = `Invalid Schema at '${fileNameInvalid}'! The following fields are not documented:
   com.samsung.ads.MyRecord.id
+  com.samsung.ads.MyRecord.MyNestedRecord
+  com.samsung.ads.MyRecord.MyNestedRecord.nestedId
   com.samsung.ads.MyRecord.MyArrayOfNestedRecords
   com.samsung.ads.MyRecord.MyArrayOfNestedRecords.nestedId
   com.samsung.ads.MyRecord.MyMapOfNestedRecords
@@ -129,6 +135,8 @@ test('throws error on multiple invalid AVSC files', async () => {
 
   const expectedErrorMessage1 = `Invalid Schema at '${fileName1}'! The following fields are not documented:
   com.samsung.ads.MyRecord.id
+  com.samsung.ads.MyRecord.MyNestedRecord
+  com.samsung.ads.MyRecord.MyNestedRecord.nestedId
   com.samsung.ads.MyRecord.MyArrayOfNestedRecords
   com.samsung.ads.MyRecord.MyArrayOfNestedRecords.nestedId
   com.samsung.ads.MyRecord.MyMapOfNestedRecords