fix(cli): sanitize type arrays

some providers sporadically return them double leading to errors in cdktf convert and get
hashicorp · Apr 2, 2024 · af6d921 · af6d921
1 parent 84dc27e
commit af6d921
Show file tree

Hide file tree

Showing 4 changed files with 282 additions and 51 deletions.
diff --git a/packages/@cdktf/provider-schema/src/__tests__/__snapshots__/provider-schema.test.ts.snap b/packages/@cdktf/provider-schema/src/__tests__/__snapshots__/provider-schema.test.ts.snap
@@ -752,3 +752,113 @@ exports[`readSchema generates a single provider schema 1`] = `
   }
 }"
 `;
+
+exports[`sanitizeProviderSchema sanitizes a provider schema 1`] = `
+{
+  "format_version": "0.1",
+  "provider_schemas": {
+    "registry.terraform.io/hashicorp/null": {
+      "data_source_schemas": {},
+      "provider": {
+        "block": {
+          "attributes": {
+            "correct": {
+              "type": [
+                "list",
+                "string",
+              ],
+            },
+            "incorrect": {
+              "type": [
+                "list",
+                "string",
+              ],
+            },
+            "version": {
+              "required": true,
+              "type": "string",
+            },
+          },
+          "block_types": {
+            "triggers": {
+              "block": {
+                "attributes": {
+                  "correct": {
+                    "type": [
+                      "list",
+                      "string",
+                    ],
+                  },
+                  "incorrect": {
+                    "type": [
+                      "list",
+                      "string",
+                    ],
+                  },
+                },
+                "block_types": {},
+              },
+              "nesting_mode": "single",
+            },
+          },
+        },
+        "version": 0,
+      },
+      "resource_schemas": {
+        "null_resource": {
+          "block": {
+            "attributes": {
+              "correct": {
+                "type": [
+                  "list",
+                  "string",
+                ],
+              },
+              "id": {
+                "computed": true,
+                "type": "string",
+              },
+              "incorrect": {
+                "type": [
+                  "list",
+                  "string",
+                ],
+              },
+            },
+            "block_types": {
+              "triggers": {
+                "block": {
+                  "attributes": {
+                    "correct": {
+                      "type": [
+                        "list",
+                        "string",
+                      ],
+                    },
+                    "incorrect": {
+                      "type": [
+                        "list",
+                        "string",
+                      ],
+                    },
+                    "triggers": {
+                      "optional": true,
+                      "type": "string",
+                    },
+                  },
+                  "block_types": {},
+                },
+                "nesting_mode": "single",
+              },
+            },
+          },
+          "version": 0,
+        },
+      },
+    },
+  },
+  "provider_versions": {
+    "registry.terraform.io/hashicorp/null": "3.1.0",
+  },
+}
+`;
diff --git a/packages/@cdktf/provider-schema/src/__tests__/provider-schema.test.ts b/packages/@cdktf/provider-schema/src/__tests__/provider-schema.test.ts
@@ -9,8 +9,13 @@ import {
   ConstructsMakerModuleTarget,
   ConstructsMakerProviderTarget,
   Language,
+  ProviderSchema,
 } from "@cdktf/commons";
-import { readModuleSchema, readProviderSchema } from "../provider-schema";
+import {
+  readModuleSchema,
+  readProviderSchema,
+  sanitizeProviderSchema,
+} from "../provider-schema";
 
 function sanitizeJson(value: any) {
   value["format_version"] = "STUBBED VERSION";
@@ -70,3 +75,94 @@ describe("readSchema", () => {
     expect(sanitizeJson(result)).toMatchSnapshot();
   }, 120000);
 });
+
+describe("sanitizeProviderSchema", () => {
+  it("sanitizes a provider schema", () => {
+    const schema: ProviderSchema = {
+      format_version: "0.1" as const,
+      provider_versions: {
+        "registry.terraform.io/hashicorp/null": "3.1.0",
+      },
+      provider_schemas: {
+        "registry.terraform.io/hashicorp/null": {
+          provider: {
+            version: 0,
+            block: {
+              attributes: {
+                version: {
+                  type: "string",
+                  required: true,
+                },
+                correct: {
+                  type: ["list", "string"],
+                },
+                incorrect: {
+                  type: ["list", "string", "list", "string"] as any,
+                },
+              },
+              block_types: {
+                triggers: {
+                  nesting_mode: "single",
+                  block: {
+                    attributes: {
+                      correct: {
+                        type: ["list", "string"],
+                      },
+                      incorrect: {
+                        type: ["list", "string", "list", "string"] as any,
+                      },
+                    },
+                    block_types: {},
+                  },
+                },
+              },
+            },
+          },
+          resource_schemas: {
+            null_resource: {
+              version: 0,
+              block: {
+                attributes: {
+                  id: {
+                    type: "string",
+                    computed: true,
+                  },
+                  correct: {
+                    type: ["list", "string"],
+                  },
+                  incorrect: {
+                    type: ["list", "string", "list", "string"] as any,
+                  },
+                },
+                block_types: {
+                  triggers: {
+                    nesting_mode: "single",
+                    block: {
+                      attributes: {
+                        triggers: {
+                          type: "string",
+                          optional: true,
+                        },
+                        correct: {
+                          type: ["list", "string"],
+                        },
+                        incorrect: {
+                          type: ["list", "string", "list", "string"] as any,
+                        },
+                      },
+                      block_types: {},
+                    },
+                  },
+                },
+              },
+            },
+          },
+          data_source_schemas: {},
+        },
+      },
+    };
+
+    const result = sanitizeProviderSchema(schema);
+    expect(result).toMatchSnapshot();
+  });
+});
diff --git a/packages/@cdktf/provider-schema/src/provider-schema.ts b/packages/@cdktf/provider-schema/src/provider-schema.ts
@@ -5,6 +5,9 @@ import * as path from "path";
 
 import { convertFiles } from "@cdktf/hcl2json";
 import {
+  Attribute,
+  AttributeType,
+  Block,
   ConstructsMakerModuleTarget,
   ConstructsMakerProviderTarget,
   Input,
@@ -14,6 +17,7 @@ import {
   TerraformModuleConstraint,
   VersionSchema,
   exec,
+  isNestedTypeAttribute,
   withTempDir,
 } from "@cdktf/commons";
 
@@ -208,7 +212,49 @@ export async function readProviderSchema(
     providerSchema.provider_versions = versionSchema.provider_selections;
   });
 
-  return providerSchema;
+  return sanitizeProviderSchema(providerSchema);
+}
+
+// The providers have some potential bugs that we want to pro-actively
+// fix here so that the rest of the code can assume a consistent schema.
+export function sanitizeProviderSchema(schema: ProviderSchema): ProviderSchema {
+  // Mainly some attributes are "doubled", e.g. ["list", "string", "list", "string"]
+  // instead of ["list", "string"]
+  function attributeDoublingFix(attribute: Attribute): Attribute {
+    if (isNestedTypeAttribute(attribute) || !Array.isArray(attribute.type)) {
+      return attribute;
+    }
+
+    const type =
+      attribute.type.length === 2
+        ? attribute.type
+        : (attribute.type as string[]).slice(0, 2); // The types tell us this can't happen, reality begs to differ
+
+    attribute.type = type as AttributeType;
+    return attribute;
+  }
+
+  // Mutates block with the fix
+  function sanitizeBlock(block: Block) {
+    Object.values(block.attributes || {}).forEach(attributeDoublingFix);
+    Object.values(block.block_types || {}).forEach((blockType) => {
+      sanitizeBlock(blockType.block);
+    });
+  }
+
+  Object.values(schema.provider_schemas || {}).forEach((provider) => {
+    const entities = [
+      provider.provider,
+      ...Object.values(provider.resource_schemas || {}),
+      ...Object.values(provider.data_source_schemas || {}),
+    ];
+
+    entities.forEach((entity) => {
+      sanitizeBlock(entity.block);
+    });
+  });
+
+  return schema;
 }
 
 export async function readModuleSchema(target: ConstructsMakerModuleTarget) {