Move require implementation to pm-require.js

Author: coditva

lib/sandbox/execute.js

@@ -9,7 +9,7 @@ const _ = require('lodash'),
     PostmanTimers = require('./timers'),
     PostmanAPI = require('./pmapi'),
     PostmanCookieStore = require('./cookie-store'),
-    PostmanRequireStore = require('./pm-require'),
+    createPostmanRequire = require('./pm-require'),
 
     EXECUTION_RESULT_EVENT_BASE = 'execution.result.',
     EXECUTION_REQUEST_EVENT_BASE = 'execution.request.',
@@ -229,8 +229,7 @@ module.exports = function (bridge, glob) {
                     },
                     dispatchAssertions,
                     new PostmanCookieStore(id, bridge, timers),
-                    new PostmanRequireStore(options.requireFileResolver),
-                    scope,
+                    createPostmanRequire(options.requireFileResolver, scope),
                     {
                         disabledAPIs: initializationOptions.disabledAPIs
                     })

lib/sandbox/pm-require.js

@@ -1,3 +1,9 @@
+const MODULE_KEY = '__module_obj', // why not use `module`?
+    MODULE_WRAPPER = [
+        '(function (exports, module) {\n',
+        `\n})(${MODULE_KEY}.exports, ${MODULE_KEY});`
+    ];
+
 class PostmanRequireStore {
     constructor (fileCache) {
         this.fileCache = fileCache || {};
@@ -18,4 +24,62 @@ class PostmanRequireStore {
     }
 }
 
-module.exports = PostmanRequireStore;
+function createPostmanRequire (fileCache, scope) {
+    const store = new PostmanRequireStore(fileCache);
+
+    return function require (name) {
+        const path = store.getResolvedPath(name);
+
+        this.cache = this.cache || {};
+
+        // Always use the resolved path as the ID of the module. This
+        // ensures that relative paths are handled correctly.
+        if (this.cache[path]) {
+            return this.cache[path].exports;
+        }
+
+        const file = path && store.getFileData(path);
+
+        if (!file) {
+            // Error should contain the name exactly as the user specified.
+            throw new Error(`Cannot find module '${name}'`);
+        }
+
+        const moduleObj = {
+            id: path,
+            exports: {}
+        };
+
+        // Add to cache before executing. This ensures that any dependency
+        // that tries to import it's parent/ancestor gets the cached
+        // version and not end up in infinite loop.
+        this.cache[moduleObj.id] = moduleObj;
+
+        const wrappedModule = MODULE_WRAPPER[0] + file + MODULE_WRAPPER[1];
+
+        scope.import({
+            [MODULE_KEY]: moduleObj
+        });
+
+        // Note: We're executing the code in the same scope as the one
+        // which called the `pm.require` function. This is because we want
+        // to share the global scope across all the required modules. Any
+        // locals are available inside the required modules and any locals
+        // created inside the required modules are available to the parent.
+        //
+        // Why `async` = true?
+        //   - We want to allow execution of async code like setTimeout etc.
+        scope.exec(wrappedModule, true, (err) => {
+            // Bubble up the error to be caught as execution error
+            if (err) {
+                throw err;
+            }
+        });
+
+        scope.unset(MODULE_KEY);
+
+        return moduleObj.exports;
+    };
+}
+
+module.exports = createPostmanRequire;

lib/sandbox/pmapi.js

@@ -7,12 +7,6 @@ const _ = require('lodash'),
     PostmanCookieList = sdk.CookieList,
     chai = require('chai'),
 
-    MODULE_KEY = '__module_obj', // why not use `module`?
-    MODULE_WRAPPER = [
-        '(function (exports, module) {\n',
-        `\n})(${MODULE_KEY}.exports, ${MODULE_KEY});`
-    ],
-
     /**
      * Use this function to assign readonly properties to an object
      *
@@ -53,12 +47,11 @@ const _ = require('lodash'),
  * @param {Function} onSkipRequest - callback to execute when pm.execution.skipRequest() called
  * @param {Function} onAssertion - callback to execute when pm.expect() called
  * @param {Object} cookieStore - cookie store
- * @param {Object} requireStore - require store
- * @param {Object} scope - scope
+ * @param {Function} require - require
  * @param {Object} [options] - options
  * @param {Array.<String>} [options.disabledAPIs] - list of disabled APIs
  */
-function Postman (execution, onRequest, onSkipRequest, onAssertion, cookieStore, requireStore, scope, options = {}) {
+function Postman (execution, onRequest, onSkipRequest, onAssertion, cookieStore, require, options = {}) {
     // @todo - ensure runtime passes data in a scope format
     let iterationData = new VariableScope();
 
@@ -301,59 +294,7 @@ function Postman (execution, onRequest, onSkipRequest, onAssertion, cookieStore,
             })
         },
 
-        require: function require (name) {
-            const path = requireStore.getResolvedPath(name);
-
-            this.cache = this.cache || {};
-
-            // Always use the resolved path as the ID of the module. This
-            // ensures that relative paths are handled correctly.
-            if (this.cache[path]) {
-                return this.cache[path].exports;
-            }
-
-            const file = path && requireStore.getFileData(path);
-
-            if (!file) {
-                // Error should contain the name exactly as the user specified.
-                throw new Error(`Cannot find module '${name}'`);
-            }
-
-            const moduleObj = {
-                id: path,
-                exports: {}
-            };
-
-            // Add to cache before executing. This ensures that any dependency
-            // that tries to import it's parent/ancestor gets the cached
-            // version and not end up in infinite loop.
-            this.cache[moduleObj.id] = moduleObj;
-
-            const wrappedModule = MODULE_WRAPPER[0] + file + MODULE_WRAPPER[1];
-
-            scope.import({
-                [MODULE_KEY]: moduleObj
-            });
-
-            // Note: We're executing the code in the same scope as the one
-            // which called the `pm.require` function. This is because we want
-            // to share the global scope across all the required modules. Any
-            // locals are available inside the required modules and any locals
-            // created inside the required modules are available to the parent.
-            //
-            // Why `async` = true?
-            //   - We want to allow execution of async code like setTimeout etc.
-            scope.exec(wrappedModule, true, (err) => {
-                // Bubble up the error to be caught as execution error
-                if (err) {
-                    throw err;
-                }
-            });
-
-            scope.unset(MODULE_KEY);
-
-            return moduleObj.exports;
-        }
+        require: require
     }, options.disabledAPIs);
 
     // extend pm api with test runner abilities