"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.defineConfig = void 0; exports.deserializeConfig = deserializeConfig; exports.loadConfig = loadConfig; exports.loadConfigFromFileRestartIfNeeded = loadConfigFromFileRestartIfNeeded; exports.loadEmptyConfigForMergeReports = loadEmptyConfigForMergeReports; exports.resolveConfigLocation = resolveConfigLocation; exports.restartWithExperimentalTsEsm = restartWithExperimentalTsEsm; var _fs = _interopRequireDefault(require("fs")); var _path = _interopRequireDefault(require("path")); var _utils = require("playwright-core/lib/utils"); var _transform = require("../transform/transform"); var _util = require("../util"); var _config = require("./config"); var _esmLoaderHost = require("./esmLoaderHost"); var _compilationCache = require("../transform/compilationCache"); var _esmUtils = require("../transform/esmUtils"); function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; } /** * Copyright Microsoft Corporation. All rights reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ const kDefineConfigWasUsed = Symbol('defineConfigWasUsed'); const defineConfig = (...configs) => { let result = configs[0]; for (let i = 1; i < configs.length; ++i) { const config = configs[i]; result = { ...result, ...config, expect: { ...result.expect, ...config.expect }, use: { ...result.use, ...config.use }, build: { ...result.build, ...config.build }, webServer: [...(Array.isArray(result.webServer) ? result.webServer : result.webServer ? [result.webServer] : []), ...(Array.isArray(config.webServer) ? config.webServer : config.webServer ? [config.webServer] : [])] }; if (!result.projects && !config.projects) continue; const projectOverrides = new Map(); for (const project of config.projects || []) projectOverrides.set(project.name, project); const projects = []; for (const project of result.projects || []) { const projectOverride = projectOverrides.get(project.name); if (projectOverride) { projects.push({ ...project, ...projectOverride, use: { ...project.use, ...projectOverride.use } }); projectOverrides.delete(project.name); } else { projects.push(project); } } projects.push(...projectOverrides.values()); result.projects = projects; } result[kDefineConfigWasUsed] = true; return result; }; exports.defineConfig = defineConfig; async function deserializeConfig(data) { if (data.compilationCache) (0, _compilationCache.addToCompilationCache)(data.compilationCache); return await loadConfig(data.location, data.configCLIOverrides, undefined, data.metadata ? JSON.parse(data.metadata) : undefined); } async function loadUserConfig(location) { let object = location.resolvedConfigFile ? await (0, _transform.requireOrImport)(location.resolvedConfigFile) : {}; if (object && typeof object === 'object' && 'default' in object) object = object['default']; return object; } async function loadConfig(location, overrides, ignoreProjectDependencies = false, metadata) { var _playwrightTest, _userConfig$build; // 1. Setup tsconfig; configure ESM loader with tsconfig and compilation cache. (0, _transform.setSingleTSConfig)(overrides === null || overrides === void 0 ? void 0 : overrides.tsconfig); await (0, _esmLoaderHost.configureESMLoader)(); // 2. Load and validate playwright config. const userConfig = await loadUserConfig(location); validateConfig(location.resolvedConfigFile || '', userConfig); const fullConfig = new _config.FullConfigInternal(location, userConfig, overrides || {}, metadata); fullConfig.defineConfigWasUsed = !!userConfig[kDefineConfigWasUsed]; if (ignoreProjectDependencies) { for (const project of fullConfig.projects) { project.deps = []; project.teardown = undefined; } } // 3. Load transform options from the playwright config. const babelPlugins = ((_playwrightTest = userConfig['@playwright/test']) === null || _playwrightTest === void 0 ? void 0 : _playwrightTest.babelPlugins) || []; const external = ((_userConfig$build = userConfig.build) === null || _userConfig$build === void 0 ? void 0 : _userConfig$build.external) || []; (0, _transform.setTransformConfig)({ babelPlugins, external }); if (!(overrides !== null && overrides !== void 0 && overrides.tsconfig)) (0, _transform.setSingleTSConfig)(fullConfig === null || fullConfig === void 0 ? void 0 : fullConfig.singleTSConfigPath); // 4. Send transform options to ESM loader. await (0, _esmLoaderHost.configureESMLoaderTransformConfig)(); return fullConfig; } function validateConfig(file, config) { if (typeof config !== 'object' || !config) throw (0, _util.errorWithFile)(file, `Configuration file must export a single object`); validateProject(file, config, 'config'); if ('forbidOnly' in config && config.forbidOnly !== undefined) { if (typeof config.forbidOnly !== 'boolean') throw (0, _util.errorWithFile)(file, `config.forbidOnly must be a boolean`); } if ('globalSetup' in config && config.globalSetup !== undefined) { if (Array.isArray(config.globalSetup)) { config.globalSetup.forEach((item, index) => { if (typeof item !== 'string') throw (0, _util.errorWithFile)(file, `config.globalSetup[${index}] must be a string`); }); } else if (typeof config.globalSetup !== 'string') { throw (0, _util.errorWithFile)(file, `config.globalSetup must be a string`); } } if ('globalTeardown' in config && config.globalTeardown !== undefined) { if (Array.isArray(config.globalTeardown)) { config.globalTeardown.forEach((item, index) => { if (typeof item !== 'string') throw (0, _util.errorWithFile)(file, `config.globalTeardown[${index}] must be a string`); }); } else if (typeof config.globalTeardown !== 'string') { throw (0, _util.errorWithFile)(file, `config.globalTeardown must be a string`); } } if ('globalTimeout' in config && config.globalTimeout !== undefined) { if (typeof config.globalTimeout !== 'number' || config.globalTimeout < 0) throw (0, _util.errorWithFile)(file, `config.globalTimeout must be a non-negative number`); } if ('grep' in config && config.grep !== undefined) { if (Array.isArray(config.grep)) { config.grep.forEach((item, index) => { if (!(0, _utils.isRegExp)(item)) throw (0, _util.errorWithFile)(file, `config.grep[${index}] must be a RegExp`); }); } else if (!(0, _utils.isRegExp)(config.grep)) { throw (0, _util.errorWithFile)(file, `config.grep must be a RegExp`); } } if ('grepInvert' in config && config.grepInvert !== undefined) { if (Array.isArray(config.grepInvert)) { config.grepInvert.forEach((item, index) => { if (!(0, _utils.isRegExp)(item)) throw (0, _util.errorWithFile)(file, `config.grepInvert[${index}] must be a RegExp`); }); } else if (!(0, _utils.isRegExp)(config.grepInvert)) { throw (0, _util.errorWithFile)(file, `config.grepInvert must be a RegExp`); } } if ('maxFailures' in config && config.maxFailures !== undefined) { if (typeof config.maxFailures !== 'number' || config.maxFailures < 0) throw (0, _util.errorWithFile)(file, `config.maxFailures must be a non-negative number`); } if ('preserveOutput' in config && config.preserveOutput !== undefined) { if (typeof config.preserveOutput !== 'string' || !['always', 'never', 'failures-only'].includes(config.preserveOutput)) throw (0, _util.errorWithFile)(file, `config.preserveOutput must be one of "always", "never" or "failures-only"`); } if ('projects' in config && config.projects !== undefined) { if (!Array.isArray(config.projects)) throw (0, _util.errorWithFile)(file, `config.projects must be an array`); config.projects.forEach((project, index) => { validateProject(file, project, `config.projects[${index}]`); }); } if ('quiet' in config && config.quiet !== undefined) { if (typeof config.quiet !== 'boolean') throw (0, _util.errorWithFile)(file, `config.quiet must be a boolean`); } if ('reporter' in config && config.reporter !== undefined) { if (Array.isArray(config.reporter)) { config.reporter.forEach((item, index) => { if (!Array.isArray(item) || item.length <= 0 || item.length > 2 || typeof item[0] !== 'string') throw (0, _util.errorWithFile)(file, `config.reporter[${index}] must be a tuple [name, optionalArgument]`); }); } else if (typeof config.reporter !== 'string') { throw (0, _util.errorWithFile)(file, `config.reporter must be a string`); } } if ('reportSlowTests' in config && config.reportSlowTests !== undefined && config.reportSlowTests !== null) { if (!config.reportSlowTests || typeof config.reportSlowTests !== 'object') throw (0, _util.errorWithFile)(file, `config.reportSlowTests must be an object`); if (!('max' in config.reportSlowTests) || typeof config.reportSlowTests.max !== 'number' || config.reportSlowTests.max < 0) throw (0, _util.errorWithFile)(file, `config.reportSlowTests.max must be a non-negative number`); if (!('threshold' in config.reportSlowTests) || typeof config.reportSlowTests.threshold !== 'number' || config.reportSlowTests.threshold < 0) throw (0, _util.errorWithFile)(file, `config.reportSlowTests.threshold must be a non-negative number`); } if ('shard' in config && config.shard !== undefined && config.shard !== null) { if (!config.shard || typeof config.shard !== 'object') throw (0, _util.errorWithFile)(file, `config.shard must be an object`); if (!('total' in config.shard) || typeof config.shard.total !== 'number' || config.shard.total < 1) throw (0, _util.errorWithFile)(file, `config.shard.total must be a positive number`); if (!('current' in config.shard) || typeof config.shard.current !== 'number' || config.shard.current < 1 || config.shard.current > config.shard.total) throw (0, _util.errorWithFile)(file, `config.shard.current must be a positive number, not greater than config.shard.total`); } if ('updateSnapshots' in config && config.updateSnapshots !== undefined) { if (typeof config.updateSnapshots !== 'string' || !['all', 'changed', 'missing', 'none'].includes(config.updateSnapshots)) throw (0, _util.errorWithFile)(file, `config.updateSnapshots must be one of "all", "changed", "missing" or "none"`); } if ('workers' in config && config.workers !== undefined) { if (typeof config.workers === 'number' && config.workers <= 0) throw (0, _util.errorWithFile)(file, `config.workers must be a positive number`);else if (typeof config.workers === 'string' && !config.workers.endsWith('%')) throw (0, _util.errorWithFile)(file, `config.workers must be a number or percentage`); } if ('tsconfig' in config && config.tsconfig !== undefined) { if (typeof config.tsconfig !== 'string') throw (0, _util.errorWithFile)(file, `config.tsconfig must be a string`); if (!_fs.default.existsSync(_path.default.resolve(file, '..', config.tsconfig))) throw (0, _util.errorWithFile)(file, `config.tsconfig does not exist`); } } function validateProject(file, project, title) { if (typeof project !== 'object' || !project) throw (0, _util.errorWithFile)(file, `${title} must be an object`); if ('name' in project && project.name !== undefined) { if (typeof project.name !== 'string') throw (0, _util.errorWithFile)(file, `${title}.name must be a string`); } if ('outputDir' in project && project.outputDir !== undefined) { if (typeof project.outputDir !== 'string') throw (0, _util.errorWithFile)(file, `${title}.outputDir must be a string`); } if ('repeatEach' in project && project.repeatEach !== undefined) { if (typeof project.repeatEach !== 'number' || project.repeatEach < 0) throw (0, _util.errorWithFile)(file, `${title}.repeatEach must be a non-negative number`); } if ('retries' in project && project.retries !== undefined) { if (typeof project.retries !== 'number' || project.retries < 0) throw (0, _util.errorWithFile)(file, `${title}.retries must be a non-negative number`); } if ('testDir' in project && project.testDir !== undefined) { if (typeof project.testDir !== 'string') throw (0, _util.errorWithFile)(file, `${title}.testDir must be a string`); } for (const prop of ['testIgnore', 'testMatch']) { if (prop in project && project[prop] !== undefined) { const value = project[prop]; if (Array.isArray(value)) { value.forEach((item, index) => { if (typeof item !== 'string' && !(0, _utils.isRegExp)(item)) throw (0, _util.errorWithFile)(file, `${title}.${prop}[${index}] must be a string or a RegExp`); }); } else if (typeof value !== 'string' && !(0, _utils.isRegExp)(value)) { throw (0, _util.errorWithFile)(file, `${title}.${prop} must be a string or a RegExp`); } } } if ('timeout' in project && project.timeout !== undefined) { if (typeof project.timeout !== 'number' || project.timeout < 0) throw (0, _util.errorWithFile)(file, `${title}.timeout must be a non-negative number`); } if ('use' in project && project.use !== undefined) { if (!project.use || typeof project.use !== 'object') throw (0, _util.errorWithFile)(file, `${title}.use must be an object`); } if ('ignoreSnapshots' in project && project.ignoreSnapshots !== undefined) { if (typeof project.ignoreSnapshots !== 'boolean') throw (0, _util.errorWithFile)(file, `${title}.ignoreSnapshots must be a boolean`); } } function resolveConfigLocation(configFile) { const configFileOrDirectory = configFile ? _path.default.resolve(process.cwd(), configFile) : process.cwd(); const resolvedConfigFile = resolveConfigFile(configFileOrDirectory); return { resolvedConfigFile, configDir: resolvedConfigFile ? _path.default.dirname(resolvedConfigFile) : configFileOrDirectory }; } function resolveConfigFile(configFileOrDirectory) { const resolveConfig = configFile => { if (_fs.default.existsSync(configFile)) return configFile; }; const resolveConfigFileFromDirectory = directory => { for (const ext of ['.ts', '.js', '.mts', '.mjs', '.cts', '.cjs']) { const configFile = resolveConfig(_path.default.resolve(directory, 'playwright.config' + ext)); if (configFile) return configFile; } }; if (!_fs.default.existsSync(configFileOrDirectory)) throw new Error(`${configFileOrDirectory} does not exist`); if (_fs.default.statSync(configFileOrDirectory).isDirectory()) { // When passed a directory, look for a config file inside. const configFile = resolveConfigFileFromDirectory(configFileOrDirectory); if (configFile) return configFile; // If there is no config, assume this as a root testing directory. return undefined; } // When passed a file, it must be a config file. return configFileOrDirectory; } async function loadConfigFromFileRestartIfNeeded(configFile, overrides, ignoreDeps) { const location = resolveConfigLocation(configFile); if (restartWithExperimentalTsEsm(location.resolvedConfigFile)) return null; return await loadConfig(location, overrides, ignoreDeps); } async function loadEmptyConfigForMergeReports() { // Merge reports is "different" for no good reason. It should not pick up local config from the cwd. return await loadConfig({ configDir: process.cwd() }); } function restartWithExperimentalTsEsm(configFile, force = false) { // Opt-out switch. if (process.env.PW_DISABLE_TS_ESM) return false; // There are two esm loader APIs: // - Older API that needs a process restart. Available in Node 16, 17, and non-latest 18, 19 and 20. // - Newer API that works in-process. Available in Node 21+ and latest 18, 19 and 20. // First check whether we have already restarted with the ESM loader from the older API. if (globalThis.__esmLoaderPortPreV20) { // clear execArgv after restart, so that childProcess.fork in user code does not inherit our loader. process.execArgv = (0, _esmUtils.execArgvWithoutExperimentalLoaderOptions)(); return false; } // Now check for the newer API presence. if (!require('node:module').register) { // With older API requiring a process restart, do so conditionally on the config. const configIsModule = !!configFile && (0, _util.fileIsModule)(configFile); if (!force && !configIsModule) return false; const innerProcess = require('child_process').fork(require.resolve('../../cli'), process.argv.slice(2), { env: { ...process.env, PW_TS_ESM_LEGACY_LOADER_ON: '1' }, execArgv: (0, _esmUtils.execArgvWithExperimentalLoaderOptions)() }); innerProcess.on('close', code => { if (code !== 0 && code !== null) (0, _utils.gracefullyProcessExitDoNotHang)(code); }); return true; } // With the newer API, always enable the ESM loader, because it does not need a restart. (0, _esmLoaderHost.registerESMLoader)(); return false; }