postman-runtime 7.52.0-beta.4 → 7.52.0

package/lib/runner/util.js

@@ -121,6 +121,65 @@ prepareLookupHash = function (items) {
     return hash;
 };
 
+/**
+ * Resolve URL string from an item and payload by substituting all variables (including vault).
+ * Returns intermediate products needed by callers that do further resolution.
+ *
+ * @private
+ * @param {Item} item - The request item
+ * @param {Object} payload - Payload containing variable scopes
+ * @returns {{ urlString: string, variableDefinitions: Array, vaultVariables: * }}
+ */
+function resolveUrl (item, payload) {
+    if (!(item && item.request && item.request.url)) {
+        return { urlString: '', variableDefinitions: [], vaultVariables: null };
+    }
+
+    // @todo - resolve variables in a more graceful way
+    var variableDefinitions = [
+            // extract the variable list from variable scopes
+            // @note: this is the order of precedence for variable resolution - don't change it
+            _.get(payload, '_variables.values', []),
+            _.get(payload, 'data', []),
+            _.get(payload, 'environment.values', []),
+            _.get(payload, 'collectionVariables.values', []),
+            _.get(payload, 'globals.values', [])
+            // @note vault variables are added later
+        ],
+        vaultValues = _.get(payload, 'vaultSecrets.values'),
+        hasVaultSecrets = vaultValues ? vaultValues.count() > 0 : false,
+        urlObj = item.request.url,
+        urlString = urlObj.toString(),
+        unresolvedUrlString = urlString,
+        vaultVariables = null,
+        vaultUrl;
+
+    if (hasVaultSecrets) {
+        // get the vault variables that match the unresolved URL string
+        vaultUrl = urlObj.protocol ? urlString : 'http://' + urlString; // force protocol
+        vaultVariables = payload.vaultSecrets.__getMatchingVariables(vaultUrl);
+
+        // resolve variables in URL string with initial vault variables
+        urlString = sdk.Property.replaceSubstitutions(urlString,
+            [...variableDefinitions, vaultVariables]);
+
+        if (urlString !== unresolvedUrlString) {
+            // get the final list of vault variables that match the resolved URL string
+            vaultUrl = new sdk.Url(urlString).toString(true);
+            vaultVariables = payload.vaultSecrets.__getMatchingVariables(vaultUrl);
+
+            // resolve vault variables in URL string
+            // @note other variable scopes are skipped as they are already resolved
+            urlString = sdk.Property.replaceSubstitutions(urlString, [vaultVariables]);
+        }
+    }
+    else if (urlString) {
+        urlString = sdk.Property.replaceSubstitutions(urlString, variableDefinitions);
+    }
+
+    return { urlString, variableDefinitions, vaultVariables };
+}
+
 /**
  * Utility functions that are required to be re-used throughout the runner
  *
@@ -397,6 +456,23 @@ module.exports = {
         };
     },
 
+    /**
+     * Resolve the URL string from an item by substituting all variables (including vault).
+     *
+     * @param {Item} item - The request item
+     * @param {Object} payload - Payload containing variable scopes
+     * @param {VariableScope} payload._variables -
+     * @param {Object} payload.data -
+     * @param {VariableScope} payload.environment -
+     * @param {VariableScope} payload.collectionVariables -
+     * @param {VariableScope} payload.globals -
+     * @param {VariableScope} payload.vaultSecrets -
+     * @returns {String} - The fully resolved URL string
+     */
+    resolveUrlString (item, payload) {
+        return resolveUrl(item, payload).urlString;
+    },
+
     /**
      * Resolve variables in item and auth in context.
      *
@@ -414,55 +490,16 @@ module.exports = {
     resolveVariables (context, payload) {
         if (!(context.item && context.item.request)) { return; }
 
-        // @todo - resolve variables in a more graceful way
-        var variableDefinitions = [
-            // extract the variable list from variable scopes
-            // @note: this is the order of precedence for variable resolution - don't change it
-                _.get(payload, '_variables.values', []),
-                _.get(payload, 'data', []),
-                _.get(payload, 'environment.values', []),
-                _.get(payload, 'collectionVariables.values', []),
-                _.get(payload, 'globals.values', [])
-            // @note vault variables are added later
-            ],
-            vaultValues = _.get(payload, 'vaultSecrets.values'),
-
-            hasVaultSecrets = vaultValues ? vaultValues.count() > 0 : false,
-
+        var resolved = resolveUrl(context.item, payload),
+            urlString = resolved.urlString,
+            variableDefinitions = resolved.variableDefinitions,
             itemParent = context.item.parent(),
-            urlObj = context.item.request.url,
-            // @note URL string is used to resolve nested variables as URL parser doesn't support them well.
-            urlString = urlObj.toString(),
-            unresolvedUrlString = urlString,
-
-            vaultVariables,
-            vaultUrl,
             item,
             auth;
 
-        if (hasVaultSecrets) {
-        // get the vault variables that match the unresolved URL string
-            vaultUrl = urlObj.protocol ? urlString : `http://${urlString}`; // force protocol
-            vaultVariables = payload.vaultSecrets.__getMatchingVariables(vaultUrl);
-
-            // resolve variables in URL string with initial vault variables
-            urlString = sdk.Property.replaceSubstitutions(urlString, [...variableDefinitions, vaultVariables]);
-
-            if (urlString !== unresolvedUrlString) {
-            // get the final list of vault variables that match the resolved URL string
-                vaultUrl = new sdk.Url(urlString).toString(true);
-                vaultVariables = payload.vaultSecrets.__getMatchingVariables(vaultUrl);
-
-                // resolve vault variables in URL string
-                // @note other variable scopes are skipped as they are already resolved
-                urlString = sdk.Property.replaceSubstitutions(urlString, [vaultVariables]);
-            }
-
-            // add vault variables to the list of variable definitions
-            variableDefinitions.push(vaultVariables);
-        }
-        else if (urlString) {
-            urlString = sdk.Property.replaceSubstitutions(urlString, variableDefinitions);
+        // add vault variables to the list of variable definitions
+        if (resolved.vaultVariables) {
+            variableDefinitions.push(resolved.vaultVariables);
         }
 
         // @todo - no need to sync variables when SDK starts supporting resolution from scope directly
@@ -474,6 +511,7 @@ module.exports = {
         item.setParent(itemParent);
 
         // re-parse and update the URL from the resolved string
+        // @note URL string is used to resolve nested variables as URL parser doesn't support them well.
         urlString && (item.request.url = new sdk.Url(urlString));
 
         auth = context.auth;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "postman-runtime",
-  "version": "7.52.0-beta.4",
+  "version": "7.52.0",
   "description": "Underlying library of executing Postman Collections",
   "author": "Postman Inc.",
   "license": "Apache-2.0",
@@ -54,9 +54,9 @@
     "node-forge": "1.3.3",
     "node-oauth1": "1.3.0",
     "performance-now": "2.1.0",
-    "postman-collection": "5.3.0-beta.2",
+    "postman-collection": "5.3.0",
     "postman-request": "2.88.1-postman.48",
-    "postman-sandbox": "6.6.1-beta.1",
+    "postman-sandbox": "6.6.1",
     "postman-url-encoder": "3.0.8",
     "serialised-error": "1.1.3",
     "strip-json-comments": "3.1.1",