-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
815 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| const MODULE_KEY = '__module_obj', // why not use `module`? | ||
| MODULE_WRAPPER = [ | ||
| '(function (exports, module) {\n', | ||
| `\n})(${MODULE_KEY}.exports, ${MODULE_KEY});` | ||
| ]; | ||
|
|
||
| /** | ||
| * Cache of all files that are available to be required. | ||
| * | ||
| * @typedef {Object.<string, { data: string } | { error: string }>} FileCache | ||
| */ | ||
|
|
||
| class PostmanRequireStore { | ||
| /** | ||
| * @param {FileCache} fileCache - fileCache | ||
| */ | ||
| constructor (fileCache) { | ||
| if (!fileCache) { | ||
| throw new Error('File cache is required'); | ||
| } | ||
|
|
||
| this.fileCache = fileCache; | ||
| } | ||
|
|
||
| /** | ||
| * Check if the file is available in the cache. | ||
| * | ||
| * @param {string} path - path | ||
| * @returns {boolean} | ||
| */ | ||
| hasFile (path) { | ||
| return Boolean(this.getFile(path)); | ||
| } | ||
|
|
||
| /** | ||
| * Get the file from the cache. | ||
| * | ||
| * @param {string} path - path | ||
| * @returns {Object|undefined} - file | ||
| */ | ||
| getFile (path) { | ||
| return this.fileCache[path]; | ||
| } | ||
|
|
||
| /** | ||
| * Get the resolved path for the file. | ||
| * | ||
| * @param {string} path - path | ||
| * @returns {string|undefined} - resolved path | ||
| */ | ||
| getResolvedPath (path) { | ||
| if (this.hasFile(path)) { | ||
| return path; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get the file data. | ||
| * | ||
| * @param {string} path - path | ||
| * @returns {string|undefined} | ||
| */ | ||
| getFileData (path) { | ||
| return this.hasFile(path) && this.getFile(path).data; | ||
| } | ||
|
|
||
| /** | ||
| * Check if the file has an error. | ||
| * | ||
| * @param {string} path - path | ||
| * @returns {boolean} | ||
| */ | ||
| hasError (path) { | ||
| return this.hasFile(path) && Boolean(this.getFile(path).error); | ||
| } | ||
|
|
||
| /** | ||
| * Get the file error. | ||
| * | ||
| * @param {string} path - path | ||
| * @returns {string|undefined} | ||
| */ | ||
| getFileError (path) { | ||
| return this.hasError(path) && this.getFile(path).error; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param {FileCache} fileCache - fileCache | ||
| * @param {Object} scope - scope | ||
| * @returns {Function} - postmanRequire | ||
| * @example | ||
| * const fileCache = { | ||
| * 'path/to/file.js': { | ||
| * data: 'module.exports = { foo: "bar" };' | ||
| * } | ||
| * }; | ||
| * | ||
| * const postmanRequire = createPostmanRequire(fileCache, scope); | ||
| * | ||
| * const module = postmanRequire('path/to/file.js'); | ||
| * console.log(module.foo); // bar | ||
| */ | ||
| function createPostmanRequire (fileCache, scope) { | ||
| const store = new PostmanRequireStore(fileCache || {}), | ||
| cache = {}; | ||
|
|
||
| /** | ||
| * @param {string} name - name | ||
| * @returns {any} - module | ||
| */ | ||
| function postmanRequire (name) { | ||
| const path = store.getResolvedPath(name); | ||
|
|
||
| if (!path) { | ||
| // Error should contain the name exactly as the user specified, | ||
| // and not the resolved path. | ||
| throw new Error(`Cannot find module '${name}'`); | ||
| } | ||
|
|
||
| if (store.hasError(path)) { | ||
| throw new Error(`Error while loading module '${name}': ${store.getFileError(path)}`); | ||
| } | ||
|
|
||
| // Any module should not be evaluated twice, so we use it from the | ||
| // cache. If there's a circular dependency, the partially evaluated | ||
| // module will be returned from the cache. | ||
| if (cache[path]) { | ||
| // Always use the resolved path as the ID of the module. This | ||
| // ensures that relative paths are handled correctly. | ||
| return cache[path].exports; | ||
| } | ||
|
|
||
| /* eslint-disable-next-line one-var */ | ||
| const file = store.getFileData(path), | ||
| 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. | ||
| cache[moduleObj.id] = moduleObj; | ||
|
|
||
| /* eslint-disable-next-line one-var */ | ||
| 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; | ||
| } | ||
|
|
||
| return postmanRequire; | ||
| } | ||
|
|
||
| module.exports = createPostmanRequire; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.