nx-plugin/devkit: when using PNPM, runPackageManagerInstall and installPackagesTask do not work in Nx plugin e2e tests on GitHub CI

The Nx 12 roadmap (https://github.com/nrwl/nx/issues/4492) mentions additional efforts to test PNPM-based repos. This seems to be one of those issues worth looking into. Either that, or I’m doing something wrong.

Current Behavior

When using PNPM as the workspace package manager, the following occurs in GitHub CI workflows:

1. When calling runPackageManagerInstall from @nrwl/nx-plugin/testing in an end-to-end test, spawnSync fails with spawnSync /bin/sh ENOENT.
2. When calling installPackagesTask from @nrwl/devkit in a generator, end-to-end tests fails with Command failed: pnpm install.

End-to-end tests work locally.

Expected Behavior

When using PNPM as the workspace package manager, the following should occurs in GitHub CI workflows:

1. Calling runPackageManagerInstall from @nrwl/nx-plugin/testing in an end-to-end test should succeed.
2. Calling installPackagesTask from @nrwl/devkit in a generator, end-to-end tests should succeed.

Steps to Reproduce

Minimal reproduction in workspace generated using create-nx-plugin: LayZeeDK/nx-plugin-issue-pnpm-install.

Failure Logs

Sample GitHub CI run.

runPackageManagerInstall error in end-to-end test:

  console.error
    Error: spawnSync /bin/sh ENOENT
        at Object.spawnSync (internal/child_process.js:1042:20)
        at spawnSync (child_process.js:621:24)
        at Object.execSync (child_process.js:666:15)
        at Object.runPackageManagerInstall (/home/runner/work/nx-plugin-issue-pnpm-install/nx-plugin-issue-pnpm-install/node_modules/.pnpm/@nrwl/nx-plugin@11.1.1_typescript@4.0.5/packages/nx-plugin/src/utils/testing-utils/nx-project.ts:50:19)
        at Object.<anonymous> (/home/runner/work/nx-plugin-issue-pnpm-install/nx-plugin-issue-pnpm-install/e2e/pnpm-install-e2e/tests/pnpm-install.spec.ts:15:27)
        at /home/runner/work/nx-plugin-issue-pnpm-install/nx-plugin-issue-pnpm-install/node_modules/.pnpm/jest-jasmine2@26.6.3_ts-node@9.1.1/node_modules/jest-jasmine2/build/queueRunner.js:45:12
        at new Promise (<anonymous>)
        at mapper (/home/runner/work/nx-plugin-issue-pnpm-install/nx-plugin-issue-pnpm-install/node_modules/.pnpm/jest-jasmine2@26.6.3_ts-node@9.1.1/node_modules/jest-jasmine2/build/queueRunner.js:28:19)
        at /home/runner/work/nx-plugin-issue-pnpm-install/nx-plugin-issue-pnpm-install/node_modules/.pnpm/jest-jasmine2@26.6.3_ts-node@9.1.1/node_modules/jest-jasmine2/build/queueRunner.js:75:41 {
      errno: 'ENOENT',
      code: 'ENOENT',
      syscall: 'spawnSync /bin/sh',
      path: '/bin/sh',
      spawnargs: [ '-c', 'pnpm install' ],
      error: [Circular],
      status: null,
      signal: null,
      output: null,
      pid: 2002,
      stdout: null,
      stderr: null
    }

installPackagesTask error in end-to-end test:

  ● pnpm-install e2e › should create pnpm-install

    Command failed: pnpx nx generate @nx-plugin/pnpm-install:pnpm-install pnpm-install4931585
    Command failed: pnpm install

Environment

GitHub CI report:

>  NX  Report complete - copy this into the issue template

  Node : 12.20.0
  OS   : linux x64
  pnpm : 5.15.0
  
  nx : Not Found
  @nrwl/angular : Not Found
  @nrwl/cli : 11.1.1
  @nrwl/cypress : Not Found
  @nrwl/devkit : 11.0.20
  @nrwl/eslint-plugin-nx : 11.1.1
  @nrwl/express : Not Found
  @nrwl/jest : 11.1.1
  @nrwl/linter : 11.1.1
  @nrwl/nest : Not Found
  @nrwl/next : Not Found
  @nrwl/node : 11.1.1
  @nrwl/react : Not Found
  @nrwl/schematics : Not Found
  @nrwl/tao : 11.1.1
  @nrwl/web : Not Found
  @nrwl/workspace : 11.1.1
  typescript : 4.0.5

Local report:

>  NX  Report complete - copy this into the issue template

  Node : 12.20.1
  OS   : win32 x64
  pnpm : 5.15.0

  nx : Not Found
  @nrwl/angular : Not Found
  @nrwl/cli : 11.1.1
  @nrwl/cypress : Not Found
  @nrwl/devkit : 11.0.20
  @nrwl/eslint-plugin-nx : 11.1.1
  @nrwl/express : Not Found
  @nrwl/jest : 11.1.1
  @nrwl/linter : 11.1.1
  @nrwl/nest : Not Found
  @nrwl/next : Not Found
  @nrwl/node : 11.1.1
  @nrwl/react : Not Found
  @nrwl/schematics : Not Found
  @nrwl/tao : 11.1.1
  @nrwl/web : Not Found
  @nrwl/workspace : 11.1.1
  typescript : 4.0.5

[bekos]

@LayZeeDK we use circleci but I have tested and GH actions. It turns out that the problem is that pnpm by default uses --frozen-lockfile on CIs and this is causing the failure if package.json has changed. I will try to send a PR that will fix it in our side.

[LayZeeDK]

It worked in this branch of my issue repo:

• https://github.com/LayZeeDK/nx-plugin-issue-pnpm-install/blob/8941c3b73b4ce9fa0e7ad1c34d25297a5f122ee6/e2e/pnpm-install-e2e/tests/pnpm-install.spec.ts#L14
• https://github.com/LayZeeDK/nx-plugin-issue-pnpm-install/runs/1697873934?check_suite_focus=true