fix(service-spec): skip adding a resource property that could not be …

…resolved
cdklabs · Dec 18, 2024 · 895cddc · 895cddc
1 parent 76fa496
commit 895cddc
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 9 deletions.
diff --git a/packages/@aws-cdk/service-spec-importers/src/importers/import-cloudformation-registry.ts b/packages/@aws-cdk/service-spec-importers/src/importers/import-cloudformation-registry.ts
@@ -71,16 +71,22 @@ export function importCloudFormationRegistryResource(options: LoadCloudFormation
     const required = calculateDefinitelyRequired(source);
 
     for (const [name, property] of Object.entries(source.properties)) {
-      let resolvedSchema = resolve(property);
-
-      withResult(schemaTypeToModelType(name, resolvedSchema, fail.in(`property ${name}`)), (type) => {
-        target.setProperty(name, {
-          type,
-          documentation: descriptionOf(resolvedSchema),
-          required: required.has(name),
-          defaultValue: describeDefault(resolvedSchema),
+      try {
+        let resolvedSchema = resolve(property);
+        withResult(schemaTypeToModelType(name, resolvedSchema, fail.in(`property ${name}`)), (type) => {
+          target.setProperty(name, {
+            type,
+            documentation: descriptionOf(resolvedSchema),
+            required: required.has(name),
+            defaultValue: describeDefault(resolvedSchema),
+          });
         });
-      });
+      } catch (e) {
+        report.reportFailure(
+          'interpreting',
+          fail(`Skip generating property ${name} for resource ${resource.typeName} because of ${e}`),
+        );
+      }
     }
   }
 

diff --git a/packages/@aws-cdk/service-spec-importers/test/cloudformation-registry.test.ts b/packages/@aws-cdk/service-spec-importers/test/cloudformation-registry.test.ts
@@ -84,6 +84,38 @@ test('type definitions in deprecated properties do not fail', () => {
   // THEN: no failure
 });
 
+test('referring to non-exist type do not fail', () => {
+  importCloudFormationRegistryResource({
+    db,
+    report,
+    resource: {
+      typeName: 'AWS::Some::Type',
+      description: 'resource with property has type non exist',
+      properties: {
+        id: { $ref: '#/definitions/Type' },
+        prop: { $ref: '#/definitions/NotExistType' },
+        prop2: { $ref: '#/definitions/Type' },
+      },
+      definitions: {
+        Type: {
+          type: 'object',
+          properties: {
+            id: {
+              type: 'string',
+            },
+          },
+        },
+      },
+    },
+  });
+
+  // THEN:
+  const resource = db.lookup('resource', 'cloudFormationType', 'equals', 'AWS::Some::Type').only();
+  expect(Object.keys(resource.properties)).toContain('id');
+  expect(Object.keys(resource.properties)).toContain('prop2');
+  expect(Object.keys(resource.properties)).not.toContain('prop');
+});
+
 test('empty objects are treated as "any"', () => {
   importCloudFormationRegistryResource({
     db,