最終更新日 2023年04月04日(火)

アセット同期を使用すると、エラーが発生する場合があります。Heroku では、可能な場合は常に asset_sync​ の代わりに CDN​ を使用することをお勧めします。

アセット同期 gem は、アセット (画像、CSS、JavaScript) を S3 などのサードパーティのファイルストアにアップロードします。そこから、アセットを S3 から直接ダウンロードするようブラウザに指示するようにアプリケーションを設定できます。現在では、可能な場合は常に、代わりに CDN​ を使用する必要があります。

デバッグ

本番環境でアセットパイプラインを使用できるということは、本番環境でアセットパイプラインをデバッグできる必要があることを示します。何らかのエラーまたは奇妙なバグが発生しているときは、多くの場合、デバッグするための最善の方法は問題の再現です。これは通常、bash セッションを開き、アセットを再生成しようとすることにより実行されます。

$ heroku run bash
~$ bundle exec rake assets:precompile

これを asset_sync​ なしで行った場合は、すべての結果が現在の dyno に制限され、本番アプリには影響を与えません。ただし、タスクが正常に実行されるたびに asset_sync​ を使用している場合は、結果のファイルが本番アプリで使用されている S3 に保存されます。

つまり、デバッグして問題を見つけようとしている間、おそらくファイルへの新しい要素の導入 (スタイル要素の変更など) によって、次のようになります。

~$ echo "body { background-color: red }" >> app/assets/stylesheets/application.css
~$ bundle exec rake assets:precompile

asset_sync​ を使用していない場合は、これによって問題は発生しません。asset_sync​ を使用している場合は、新しい application-<fingerprint>.css​ が生成されて S3 に保存されるため、アプリの設定方法によっては問題が発生する可能性があります。

前にコンパイルされたファイルを削除するためにアセット同期が設定されている場合は、本番アプリが突然、以前の application-<old-fingerprint>.css​ ファイルにアクセスできなくなります。このコマンドの目的は本番環境を変更することではなく、問題をデバッグすることであったため、これは不正になります。

別の asset_sync​ オプションは、マニフェストファイルをアップロードして S3 から使用することです。これが有効になっている場合は、アプリが (何らかの設定変更の後に heroku restart​ 経由で、または 24 時間おきに) 再起動すると新しいアプリが起動し、生成した新しいマニフェストファイルが今作成された application.css ファイルは最新であることを示しているため、それをサイトへの訪問者に対して処理し始めます。アセットをデバッグしているユーザーが原因で、本番環境アプリケーションのアセットが “ランダムに” 変更されるように見える可能性があるため、これは不正です。

これらのタイプのデバッグの間違いは、誤って本番環境の AWS 資格情報を使用している場合など、ローカルでも発生する可能性があります。asset_sync​ を使用している場合は、チームの全員、および業者や Heroku サポートスタッフなどの何らかの問題のデバッグを支援しているすべてのユーザーが、本番環境アプリケーションを誤って変更しないようこの gem に注意する必要があります。

ロールバック

Heroku アプリケーションを以前のリリースにロールバックした場合、デフォルトでは、アセットは再コンパイルされません。マニフェストの同期オプションを使用しており、コードと共にアセットがロールバックされることを想定していた場合は、これにより問題が発生することがあります。この動作は想定されず、そのアプリケーションが asset_sync​ を利用していることをすぐに思い出せないユーザーにとっては紛らわしい場合があります。

パイプライン

パイプライン​を使用してステージング slug を本番環境にプロモートし、CDN​ 経由でアセットを処理している場合、アセットの事前コンパイルはステージングアプリに対して 1 回だけ実行されます。

パイプラインを使用すると、バグをキャッチするために常にまずステージングにデプロイする習慣が促進されます。また、本番環境へのプロモーションも非常に速くなります。マイナス面としては、アプリが本番環境に “プロモート” されたときに、ディスク上のファイルが新しいアプリに移動され、新しい rake assets:precompile​ が実行されない点があります。このため、自身の内部にある “ステージング” CDN URL でコンパイルされたアセットは本番環境にプロモートされます。

body { background-image: url("http://staging-cdn.example.com/assets/smile-<fingerprint>.png") }

多くのアプリケーションにとって、ステージング環境と本番環境の間での CDN の共有は想定外ですが、問題は発生しません。この両方を、同じ “asset_host” が存在するように手動で設定できます。これが機能するのは、アセットのコピーがステージングアプリで変更された場合でも、すべてのアセットのフィンガープリントが取られ、"本番" アプリがブラウザの正しいフィンガープリントを指すようになるためです。ステージングアプリはアセットの最大 3 つの古いコピーを処理し、CDN ではアセットがいつまでもキャッシュされるようにする必要があります。

本番アプリとステージングアプリの間で CDN を共有できない場合は、一時的な回避策としてアセット同期を使用できます。これを機能させるには、リリースフェーズを使用​し、Procfile​ にリリースフェーズエントリを追加する必要があります。

release: rake assets:precompile

“manifest”​ オプションが有効になっていることを確認する必要があります。これが機能するのは、プロモーションでリリースフェーズが再実行され、本番アプリのアセットが本番 S3 (またはその他のファイルストア) バケットにアップロードされるためです。manifest オプションを使用する必要がある理由は、リリースフェーズでのすべてのディスク変更がアプリケーションに保存されるわけではないことです。マニフェストファイルをアップロードしない場合、起動したアプリは、引き続き “ステージング” から生成されたすべてのアセットを指しているディスクのマニフェストファイルを使用します。

この回避策を使用することにした場合は、注意が必要です。前のセクションでは、manifest ファイルオプションの使用に関する警告が示されました。これにより、デバッグやロールバックがより困難で、かつ予測不可能になる場合があります。実装と注意事項についての詳細は、リリースフェーズのドキュメント​を参照してください。