Skip to content
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.

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

fix: npmDependencies returns dependencies from .nx/installation/node_modules if node_modules is a file #2152

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions libs/shared/file-system/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ export { readAndCacheJsonFile } from './lib/cache-json';
export { clearJsonCache } from './lib/cache-json';
export { readAndParseJson } from './lib/cache-json';
export { listFiles } from './lib/list-files';
export { readDirectory } from './lib/read-directory';
export { readFile } from './lib/read-file';
9 changes: 9 additions & 0 deletions libs/shared/file-system/src/lib/read-directory.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { readdir } from 'fs/promises';

export async function readDirectory(path: string): Promise<string[]> {
try {
return readdir(path);
} catch {
return [];
}
}
105 changes: 105 additions & 0 deletions libs/shared/npm/src/lib/npm-dependencies.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
import { npmDependencies } from './npm-dependencies';
import { directoryExists, readDirectory } from '@nx-console/shared/file-system';

jest.mock('@nx-console/shared/file-system');

describe('npmDependencies', () => {
beforeEach(() => {
jest.resetAllMocks();
});

it('should return no dependencies if `node_modules` and `.nx/installation/node_modules` do not exist', async () => {
jest.mocked(directoryExists).mockResolvedValue(false);

expect(await npmDependencies('workspace')).toEqual([]);
});

it('should return dependencies from `node_modules` if `node_modules` exists', async () => {
jest
.mocked(directoryExists)
.mockImplementation((filePath) =>
Promise.resolve(
[
'workspace/node_modules',
'workspace/node_modules/package-foo',
'workspace/node_modules/package-bar',
].includes(filePath)
)
);
jest
.mocked(readDirectory)
.mockResolvedValue(['package-foo', 'package-bar']);

expect(await npmDependencies('workspace')).toEqual([
'workspace/node_modules/package-foo',
'workspace/node_modules/package-bar',
]);
});

it('should return dependencies from `.nx/installation/node_modules` if only `.nx/installation/node_modules` exists', async () => {
jest
.mocked(directoryExists)
.mockImplementation((filePath) =>
Promise.resolve(
[
'workspace/.nx/installation/node_modules',
'workspace/.nx/installation/node_modules/package-foo',
'workspace/.nx/installation/node_modules/package-bar',
].includes(filePath)
)
);
jest
.mocked(readDirectory)
.mockResolvedValue(['package-foo', 'package-bar']);

expect(await npmDependencies('workspace')).toEqual([
'workspace/.nx/installation/node_modules/package-foo',
'workspace/.nx/installation/node_modules/package-bar',
]);
});

it('should return packages from `node_modules` if `node_modules` and `.nx/installation/node_modules` exist', async () => {
jest
.mocked(directoryExists)
.mockImplementation((filePath) =>
Promise.resolve(
[
'workspace/node_modules',
'workspace/node_modules/package-foo',
'workspace/node_modules/package-bar',
'workspace/.nx/installation/node_modules',
].includes(filePath)
)
);
jest
.mocked(readDirectory)
.mockResolvedValue(['package-foo', 'package-bar']);

expect(await npmDependencies('workspace')).toEqual([
'workspace/node_modules/package-foo',
'workspace/node_modules/package-bar',
]);
});

it('should return scoped packages starting with @', async () => {
jest
.mocked(directoryExists)
.mockImplementation((filePath) =>
Promise.resolve(
[
'workspace/node_modules',
'workspace/node_modules/@scope',
'workspace/.nx/installation/node_modules',
].includes(filePath)
)
);
jest
.mocked(readDirectory)
.mockResolvedValueOnce(['@scope'])
.mockResolvedValueOnce(['package-foo']);

expect(await npmDependencies('workspace')).toEqual([
'workspace/node_modules/@scope/package-foo',
]);
});
});
55 changes: 21 additions & 34 deletions libs/shared/npm/src/lib/npm-dependencies.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { stat, readdir } from 'fs/promises';
import { join } from 'path';
import { directoryExists, readDirectory } from '@nx-console/shared/file-system';

/**
* Get a flat list of all node_modules folders in the workspace.
Expand All @@ -20,48 +20,35 @@ export async function npmDependencies(workspacePath: string) {
let nodeModulesDir = nodeModules;

const res: string[] = [];
try {
if (!(await stat(nodeModules)).isDirectory()) {
return res;
}
} catch {
try {
if (!(await stat(nodeModulesEncapsulated)).isDirectory()) {
return res;
} else {
nodeModulesDir = nodeModulesEncapsulated;
}
} catch {

if (!(await directoryExists(nodeModules))) {
if (!(await directoryExists(nodeModulesEncapsulated))) {
return res;
} else {
nodeModulesDir = nodeModulesEncapsulated;
}
}

const dirContents = await readdir(nodeModulesDir);
const dirContents = await readDirectory(nodeModulesDir);

for (const npmPackageOrScope of dirContents) {
try {
if (npmPackageOrScope.startsWith('.')) {
continue;
}

const packageStats = await stat(join(nodeModulesDir, npmPackageOrScope));
if (!packageStats.isDirectory()) {
continue;
}
if (npmPackageOrScope.startsWith('.')) {
continue;
}

if (npmPackageOrScope.startsWith('@')) {
(await readdir(join(nodeModulesDir, npmPackageOrScope))).forEach(
(p) => {
res.push(`${nodeModulesDir}/${npmPackageOrScope}/${p}`);
}
);
} else {
res.push(`${nodeModulesDir}/${npmPackageOrScope}`);
}
} catch (e) {
// ignore packages where reading them causes an error
if (!(await directoryExists(join(nodeModulesDir, npmPackageOrScope)))) {
continue;
}

if (npmPackageOrScope.startsWith('@')) {
(await readDirectory(join(nodeModulesDir, npmPackageOrScope))).forEach(
(p) => {
res.push(`${nodeModulesDir}/${npmPackageOrScope}/${p}`);
}
);
} else {
res.push(`${nodeModulesDir}/${npmPackageOrScope}`);
}
}

return res;
Expand Down
Loading