Yarn 2 への移行

この記事の英語版に更新があります。ご覧の翻訳には含まれていない変更点があるかもしれません。

最終更新日 2020年08月11日(火)

喜ばしいことに、Yarn 2 は 2020 年の初頭にリリースされました。チームでは “ゼロダウンロード” のパッケージマネージャーを作成しました。これにより、ユーザーは “vendor” ディレクトリを使用して、自分の Yarn バイナリ、依存関係、および開発の依存関係を自分のリポジトリに含めることができます。Yarn の新しい哲学についてはこちらをご覧ください​。

この記事の目的は、現在の Heroku ユーザーが Yarn 1 から Yarn 2 に移行するのを支援することです。移行するアプリで Yarn 1 をすでに使用していること、また Heroku Node.js buildpack の最新バージョンを使用していることが前提です。この記事の内容は、Heroku Ruby buildpack などの他のスクリプトから Yarn をインストールするアプリケーションには当てはまりません。"ゼロダウンロード" の利点を最大限に活かすために、Heroku では、すべての依存関係を .yarn​ ディレクトリに含めることが期待されています。

Yarn を使用している Heroku ユーザーが Yarn 2 に移行することは必須ではなく、Yarn 1 が非推奨になった後もユーザーはアプリ内で Yarn 1 にアクセスできます。しかし、パッケージマネージャーで最新のバグ修正とセキュリティパッチを確実にするために、Yarn 2 に移行することをお勧めします。

この記事を参考にして、アプリのコードをローカルで Yarn 2 に移行し、Heroku 上のアプリケーションも移行します。

以下の記述では、git​ へのファイルのチェックインに言及していますが、指示内容は他のバージョン管理システムにも適用できます。

ローカルの設定

ローカル環境の準備

移行が必要なソースコードのディレクトリに移動します。ローカルコマンドはプロジェクトのルートで実行されます。ローカルの yarn バージョンが最新であることを確認してください。ローカルで更新するには、npm を使用してインストールを実行します。

npm install -g yarn

バージョンは 1.22.4 以上である必要があります。確認するには yarn -v​ を実行します。

カスタムのキャッシュディレクトリをワークスペースに移動する

package.json​ で、cacheDirectories​ を workspaces​ に変更します。たとえば、次の内容があるとします。

"cacheDirectories": [
  "client/node_modules"
]

これを次のように変更し、プロジェクトが非公開であることを指定します。

"workspaces": [
  "client"
],
"private": true,

node_modules​ ディレクトリを指定する必要はありません。サブディレクトリの package.json​ 内の "name"​ キーが、ルートの package.json​ で指定されたディレクトリ名とワークスペース名を反映していることを確認してください。

次に、サブディレクトリに node_modules​ フォルダーと yarn.lock​ ファイルがあれば削除し、アプリケーションディレクトリに移動して yarn​ を実行します。

cd ~/path/to/project && yarn install

ディレクトリの yarn.lock​ ファイルが更新され、ワークスペースによって指定された依存関係ツリー全体が反映されます。サブディレクトリの package.json​ で指定された依存関係を探して、ロックファイルが更新されたことを確認してください。

ソースコードの変更

Heroku で Yarn 2 を使用するために、Git にチェックインする必要がある追加のファイルが存在します。Yarn は “ゼロダウンロード” の哲学に傾倒しています。チェックインするファイルとディレクトリが増える分だけコストも高くなりますが、これによって Heroku でのビルドが高速になります。

yarn​ を使用して、ソースコードに yarn のバージョンを設定します。

yarn set version berry

.yarnrc.yml​ ファイルと .yarn​ ディレクトリが作成されます。両方を Git にチェックインし、ビルド時に Heroku で利用できることを確認してください。.yarn​ ディレクトリには、yarn-berry.js​ を含む releases​ ディレクトリがあります。

次に、package.json​ から依存関係をインストールします。

yarn install

yarn.lock​ ファイルが変更されます。これらの変更を Git にチェックインします。

pnp.js​ ファイルも生成されます。これは “プラグアンドプレイ” ファイルです。Yarn では、このファイルを使用してパッケージにアクセスします。.yarn​ ディレクトリに生成される追加のファイルもあり、これには、依存関係がインストールされる新しい cache​ ディレクトリ、build-state.yml​ ファイル、install-state.gz​ ファイルなどが含まれます。.yarn​ の内容を Git にチェックインします。

.yarn/cache​ の内容は node_modules​ と比較できません。これらのファイルは圧縮され、プロジェクトへのチェックインが意図されています。

Heroku アプリのキャッシュのクリア

Heroku では、ビルドの開始時にキャッシュが復元されることも、ビルドの終了時にキャッシュが保存されることもないため、以前のビルドから残っているキャッシュを前もってパージすることができます。

heroku-cli​ がインストールされていることを確認してください。その後、heroku-repo​ プラグインをインストールします。

heroku plugins:install heroku-repo

次に、コマンドを実行してキャッシュをクリアします。

heroku repo:purge_cache --app $APP_NAME

この後、アプリを再デプロイする必要がありますが、その前に、デプロイを確実に成功させるために次の手順を完了してください。

Heroku 環境の更新 (Plug'n'Play を使用)

Yarn 2 を使用している場合、Yarn の Plug'n'Play を使用して依存関係を参照するか、ノードモジュールを使用し続けるかを選択できます。それぞれの場合で少し異なった設定が必要なため、ノードモジュールを使用する場合は、それに応じたアプリの設定​を行ってください。

依存関係キャッシュの無効化

Heroku では現在、Yarn 2 との依存関係を .yarn/cache​ ディレクトリからキャッシュしません。Plug'n'Play を使用する場合、Yarn は zip 圧縮された依存関係が .yarn/cache​ ディレクトリにあることを期待します。ただしその場合でも、すべての依存関係に対して postinstall​ スクリプトが実行されることを保証するために、buildpack は yarn install​ を実行します。

Yarn 1 と node_modules​ に関連付けられた環境変数を削除することが必要になります。したがって、NODE_MODULES_CACHE​ 環境変数を削除します。この変数を false​ に設定する必要があります。

heroku config:set NODE_MODULES_CACHE=false

Heroku では .yarn/cache​ ディレクトリからのキャッシングに取り組んでいますが、まだサポートされていません。カスタムキャッシュ設定を使用したい場合、カスタムキャッシング設定​によって実現できます。

本番環境変数の削除

Yarn 2 でパッケージをトップレベルにインストールする場合、devDependencies​ なしで dependencies​ のみをインストールするために使用できる --production​ フラグはもうありません。これは 2 つのことを意味します。

  1. buildpack は、最初の yarn install​ の手順ですべての依存関係のインストールを実行します。
  2. Yarn 1 と異なり、buildpack は、devDependencies​ に列挙されている依存関係をビルド終了時に削除できません。

--production​ フラグと devDependencies​ の管理を利用するためには、Yarn ワークスペースを使用する必要があります。詳細は https://yarnpkg.com/features/workspaces​ のドキュメントをご覧ください。

Yarn 2 で本番環境変数を有効にしたままの場合、ビルドは失敗します。必ず環境変数を設定解除してください。

heroku config:unset NPM_CONFIG_PRODUCTION YARN_PRODUCTION

プライベートレジストリ環境変数の削除

プライベートレジストリにアクセスするためのトークンを設定済みであり、チェックインしたキャッシュと共に Yarn 2 を使用している場合は、トークンも設定解除してください。次のように実行できます。

heroku config:unset PRIVATE_NPM_TOKEN

Heroku 環境の更新 (ノードモジュール向け)

すでに述べたように、依存関係には Plug'n'Play またはノードモジュールのどちらかを使用します。Plug'n'Play を使用するには、前に説明した手順に従う​必要があります。

Yarn 設定のセットアップ

依存関係に PnP を使用しないことを選択した場合、.yarnrc.yml​ でこれを指定する必要があります。次の内容を追加します。

nodeLinker: "node-modules"

よりカスタマイズのしやすい Yarn 2 設定についてはこちらで説明​されています。

これで、Yarn 2 でノードモジュールを使用する準備ができました。

依存関係のキャッシング

ノードモジュールを使用している場合、Heroku のキャッシュを使用してビルド間の依存関係を保存するかどうかは自由に選択できます。アプリのビルドのパフォーマンスとセキュリティはどちらの場合のほうが高くなるか、テストすることをお勧めします。

すでに依存関係をキャッシュしている場合は、キャッシュを無効にしてアプリをテストしてみてください。

heroku config:set NODE_MODULES_CACHE=false

キャッシュを再び有効にするには、NODE_MODULES_CACHE​ 変数を再設定します。

heroku config:set NODE_MODULES_CACHE=true

本番環境変数の削除

こちら​で説明したように、Yarn 2 の使用時は --production​ フラグを指定するとビルドが失敗するため、無効にする必要があります。

heroku config:unset NPM_CONFIG_PRODUCTION YARN_PRODUCTION

アプリのテスト

変更が終わったら、必ずアプリのコードに対してテストスイートを実行してください。問題なくテストに合格したら、アプリケーションを Heroku にデプロイします。ビルドが成功したことを確認します。

問題が発生した場合は、GitHub で問題をオープン​してください。