chore: migrate to Yarn 2 #2316

ylemkimon · 2020-07-16T22:21:25Z

Yarn 2 supports PnP (Plug'n'Play). (https://yarnpkg.com/features/pnp)

codecov-commenter · 2020-07-16T23:06:53Z

Codecov Report

Merging #2316 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2316   +/-   ##
=======================================
  Coverage   93.96%   93.96%           
=======================================
  Files          84       84           
  Lines        5434     5434           
  Branches      959      959           
=======================================
  Hits         5106     5106           
  Misses        297      297           
  Partials       31       31

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 591bc7b...9ced0e6. Read the comment docs.

ylemkimon · 2020-07-16T23:23:25Z

.eslintrc

+        ],
+        "rules": {
+            "react/prop-types": 0
+        }


ESLint has issues with shared configs and PnP (yarnpkg/berry#8), so I've moved website/.eslintrc to here.

ylemkimon · 2020-07-16T23:24:56Z

.yarnrc.yml

@@ -0,0 +1 @@
+yarnPath: ".yarn/releases/yarn-berry.js"


https://yarnpkg.com/getting-started/install:

Using a single package manager across your system has always been a problem. To be stable, installs need to be run with the same package manager version across environments, otherwise there's a risk we introduce accidental breaking changes between versions - after all, that's why the concept of lockfile was introduced in the first place! And with Yarn being in a sense your very first project dependency, it should make sense to "lock it" as well.

For this reason, Yarn 2 and later are meant to be managed on a by-project basis. Don't worry, little will change!

kevinbarabash · 2020-08-02T19:34:55Z

.circleci/config.yml

@@ -112,7 +113,7 @@ jobs:

      - run:
          name: Verify screenshots and generate diffs and new screenshots
-          command: node dockers/screenshotter/screenshotter.js --selenium-ip localhost -b $CIRCLE_JOB --verify --diff --new --coverage
+          command: yarn node dockers/screenshotter/screenshotter.js --selenium-ip localhost -b $CIRCLE_JOB --verify --diff --new --coverage


Is yarn monkey patching node?

@kevinbarabash Sorry, I've quoted the wrong documentation. https://yarnpkg.com/advanced/migration#call-your-scripts-through-yarn-node-rather-than-node:

We now need to inject some variables into the environment for Node to be able to locate your dependencies. In order to make this possible, we ask you to use yarn node which transparently does the heavy lifting.

Note: this section only applies to the shell CLI. The commands defined in your scripts are unaffected, as we make sure that node always points to the right location, with the right variables already set.

Looking at the source, it seems it just adds --require .pnp.js to NODE_OPTIONS variable. Preloaded .pnp.js then registers a custom module resolver.

ylemkimon · 2020-07-16T23:41:22Z

webpack.analyze.js

@@ -1,5 +1,6 @@
 // @flow
 const {targets, createConfig} = require('./webpack.common');
+// $FlowIgnore


Flow has issues resolving dependencies with PnP (yarnpkg/berry#634), but as we don't have any dependencies in main codebase, I think it's an acceptable loss. Furthermore, Typescript doesn't have this issue (#2326).

Since we don't have flow-typed for them and they don't have type information, so nothing is changed.

ylemkimon · 2020-07-16T23:42:29Z

website/package.json

-  "dependencies": {}
+  "dependenciesMeta": {
+    "docusaurus": {
+      "unplugged": true


Docusaurus requires write access to node_modules, so we cannot use PnP and should unplug it. (yarnpkg/berry#818 (comment))

If docusaurus is "unplugged" does this mean that it and all of its dependencies are installed into node_modules?

@kevinbarabash AFAIK, only the dependency itself is unplugged. Its dependencies remain PnP-ed.

That's pretty cool.

kevinbarabash

I knew about the big changes in yarn 2, but haven't had the chance to experiment with it in any projects yet. I'm interested to see how this turns out.

kevinbarabash · 2020-08-02T19:34:01Z

bower.json

@@ -1,36 +0,0 @@
-{


Is removing this file necessary to migrate to yarn 2?

@kevinbarabash No, I had to update the Yarn version in Netlify, where I realized it installs Bower and runs bower install. I've separated changes to #2372 and it's merged.

kevinbarabash · 2020-08-02T19:34:55Z

.circleci/config.yml

@@ -112,7 +113,7 @@ jobs:

      - run:
          name: Verify screenshots and generate diffs and new screenshots
-          command: node dockers/screenshotter/screenshotter.js --selenium-ip localhost -b $CIRCLE_JOB --verify --diff --new --coverage
+          command: yarn node dockers/screenshotter/screenshotter.js --selenium-ip localhost -b $CIRCLE_JOB --verify --diff --new --coverage


Is yarn monkey patching node?

kevinbarabash · 2020-08-02T19:38:08Z

website/package.json

-  "dependencies": {}
+  "dependenciesMeta": {
+    "docusaurus": {
+      "unplugged": true


If docusaurus is "unplugged" does this mean that it and all of its dependencies are installed into node_modules?

kevinbarabash · 2020-08-02T19:38:59Z

webpack.common.js

+// $FlowIgnore
 const TerserPlugin = require('terser-webpack-plugin');
+// $FlowIgnore
 const MiniCssExtractPlugin = require('mini-css-extract-plugin');
+// $FlowIgnore
+const PnpWebpackPlugin = require('pnp-webpack-plugin');

 const {version} = require("./package.json");

+// $FlowIgnore
 const browserslist = require('browserslist')();
+// $FlowIgnore
 const caniuse = require('caniuse-lite');


Why do we need $FlowIngores for these imports now?

@kevinbarabash See #2316 (comment) above.

kevinbarabash · 2020-08-02T19:39:55Z

.gitignore

+!.yarn/releases
+!.yarn/plugins
+!.yarn/sdks
+!.yarn/versions


I don't see any files checked into for this director or .website, did you forget to add some files to this PR?

@kevinbarabash They are files recommended by the doc. Yarn automatically uses Yarn in parent directories, so there are currently no files for website.

edemaine · 2020-08-02T20:15:54Z

I was looking at Yarn 2 the other day. It's annoying that it requires checking in the entire yarn binary (2MB). PnP looks pretty cool though!

ylemkimon · 2020-08-02T20:27:16Z

@edemaine But I think it's in the right direction. It allows to use a single, even outdated, Yarn across projects. Git nowadays handles large files really smoothly.

kevinbarabash

Let's give it a try.🤞

ylemkimon · 2020-08-03T13:49:44Z

~~I wonder Dependabot will work with Yarn 2 (dependabot/dependabot-core#1297).~~ I should've searched more. There was another issue in Dependabot, dependabot/dependabot-core#2030, so it breaks lockfile.

kevinbarabash · 2020-08-03T22:50:42Z

🤞

ylemkimon added the GH Review: review-needed label Jul 16, 2020

ylemkimon force-pushed the yarn-v2 branch 2 times, most recently from 80ff6bd to fc90e85 Compare July 16, 2020 23:04

ylemkimon changed the base branch from master to bump-dep July 16, 2020 23:19

ylemkimon force-pushed the yarn-v2 branch from 4f28b11 to bf53af6 Compare July 16, 2020 23:38

ylemkimon commented Jul 16, 2020

View reviewed changes

ylemkimon changed the title ~~Migrate to Yarn 2~~ feat: migrate to Yarn 2 Jul 17, 2020

ylemkimon changed the title ~~feat: migrate to Yarn 2~~ chore: migrate to Yarn 2 Jul 17, 2020

Base automatically changed from bump-dep to master July 25, 2020 18:38

chore: migrate to Yarn 2

0ada716

ylemkimon force-pushed the yarn-v2 branch from bf53af6 to 0ada716 Compare July 25, 2020 19:43

kevinbarabash reviewed Aug 2, 2020

View reviewed changes

kevinbarabash approved these changes Aug 2, 2020

View reviewed changes

Merge branch 'master' into yarn-v2

e89f915

ylemkimon force-pushed the yarn-v2 branch from cb3f42c to e89f915 Compare August 3, 2020 05:02

Update config.yml

9ced0e6

ylemkimon merged commit f97c545 into master Aug 3, 2020

ylemkimon deleted the yarn-v2 branch August 3, 2020 16:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: migrate to Yarn 2 #2316

chore: migrate to Yarn 2 #2316

ylemkimon commented Jul 16, 2020 •

edited

codecov-commenter commented Jul 16, 2020 •

edited

ylemkimon Jul 16, 2020

ylemkimon Jul 16, 2020

This comment was marked as duplicate.

kevinbarabash Aug 2, 2020

ylemkimon Aug 2, 2020

ylemkimon Aug 2, 2020 •

edited

ylemkimon Jul 16, 2020 •

edited

ylemkimon Aug 2, 2020

ylemkimon Jul 16, 2020

kevinbarabash Aug 2, 2020

ylemkimon Aug 2, 2020

kevinbarabash Aug 3, 2020

kevinbarabash left a comment

kevinbarabash Aug 2, 2020

ylemkimon Aug 2, 2020

kevinbarabash Aug 2, 2020

kevinbarabash Aug 2, 2020

kevinbarabash Aug 2, 2020

ylemkimon Aug 2, 2020

kevinbarabash Aug 2, 2020

kevinbarabash Aug 2, 2020

ylemkimon Aug 2, 2020

edemaine commented Aug 2, 2020

ylemkimon commented Aug 2, 2020 •

edited

kevinbarabash left a comment

ylemkimon commented Aug 3, 2020 •

edited

kevinbarabash commented Aug 3, 2020

chore: migrate to Yarn 2 #2316

chore: migrate to Yarn 2 #2316

Conversation

ylemkimon commented Jul 16, 2020 • edited

codecov-commenter commented Jul 16, 2020 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as duplicate.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ylemkimon Aug 2, 2020 • edited

Choose a reason for hiding this comment

ylemkimon Jul 16, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kevinbarabash left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

edemaine commented Aug 2, 2020

ylemkimon commented Aug 2, 2020 • edited

kevinbarabash left a comment

Choose a reason for hiding this comment

ylemkimon commented Aug 3, 2020 • edited

kevinbarabash commented Aug 3, 2020

ylemkimon commented Jul 16, 2020 •

edited

codecov-commenter commented Jul 16, 2020 •

edited

ylemkimon Aug 2, 2020 •

edited

ylemkimon Jul 16, 2020 •

edited

ylemkimon commented Aug 2, 2020 •

edited

ylemkimon commented Aug 3, 2020 •

edited