fix: support indexed circular access (#1593)

fixes #1276
vega · Mar 3, 2023 · fc08d89 · fc08d89
1 parent 9b2b4bd
commit fc08d89
Show file tree

Hide file tree

Showing 8 changed files with 58 additions and 15 deletions.
diff --git a/src/NodeParser/IndexedAccessTypeNodeParser.ts b/src/NodeParser/IndexedAccessTypeNodeParser.ts
@@ -6,6 +6,7 @@ import { BaseType } from "../Type/BaseType";
 import { LiteralType } from "../Type/LiteralType";
 import { NeverType } from "../Type/NeverType";
 import { NumberType } from "../Type/NumberType";
+import { ReferenceType } from "../Type/ReferenceType";
 import { StringType } from "../Type/StringType";
 import { TupleType } from "../Type/TupleType";
 import { UnionType } from "../Type/UnionType";
@@ -67,6 +68,9 @@ export class IndexedAccessTypeNodeParser implements SubNodeParser {
                 if (type instanceof NumberType && objectType instanceof TupleType) {
                     return new UnionType(objectType.getTypes());
                 } else if (type instanceof LiteralType) {
+                    if (objectType instanceof ReferenceType) {
+                        return objectType;
+                    }
                     throw new LogicError(`Invalid index "${type.getValue()}" in type "${objectType.getId()}"`);
                 } else {
                     throw new LogicError(`No additional properties in type "${objectType.getId()}"`);

diff --git a/src/Type/ReferenceType.ts b/src/Type/ReferenceType.ts
@@ -36,6 +36,10 @@ export class ReferenceType extends BaseType {
         return this.type;
     }
 
+    public hasType(): boolean {
+        return this.type != null;
+    }
+
     public setType(type: BaseType): void {
         this.type = type;
         this.setId(type.getId());

diff --git a/src/Utils/derefType.ts b/src/Utils/derefType.ts
@@ -4,13 +4,14 @@ import { BaseType } from "../Type/BaseType";
 import { DefinitionType } from "../Type/DefinitionType";
 import { ReferenceType } from "../Type/ReferenceType";
 
+/**
+ * Dereference the type as far as possible.
+ */
 export function derefType(type: BaseType): BaseType {
-    if (
-        type instanceof ReferenceType ||
-        type instanceof DefinitionType ||
-        type instanceof AliasType ||
-        type instanceof AnnotatedType
-    ) {
+    if (type instanceof DefinitionType || type instanceof AliasType || type instanceof AnnotatedType) {
+        return derefType(type.getType());
+    }
+    if (type instanceof ReferenceType && type.hasType()) {
         return derefType(type.getType());
     }
 

diff --git a/test/valid-data-type.test.ts b/test/valid-data-type.test.ts
@@ -82,6 +82,7 @@ describe("valid-data-type", () => {
         assertMissingFormatterFor(new FunctionType(), "type-indexed-access-method-signature", "MyType")
     );
     it("type-indexed-circular-access", assertValidSchema("type-indexed-circular-access", "*"));
+    it("type-indexed-circular", assertValidSchema("type-indexed-circular", "MyType"));
     it("type-keyof-tuple", assertValidSchema("type-keyof-tuple", "MyType"));
     it("type-keyof-object", assertValidSchema("type-keyof-object", "MyType"));
     it("type-keyof-object-function", assertValidSchema("type-keyof-object-function", "MyType"));

diff --git a/test/valid-data/string-template-expression-literals/schema.json b/test/valid-data/string-template-expression-literals/schema.json
@@ -13,6 +13,13 @@
           ],
           "type": "string"
         },
+        "bool": {
+          "enum": [
+            "true!",
+            "false!"
+          ],
+          "type": "string"
+        },
         "foo": {
           "enum": [
             "ok",
@@ -21,15 +28,11 @@
           ],
           "type": "string"
         },
-        "ok": {
-          "const": "id_ok",
-          "type": "string"
-        },
         "num": {
           "type": "string"
         },
-        "bool": {
-          "enum": ["true!", "false!"],
+        "ok": {
+          "const": "id_ok",
           "type": "string"
         }
       },

diff --git a/test/valid-data/type-indexed-circular/main.ts b/test/valid-data/type-indexed-circular/main.ts
@@ -0,0 +1,9 @@
+export interface GeoJsonObject {
+    type: GeometryCollection["type"];
+}
+
+export interface GeometryCollection extends GeoJsonObject {
+    type: "GeometryCollection";
+}
+
+export type MyType = GeometryCollection;
diff --git a/test/valid-data/type-indexed-circular/schema.json b/test/valid-data/type-indexed-circular/schema.json
@@ -0,0 +1,22 @@
+{
+  "$ref": "#/definitions/MyType",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "GeometryCollection": {
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "const": "GeometryCollection",
+          "type": "string"
+        }
+      },
+      "required": [
+        "type"
+      ],
+      "type": "object"
+    },
+    "MyType": {
+      "$ref": "#/definitions/GeometryCollection"
+    }
+  }
+}
diff --git a/test/vega-lite.test.ts b/test/vega-lite.test.ts
@@ -6,16 +6,15 @@ import stringify from "safe-stable-stringify";
 
 describe("vega-lite", () => {
     it("schema", () => {
-        const type = "TopLevelSpec";
         const config: Config = {
             path: `node_modules/vega-lite/src/index.ts`,
-            type,
+            type: "TopLevelSpec",
             encodeRefs: false,
             skipTypeCheck: true,
         };
 
         const generator = createGenerator(config);
-        const schema = generator.createSchema(type);
+        const schema = generator.createSchema(config.type);
         const schemaFile = resolve("test/vega-lite/schema.json");
 
         if (process.env.UPDATE_SCHEMA) {