yarn check で大量のエラーが発生します

ghost commented 4 years ago

改善詳細 / Details of Improvement

yarn check で大量のエラーが発生します

スクリーンショット / Screenshot

現在の状態は以下の通りで yarn check で大量のエラーが発生します (エラー数は93件)

tokyo-citizen@macos ~ % node --version
v12.18.3
tokyo-citizen@macos ~ % yarn --version
1.22.4
tokyo-citizen@macos ~ % git clone git://github.com/tokyo-metropolitan-gov/covid19.git covid19
Cloning into 'covid19'...
remote: Enumerating objects: 613188, done.
remote: Total 613188 (delta 0), reused 0 (delta 0), pack-reused 613188
Receiving objects: 100% (613188/613188), 1.10 GiB | 10.78 MiB/s, done.
Resolving deltas: 100% (302229/302229), done.
tokyo-citizen@macos ~ % cd covid19
tokyo-citizen@macos covid19 % yarn install --frozen-lockfile
yarn install v1.22.4
[1/5] 🔍  Validating package.json...
[2/5] 🔍  Resolving packages...
[3/5] 🚚  Fetching packages...
[4/5] 🔗  Linking dependencies...
warning "@nuxtjs/eslint-config > eslint-plugin-vue@6.2.2" has incorrect peer dependency "eslint@^5.0.0 || ^6.0.0".
warning "@nuxtjs/stylelint-module > stylelint-webpack-plugin@2.1.0" has unmet peer dependency "webpack@^4.0.0 || ^5.0.0".
warning "@nuxtjs/vuetify > sass-loader@8.0.2" has unmet peer dependency "webpack@^4.36.0 || ^5.0.0".
warning "@nuxtjs/vuetify > vuetify-loader@1.5.0" has unmet peer dependency "webpack@^4.0.0".
warning "nuxt-purgecss > purgecss-webpack-plugin@2.3.0" has unmet peer dependency "webpack@*".
warning " > vue-axe@2.4.0" has incorrect peer dependency "axe-core@3.5.3".
warning " > vue-jest@4.0.0-beta.5" has incorrect peer dependency "jest@^25.x".
warning "vue-jest > ts-jest@25.5.1" has incorrect peer dependency "jest@>=25 <26".
[5/5] 🔨  Building fresh packages...
✨  Done in 19.55s.
tokyo-citizen@macos covid19 % yarn check |& grep ^error\ Found 
error Found 93 errors.

yarn.lock を再生成するとエラーが劇的に減ります (エラー数は4件)

tokyo-citizen@macos covid19 % rm yarn.lock
tokyo-citizen@macos covid19 % rm -rf node_modules
tokyo-citizen@macos covid19 % yarn install
yarn install v1.22.4
info No lockfile found.
[1/5] 🔍  Validating package.json...
[2/5] 🔍  Resolving packages...
warning nuxt > @nuxt/webpack > @nuxt/babel-preset-app > core-js@2.6.11: core-js@<3 is no longer maintained and not recommended for usage due to the number of issues. Please, upgrade your dependencies to the actual version of core-js@3.
warning nuxt > @nuxt/webpack > webpack > watchpack > watchpack-chokidar2 > chokidar@2.1.8: Chokidar 2 will break on node v14+. Upgrade to chokidar 3 with 15x less dependencies.
warning nuxt > @nuxt/webpack > webpack > watchpack > watchpack-chokidar2 > chokidar > fsevents@1.2.13: fsevents 1 will break on node v14+ and could be using insecure binaries. Upgrade to fsevents 2.
warning nuxt > @nuxt/webpack > webpack > micromatch > snapdragon > source-map-resolve > resolve-url@0.2.1: https://github.com/lydell/resolve-url#deprecated
warning nuxt > @nuxt/webpack > webpack > micromatch > snapdragon > source-map-resolve > urix@0.1.0: Please see https://github.com/lydell/urix#deprecated
warning jest > jest-cli > jest-config > jest-environment-jsdom > jsdom > request@2.88.2: request has been deprecated, see https://github.com/request/request/issues/3142
warning jest > jest-cli > jest-config > jest-environment-jsdom > jsdom > request-promise-native@1.0.9: request-promise-native has been deprecated because it extends the now deprecated request package, see https://github.com/request/request/issues/3142
warning jest > jest-cli > jest-config > jest-environment-jsdom > jsdom > request > har-validator@5.1.5: this library is no longer supported
warning vue-jest > extract-from-css > css > urix@0.1.0: Please see https://github.com/lydell/urix#deprecated
[3/5] 🚚  Fetching packages...
[4/5] 🔗  Linking dependencies...
warning "@nuxtjs/eslint-config > eslint-plugin-vue@6.2.2" has incorrect peer dependency "eslint@^5.0.0 || ^6.0.0".
warning "@nuxtjs/stylelint-module > stylelint-webpack-plugin@2.1.0" has unmet peer dependency "webpack@^4.0.0 || ^5.0.0".
warning "@nuxtjs/vuetify > sass-loader@8.0.2" has unmet peer dependency "webpack@^4.36.0 || ^5.0.0".
warning "@nuxtjs/vuetify > vuetify-loader@1.6.0" has unmet peer dependency "webpack@^4.0.0".
warning "nuxt-purgecss > purgecss-webpack-plugin@2.3.0" has unmet peer dependency "webpack@*".
warning " > vue-axe@2.4.0" has incorrect peer dependency "axe-core@3.5.3".
warning " > vue-jest@4.0.0-beta.5" has incorrect peer dependency "jest@^25.x".
warning "vue-jest > ts-jest@25.5.1" has incorrect peer dependency "jest@>=25 <26".
[5/5] 🔨  Building fresh packages...
success Saved lockfile.
✨  Done in 33.11s.
tokyo-citizen@macos covid19 % yarn check |& grep ^error\ Found
error Found 4 errors.

残存するエラーは以下の通りですが不要またはリリース待ちのパッケージ関連と推測しました

tokyo-citizen@macos covid19 % yarn check |& grep ^error
error "vue-axe#axe-core@3.5.3" doesn't satisfy found match of "axe-core@4.0.1"
error "vue-jest#jest@^25.x" doesn't satisfy found match of "jest@26.4.0"
error "@nuxtjs/eslint-config#eslint-plugin-vue#eslint@^5.0.0 || ^6.0.0" doesn't satisfy found match of "eslint@7.7.0"
error "vue-jest#ts-jest#jest@>=25 <26" doesn't satisfy found match of "jest@26.4.0"
error Found 4 errors.

参考として更新後の yarn.lock を用いて yarn install した場合の挙動です

tokyo-citizen@macos covid19 % rm -rf node_modules
tokyo-citizen@macos covid19 % yarn install --frozen-lockfile
yarn install v1.22.4
[1/5] 🔍  Validating package.json...
[2/5] 🔍  Resolving packages...
[3/5] 🚚  Fetching packages...
[4/5] 🔗  Linking dependencies...
warning "@nuxtjs/eslint-config > eslint-plugin-vue@6.2.2" has incorrect peer dependency "eslint@^5.0.0 || ^6.0.0".
warning "@nuxtjs/stylelint-module > stylelint-webpack-plugin@2.1.0" has unmet peer dependency "webpack@^4.0.0 || ^5.0.0".
warning "@nuxtjs/vuetify > sass-loader@8.0.2" has unmet peer dependency "webpack@^4.36.0 || ^5.0.0".
warning "@nuxtjs/vuetify > vuetify-loader@1.6.0" has unmet peer dependency "webpack@^4.0.0".
warning "nuxt-purgecss > purgecss-webpack-plugin@2.3.0" has unmet peer dependency "webpack@*".
warning " > vue-axe@2.4.0" has incorrect peer dependency "axe-core@3.5.3".
warning " > vue-jest@4.0.0-beta.5" has incorrect peer dependency "jest@^25.x".
warning "vue-jest > ts-jest@25.5.1" has incorrect peer dependency "jest@>=25 <26".
[5/5] 🔨  Building fresh packages...
✨  Done in 16.55s.
tokyo-citizen@macos covid19 % yarn check |& grep ^error
error "vue-axe#axe-core@3.5.3" doesn't satisfy found match of "axe-core@4.0.1"
error "vue-jest#jest@^25.x" doesn't satisfy found match of "jest@26.4.0"
error "@nuxtjs/eslint-config#eslint-plugin-vue#eslint@^5.0.0 || ^6.0.0" doesn't satisfy found match of "eslint@7.7.0"
error "vue-jest#ts-jest#jest@>=25 <26" doesn't satisfy found match of "jest@26.4.0"
error Found 4 errors.

期待する見せ方・挙動 / Expected behavior

yarn.lock を再生成するなどの方法で yarn check で大量のエラーが発生しないようにするのが良いと思います
再発リスク低減手段の一つとして Renovate の設定に lockFileMaintenance を追加することを検討するのが良いと思います(必要に応じて)

動作環境・ブラウザ / Environment

開発環境

kaizumaki commented 4 years ago

RenovateのPRはyarn.lockの更新をよしなにやってくれてると思ってるんですが...どこかで狂ってしまうんでしょうか。おっしゃるとおり、 lockFileMaintenance の設定を追加するとともにスケジューリングしたほうがよさそうですね。

ghost commented 4 years ago

あくまで推測として、以下「も」関係して、package.json と yarn.lock の一貫性が崩れたのではと思っています。 (直して前に進むことが大事だと思いますので、今回に限っては不毛な git-bisect や巨大な yarn.lock の差分確認には手を出しません😅)

参考: マージ済み PR #5061 の差分

mcdmaster commented 4 years ago

そこで私が何度も提案している "resolutions" ブロックの登場ですね♪

package.json ファイルの "devDependencies" ブロックの直後に、下記のセクションを付与してみてください。すくなくとも、core-js がらみのエラーは消えること請け合いです

  "resolutions": {
    "core-js": "3.x"
  }

mcdmaster commented 4 years ago

あ、 #5301 の方に書いた方がよかったですね

ghost commented 4 years ago

@mcdmaster

私のIssueの出し方が良くなかったと思いますので、ちょっと問題を整理しますね。😀

5301
- 紆余曲折はあれど PR #5061 の最終的な目的は core-js@3 への移行に落ち着いた
- 差分を確認すると package.json に core-js@3 関連のライブラリが追加されていない
- commit過程を確認すると最終的に試行錯誤過程の yarn.lock のみがマージされた状態と推測される
- 結果として package.json と yarn.lock の一貫性が崩れている
- 対処として、本来の目的に適合するように package.json を更新する必要がある (おそらく yarn.lock のリフレッシュも必要と考えられる)
5302
- yarn check のエラーが大量に出ている
- 多くは package.json と yarn.lock の一貫性が崩れていることが原因と推測される
- 対処として yarn.lock のリフレッシュが考えられる
- 恒久策の一つとして Renovate で lockFileMaintenance の設定を追加することが考えられる
- 前提条件
- ライブラリの追加変更削除を行う際には可能な限り yarn を用いる (特に yarn.lock の冒頭にある loudly な警告のように yarn.lock の直接編集はご法度)
- yarn で更新された package.json と yarn.lock をセットで commit する

kaizumaki commented 4 years ago

@tokyo-citizen まとめありがとうございます！ Renovateの設定とスケジューリングはやったほうがよさそうなので、進めたいと思います。別途、yarn.lockのリフレッシュでしょうか。

ghost commented 4 years ago

@kaizumaki 現状だと @babel/runtime-corejs3 が yarn.lockだけにある状態なので、yarn.lock のリフレッシュを行う場合には、先祖返りで混乱しないように、 #5301 の中で一括実施するのがいい気がします。

現在の状態で偶然 core-js@3 が利用できているのかはよくわかっていません... (ご存知のようにIE11の救済等で babel のトランスパイルに強く依存していると思いますので気にしています)

kaizumaki commented 4 years ago

@tokyo-citizen #5348 でRenovateの設定を追加しました。これでしばらく様子をみようと思います。便宜上こちらのissueがクローズになりましたが、ディスカッションを続ける場合は再オープンしてもらってOKです！

Tokyo-Metro-Gov / covid19