Skip to content

Commit 93faa7c

Browse files
Strum355Strum355
authored
fix(npm): extract workspace member subtree from npm ls output (#485)
Implements TC-4181
1 parent f136061 commit 93faa7c

9 files changed

Lines changed: 200 additions & 2 deletions

File tree

‎src/providers/javascript_npm.js‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,26 @@ export default class Javascript_npm extends Base_javascript {
1717
_updateLockFileCmdArgs() {
1818
return ['install', '--package-lock-only'];
1919
}
20+
21+
_buildDependencyTree(includeTransitive, opts = {}) {
22+
// npm ls --json returns a single tree rooted at the workspace root.
23+
// When analyzing a workspace member, its deps are nested under the
24+
// root's dependencies keyed by the member name — extract that subtree
25+
// so downstream analysis sees only the member's dependencies.
26+
const tree = super._buildDependencyTree(includeTransitive, opts);
27+
const memberName = this._getManifest().name;
28+
if (tree.name === memberName) {
29+
return tree;
30+
}
31+
const memberEntry = tree.dependencies?.[memberName];
32+
if (memberEntry) {
33+
return {
34+
name: memberName,
35+
version: memberEntry.version || this._getManifest().version,
36+
dependencies: memberEntry.dependencies,
37+
optionalDependencies: memberEntry.optionalDependencies,
38+
};
39+
}
40+
return tree;
41+
}
2042
}

‎test/providers/javascript.test.js‎

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ suite('testing the javascript-npm data provider', async () => {
9090

9191
compareSboms(providedDataForStack.content, expectedSbom);
9292

93-
}).timeout(process.env.GITHUB_ACTIONS ? 30000 : 10000);
93+
}).timeout(30000);
9494
test(`verify package.json data provided for ${providerName} - component analysis - ${scenario}`, async () => {
9595
// load the expected list for the scenario
9696
let expectedSbom = fs.readFileSync(`test/providers/tst_manifests/js-common/${testCase}/component_expected_sbom.json`,).toString().trim()
@@ -102,10 +102,44 @@ suite('testing the javascript-npm data provider', async () => {
102102
let providedDataForComponent = provider.provideComponent(manifestPath);
103103

104104
compareSboms(providedDataForComponent.content, expectedSbom);
105-
}).timeout(process.env.GITHUB_ACTIONS ? 15000 : 10000)
105+
}).timeout(15000)
106106

107107
});
108108

109+
[
110+
{ providerName: 'npm', testCase: 'workspace_member' },
111+
].forEach(({ providerName, testCase }) => {
112+
/// Verifies that stack analysis resolves transitive dependencies for a workspace member.
113+
test(`verify workspace member data provided for ${providerName} - stack analysis`, async () => {
114+
// Given a workspace member manifest and mock listing from the workspace root
115+
const listing = fs.readFileSync(`test/providers/tst_manifests/${providerName}/${testCase}/listing_stack.json`).toString();
116+
const expectedSbom = fs.readFileSync(`test/providers/tst_manifests/${providerName}/${testCase}/stack_expected_sbom.json`).toString();
117+
const provider = await createMockProvider(providerName, listing);
118+
const manifestPath = `test/providers/tst_manifests/${providerName}/${testCase}/packages/member-a/package.json`;
119+
120+
// When running stack analysis on the workspace member
121+
const result = provider.provideStack(manifestPath);
122+
123+
// Then the SBOM should contain the member's transitive dependencies
124+
compareSboms(result.content, expectedSbom);
125+
}).timeout(30000);
126+
127+
/// Verifies that component analysis resolves direct dependencies for a workspace member.
128+
test(`verify workspace member data provided for ${providerName} - component analysis`, async () => {
129+
// Given a workspace member manifest and mock listing from the workspace root
130+
const listing = fs.readFileSync(`test/providers/tst_manifests/${providerName}/${testCase}/listing_component.json`).toString();
131+
const expectedSbom = fs.readFileSync(`test/providers/tst_manifests/${providerName}/${testCase}/component_expected_sbom.json`).toString();
132+
const provider = await createMockProvider(providerName, listing);
133+
const manifestPath = `test/providers/tst_manifests/${providerName}/${testCase}/packages/member-a/package.json`;
134+
135+
// When running component analysis on the workspace member
136+
const result = provider.provideComponent(manifestPath);
137+
138+
// Then the SBOM should contain only the member's direct dependencies
139+
compareSboms(result.content, expectedSbom);
140+
}).timeout(15000);
141+
});
142+
109143
test('loads a valid manifest with ignored dependencies', () => {
110144
const testCase = 'package_json_deps_with_exhortignore_object';
111145
const manifestPath = `test/providers/tst_manifests/npm/${testCase}/package.json`;

‎test/providers/tst_manifests/npm/workspace_member/component_expected_sbom.json‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"bomFormat": "CycloneDX",
3+
"specVersion": "1.4",
4+
"version": 1,
5+
"metadata": {
6+
"timestamp": "2023-08-07T00:00:00.000Z",
7+
"component": {
8+
"name": "member-a",
9+
"version": "1.0.0",
10+
"purl": "pkg:npm/member-a@1.0.0",
11+
"type": "application",
12+
"bom-ref": "pkg:npm/member-a@1.0.0"
13+
}
14+
},
15+
"components": [
16+
{
17+
"name": "axios",
18+
"version": "0.21.1",
19+
"purl": "pkg:npm/axios@0.21.1",
20+
"type": "library",
21+
"bom-ref": "pkg:npm/axios@0.21.1"
22+
}
23+
],
24+
"dependencies": [
25+
{
26+
"ref": "pkg:npm/member-a@1.0.0",
27+
"dependsOn": [
28+
"pkg:npm/axios@0.21.1"
29+
]
30+
},
31+
{
32+
"ref": "pkg:npm/axios@0.21.1",
33+
"dependsOn": []
34+
}
35+
]
36+
}

‎test/providers/tst_manifests/npm/workspace_member/listing_component.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "test-workspace-root",
3+
"dependencies": {
4+
"member-a": {
5+
"version": "1.0.0",
6+
"resolved": "file:../packages/member-a",
7+
"overridden": false,
8+
"dependencies": {
9+
"axios": {
10+
"version": "0.21.1",
11+
"resolved": "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz",
12+
"overridden": false
13+
}
14+
}
15+
}
16+
}
17+
}

‎test/providers/tst_manifests/npm/workspace_member/listing_stack.json‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"name": "test-workspace-root",
3+
"dependencies": {
4+
"member-a": {
5+
"version": "1.0.0",
6+
"resolved": "file:../packages/member-a",
7+
"overridden": false,
8+
"dependencies": {
9+
"axios": {
10+
"version": "0.21.1",
11+
"resolved": "https://registry.npmjs.org/axios/-/axios-0.21.1.tgz",
12+
"overridden": false,
13+
"dependencies": {
14+
"follow-redirects": {
15+
"version": "1.16.0",
16+
"resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.16.0.tgz",
17+
"overridden": false
18+
}
19+
}
20+
}
21+
}
22+
}
23+
}
24+
}

‎test/providers/tst_manifests/npm/workspace_member/package-lock.json‎

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎test/providers/tst_manifests/npm/workspace_member/package.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"name": "test-workspace-root",
3+
"private": true,
4+
"workspaces": ["packages/*"]
5+
}

‎test/providers/tst_manifests/npm/workspace_member/packages/member-a/package.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"name": "member-a",
3+
"version": "1.0.0",
4+
"dependencies": {
5+
"axios": "0.21.1"
6+
}
7+
}

‎test/providers/tst_manifests/npm/workspace_member/stack_expected_sbom.json‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
{
2+
"bomFormat": "CycloneDX",
3+
"specVersion": "1.4",
4+
"version": 1,
5+
"metadata": {
6+
"timestamp": "2023-08-07T00:00:00.000Z",
7+
"component": {
8+
"name": "member-a",
9+
"version": "1.0.0",
10+
"purl": "pkg:npm/member-a@1.0.0",
11+
"type": "application",
12+
"bom-ref": "pkg:npm/member-a@1.0.0"
13+
}
14+
},
15+
"components": [
16+
{
17+
"name": "axios",
18+
"version": "0.21.1",
19+
"purl": "pkg:npm/axios@0.21.1",
20+
"type": "library",
21+
"bom-ref": "pkg:npm/axios@0.21.1"
22+
},
23+
{
24+
"name": "follow-redirects",
25+
"version": "1.16.0",
26+
"purl": "pkg:npm/follow-redirects@1.16.0",
27+
"type": "library",
28+
"bom-ref": "pkg:npm/follow-redirects@1.16.0"
29+
}
30+
],
31+
"dependencies": [
32+
{
33+
"ref": "pkg:npm/member-a@1.0.0",
34+
"dependsOn": [
35+
"pkg:npm/axios@0.21.1"
36+
]
37+
},
38+
{
39+
"ref": "pkg:npm/axios@0.21.1",
40+
"dependsOn": [
41+
"pkg:npm/follow-redirects@1.16.0"
42+
]
43+
},
44+
{
45+
"ref": "pkg:npm/follow-redirects@1.16.0",
46+
"dependsOn": []
47+
}
48+
]
49+
}

0 commit comments

Comments
 (0)