Merge pull request #35 from JaredCE/deal-with-XML

Deal with xml

Author: JaredCE

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "arazzo-runner",
-  "version": "0.0.12",
+  "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.json

@@ -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]);

src/Arazzo.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) {

src/Expression.js

@@ -1589,7 +1589,7 @@ describe(`OpenAPI Parameter Types`, function () {
                 "access-control-allow-origin": "*",
                 connection: "keep-alive",
                 "content-length": "102",
-                "content-type": "application/xml",
+                "content-type": "application/json",
                 date: "Thu, 15 Jan 2026 20:26:31 GMT",
                 server: "Jetty(9.2.9.v20150224)",
               },

test/unit/Arazzo.parameters.spec.js

@@ -880,7 +880,6 @@ describe(`OpenAPI Security`, function () {
 
   describe(`mutualTLS`, function () {
     it(`handles the security requirements`, async function () {
-      // nock.recorder.rec();
       const AccessToken =
         "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.NHVaYe26MbtOYhSKkoKYdFVomg4i8ZJd8_-RU8VNbftc4TSMb4bXP3l3YlNWACwyXPGffz5aXHc6lty1Y2t4SWRqGteragsVdZufDn5BlnJl9pdR_kdVFUsra2rWKEofkZeIC4yWytE58sMIihvo9H1ScmmVwBcQP6XETqYd0aSHp1gOa9RdUPDvoXQ5oqygTqVtxaDr6wUFKrKItgBMzWIdNZ6y7O9E0DhEPTbE9rfBo6KTFsHAZnMg4k68CDp2woYIaXbmYTWcvbzIuHO7_37GT79XdIwkm95QJ7hYC9RiwrV7mesbY4PAahERJawntho0my942XheVLmGwLMBkQ";
 
@@ -950,16 +949,20 @@ describe(`OpenAPI Security`, function () {
         reqheaders: { Authorization: AccessToken },
       })
         .delete("/v2/user/jack")
-        .reply(200, "", {
-          "access-control-allow-headers":
-            "Content-Type, api_key, Authorization",
-          "access-control-allow-methods": "GET, POST, DELETE, PUT",
-          "access-control-allow-origin": "*",
-          connection: "close",
-          "content-length": "0",
-          date: "Fri, 16 Jan 2026 23:49:12 GMT",
-          server: "Jetty(9.2.9.v20150224)",
-        });
+        .reply(
+          200,
+          {},
+          {
+            "access-control-allow-headers":
+              "Content-Type, api_key, Authorization",
+            "access-control-allow-methods": "GET, POST, DELETE, PUT",
+            "access-control-allow-origin": "*",
+            connection: "close",
+            "content-length": `${JSON.stringify({}).length}`,
+            date: "Fri, 16 Jan 2026 23:49:12 GMT",
+            server: "Jetty(9.2.9.v20150224)",
+          },
+        );
 
       const inputFile = new Input(
         "./test/mocks/inputs/security/input.json",

test/unit/Arazzo.security.spec.js

@@ -144,7 +144,7 @@ describe(`Arazzo Document`, function () {
                 } catch (err) {
                   expect(err).to.be.instanceOf(Error);
                   expect(err.message).to.be.equal(
-                    `SyntaxError: Unexpected token '<', "<?xml vers"... is not valid JSON`,
+                    `Invalid JSON pointer '/id': Invalid object key "id" at position 0 in "/id": key not found in object`,
                   );
                 }
               });
@@ -2266,7 +2266,7 @@ describe(`Arazzo Document`, function () {
                 } catch (err) {
                   expect(err).to.be.instanceOf(Error);
                   expect(err.message).to.be.equal(
-                    `SyntaxError: Unexpected token '<', "<?xml vers"... is not valid JSON`,
+                    `Invalid JSON pointer '/id': Invalid object key "id" at position 0 in "/id": key not found in object`,
                   );
                 }
               });

test/unit/Arazzo.spec.js

@@ -549,6 +549,21 @@ describe(`Expression`, function () {
       expect(expected).to.be.eql("john");
     });
 
+    it(`can resolve a json pointer expression when the context is XML`, function () {
+      const expression = new Expression();
+
+      expression.addToContext(
+        "response.body",
+        `<?xml version="1.0" encoding="UTF-8" standalone="yes"?><apiResponse><name>john</name></apiResponse>`,
+      );
+
+      const expected = expression.resolveExpression(
+        "$response.body#/apiResponse/name",
+      );
+
+      expect(expected).to.be.eql("john");
+    });
+
     it(`can resolve a templated expression to a json Pointer`, function () {
       const expression = new Expression();