cypress-rspack-dev-server
Version:
Launches Rspack Dev Server for Component Testing
146 lines (145 loc) • 6.92 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.sourceFramework = sourceFramework;
exports.sourceRspack = sourceRspack;
exports.sourceRspackDevServer = sourceRspackDevServer;
exports.sourceDefaultRspackDependencies = sourceDefaultRspackDependencies;
exports.restoreLoadHook = restoreLoadHook;
const tslib_1 = require("tslib");
const module_1 = tslib_1.__importDefault(require("module"));
const path_1 = tslib_1.__importDefault(require("path"));
const debug_1 = tslib_1.__importDefault(require("debug"));
const dynamic_import_1 = require("../dynamic-import");
const debug = (0, debug_1.default)('cypress-rspack-dev-server:sourceRelativeRspackModules');
const originalModuleLoad = module_1.default._load;
const originalModuleResolveFilename = module_1.default._resolveFilename;
const frameworkRspackMapper = {
react: 'react',
vue: undefined,
next: 'next',
angular: '@angular-devkit/build-angular',
svelte: undefined,
};
function resolveEntryPoint(importPath, packageJson) {
let entryFile = packageJson.main || 'index.js';
if (packageJson.exports) {
const exportsDot = packageJson.exports['.'] || packageJson.exports;
if (typeof exportsDot === 'string') {
entryFile = exportsDot;
}
else if (typeof exportsDot === 'object') {
entryFile = exportsDot.import || exportsDot.default || exportsDot.require || entryFile;
}
}
return path_1.default.resolve(importPath, entryFile);
}
// Source the users framework from the provided projectRoot. The framework, if available, will serve
// as the resolve base for rspack dependency resolution.
function sourceFramework(config) {
debug('Framework: Attempting to source framework for %s', config.cypressConfig.projectRoot);
if (!config.framework) {
debug('Framework: No framework provided');
return null;
}
const sourceOfRspack = frameworkRspackMapper[config.framework];
if (!sourceOfRspack) {
debug('Not a higher-order framework so rspack dependencies should be resolvable from projectRoot');
return null;
}
const framework = {};
try {
const frameworkJsonPath = require.resolve(`${sourceOfRspack}/package.json`, {
paths: [config.cypressConfig.projectRoot],
});
const frameworkPathRoot = path_1.default.dirname(frameworkJsonPath);
// Want to make sure we're sourcing this from the user's code. Otherwise we can
// warn and tell them they don't have their dependencies installed
framework.importPath = frameworkPathRoot;
framework.packageJson = require(frameworkJsonPath);
debug('Framework: Successfully sourced framework - %o', framework);
return framework;
}
catch (e) {
debug('Framework: Failed to source framework - %s', e);
// TODO
return null;
}
}
// Source the rspack module from the provided framework or projectRoot. We override the module resolution
// so that other packages that import rspack resolve to the version we found.
async function sourceRspack(config, framework) {
var _a;
const searchRoot = (_a = framework === null || framework === void 0 ? void 0 : framework.importPath) !== null && _a !== void 0 ? _a : config.cypressConfig.projectRoot;
debug('Rspack: Attempting to source rspack from %s', searchRoot);
const rspack = {};
const rspackJsonPath = require.resolve('@rspack/core/package.json', {
paths: [searchRoot],
});
rspack.importPath = path_1.default.dirname(rspackJsonPath);
rspack.packageJson = require(rspackJsonPath);
const rspackEntryPath = resolveEntryPoint(rspack.importPath, rspack.packageJson);
const mod = await (0, dynamic_import_1.dynamicAbsoluteImport)(rspackEntryPath);
rspack.module = mod.rspack;
module_1.default._load = function (request, parent, isMain) {
if (request === 'rspack' || request.startsWith('rspack/')) {
const resolvePath = require.resolve(request, {
paths: [rspack.importPath],
});
return originalModuleLoad(resolvePath, parent, isMain);
}
return originalModuleLoad(request, parent, isMain);
};
module_1.default._resolveFilename = function (request, parent, isMain, options) {
if (request === 'rspack' || (request.startsWith('rspack/') && !(options === null || options === void 0 ? void 0 : options.paths))) {
const resolveFilename = originalModuleResolveFilename(request, parent, isMain, {
paths: [rspack.importPath],
});
return resolveFilename;
}
return originalModuleResolveFilename(request, parent, isMain, options);
};
return rspack;
}
// Source the @rspack/dev-server module from the provided framework or projectRoot.
// If none is found, we fallback to the version bundled with this package.
async function sourceRspackDevServer(config, framework) {
var _a;
const searchRoot = (_a = framework === null || framework === void 0 ? void 0 : framework.importPath) !== null && _a !== void 0 ? _a : config.cypressConfig.projectRoot;
const rspackDevServer = {};
let rspackDevServerJsonPath;
try {
rspackDevServerJsonPath = require.resolve('@rspack/dev-server/package.json', {
paths: [searchRoot],
});
}
catch (e) {
if (e.code !== 'MODULE_NOT_FOUND') {
debug('RspackDevServer: Failed to source @rspack/dev-server - %s', e);
throw e;
}
debug('RspackDevServer: Falling back to bundled version');
rspackDevServerJsonPath = require.resolve('@rspack/dev-server/package.json', {
paths: [__dirname],
});
}
rspackDevServer.importPath = path_1.default.dirname(rspackDevServerJsonPath);
rspackDevServer.packageJson = require(rspackDevServerJsonPath);
const rspackDevServerEntryPath = resolveEntryPoint(rspackDevServer.importPath, rspackDevServer.packageJson);
// WORKAROUND: see import comment at top of file
const mod = await (0, dynamic_import_1.dynamicAbsoluteImport)(rspackDevServerEntryPath);
rspackDevServer.module = mod.RspackDevServer;
debug('RspackDevServer: Successfully sourced @rspack/dev-server - %o', rspackDevServer);
return rspackDevServer;
}
// Most frameworks follow a similar path for sourcing rspack dependencies so this is a utility to handle all the sourcing.
async function sourceDefaultRspackDependencies(config) {
const framework = sourceFramework(config);
const rspack = await sourceRspack(config, framework);
const rspackDevServer = await sourceRspackDevServer(config, framework);
return { framework, rspack, rspackDevServer };
}
function restoreLoadHook() {
;
module_1.default._load = originalModuleLoad;
module_1.default._resolveFilename = originalModuleResolveFilename;
}