UNPKG

@browserstack/testcafe

Version:

Automated browser testing for the modern web development stack.

89 lines 12.1 kB
"use strict"; var __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", { value: true }); const debug_1 = __importDefault(require("debug")); const os_1 = __importDefault(require("os")); const path_1 = __importDefault(require("path")); const async_exit_hook_1 = __importDefault(require("async-exit-hook")); const tmp_1 = __importDefault(require("tmp")); const make_dir_1 = __importDefault(require("make-dir")); const lockfile_1 = __importDefault(require("./lockfile")); const cleanup_process_1 = __importDefault(require("./cleanup-process")); const promisified_functions_1 = require("../../utils/promisified-functions"); // NOTE: mutable for testing purposes const TESTCAFE_TMP_DIRS_ROOT = path_1.default.join(os_1.default.tmpdir(), 'testcafe'); const DEFAULT_NAME_PREFIX = 'tmp'; const USED_TEMP_DIRS = {}; const DEBUG_LOGGER = debug_1.default('testcafe:utils:temp-directory'); class TempDirectory { constructor(namePrefix) { this.namePrefix = namePrefix || DEFAULT_NAME_PREFIX; this.path = ''; this.lockFile = null; } async _getTmpDirsList() { const tmpDirNames = await promisified_functions_1.readDir(TempDirectory.TEMP_DIRECTORIES_ROOT); return tmpDirNames .filter(tmpDir => !USED_TEMP_DIRS[tmpDir]) .filter(tmpDir => path_1.default.basename(tmpDir).startsWith(this.namePrefix)); } async _findFreeTmpDir(tmpDirNames) { for (const tmpDirName of tmpDirNames) { const tmpDirPath = path_1.default.join(TempDirectory.TEMP_DIRECTORIES_ROOT, tmpDirName); const lockFile = new lockfile_1.default(tmpDirPath); if (lockFile.init()) { this.path = tmpDirPath; this.lockFile = lockFile; return true; } } return false; } async _createNewTmpDir() { this.path = tmp_1.default.tmpNameSync({ dir: TempDirectory.TEMP_DIRECTORIES_ROOT, prefix: this.namePrefix + '-' }); await make_dir_1.default(this.path); this.lockFile = new lockfile_1.default(this.path); this.lockFile.init(); } _disposeSync() { if (!USED_TEMP_DIRS[this.path]) return; this.lockFile.dispose(); delete USED_TEMP_DIRS[this.path]; } static async createDirectory(prefix) { const tmpDir = new TempDirectory(prefix); await tmpDir.init(); return tmpDir; } static disposeDirectoriesSync() { Object.values(USED_TEMP_DIRS).forEach(tmpDir => tmpDir._disposeSync()); } async init() { await make_dir_1.default(TempDirectory.TEMP_DIRECTORIES_ROOT); const tmpDirNames = await this._getTmpDirsList(this.namePrefix); DEBUG_LOGGER('Found temp directories:', tmpDirNames); const existingTmpDirFound = await this._findFreeTmpDir(tmpDirNames); if (!existingTmpDirFound) await this._createNewTmpDir(); DEBUG_LOGGER('Temp directory path: ', this.path); await cleanup_process_1.default.init(); await cleanup_process_1.default.addDirectory(this.path); USED_TEMP_DIRS[this.path] = this; } async dispose() { if (!USED_TEMP_DIRS[this.path]) return; this.lockFile.dispose(); await cleanup_process_1.default.removeDirectory(this.path); delete USED_TEMP_DIRS[this.path]; } } exports.default = TempDirectory; // NOTE: exposed for testing purposes TempDirectory.TEMP_DIRECTORIES_ROOT = TESTCAFE_TMP_DIRS_ROOT; async_exit_hook_1.default(TempDirectory.disposeDirectoriesSync); module.exports = exports.default; //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/temp-directory/index.js"],"names":[],"mappings":";;;;;AAAA,kDAA0B;AAC1B,4CAAoB;AACpB,gDAAwB;AACxB,sEAA4C;AAC5C,8CAAsB;AACtB,wDAA+B;AAC/B,0DAAkC;AAClC,wEAA+C;AAC/C,6EAA4D;AAG5D,qCAAqC;AACrC,MAAM,sBAAsB,GAAG,cAAI,CAAC,IAAI,CAAC,YAAE,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC;AAClE,MAAM,mBAAmB,GAAM,KAAK,CAAC;AACrC,MAAM,cAAc,GAAW,EAAE,CAAC;AAClC,MAAM,YAAY,GAAa,eAAK,CAAC,+BAA+B,CAAC,CAAC;AAEtE,MAAqB,aAAa;IAC9B,YAAa,UAAU;QACnB,IAAI,CAAC,UAAU,GAAG,UAAU,IAAI,mBAAmB,CAAC;QAEpD,IAAI,CAAC,IAAI,GAAO,EAAE,CAAC;QACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,eAAe;QACjB,MAAM,WAAW,GAAG,MAAM,+BAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;QAEvE,OAAO,WAAW;aACb,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;aACzC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,cAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;IAC7E,CAAC;IAED,KAAK,CAAC,eAAe,CAAE,WAAW;QAC9B,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;YAClC,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,aAAa,CAAC,qBAAqB,EAAE,UAAU,CAAC,CAAC;YAE9E,MAAM,QAAQ,GAAG,IAAI,kBAAQ,CAAC,UAAU,CAAC,CAAC;YAE1C,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE;gBACjB,IAAI,CAAC,IAAI,GAAO,UAAU,CAAC;gBAC3B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;gBAEzB,OAAO,IAAI,CAAC;aACf;SACJ;QAED,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,gBAAgB;QAClB,IAAI,CAAC,IAAI,GAAG,aAAG,CAAC,WAAW,CAAC,EAAE,GAAG,EAAE,aAAa,CAAC,qBAAqB,EAAE,MAAM,EAAE,IAAI,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC,CAAC;QAEzG,MAAM,kBAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEzB,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAExC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAED,YAAY;QACR,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC;YAC1B,OAAO;QAEX,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;QAExB,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,eAAe,CAAE,MAAM;QAChC,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;QAEzC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QAEpB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,sBAAsB;QACzB,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,KAAK,CAAC,IAAI;QACN,MAAM,kBAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;QAEnD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEhE,YAAY,CAAC,yBAAyB,EAAE,WAAW,CAAC,CAAC;QAErD,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAEpE,IAAI,CAAC,mBAAmB;YACpB,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAElC,YAAY,CAAC,uBAAuB,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAEjD,MAAM,yBAAc,CAAC,IAAI,EAAE,CAAC;QAC5B,MAAM,yBAAc,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE7C,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,OAAO;QACT,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC;YAC1B,OAAO;QAEX,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;QAExB,MAAM,yBAAc,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEhD,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;CACJ;AA9FD,gCA8FC;AAED,qCAAqC;AACrC,aAAa,CAAC,qBAAqB,GAAG,sBAAsB,CAAC;AAE7D,yBAAa,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC","sourcesContent":["import debug from 'debug';\nimport os from 'os';\nimport path from 'path';\nimport setupExitHook from 'async-exit-hook';\nimport tmp from 'tmp';\nimport makeDir from 'make-dir';\nimport LockFile from './lockfile';\nimport cleanupProcess from './cleanup-process';\nimport { readDir } from '../../utils/promisified-functions';\n\n\n// NOTE: mutable for testing purposes\nconst TESTCAFE_TMP_DIRS_ROOT = path.join(os.tmpdir(), 'testcafe');\nconst DEFAULT_NAME_PREFIX    = 'tmp';\nconst USED_TEMP_DIRS         = {};\nconst DEBUG_LOGGER           = debug('testcafe:utils:temp-directory');\n\nexport default class TempDirectory {\n    constructor (namePrefix) {\n        this.namePrefix = namePrefix || DEFAULT_NAME_PREFIX;\n\n        this.path     = '';\n        this.lockFile = null;\n    }\n\n    async _getTmpDirsList () {\n        const tmpDirNames = await readDir(TempDirectory.TEMP_DIRECTORIES_ROOT);\n\n        return tmpDirNames\n            .filter(tmpDir => !USED_TEMP_DIRS[tmpDir])\n            .filter(tmpDir => path.basename(tmpDir).startsWith(this.namePrefix));\n    }\n\n    async _findFreeTmpDir (tmpDirNames) {\n        for (const tmpDirName of tmpDirNames) {\n            const tmpDirPath = path.join(TempDirectory.TEMP_DIRECTORIES_ROOT, tmpDirName);\n\n            const lockFile = new LockFile(tmpDirPath);\n\n            if (lockFile.init()) {\n                this.path     = tmpDirPath;\n                this.lockFile = lockFile;\n\n                return true;\n            }\n        }\n\n        return false;\n    }\n\n    async _createNewTmpDir () {\n        this.path = tmp.tmpNameSync({ dir: TempDirectory.TEMP_DIRECTORIES_ROOT, prefix: this.namePrefix + '-' });\n\n        await makeDir(this.path);\n\n        this.lockFile = new LockFile(this.path);\n\n        this.lockFile.init();\n    }\n\n    _disposeSync () {\n        if (!USED_TEMP_DIRS[this.path])\n            return;\n\n        this.lockFile.dispose();\n\n        delete USED_TEMP_DIRS[this.path];\n    }\n\n    static async createDirectory (prefix) {\n        const tmpDir = new TempDirectory(prefix);\n\n        await tmpDir.init();\n\n        return tmpDir;\n    }\n\n    static disposeDirectoriesSync () {\n        Object.values(USED_TEMP_DIRS).forEach(tmpDir => tmpDir._disposeSync());\n    }\n\n    async init () {\n        await makeDir(TempDirectory.TEMP_DIRECTORIES_ROOT);\n\n        const tmpDirNames = await this._getTmpDirsList(this.namePrefix);\n\n        DEBUG_LOGGER('Found temp directories:', tmpDirNames);\n\n        const existingTmpDirFound = await this._findFreeTmpDir(tmpDirNames);\n\n        if (!existingTmpDirFound)\n            await this._createNewTmpDir();\n\n        DEBUG_LOGGER('Temp directory path: ', this.path);\n\n        await cleanupProcess.init();\n        await cleanupProcess.addDirectory(this.path);\n\n        USED_TEMP_DIRS[this.path] = this;\n    }\n\n    async dispose () {\n        if (!USED_TEMP_DIRS[this.path])\n            return;\n\n        this.lockFile.dispose();\n\n        await cleanupProcess.removeDirectory(this.path);\n\n        delete USED_TEMP_DIRS[this.path];\n    }\n}\n\n// NOTE: exposed for testing purposes\nTempDirectory.TEMP_DIRECTORIES_ROOT = TESTCAFE_TMP_DIRS_ROOT;\n\nsetupExitHook(TempDirectory.disposeDirectoriesSync);\n"]}