Skip to content

fix: adjust path replacement script to work with node 20.19.0 #3189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: release/12.2
Choose a base branch
from
Open

fix: adjust path replacement script to work with node 20.19.0 #3189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/it-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ on:
env:
NX_PARALLEL: ${{ vars.NX_PARALLEL }}
NX_TASK_TARGET_CONFIGURATION: ci
NX_SKIP_NX_CACHE: ${{ inputs.skipNxCache }}
NX_SKIP_NX_CACHE: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you need this change?

Copy link
Contributor Author

@guillaumerochelle guillaumerochelle May 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previous PR used the cache for the PR build and it-tests were successful.
The build on the release failed because it-tests ran without cache.

Trying to skip NX cache on the PR build to avoid merging something which won't build afterwards.
I will revert this once I find the solution.

YARN_ENABLE_HARDENED_MODE: 0

permissions:
Expand Down
21 changes: 12 additions & 9 deletions packages/@o3r/testing/src/tools/path-replacement/path-replacement.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ export function adjustPath(frameworkName: 'playwright' | 'protractor', customTra
const moduleTypesCache: Record<string, ModuleType> = {};
// eslint-disable-next-line @typescript-eslint/unbound-method -- No need to bind the method, we are using `apply`
const originalRequire = Module.prototype.require;
const originalResolve = require.resolve;
const regex = new RegExp(`@o3r/testing/core(?!/${frameworkName})(.*)`);
Module.prototype.require = function (this: NodeJS.Module, id: string) {
const newId = id.replace(regex, `@o3r/testing/core/${frameworkName}$1`);
Expand All @@ -32,9 +33,9 @@ export function adjustPath(frameworkName: 'playwright' | 'protractor', customTra
...this.paths.map((i) => i.replace(/[/\\]node_modules$/, ''))
];

const filePath = require.resolve(newId, { paths });
const filePath = originalResolve(newId, { paths });

const moduleType = checkModuleType(filePath, moduleTypesCache);
const moduleType = checkModuleType(filePath, moduleTypesCache, originalRequire, originalResolve);
if (moduleType === 'ESM') {
return convertESMToCJS(newId, filePath, cjsModulesCache, customTransformOptions);
}
Expand Down Expand Up @@ -89,8 +90,10 @@ function convertESMToCJS(moduleId: string, filePath: string, cjsModulesCache: Re
* Check the module type of the given module path.
* @param modulePath
* @param cache
* @param originalRequire
* @param originalResolve
*/
function checkModuleType(modulePath: string, cache: Record<string, ModuleType>): ModuleType {
function checkModuleType(modulePath: string, cache: Record<string, ModuleType>, originalRequire: (id: string) => any, originalResolve: NodeJS.RequireResolve): ModuleType {
if (cache[modulePath]) {
return cache[modulePath];
}
Expand All @@ -110,10 +113,9 @@ function checkModuleType(modulePath: string, cache: Record<string, ModuleType>):
}
case '.js': {
// Find recursively the package.json file to check if it is an ESM module
const packageJsonPath = findPackageJson(modulePath);
const packageJsonPath = findPackageJson(modulePath, originalResolve);
if (packageJsonPath !== null) {
// eslint-disable-next-line @typescript-eslint/no-require-imports -- Needed to require the package.json file
const packageJson = require(packageJsonPath);
const packageJson = originalRequire(packageJsonPath);
type = packageJson.type === 'module' ? 'ESM' : 'CJS';
}

Expand All @@ -132,12 +134,13 @@ function checkModuleType(modulePath: string, cache: Record<string, ModuleType>):
* Returns the path to the package.json file in the directory path given as argument.
* The method is called recursively to find the package.json in the parent directories.
* @param dirPath
* @param originalResolve
*/
function findPackageJson(dirPath: string): string | null {
function findPackageJson(dirPath: string, originalResolve: NodeJS.RequireResolve): string | null {
const packageJsonPath = path.join(dirPath, 'package.json');
const packageJsonExists = (() => {
try {
require.resolve(packageJsonPath);
originalResolve(packageJsonPath);
return true;
} catch {
return false;
Expand All @@ -152,5 +155,5 @@ function findPackageJson(dirPath: string): string | null {
if (parentDir === dirPath) {
return null;
}
return findPackageJson(parentDir);
return findPackageJson(parentDir, originalResolve);
}
Loading