arazzo-runner 0.0.11 → 0.0.13

package/README.md

@@ -66,6 +66,24 @@ 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.
 
+### Config file
+
+Arazzo Runner allows for a config file to keep hold of secrets to get OpenAPI/Arazzo documents held on paths behind apikeys:
+
+```js
+"use strict";
+
+module.exports = {
+  documentKey: {
+    key: process.env.APIKey,
+    in: "header|query", // either in the header or the query params
+    name: "apiKey",
+  },
+};
+```
+
+When downloading OpenAPI/Arazzo documents, it will use the documentKey to access those files. This file should be stored in `./options/config.js`
+
 ## OpenAPI Servers
 
 OpenAPI Documents allow you to specify servers at the root, [path](https://spec.openapis.org/oas/latest.html#path-item-object) and [operation](https://spec.openapis.org/oas/latest.html#operation-object) level. They allow you to specify multiple servers, however the OpenAPI specification is opinionated that all servers specified in a Document should return the same thing and this Arazzo Runner will follow this opinion and only attempt one of the specified servers.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arazzo-runner",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "description": "A runner to run through Arazzo Document workflows",
   "main": "index.js",
   "scripts": {
@@ -40,6 +40,7 @@
     "@swaggerexpert/arazzo-runtime-expression": "^1.0.1",
     "@swaggerexpert/json-pointer": "^2.10.2",
     "ajv": "^8.17.1",
+    "fast-xml-parser": "^5.3.3",
     "jsonpath": "^1.1.1",
     "openapi-params": "^0.0.5",
     "openapi-server-url-templating": "^1.3.0",

package/src/Arazzo.js

@@ -348,9 +348,9 @@ class Arazzo extends Document {
     } else {
       this.logger.verbose("Using fetch call");
 
-      this.logger.verbose(`url: ${url}`);
-      this.logger.verbose(`method: ${options.method}`);
-      this.logger.verbose("headers:");
+      this.logger.verbose(`request url: ${url}`);
+      this.logger.verbose(`request method: ${options.method}`);
+      this.logger.verbose("request headers:");
       for (const [key, value] of options.headers.entries()) {
         this.logger.verbose(`${key}: ${value}`);
       }
@@ -360,6 +360,12 @@ class Arazzo extends Document {
       response = await fetch(url, options);
     }
 
+    this.logger.verbose(`received StatusCode: ${response.status}`);
+    this.logger.verbose(`received headers:`);
+    for (const [key, value] of response.headers.entries()) {
+      this.logger.verbose(`${key}: ${value}`);
+    }
+
     if (response.headers.has("retry-after")) {
       const retryAfter = parseRetryAfter(response.headers.get("retry-after"));
       if (retryAfter !== null) {
@@ -504,32 +510,48 @@ class Arazzo extends Document {
    * @param {*} response
    */
   async dealWithResponse(response) {
+    if (
+      response.headers.has("Content-Type") &&
+      response.headers.get("Content-Type") === "application/json"
+    ) {
+      const json = await response?.json().catch((err) => {
+        this.logger.error(
+          `Error trying to resolve ${this.step.stepId} outputs`,
+        );
+        throw new Error(err);
+      });
+
+      this.expression.addToContext("response.body", json);
+    } else {
+      const body = await response.body;
+
+      this.expression.addToContext("response.body", body);
+    }
+
     this.doNotProcessStep = false;
     this.alreadyProcessingOnFailure = false;
 
     if (this.step.successCriteria) {
-      if (this.step.successCriteria) {
-        const passedSuccessCriteria = this.hasPassedSuccessCriteria();
-
-        if (passedSuccessCriteria) {
-          this.logger.success("All criteria checks passed");
-          if (this.currentRetryRule) {
-            if (this.retryContext.doNotDeleteRetryLimits) {
-              this.retryLimits[this.currentRetryRule] = 0;
-              this.logger.notice("Retries stopped");
-            }
+      const passedSuccessCriteria = this.hasPassedSuccessCriteria();
+
+      if (passedSuccessCriteria) {
+        this.logger.success("All criteria checks passed");
+        if (this.currentRetryRule) {
+          if (this.retryContext.doNotDeleteRetryLimits) {
+            this.retryLimits[this.currentRetryRule] = 0;
+            this.logger.notice("Retries stopped");
           }
+        }
 
-          await this.dealWithPassedRule(response);
+        await this.dealWithPassedRule(response);
+      } else {
+        this.logger.error("Not all criteria checks passed");
+        if (this.step.onFailure) {
+          await this.dealWithFailedRule();
         } else {
-          this.logger.error("Not all criteria checks passed");
-          if (this.step.onFailure) {
-            await this.dealWithFailedRule();
-          } else {
-            throw new Error(
-              `${this.step.stepId} step of the ${this.workflow.workflowId} workflow failed the successCriteria`,
-            );
-          }
+          throw new Error(
+            `${this.step.stepId} step of the ${this.workflow.workflowId} workflow failed the successCriteria`,
+          );
         }
       }
     } else {
@@ -843,14 +865,7 @@ class Arazzo extends Document {
    * @private
    * @param {*} response
    */
-  async dealWithStepOutputs(response) {
-    const json = await response?.json().catch((err) => {
-      this.logger.error(`Error trying to resolve ${this.step.stepId} outputs`);
-      throw new Error(err);
-    });
-
-    this.expression.addToContext("response.body", json);
-
+  async dealWithStepOutputs() {
     const outputs = {};
     for (const key in this.step.outputs) {
       const value = this.expression.resolveExpression(this.step.outputs[key]);
@@ -1067,7 +1082,7 @@ class Arazzo extends Document {
         this.sourceDescription.type,
         this.sourceDescription.url,
         this.sourceDescription.name,
-        { logger: this.logger },
+        { logger: this.logger, config: this.config },
       );
 
       Object.assign(this.loadedSourceDescriptions, {

package/src/Document.js

@@ -15,14 +15,40 @@ const fsp = require("node:fs/promises");
 const path = require("node:path");
 
 class Document {
-  constructor(url, name, { logger, reporter }) {
+  constructor(url, name, { logger, config }) {
     this.url = url;
     this.name = name;
     this.logger = logger;
+    this.config = config;
   }
 
   async loadDocument() {
-    const response = await fetch(this.url);
+    let headers = new Headers();
+    let fetchURL = new URL(this.url);
+
+    if (this.config) {
+      if (this.config?.documentKey) {
+        if (this.config.documentKey.in === "header") {
+          headers.append(
+            this.config.documentKey.name,
+            this.config.documentKey.key,
+          );
+        } else {
+          fetchURL.searchParams.append(
+            this.config.documentKey.name,
+            this.config.documentKey.key,
+          );
+        }
+      }
+    }
+
+    this.logger.verbose(`fetching ${this.type} document from: ${fetchURL}`);
+    this.logger.verbose("fetch headers:");
+    for (const [key, value] of headers.entries()) {
+      this.logger.verbose(`${key}: ${value}`);
+    }
+
+    const response = await fetch(fetchURL, { headers: headers });
 
     if (!response.ok) {
       throw new Error(`Error fetching document from ${this.url}`);

package/src/Expression.js

@@ -242,6 +242,18 @@ class Expression {
   //   return expression;
   // }
 
+  /**
+   * @private
+   * @param {*} value
+   * @returns {boolean}
+   */
+  isXML(value) {
+    return (
+      typeof value === "string" &&
+      (value.trim().startsWith("<?xml") || value.trim().startsWith("<"))
+    );
+  }
+
   /**
    * Resolves a runtime expression to its value in the context
    * @public
@@ -470,6 +482,18 @@ class Expression {
         throw new Error(`Context path '${normalised}' not found`);
       }
 
+      // NEW: Check if contextData is XML
+      if (this.isXML(contextData)) {
+        const { XMLParser } = require("fast-xml-parser");
+        const parser = new XMLParser({
+          ignoreAttributes: false,
+          attributeNamePrefix: "@_",
+        });
+        const jsonData = parser.parse(contextData);
+        return evaluate(jsonData, pointer);
+      }
+
+      // Regular JSON pointer evaluation
       try {
         return evaluate(contextData, pointer);
       } catch (err) {

package/src/OpenAPI.js

@@ -65,7 +65,6 @@ class OpenAPI extends Document {
 
     for await (const { value } of componentPipeline) {
       if (value.securitySchemes) {
-        console.log(value.securitySchemes);
         this.securitySchemes = value.securitySchemes;
       }
     }

package/src/Runner.js

@@ -5,10 +5,23 @@ const Input = require("./Input");
 
 const Logger = require("./Logger");
 
+const path = require("node:path");
+
 class Runner {
   constructor(options, logger) {
     const verboseLogging = options?.verbose || false;
     this.logger = logger || new Logger(verboseLogging);
+
+    try {
+      this.logger.verbose(
+        `Loading config from ${path.resolve("./options", "config")}`,
+      );
+
+      this.config = require(path.resolve("./options", "config.js"));
+    } catch (err) {
+      this.logger.verbose("No config found");
+      this.config = {};
+    }
   }
 
   /**
@@ -23,7 +36,7 @@ class Runner {
       "arazzo",
       arazzoUrl,
       "arazzo",
-      { logger: this.logger },
+      { logger: this.logger, config: this.config },
     );
 
     if (!this.isUrl(arazzoUrl)) {