arazzo-runner 0.0.5 → 0.0.7

package/README.md

@@ -63,6 +63,12 @@ jq --arg password "$secret_password" '.workflowId1.password = $password' input.j
 
 Obviously, if you have a lot of secret variables that need adding as inputs, then you might need to write a script that can alter the `input.json` file for you within your CI/CD runner.
 
+## OpenAPI Parameters
+
+OpenAPI Documents allow you to specify [`header`, `path` and `query` parameters](https://spec.openapis.org/oas/latest.html#parameter-object) in myriad of styles. This Arazzo Runner will respect your styling and send the format to the server as specified by your OpenAPI document.
+
+It currently does not follow the `allowEmptyValue`, `allowReserved` or the `content` keywords currently.
+
 ## Logging And Reporting
 
 ### Logging
@@ -93,14 +99,18 @@ Work on Reporting still needs completeing.
 
 ## Still unsupported
 
-### OpenAPI Params
+### PathOperation
 
-OpenAPI parameter types with style and explode are not quite supported yet
+Accessing an OpenAPI operation by Operation Path `'{$sourceDescriptions.petstoreDescription.url}#/paths/~1pet~1findByStatus/get'` does not work currently
 
 ### OpenAPI Servers on various levels
 
 This pulls from the top level servers object of an OpenAPI Document. Server variables do not work either.
 
+### OpenAPI server variables
+
+OpenAPI server variables currently do not work
+
 ### JSONPath and XPath criteria objects
 
 Criteria Objects set as type JSON Path or XPath do not work

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arazzo-runner",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "A runner to run through Arazzo Document workflows",
   "main": "index.js",
   "scripts": {
@@ -41,7 +41,7 @@
     "@swaggerexpert/json-pointer": "^2.10.2",
     "ajv": "^8.17.1",
     "jsonpath": "^1.1.1",
-    "openapi-params": "^0.0.4",
+    "openapi-params": "^0.0.5",
     "stream-chain": "^3.4.0",
     "stream-json": "^1.9.1"
   }

package/src/Arazzo.js

@@ -68,7 +68,6 @@ class Arazzo extends Document {
       } catch (err) {
         if (err.name === "AbortError") {
           if (err.goto) {
-            // console.log("goto error");
             await this.handleGotoRule(err.goto);
           }
         } else {
@@ -112,16 +111,18 @@ class Arazzo extends Document {
 
       this.expression.addToContext("inputs", this.inputs);
 
-      this.workflow.rules = rules;
-
       if (this.workflow.onSuccess) {
-        this.workflow.rules.setWorkflowSuccess(this.workflow.onSuccess);
+        // this.workflow.rules.set(this.workflow.onSuccess);
+        rules.setSuccessRules(this.workflow.onSuccess);
       }
 
       if (this.workflow.onFailure) {
-        this.workflow.rules.setWorkflowFailures(this.workflow.onFailure);
+        // this.workflow.rules.setWorkflowFailures(this.workflow.onFailure);
+        rules.setFailureRules(this.workflow.onFailure);
       }
 
+      this.workflow.rules = rules;
+
       await this.runSteps();
 
       if (this.workflow.outputs) {
@@ -203,6 +204,7 @@ class Arazzo extends Document {
 
     if (step) {
       this.step = step;
+      const rules = new Rules(this.expression, { logger: this.logger });
       // if (!this.stepContext[step.stepId])
       //   Object.assign(this.stepContext, { [step.stepId]: {} });
 
@@ -211,13 +213,19 @@ class Arazzo extends Document {
       // need to deal with reloading the rules when in a retry state or a goto state
       // if (this.stepContext?.[step.stepId]?.hasLoadedRules === false) {
       if (this.step.onSuccess) {
-        this.workflow.rules.setStepSuccesses(this.step.onSuccess);
+        rules.setSuccessRules(this.step.onSuccess);
+        // this.workflow.rules.setStepSuccesses(this.step.onSuccess);
       }
 
       if (this.step.onFailure) {
-        this.workflow.rules.setStepFailures(this.step.onFailure);
+        rules.setFailureRules(this.step.onFailure);
+        // this.workflow.rules.setStepFailures(this.step.onFailure);
       }
 
+      rules.combineRules(this.workflow.rules);
+      this.step.rules = rules;
+      // this.step.rules.combineRules(this.workflow.rules);
+
       //   this.stepContext[step.stepId].hasLoadedRules = true;
       // }
 
@@ -434,7 +442,7 @@ class Arazzo extends Document {
       await this.dealWithStepOutputs(response);
     }
 
-    const whatNext = this.workflow.rules.runRules(true);
+    const whatNext = this.step.rules.runRules(true);
 
     if (whatNext.endWorkflow) {
       this.workflowIndex += 1;
@@ -496,7 +504,7 @@ class Arazzo extends Document {
     //   await this.dealWithStepOutputs(response);
     // }
 
-    const whatNext = this.workflow.rules.runRules();
+    const whatNext = this.step.rules.runRules();
     if (whatNext.endWorkflow) {
       this.workflowIndex += 1;
       this.logger.notice(
@@ -683,8 +691,6 @@ class Arazzo extends Document {
 
     if (this.retryLimits[whatNext.name] === 0)
       this.retrySet.delete(whatNext.name);
-
-    // console.log("I need to return here after retrying");
   }
 
   /**
@@ -729,13 +735,14 @@ class Arazzo extends Document {
    * @private
    */
   mapParameters() {
-    const headers = new Headers();
-    const queryParams = new URLSearchParams();
-    const pathParams = {};
+    const headersObj = new Headers();
+    const headers = new URLParams();
+    const queryParams = new URLParams();
+    const pathParams = new URLParams();
 
     for (const param of this.step?.parameters || []) {
       const operationDetailParam =
-        this.sourceDescription.operationDetails?.parameters
+        this.sourceDescriptionFile.operationDetails?.parameters
           .filter((obj) => obj.name === param.name && obj.in === param.in)
           .at(0);
 
@@ -743,27 +750,61 @@ class Arazzo extends Document {
 
       switch (param.in) {
         case "header":
-          headers.append(param.name, value);
+          const headerStyle = operationDetailParam?.style || "simple";
+          const headerExplode = operationDetailParam?.explode || false;
+          headers.append(param.name, value, {
+            style: headerStyle,
+            explode: headerExplode,
+          });
+          for (const [header, value] of headers) {
+            if (header === param.name) {
+              headersObj.append(param.name, value);
+            }
+          }
 
           break;
 
         case "path":
           for (const operation of this.operations) {
-            operation.url = operation.url.replace(`{${param.name}}`, value);
-            Object.assign(pathParams, { [param.name]: value });
+            const pathStyle = operationDetailParam?.style || "simple";
+            const pathExplode = operationDetailParam?.explode || false;
+            pathParams.append(param.name, value, {
+              style: pathStyle,
+              explode: pathExplode,
+            });
+            for (const [name, value] of pathParams.entries()) {
+              operation.url = operation.url.replace(`{${name}}`, value);
+            }
+            // operation.url = operation.url.replace(`{${param.name}}`, value);
+            // Object.assign(pathParams, { [param.name]: value });
           }
           break;
 
         case "query":
-          queryParams.append(param.name, value);
+          // queryParams.append(param.name, value);
+          const style = operationDetailParam?.style || "form";
+          let explode = false;
+          if (Object.hasOwn(operationDetailParam, "explode")) {
+            explode = operationDetailParam.explode;
+          } else {
+            if (style === "form") {
+              explode = true;
+            }
+          }
+          // const explode = operationDetailParam?.explode || false;
+          queryParams.append(param.name, value, {
+            style: style,
+            explode: explode,
+          });
           break;
       }
     }
 
-    this.expression.addToContext("request.path", pathParams);
+    this.addParamsToContext(pathParams, "path", "request");
+    // this.expression.addToContext("request.path", pathParams);
 
     for (const operation of this.operations) {
-      operation.headers = headers;
+      operation.headers = headersObj;
       operation.queryParams = queryParams;
     }
   }

package/src/Rules.js

@@ -13,24 +13,65 @@ class Rules {
     };
   }
 
-  setWorkflowFailures(failureActions) {
-    this.workflowFailures = failureActions;
+  /**
+   * @typedef {Object} criteriaType
+   * @property {string} type - REQUIRED. The type of condition to be applied. The options allowed are jsonpath or xpath.
+   * @property {string=} version - REQUIRED. A short hand string representing the version of the expression type being used. The allowed values for JSONPath are draft-goessner-dispatch-jsonpath-00. The allowed values for XPath are xpath-30, xpath-20, or xpath-10.
+   */
+
+  /**
+   * @typedef {Object} criteria
+   * @property {string} context - A Runtime Expression used to set the context for the condition to be applied on. If type is specified, then the context MUST be provided (e.g. $response.body would set the context that a JSONPath query expression could be applied to).
+   * @property {string} condition - REQUIRED. The condition to apply. Conditions can be simple (e.g. $statusCode == 200 which applies an operator on a value obtained from a runtime expression), or a regex, or a JSONPath expression. For regex or JSONPath, the type and context MUST be specified.
+   * @property {criteriaType} type - The type of condition to be applied. If specified, the options allowed are simple, regex, jsonpath or xpath. If omitted, then the condition is assumed to be simple, which at most combines literals, operators and Runtime Expressions. If jsonpath, then the expression MUST conform to JSONPath. If xpath the expression MUST conform to XML Path Language 3.1. Should other variants of JSONPath or XPath be required, then a Criterion Expression Type Object MUST be specified.
+   */
+
+  /**
+   * @typedef {Object} failureActionsObject
+   * @property {string} name - REQUIRED. The name of the failure action. Names are case sensitive.
+   * @property {string} type - REQUIRED. The type of action to take. Possible values are "end", "retry", or "goto".
+   * @property {string=} workflowId - The workflowId referencing an existing workflow within the Arazzo Description to transfer to upon failure of the step. This field is only relevant when the type field value is "goto" or "retry". If the referenced workflow is contained within an arazzo type sourceDescription, then the workflowId MUST be specified using a Runtime Expression (e.g., $sourceDescriptions.<name>.<workflowId>) to avoid ambiguity or potential clashes. This field is mutually exclusive to stepId. When used with "retry", context transfers back upon completion of the specified workflow.
+   * @property {string=} stepId - The stepId to transfer to upon failure of the step. This field is only relevant when the type field value is "goto" or "retry". The referenced stepId MUST be within the current workflow. This field is mutually exclusive to workflowId. When used with "retry", context transfers back upon completion of the specified step.
+   * @property {number=} retryAfter - A non-negative decimal indicating the seconds to delay after the step failure before another attempt SHALL be made. Note: if an HTTP Retry-After response header was returned to a step from a targeted operation, then it SHOULD overrule this particular field value. This field only applies when the type field value is "retry".
+   * @property {number=} retryLimit - A non-negative integer indicating how many attempts to retry the step MAY be attempted before failing the overall step. If not specified then a single retry SHALL be attempted. This field only applies when the type field value is "retry". The retryLimit MUST be exhausted prior to executing subsequent failure actions.
+   * @property {criteria[]} criteria - A list of assertions to determine if this action SHALL be executed. Each assertion is described using a Criterion Object.
+   */
+
+  /**
+   * @typedef {Object} successActionsObject
+   * @property {string} name - REQUIRED. The name of the failure action. Names are case sensitive.
+   * @property {string} type - REQUIRED. The type of action to take. Possible values are "end" or "goto".
+   * @property {string=} workflowId -  The workflowId referencing an existing workflow within the Arazzo Description to transfer to upon success of the step. This field is only relevant when the type field value is "goto". If the referenced workflow is contained within an arazzo type sourceDescription, then the workflowId MUST be specified using a Runtime Expression (e.g., $sourceDescriptions.<name>.<workflowId>) to avoid ambiguity or potential clashes. This field is mutually exclusive to stepId.
+   * @property {string=} stepId - The stepId to transfer to upon success of the step. This field is only relevant when the type field value is "goto". The referenced stepId MUST be within the current workflow. This field is mutually exclusive to workflowId.
+   * @property {criteria[]} criteria - A list of assertions to determine if this action SHALL be executed. Each assertion is described using a Criterion Object. All criteria assertions MUST be satisfied for the action to be executed.
+   */
+
+  /**
+   * Sets the Failure Action Rules to be run
+   * @function setFailureRules
+   * @param {failureActionsObject[]} failureActions
+   */
+  setFailureRules(failureActions) {
     this.failureRules.push(...failureActions);
   }
 
-  setStepFailures(failureActions) {
-    this.stepFailures = failureActions;
-    this.failureRules.push(...failureActions);
-  }
-
-  setWorkflowSuccess(successActions) {
-    this.workflowSuccesses = successActions;
+  /**
+   * Sets the Success Action Rules to be run
+   * @function setSuccessRules
+   * @param {successActionsObject[]} successActions
+   */
+  setSuccessRules(successActions) {
     this.successRules.push(...successActions);
   }
 
-  setStepSuccesses(successActions) {
-    this.stepSuccesses = successActions;
-    this.successRules.push(...successActions);
+  /**
+   * Takes a Rules instance and combines the rules
+   * @function combineRules
+   * @param {Rules} rulesObj
+   */
+  combineRules(rulesObj) {
+    this.failureRules.push(...rulesObj.failureRules);
+    this.successRules.push(...rulesObj.successRules);
   }
 
   runRules(successRules = false) {
@@ -48,6 +89,11 @@ class Rules {
       this.logger.notice(`Running onFailure Rules`);
     }
 
+    if (this.rules.length)
+      this.logger.notice(
+        "==================================================================================",
+      );
+
     for (const rule of this.rules) {
       if (rule.criteria) {
         const passedCriteria = this.criteriaChecks(rule);
@@ -60,6 +106,7 @@ class Rules {
             obj.goto = true;
             if (rule.stepId) obj.stepId = rule.stepId;
             else obj.workflowId = rule.workflowId;
+            break;
           } else {
             obj.name = rule.name;
             obj.retry = true;
@@ -67,30 +114,51 @@ class Rules {
             if (rule.workflowId) obj.workflowId = rule.workflowId;
             obj.retryLimit = rule?.retryLimit || 1;
             if (rule.retryAfter) obj.retryAfter = rule.retryAfter;
+            break;
           }
         }
       }
     }
 
+    if (this.rules.length)
+      this.logger.notice(
+        "==================================================================================",
+      );
+
     return obj;
   }
 
+  /**
+   * @function criteriaChecks
+   * @private
+   * @param {successActionsObject|failureActionsObject} rule
+   * @returns {boolean[]}
+   */
   criteriaChecks(rule) {
     const passedCriteria = [];
 
-    this.logger.notice(
-      "==================================================================================",
-    );
-
     for (const criteriaObject of rule.criteria) {
       if (criteriaObject?.type) {
         if (criteriaObject.type === "regex") {
+          this.logger.notice(
+            `checking ${rule.name} rule: ${criteriaObject.context} matches ${criteriaObject.condition} `,
+          );
           const hasPassedCheck = this.expression.checkRegexExpression(
             criteriaObject.context,
             criteriaObject.condition,
           );
 
-          if (hasPassedCheck) hasPassed.push(true);
+          if (hasPassedCheck) {
+            this.logger.success(
+              `${criteriaObject.context} matched ${criteriaObject.condition}`,
+            );
+            passedCriteria.push(hasPassedCheck);
+          } else {
+            this.logger.error(
+              `${criteriaObject.context} did not match ${criteriaObject.condition}`,
+            );
+          }
+          // if (hasPassedCheck) hasPassed.push(true);
         } else {
         }
       } else {
@@ -110,20 +178,22 @@ class Rules {
       }
     }
 
-    this.logger.notice(
-      "==================================================================================",
-    );
-
     return passedCriteria;
   }
 
+  /**
+   * @function buildFailureRules
+   * @private
+   */
   buildFailureRules() {
-    this.failureRules.reverse();
     this.rules = this.failureRules;
   }
 
+  /**
+   * @function buildSuccessRules
+   * @private
+   */
   buildSuccessRules() {
-    this.successRules.reverse();
     this.rules = this.successRules;
   }
 }