fix(ibm-api-symmetry): allow for dictionary properties when appropriate

Before, this rule took a strict approach to dictionaries - any dictionary
defined on a variant schema could cause the rule to produce a warning.
However, in cases where the dictionary property actually matches a
dictionary property on the canonical schema, this is too strict. When
canonical/variant schemas have identical dictionary schemas, we should
not disqualify the variant from being a graph fragment of the canonical.

Signed-off-by: Dustin Popp <[email protected]>

Author: dpopp07

packages/ruleset/src/functions/api-symmetry.js

@@ -3,6 +3,8 @@
  * SPDX-License-Identifier: Apache2.0
  */
 
+const { isEqual } = require('lodash');
+
 const {
   getSchemaType,
   isObject,
@@ -128,7 +130,8 @@ function checkApiForSymmetry(apidef, nodes) {
 /**
  * Determine if the variant schema is indeed a proper graph fragment of the
  * canonical schema, using the following conditions:
- * - The variant does not define additional or pattern properties
+ * - The variant does not define additional or pattern properties that are not
+ *   defined identically on the canonical schema.
  * - The variant does not define any properties that do not exist on the
  *   canonical schema (exists = present and has same type)
  * - The variant omits at least one property from the canonical schema
@@ -163,17 +166,23 @@ function checkForGraphFragmentPattern(
     );
     let result = true;
 
-    // A variant schema cannot allow extraneous properties and still be
-    // an explicit graph fragment of the canonical schema.
-    if (variant.additionalProperties) {
+    // A variant schema cannot allow extraneous properties that aren't allowed
+    // on the canonical schema and still be a graph fragment.
+    if (
+      variant.additionalProperties &&
+      !isEqual(variant.additionalProperties, canonical.additionalProperties)
+    ) {
       logger.info(
-        `${ruleId}: schema defines 'additionalProperties' - it is not a proper graph fragment`
+        `${ruleId}: 'additionalProperties' on variant does not match canonical - it is not a proper graph fragment`
       );
       result = false;
     }
-    if (variant.patternProperties) {
+    if (
+      variant.patternProperties &&
+      !isEqual(variant.patternProperties, canonical.patternProperties)
+    ) {
       logger.info(
-        `${ruleId}: schema defines 'patternProperties' - it is not a proper graph fragment`
+        `${ruleId}: 'patternProperties' on variant does not match canonical - it is not a proper graph fragment`
       );
       result = false;
     }

packages/ruleset/test/rules/api-symmetry.test.js

@@ -623,6 +623,52 @@ describe(`Spectral rule: ${ruleId}`, () => {
       expect(results).toHaveLength(0);
     });
 
+    it('prototype schema with nested additionalProperties is compliant', async () => {
+      const testDocument = makeCopy(rootDocument);
+      testDocument.components.schemas.Movie.properties.personnel = {
+        type: 'object',
+        properties: {
+          cast: {
+            description: 'key-value pairs mapping name to role',
+            type: 'object',
+            additionalProperties: {
+              type: 'string',
+            },
+          },
+        },
+      };
+
+      testDocument.components.schemas.MoviePrototype.properties.personnel =
+        testDocument.components.schemas.Movie.properties.personnel;
+
+      const results = await testRule(ruleId, rule, testDocument);
+      expect(results).toHaveLength(0);
+    });
+
+    it('prototype schema with nested patternProperties is compliant', async () => {
+      const testDocument = makeCopy(rootDocument);
+      testDocument.components.schemas.Movie.properties.personnel = {
+        type: 'object',
+        properties: {
+          cast: {
+            description: 'key-value pairs mapping name to role',
+            type: 'object',
+            patternProperties: {
+              '^[A-Z][a-z]+( ?[A-Z][a-z]+)*$': {
+                type: 'string',
+              },
+            },
+          },
+        },
+      };
+
+      testDocument.components.schemas.MoviePrototype.properties.personnel =
+        testDocument.components.schemas.Movie.properties.personnel;
+
+      const results = await testRule(ruleId, rule, testDocument);
+      expect(results).toHaveLength(0);
+    });
+
     // Already covered in root document:
     // - Valid Prototype schemas
     // - Valid Patch schemas