Merge pull request #26 from JaredCE/handle-servers-correctly

Handle servers correctly

Author: JaredCE

README.md

@@ -63,6 +63,18 @@ 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 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.
+
+This Arazzo Runner will pick the first server it comes across in the array of servers and run the operation against that.
+
+- If the operation has servers specified, it will use the first server at the operation level, ignoring path and root servers.
+- If the operation does not have a server specified, and the path level does, it will use the path level server, ignoring the root level
+- If the operation only has servers specified at the root of the document, it will only use the first root level server.
+
+It will attempt to map to the [Server Variables](https://spec.openapis.org/oas/latest.html#server-variable-object), using the `default` that is set.
+
 ## 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.
@@ -99,17 +111,13 @@ Work on Reporting still needs completeing.
 
 ## Still unsupported
 
-### PathOperation
+### Security
 
-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 security is still not fully supported
 
-### OpenAPI server variables
+### PathOperation
 
-OpenAPI server variables currently do not work
+Accessing an OpenAPI operation by Operation Path `'{$sourceDescriptions.petstoreDescription.url}#/paths/~1pet~1findByStatus/get'` does not work currently
 
 ### JSONPath and XPath criteria objects
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "arazzo-runner",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "A runner to run through Arazzo Document workflows",
   "main": "index.js",
   "scripts": {
@@ -42,6 +42,7 @@
     "ajv": "^8.17.1",
     "jsonpath": "^1.1.1",
     "openapi-params": "^0.0.5",
+    "openapi-server-url-templating": "^1.3.0",
     "stream-chain": "^3.4.0",
     "stream-json": "^1.9.1"
   }

package.json

@@ -210,8 +210,6 @@ class Arazzo extends Document {
 
       this.logger.notice(`Running Step: ${step.stepId}`);
 
-      // 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) {
         rules.setSuccessRules(this.step.onSuccess);
         // this.workflow.rules.setStepSuccesses(this.step.onSuccess);
@@ -224,10 +222,6 @@ class Arazzo extends Document {
 
       rules.combineRules(this.workflow.rules);
       this.step.rules = rules;
-      // this.step.rules.combineRules(this.workflow.rules);
-
-      //   this.stepContext[step.stepId].hasLoadedRules = true;
-      // }
 
       await this.loadOperationData();
 
@@ -253,7 +247,7 @@ class Arazzo extends Document {
    * @private
    */
   async runOpenAPIStep() {
-    this.operations = await this.sourceDescriptionFile.buildOperation(
+    this.operation = await this.sourceDescriptionFile.buildOperation(
       this.inputs,
       this.step,
     );
@@ -307,50 +301,48 @@ class Arazzo extends Document {
       }
     };
 
-    for (const operation of this.operations) {
-      let url = operation.url;
+    let url = this.operation.url;
 
-      if (operation.queryParams.size) {
-        url += `?${operation.queryParams}`;
-      }
+    if (this.operation.queryParams.size) {
+      url += `?${this.operation.queryParams}`;
+    }
 
-      const options = {
-        method: operation.operation,
-        headers: operation.headers,
-      };
+    const options = {
+      method: this.operation.method,
+      headers: this.operation.headers,
+    };
 
-      if (operation.data) {
-        options.body = operation.data;
-      }
+    if (this.operation.data) {
+      options.body = this.operation.data;
+    }
 
-      if (this.retryAfter) {
-        this.logger.notice(
-          `retryAfter was set: waiting ${this.retryAfter * 1000} seconds`,
-        );
-        await sleep(this.retryAfter * 1000);
-      }
+    if (this.retryAfter) {
+      this.logger.notice(
+        `retryAfter was set: waiting ${this.retryAfter * 1000} seconds`,
+      );
+      await sleep(this.retryAfter * 1000);
+    }
 
-      this.expression.addToContext("url", url);
-      this.expression.addToContext("method", options.method);
+    this.expression.addToContext("url", url);
+    this.expression.addToContext("method", options.method);
 
-      this.logger.notice(`Making a ${options.method.toUpperCase()} to ${url}`);
+    this.logger.notice(`Making a ${options.method.toUpperCase()} to ${url}`);
 
-      const response = await fetch(url, options);
+    const response = await fetch(url, options);
 
-      if (response.headers.has("retry-after")) {
-        const retryAfter = parseRetryAfter(response.headers.get("retry-after"));
-        if (retryAfter !== null) {
-          this.retryAfter = retryAfter;
-        }
+    if (response.headers.has("retry-after")) {
+      const retryAfter = parseRetryAfter(response.headers.get("retry-after"));
+      if (retryAfter !== null) {
+        this.retryAfter = retryAfter;
       }
+    }
 
-      this.addParamsToContext(response.headers, "header", "response");
-      this.expression.addToContext("statusCode", response.status);
+    this.addParamsToContext(response.headers, "header", "response");
+    this.expression.addToContext("statusCode", response.status);
 
-      this.logger.notice(`${url} responded with a: ${response.status}`);
+    this.logger.notice(`${url} responded with a: ${response.status}`);
 
-      await this.dealWithResponse(response);
-    }
+    await this.dealWithResponse(response);
   }
 
   /**
@@ -725,10 +717,8 @@ class Arazzo extends Document {
     this.mapParameters();
     this.mapRequestBody();
 
-    for (const operation of this.operations) {
-      this.addParamsToContext(operation.headers, "headers", "request");
-      this.addParamsToContext(operation.queryParams, "query", "request");
-    }
+    this.addParamsToContext(this.operation.headers, "headers", "request");
+    this.addParamsToContext(this.operation.queryParams, "query", "request");
   }
 
   /**
@@ -765,19 +755,18 @@ class Arazzo extends Document {
           break;
 
         case "path":
-          for (const operation of this.operations) {
-            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 });
+          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()) {
+            this.operation.url = this.operation.url.replace(`{${name}}`, value);
           }
+
           break;
 
         case "query":
@@ -801,12 +790,9 @@ class Arazzo extends Document {
     }
 
     this.addParamsToContext(pathParams, "path", "request");
-    // this.expression.addToContext("request.path", pathParams);
 
-    for (const operation of this.operations) {
-      operation.headers = headersObj;
-      operation.queryParams = queryParams;
-    }
+    this.operation.headers = headersObj;
+    this.operation.queryParams = queryParams;
   }
 
   /**
@@ -833,13 +819,14 @@ class Arazzo extends Document {
         this.step.requestBody.payload,
       );
 
-      for (const operation of this.operations) {
-        if (this.step.requestBody.contentType) {
-          operation.headers.append("accept", this.step.requestBody.contentType);
-        }
-
-        operation.data = payload;
+      if (this.step.requestBody.contentType) {
+        this.operation.headers.append(
+          "accept",
+          this.step.requestBody.contentType,
+        );
       }
+
+      this.operation.data = payload;
     }
   }
 

src/Arazzo.js

@@ -1,5 +1,7 @@
 "use strict";
 
+const { substitute, parse } = require("openapi-server-url-templating");
+
 const Document = require("./Document");
 
 class OpenAPI extends Document {
@@ -17,8 +19,9 @@ class OpenAPI extends Document {
         for (let operation in value[key]) {
           if (value[key][operation]?.operationId === operationId) {
             this.path = key;
-            this.operation = operation;
+            this.method = operation;
             this.operationDetails = value[key][operation];
+            this.pathServers = value[key]?.["servers"] || [];
           }
         }
       }
@@ -30,11 +33,19 @@ class OpenAPI extends Document {
   }
 
   async buildOperation(inputs, step) {
-    await this.getServers();
+    if (!this.pathServers.length && !this.operationDetails?.servers?.length) {
+      await this.getServers();
+    } else {
+      if (this.operationDetails.servers) {
+        this.servers = this.operationDetails.servers;
+      } else {
+        this.servers = this.pathServers;
+      }
+    }
 
     this.buildOperations();
 
-    return this.operations;
+    return this.operation;
   }
 
   async getServers() {
@@ -65,15 +76,42 @@ class OpenAPI extends Document {
     }
   }
 
-  buildOperations() {
-    this.operations = [];
+  parseServer() {
+    const server = this.servers.at(0);
 
-    for (const server of this.servers) {
-      this.operations.push({
-        url: `${server.url}${this.path}`,
-        operation: this.operation,
-      });
+    if (server.variables) {
+      const parseResult = parse(server.url);
+      const parts = [];
+
+      parseResult.ast.translate(parts);
+
+      for (const partType of parts) {
+        const [type, value] = partType;
+
+        if (type === "server-variable-name") {
+          const replacementValueData = server.variables[value];
+          if (replacementValueData.default) {
+            server.url = server.url.replace(
+              `{${value}}`,
+              replacementValueData.default,
+            );
+          }
+        }
+      }
     }
+
+    return server;
+  }
+
+  buildOperations() {
+    this.operation = {};
+
+    const server = this.parseServer();
+
+    Object.assign(this.operation, {
+      url: `${server.url}${this.path}`,
+      method: this.method,
+    });
   }
 }