chore: Upgrade to Yarn 3

[tschaffter]

• Fixes Explore pnpm and yarn v3 #588
• Fixes Evaluate not removing node_modules after git merge #586

Notes

• This PR upgrades the development environment to Yarn 2+ ("Yarn Berry").
• Yarn 2+ introduces lock file format v2.
  • Look similar to v1 but best to regenerate the lock file with Yarn 2+ if possible.
• Motivations and performance benchmarks
• Yarn 3 CLI is almost identical to Yarn 1 CLI.
  • The only difference relevant to our project is:
    • yarn install --frozen-lockfile is replaced by yarn install --immutable
    • yarn bin is not longer displaying the path to the local node_modules/.bin folder (used in dev-env.sh).

Testing

1. Checkout this branch.
2. Rebuild the dev container.
3. Remove the existing node_modules.
4. Install the Node.js dependencies: challenge-install.
5. Start the challenge registry: nx serve challenge-registry.
6. Check that the registry loads successfully in the browser.

Note
Repeat Steps 3-4 when returning to a branch that uses Yarn 1.

TODO before merging

• Replace dev container image tag by whatever value is used in main.

[tschaffter]

Yarn messes up $PATH

$ echo $PATH
/vscode/vscode-server/bin/linux-x64/e4503b30fc78200f846c62cf8091b76ff5547662/bin/remote-cli:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:➤ YN0000: ng ➤ YN0000: nx-cloud ➤ YN0000: openapi-generator-cli ➤ YN0000: openapi ➤ YN0000: coveralls ➤ YN0000: cypress ➤ YN0000: eslint ➤ YN0000: hint ➤ YN0000: husky ➤ YN0000: lint-openapi ➤ YN0000: prettier ➤ YN0000: redoc-cli ➤ YN0000: shx ➤ YN0000: tsc ➤ YN0000: tsserver ➤ YN0000: ng-xi18n ➤ YN0000: ngc ➤ YN0000: ngcc ➤ YN0000: eslint-config-prettier ➤ YN0000: jest ➤ YN0000: ng-packagr ➤ YN0000: nx ➤ YN0000: ts-jest ➤ YN0000: ts-node ➤ YN0000: ts-node-cwd ➤ YN0000: ts-node-esm ➤ YN0000: ts-node-script ➤ YN0000: ts-node-transpile-only ➤ YN0000: ts-script ➤ YN0000: Done in 0s 55ms

Here is the path in the dev container used in the main branch:

vscode@b9fbf54728dd:/workspaces/challenge-registry$ echo $PATH
/vscode/vscode-server/bin/linux-x64/e4503b30fc78200f846c62cf8091b76ff5547662/bin/remote-cli:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/workspaces/challenge-registry/node_modules/.bin

The issue occurs when sourcing dev-env.sh.

vscode@ac5a8a1b4f30:/workspaces/challenge-registry$ echo $PATH
/vscode/vscode-server/bin/linux-x64/e4503b30fc78200f846c62cf8091b76ff5547662/bin/remote-cli:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/workspaces/challenge-registry/node_modules/.bin
vscode@ac5a8a1b4f30:/workspaces/challenge-registry$ nx --version
14.5.4
vscode@ac5a8a1b4f30:/workspaces/challenge-registry$ git branch
  connect-app-and-backend
  doc-linter-formatter
  document-stack-components
  explore-dvc
  gradle-unit-integration
  main
* test-yarn3
vscode@ac5a8a1b4f30:/workspaces/challenge-registry$ . ./dev-env.sh 
vscode@ac5a8a1b4f30:/workspaces/challenge-registry$ echo $PATH
/vscode/vscode-server/bin/linux-x64/e4503b30fc78200f846c62cf8091b76ff5547662/bin/remote-cli:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/workspaces/challenge-registry/node_modules/.bin:➤ YN0000: ng ➤ YN0000: nx-cloud ➤ YN0000: openapi-generator-cli ➤ YN0000: openapi ➤ YN0000: coveralls ➤ YN0000: cypress ➤ YN0000: eslint ➤ YN0000: hint ➤ YN0000: husky ➤ YN0000: lint-openapi ➤ YN0000: prettier ➤ YN0000: redoc-cli ➤ YN0000: shx ➤ YN0000: tsc ➤ YN0000: tsserver ➤ YN0000: ng-xi18n ➤ YN0000: ngc ➤ YN0000: ngcc ➤ YN0000: eslint-config-prettier ➤ YN0000: jest ➤ YN0000: ng-packagr ➤ YN0000: nx ➤ YN0000: ts-jest ➤ YN0000: ts-node ➤ YN0000: ts-node-cwd ➤ YN0000: ts-node-esm ➤ YN0000: ts-node-script ➤ YN0000: ts-node-transpile-only ➤ YN0000: ts-script ➤ YN0000: Done in 0s 46ms

Fixed

[tschaffter]

@rrchai Would you have time to review this PR before our next dev workshop (September 2nd)?

[tschaffter]

@rrchai This PR can be tested despite the conflict with yarn.lock shown above. The lock file that comes with this PR (generated with Yarn 3) is different from the lock file in main (generated with Yarn 1).

[rrchai]

Thanks for upgrading yarn. I like the colors here during the challenge-install:

I can reproduce similar running time for installation with yarn 2+ - faster is always great 🍾 :

hyperfine  --warmup 1 --prepare 'rm -rf node_modules' --runs 5 'yarn install --immutable'
Benchmark 1: yarn install --immutable
  Time (mean ± σ):     55.868 s ±  0.637 s    [User: 71.734 s, System: 37.474 s]
  Range (min … max):   54.812 s … 56.484 s    5 runs

And I can access to the webpage with no errors.