fix(ibm-api-symmetry): print info logs in coherent order

The code to determine if one schema is a graph fragment of the other
uses a depth-first algorithm that prints a log, if it determines the
schema to violate the graph fragment pattern, with the reason behind
the violation. Due to the depth-first nature of the algorithm, the
logs are currently printed in depth first order, which is not as
coherent for the user to read.

This change introduces a stack to collect the logs during processing
and print them in reverse order afterwards to give a user a sense
of what happened during the processing.

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

Author: dpopp07

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

@@ -22,6 +22,10 @@ const {
 let ruleId;
 let logger;
 
+// The graph fragment check is depth-first. Use this stack to
+// print the relevant info logs in a sane order.
+const infoLogStack = [];
+
 /**
  * The implementation for this rule makes assumptions that are dependent on the
  * presence of the following other rules:
@@ -174,7 +178,7 @@ function checkForGraphFragmentPattern(
         schema => getSchemaType(variant) === getSchemaType(schema)
       )
     ) {
-      logger.info(
+      infoLogStack.push(
         `${ruleId}: variant and canonical schemas are different types`
       );
       result = false;
@@ -198,7 +202,7 @@ function checkForGraphFragmentPattern(
           )
       )
     ) {
-      logger.info(
+      infoLogStack.push(
         `${ruleId}: variant is array with schema that is not a graph fragment of canonical items schema`
       );
       result = false;
@@ -222,7 +226,7 @@ function checkForGraphFragmentPattern(
           )
       )
     ) {
-      logger.info(
+      infoLogStack.push(
         `${ruleId}: variant is dictionary with an additionalProperties schema that is not a graph fragment of canonical`
       );
       result = false;
@@ -258,7 +262,7 @@ function checkForGraphFragmentPattern(
           )
       )
     ) {
-      logger.info(
+      infoLogStack.push(
         `${ruleId}: variant is dictionary with a patternProperties schema that is not a graph fragment of canonical`
       );
       result = false;
@@ -301,7 +305,7 @@ function checkForGraphFragmentPattern(
         // Note: Prototype schemas are allowed to define writeOnly properties
         // that don't exist on the canonical schema.
         if (!valid && !(considerWriteOnly && prop.writeOnly)) {
-          logger.info(
+          infoLogStack.push(
             propExistsSomewhere
               ? `${ruleId}: nested object property ${name} is not a graph fragment of canonical property ${name}`
               : `${ruleId}: property '${name}' does not exist on the canonical schema`
@@ -324,7 +328,7 @@ function checkForGraphFragmentPattern(
           true
         )
       ) {
-        logger.info(
+        infoLogStack.push(
           `${ruleId}: variant schema applicator '${applicator}' is not a graph fragment of the canonical schema`
         );
         result = false;
@@ -409,6 +413,12 @@ function checkForGraphFragmentPattern(
     false
   );
 
+  // Print the logs gathered within the `isGraphFragment` function,
+  // in reverse order - it will be coherent for the user.
+  while (infoLogStack.length) {
+    logger.info(infoLogStack.pop());
+  }
+
   logger.debug(
     `${ruleId}: isGraphFragment() returned [${variantIsGraphFragment},${variantOmitsProperties}]`
   );