Heroku での Active Storage

最終更新日 2024年04月24日(水)

Rails 5.2 で導入された Active Storage​ は、Active Record モデルへのファイルの添付と保存を管理する方法です。このガイドでは、Heroku で Active Storage を使用する方法について説明します。

一時的ディスク

Heroku には “一時的” ハードドライブがあります。これは、ファイルをディスクに書き込むことはできるが、アプリケーションを再起動するとそれらのファイルは失われるという意味です。Active Storage では、:local​ ストレージオプションがデフォルトで使用されます。このオプションでは、アップロードされたファイルの保存にローカルファイルシステムを使用します。:local​オプションを使用してファイルアップロードを保存した場合、しばらくは問題ありませんが、添付ファイルは表示動作に支障をきたすようになり、最終的には消滅します。ファイルはアプリがデプロイされるか、(24 時間おきに) 自動的に再起動されると消滅します。アプリに複数の dyno がある場合、すべてのファイルがすべての dyno に存在するとは限らなくなります。つまり、Web リクエストを処理する dyno が、特定のアップロード済みファイルを含む dyno とは異なっている可能性があります。たとえば、2 つの dyno がある場合、アップロードしたファイルが片方の dyno にしか存在しなくなります。Web ページを更新すると、50% の確率でファイルがある方の dyno に Web リクエストがルーティングされ、50% の確率でファイルが破損しているように見えます。さらに、heroku run bash​ インスタンスやスケジューラータスクなどのコマンドでは新しい dyno を使用するため、これらの One-off dyno からは、ディスクに保存されている一切のファイルが見えません。

アップロードしたファイルをディスクに保存する代わりに、Amazon S3 などのクラウドファイルストレージサービスを利用するのがベストプラクティスです。

異なるストレージバックエンド​を使用するには、config/storage.yml​ ファイルの内容を変更する必要があります。bucketeer アドオン​を使用して S3 を管理している場合、次の内容を config/storage.yml​ に追加できます。

amazon:
  service: S3
  access_key_id: <%= ENV['BUCKETEER_AWS_ACCESS_KEY_ID'] %>
  secret_access_key: <%= ENV['BUCKETEER_AWS_SECRET_ACCESS_KEY'] %>
  region: <%= ENV['BUCKETEER_AWS_REGION'] %>
  bucket: <%= ENV['BUCKETEER_BUCKET_NAME'] %>

追加したら、このストレージバックエンドを本番環境で使用するようアプリケーションに指示する必要があります。config/environments/production.rb​で、アクティブストレージサービスを amazon に設定していることを確認します。

  config.active_storage.service = :amazon

最後に、AWS gem もインクルードする必要もあります。次の内容を Gemfile​ に追加します。

gem "aws-sdk-s3", require: false

次のコマンドを忘れずにローカルで実行してください。

$ bundle install

その後、Heroku へのデプロイを試みる前に、ファイルを Git にコミットします。

添付ファイルのプレビュー

Active Storage の大きな特徴の 1 つは、画像以外の添付ファイルのプレビュー​を使用できることです。具体的には、PDF とビデオをプレビューできます。この機能を使用するには、これらのファイルの処理方法を知っているシステムリソースにアプリケーションがアクセスできる必要があります。Rails ではデフォルトで、PDF プレビュー用の poppler​ と、ビデオプレビュー用の ffmpeg​ がサポートされています。Heroku では、これらのシステム依存関係はデフォルトでは利用できません。

これらの種類のファイルを Active Support でプレビュー可能にするには、次のように実行する必要があります。

$ heroku buildpacks:add -i 1 https://github.com/heroku/heroku-buildpack-activestorage-preview

実行したら、もう一度デプロイしてバイナリを取得する必要があります。コマンドラインで which ffmpeg​ を実行すると、依存関係がインストールされていることを確認できます。出力がない場合、操作が正しく実行されなかったことを示しています。結果が表示された場合、バイナリは使用準備ができています。

$ heroku run bash
~$ which ffmpeg
/app/.heroku/activestorage-preview/usr/bin/ffmpeg

poppler​ がない状態で PDF のプレビューを試みると、ページはエラーになり、ログには次のように記録されます。

ActionView::Template::Error (ActiveStorage::UnpreviewableError)

ffmpeg​ がない状態でビデオのプレビューを試みると、プレビューが破損しているように見え、ログには次のようなエラーが記録されます。

Errno::ENOENT (No such file or directory - ffmpeg):