testcafe/lib/api/test-controller/execution-context.js

Automated browser testing for the modern web development stack.

"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.createExecutionContext = exports.setContextOptions = exports.DEFAULT_CONTEXT_OPTIONS = void 0;
const vm_1 = require("vm");
const module_1 = __importDefault(require("module"));
const path_1 = __importDefault(require("path"));
const exportable_lib_1 = __importDefault(require("../exportable-lib"));
const node_modules_folder_name_1 = __importDefault(require("../../utils/node-modules-folder-name"));
const OPTIONS_KEY = Symbol('options');
exports.DEFAULT_CONTEXT_OPTIONS = {
    skipVisibilityCheck: false,
    collectionMode: false,
};
function getModuleBasePaths(currentPath) {
    const nodePaths = [];
    let parentDir = path_1.default.dirname(currentPath);
    while (currentPath !== parentDir) {
        currentPath = parentDir;
        parentDir = path_1.default.dirname(currentPath);
        nodePaths.push(path_1.default.join(currentPath, node_modules_folder_name_1.default));
    }
    return nodePaths;
}
function createRequire(filename) {
    //Deprecated since: Node v12.2.0
    if (module_1.default.createRequireFromPath)
        return module_1.default.createRequireFromPath(filename);
    if (module_1.default.createRequire)
        return module_1.default.createRequire(filename);
    const dummyModule = new module_1.default(filename, module);
    const localModulesPaths = getModuleBasePaths(filename);
    dummyModule.filename = filename;
    dummyModule.paths = localModulesPaths.concat(module.paths);
    return id => dummyModule.require(id);
}
function createSelectorDefinition(testRun) {
    return (fn, options = {}) => {
        const { skipVisibilityCheck, collectionMode } = testRun.controller ?
            testRun.controller.getExecutionContext()[OPTIONS_KEY] :
            createExecutionContext(testRun)[OPTIONS_KEY];
        if (skipVisibilityCheck)
            options.visibilityCheck = false;
        if (testRun && testRun.id)
            options.boundTestRun = testRun;
        if (collectionMode)
            options.collectionMode = collectionMode;
        return exportable_lib_1.default.Selector(fn, options);
    };
}
function createClientFunctionDefinition(testRun) {
    return (fn, options = {}) => {
        if (testRun && testRun.id)
            options.boundTestRun = testRun;
        return exportable_lib_1.default.ClientFunction(fn, options);
    };
}
function setContextOptions(context, options) {
    context[OPTIONS_KEY] = options;
}
exports.setContextOptions = setContextOptions;
function createExecutionContext(testRun) {
    const filename = testRun.test.testFile.filename;
    const replacers = {
        require: createRequire(filename),
        __filename: filename,
        __dirname: path_1.default.dirname(filename),
        t: testRun.controller,
        Selector: createSelectorDefinition(testRun),
        ClientFunction: createClientFunctionDefinition(testRun),
        Role: exportable_lib_1.default.Role,
        RequestLogger: exportable_lib_1.default.RequestLogger,
        RequestMock: exportable_lib_1.default.RequestMock,
        RequestHook: exportable_lib_1.default.RequestHook,
        [OPTIONS_KEY]: exports.DEFAULT_CONTEXT_OPTIONS,
        userVariables: exportable_lib_1.default.userVariables,
    };
    return (0, vm_1.createContext)(new Proxy(replacers, {
        get: (target, property) => {
            if (replacers.hasOwnProperty(property))
                return replacers[property];
            if (global.hasOwnProperty(property))
                return global[property];
            throw new Error(`${property} is not defined`);
        },
    }));
}
exports.createExecutionContext = createExecutionContext;
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"execution-context.js","sourceRoot":"","sources":["../../../src/api/test-controller/execution-context.js"],"names":[],"mappings":";;;;;;AAAA,2BAAmC;AACnC,oDAA4B;AAC5B,gDAAwB;AACxB,uEAA8C;AAC9C,oGAAgE;AAEhE,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AAEzB,QAAA,uBAAuB,GAAG;IACnC,mBAAmB,EAAE,KAAK;IAC1B,cAAc,EAAO,KAAK;CAC7B,CAAC;AAEF,SAAS,kBAAkB,CAAE,WAAW;IACpC,MAAM,SAAS,GAAG,EAAE,CAAC;IACrB,IAAI,SAAS,GAAK,cAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAE5C,OAAO,WAAW,KAAK,SAAS,EAAE;QAC9B,WAAW,GAAG,SAAS,CAAC;QACxB,SAAS,GAAK,cAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAExC,SAAS,CAAC,IAAI,CAAC,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,kCAAY,CAAC,CAAC,CAAC;KACxD;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,SAAS,aAAa,CAAE,QAAQ;IAC5B,gCAAgC;IAChC,IAAI,gBAAM,CAAC,qBAAqB;QAC5B,OAAO,gBAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IAElD,IAAI,gBAAM,CAAC,aAAa;QACpB,OAAO,gBAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAE1C,MAAM,WAAW,GAAY,IAAI,gBAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC1D,MAAM,iBAAiB,GAAM,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAE1D,WAAW,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAChC,WAAW,CAAC,KAAK,GAAM,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAE9D,OAAO,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;AACzC,CAAC;AAED,SAAS,wBAAwB,CAAE,OAAO;IACtC,OAAO,CAAC,EAAE,EAAE,OAAO,GAAG,EAAE,EAAE,EAAE;QACxB,MAAM,EAAE,mBAAmB,EAAE,cAAc,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;YAChE,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;YACvD,sBAAsB,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC;QAEjD,IAAI,mBAAmB;YACnB,OAAO,CAAC,eAAe,GAAG,KAAK,CAAC;QAEpC,IAAI,OAAO,IAAI,OAAO,CAAC,EAAE;YACrB,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC;QAEnC,IAAI,cAAc;YACd,OAAO,CAAC,cAAc,GAAG,cAAc,CAAC;QAE5C,OAAO,wBAAa,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC,CAAC;AACN,CAAC;AAED,SAAS,8BAA8B,CAAE,OAAO;IAC5C,OAAO,CAAC,EAAE,EAAE,OAAO,GAAG,EAAE,EAAE,EAAE;QACxB,IAAI,OAAO,IAAI,OAAO,CAAC,EAAE;YACrB,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC;QAEnC,OAAO,wBAAa,CAAC,cAAc,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC,CAAC;AACN,CAAC;AAED,SAAgB,iBAAiB,CAAE,OAAO,EAAE,OAAO;IAC/C,OAAO,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC;AACnC,CAAC;AAFD,8CAEC;AAED,SAAgB,sBAAsB,CAAE,OAAO;IAC3C,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAEhD,MAAM,SAAS,GAAG;QACd,OAAO,EAAS,aAAa,CAAC,QAAQ,CAAC;QACvC,UAAU,EAAM,QAAQ;QACxB,SAAS,EAAO,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QACtC,CAAC,EAAe,OAAO,CAAC,UAAU;QAClC,QAAQ,EAAQ,wBAAwB,CAAC,OAAO,CAAC;QACjD,cAAc,EAAE,8BAA8B,CAAC,OAAO,CAAC;QACvD,IAAI,EAAY,wBAAa,CAAC,IAAI;QAClC,aAAa,EAAG,wBAAa,CAAC,aAAa;QAC3C,WAAW,EAAK,wBAAa,CAAC,WAAW;QACzC,WAAW,EAAK,wBAAa,CAAC,WAAW;QACzC,CAAC,WAAW,CAAC,EAAG,+BAAuB;QACvC,aAAa,EAAG,wBAAa,CAAC,aAAa;KAC9C,CAAC;IAEF,OAAO,IAAA,kBAAa,EAAC,IAAI,KAAK,CAAC,SAAS,EAAE;QACtC,GAAG,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;YACtB,IAAI,SAAS,CAAC,cAAc,CAAC,QAAQ,CAAC;gBAClC,OAAO,SAAS,CAAC,QAAQ,CAAC,CAAC;YAE/B,IAAI,MAAM,CAAC,cAAc,CAAC,QAAQ,CAAC;gBAC/B,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC;YAE5B,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,iBAAiB,CAAC,CAAC;QAClD,CAAC;KACJ,CAAC,CAAC,CAAC;AACR,CAAC;AA7BD,wDA6BC","sourcesContent":["import { createContext } from 'vm';\nimport Module from 'module';\nimport path from 'path';\nimport exportableLib from '../exportable-lib';\nimport NODE_MODULES from '../../utils/node-modules-folder-name';\n\nconst OPTIONS_KEY = Symbol('options');\n\nexport const DEFAULT_CONTEXT_OPTIONS = {\n    skipVisibilityCheck: false,\n    collectionMode:      false,\n};\n\nfunction getModuleBasePaths (currentPath) {\n    const nodePaths = [];\n    let parentDir   = path.dirname(currentPath);\n\n    while (currentPath !== parentDir) {\n        currentPath = parentDir;\n        parentDir   = path.dirname(currentPath);\n\n        nodePaths.push(path.join(currentPath, NODE_MODULES));\n    }\n\n    return nodePaths;\n}\n\nfunction createRequire (filename) {\n    //Deprecated since: Node v12.2.0\n    if (Module.createRequireFromPath)\n        return Module.createRequireFromPath(filename);\n\n    if (Module.createRequire)\n        return Module.createRequire(filename);\n\n    const dummyModule          = new Module(filename, module);\n    const localModulesPaths    = getModuleBasePaths(filename);\n\n    dummyModule.filename = filename;\n    dummyModule.paths    = localModulesPaths.concat(module.paths);\n\n    return id => dummyModule.require(id);\n}\n\nfunction createSelectorDefinition (testRun) {\n    return (fn, options = {}) => {\n        const { skipVisibilityCheck, collectionMode } = testRun.controller ?\n            testRun.controller.getExecutionContext()[OPTIONS_KEY] :\n            createExecutionContext(testRun)[OPTIONS_KEY];\n\n        if (skipVisibilityCheck)\n            options.visibilityCheck = false;\n\n        if (testRun && testRun.id)\n            options.boundTestRun = testRun;\n\n        if (collectionMode)\n            options.collectionMode = collectionMode;\n\n        return exportableLib.Selector(fn, options);\n    };\n}\n\nfunction createClientFunctionDefinition (testRun) {\n    return (fn, options = {}) => {\n        if (testRun && testRun.id)\n            options.boundTestRun = testRun;\n\n        return exportableLib.ClientFunction(fn, options);\n    };\n}\n\nexport function setContextOptions (context, options) {\n    context[OPTIONS_KEY] = options;\n}\n\nexport function createExecutionContext (testRun) {\n    const filename = testRun.test.testFile.filename;\n\n    const replacers = {\n        require:        createRequire(filename),\n        __filename:     filename,\n        __dirname:      path.dirname(filename),\n        t:              testRun.controller,\n        Selector:       createSelectorDefinition(testRun),\n        ClientFunction: createClientFunctionDefinition(testRun),\n        Role:           exportableLib.Role,\n        RequestLogger:  exportableLib.RequestLogger,\n        RequestMock:    exportableLib.RequestMock,\n        RequestHook:    exportableLib.RequestHook,\n        [OPTIONS_KEY]:  DEFAULT_CONTEXT_OPTIONS,\n        userVariables:  exportableLib.userVariables,\n    };\n\n    return createContext(new Proxy(replacers, {\n        get: (target, property) => {\n            if (replacers.hasOwnProperty(property))\n                return replacers[property];\n\n            if (global.hasOwnProperty(property))\n                return global[property];\n\n            throw new Error(`${property} is not defined`);\n        },\n    }));\n}\n"]}