Merge pull request #6335 from snyk/fix/pnpm-workspaces-respect-exclude

fix: pnpm workspaces respect exclude

Author: calhar-snyk

package-lock.json

@@ -122,8 +122,8 @@
     "snyk-gradle-plugin": "5.1.1",
     "snyk-module": "3.1.0",
     "snyk-mvn-plugin": "4.3.3",
-    "snyk-nodejs-lockfile-parser": "2.4.2",
-    "snyk-nodejs-plugin": "1.4.4",
+    "snyk-nodejs-lockfile-parser": "2.4.3",
+    "snyk-nodejs-plugin": "1.4.5",
     "snyk-nuget-plugin": "2.12.0",
     "snyk-php-plugin": "1.12.1",
     "snyk-policy": "^4.1.6",

package.json

@@ -214,6 +214,7 @@ async function processWorkspacesProjects(
       {
         strictOutOfSync: options.strictOutOfSync,
         dev: options.dev,
+        exclude: options.exclude,
       },
       targetFiles,
     );

src/lib/plugins/get-multi-plugin-result.ts

@@ -0,0 +1,7 @@
+{
+  "name": "app1",
+  "version": "1.0.0",
+  "dependencies": {
+    "lodash": "4.17.11"
+  }
+}

test/fixtures/pnpm-workspace-with-exclude-issue/workspace/app1/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "app2",
+  "version": "1.0.0",
+  "dependencies": {
+    "axios": "0.21.0"
+  }
+}

test/fixtures/pnpm-workspace-with-exclude-issue/workspace/app2/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "pnpm-workspace-root",
+  "version": "1.0.0",
+  "private": true,
+  "description": "Test fixture for pnpm workspace exclude bug"
+}

test/fixtures/pnpm-workspace-with-exclude-issue/workspace/package.json

@@ -0,0 +1,4 @@
+packages:
+  - 'app1'
+  - 'app2'
+  - 'shared'

test/fixtures/pnpm-workspace-with-exclude-issue/workspace/pnpm-lock.yaml

@@ -0,0 +1,7 @@
+{
+  "name": "shared",
+  "version": "1.0.0",
+  "dependencies": {
+    "moment": "2.29.1"
+  }
+}

test/fixtures/pnpm-workspace-with-exclude-issue/workspace/pnpm-workspace.yaml

@@ -1,13 +1,13 @@
+import { mkdir, rm, writeFile } from 'fs/promises';
+import { tmpdir } from 'os';
+import { join } from 'path';
+import { fakeServer } from '../../../acceptance/fake-server';
 import {
   createProjectFromFixture,
   createProjectFromWorkspace,
 } from '../../util/createProject';
-import { runSnykCLI } from '../../util/runSnykCLI';
-import { fakeServer } from '../../../acceptance/fake-server';
 import { getServerPort } from '../../util/getServerPort';
-import { rm, writeFile, mkdir } from 'fs/promises';
-import { join } from 'path';
-import { tmpdir } from 'os';
+import { runSnykCLI } from '../../util/runSnykCLI';
 
 jest.setTimeout(1000 * 60);
 
@@ -403,4 +403,81 @@ describe('snyk test --all-projects (mocked server only)', () => {
       console.warn('teardown failed');
     }
   });
+
+  test('`test pnpm-workspace --all-projects --exclude=shared` excludes specified directory', async () => {
+    server.setFeatureFlag('enablePnpmCli', true);
+
+    const project = await createProjectFromFixture(
+      'pnpm-workspace-with-exclude-issue/workspace',
+    );
+
+    const { code, stdout } = await runSnykCLI(
+      'test --all-projects --exclude=shared',
+      {
+        cwd: project.path(),
+        env,
+      },
+    );
+
+    const backendRequests = server.getRequests().filter((req: any) => {
+      return req.url.includes('/api/v1/test');
+    });
+
+    const sharedPath = join('shared', 'package.json');
+    const app1Path = join('app1', 'package.json');
+    const app2Path = join('app2', 'package.json');
+
+    expect(backendRequests.length).toBe(3);
+    expect(stdout).not.toMatch(sharedPath);
+    expect(stdout).toMatch(app1Path);
+    expect(stdout).toMatch(app2Path);
+    expect(code).toEqual(0);
+  });
+
+  test('`test pnpm-workspace --all-projects --exclude=shared --detection-depth=2` excludes specified directory', async () => {
+    server.setFeatureFlag('enablePnpmCli', true);
+
+    const project = await createProjectFromFixture(
+      'pnpm-workspace-with-exclude-issue/workspace',
+    );
+
+    const { code, stdout } = await runSnykCLI(
+      'test --all-projects --exclude=shared --detection-depth=2',
+      {
+        cwd: project.path(),
+        env,
+      },
+    );
+
+    const backendRequests = server.getRequests().filter((req: any) => {
+      return req.url.includes('/api/v1/test');
+    });
+
+    expect(backendRequests.length).toBe(3);
+    expect(stdout).not.toMatch(join('shared', 'package.json'));
+    expect(code).toEqual(0);
+  });
+
+  test('`test pnpm-workspace --all-projects` scans all workspace projects', async () => {
+    server.setFeatureFlag('enablePnpmCli', true);
+
+    const project = await createProjectFromFixture(
+      'pnpm-workspace-with-exclude-issue/workspace',
+    );
+
+    const { code, stdout } = await runSnykCLI('test --all-projects', {
+      cwd: project.path(),
+      env,
+    });
+
+    const backendRequests = server.getRequests().filter((req: any) => {
+      return req.url.includes('/api/v1/test');
+    });
+
+    expect(backendRequests.length).toBe(4);
+    expect(stdout).toMatch(join('app1', 'package.json'));
+    expect(stdout).toMatch(join('app2', 'package.json'));
+    expect(stdout).toMatch(join('shared', 'package.json'));
+    expect(code).toEqual(0);
+  });
 });