Installation: provide a production-safe, queue-only database setup command

オープン
#836 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 4 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
45/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
mysql, rails, ruby
領域
backend, databases

調査の方向性

Start with the installation guide and the Rails 7.2 task behavior cited in the issue, especially the db:schema:load:queue prerequisite and the db:prepare implementation. Compare the existing queue-scoped setup options against the requested safety constraints; done means documenting or providing a supported path that initializes only the queue database without seeds, unrelated migrations, or test-database access.

索引モデルが issue の本文から書いたものです。

説明

Summary

The installation guide currently recommends running db:prepare in production after configuring a separate Solid Queue database:

Then run db:prepare in production to ensure the database is created and the schema is loaded.

For an existing production application, this command is not scoped to Solid Queue. It can execute the application's db/seeds.rb and run pending migrations for other databases, including the primary database.

The apparent queue-specific alternative, bin/rails db:schema:load:queue, is not reliable either on Rails 7.2.3.2: it invokes db:test:purge:queue first and therefore requires a configured and accessible test database, even when RAILS_ENV=production.

Could Solid Queue provide or document a supported installation path that initializes only the queue database, without touching the test database, running application seeds, or migrating unrelated databases?

Environment

  • Solid Queue: 1.7.2

  • Rails: 7.2.3.2

  • Ruby: 3.4.10

  • Database: MySQL

  • Setup: an existing production application with a populated primary database and a new, separate queue database

Why db:prepare is risky for this installation scenario

In Rails 7.2.3.2, db:prepare calls ActiveRecord::Tasks::DatabaseTasks.prepare_all, which iterates over all database configurations for the current environment.

Its implementation sets seed = true whenever any database is considered uninitialized, and eventually calls:

load_seed if seed

Source:

https://github.com/rails/rails/blob/v7.2.3.2/activerecord/lib/active_record/tasks/database_tasks.rb#L176-L220

Consequently, adding a new queue database is enough to trigger the application's seed loader, even if the primary database has existed for years and is already fully initialized.

This is unsafe for applications whose db/seeds.rb is not idempotent or contains administrative data changes. A command run solely to install Solid Queue should not unexpectedly execute application seed logic against an existing production system.

The same implementation also runs migrations for the current environment's database configurations, so pending primary-database migrations may be executed as part of the Solid Queue installation.

There is an additional edge case around schema loading: Rails determines whether a database is initialized by checking for schema_migrations. If an existing database does not have that table, db:prepare may load its schema; schemas containing force: :cascade can then recreate existing tables.

To be clear, I am not saying that db:prepare always reloads the primary schema or drops production tables. An initialized primary database is normally not schema-loaded. The concern is that its application-wide behavior is much broader and more state-dependent than what is needed to initialize Solid Queue.

Why db:schema:load:queue does not solve the problem

Running:

RAILS_ENV=production bin/rails db:schema:load:queue

fails with:

bin/rails aborted!
TypeError: Invalid type for configuration. Expected Symbol, String, or Hash. Got nil (TypeError)

Tasks: TOP => db:schema:load:queue => db:test:purge:queue

On Rails 7.2.3.2, the named schema-loading task has a hard-coded prerequisite:

task name => "db:test:purge:#{name}"

Source:

https://github.com/rails/rails/blob/v7.2.3.2/activerecord/lib/active_record/railties/databases.rake#L495-L504

That prerequisite explicitly resolves the database configuration using the test environment:

ActiveRecord::Tasks::DatabaseTasks.with_temporary_pool_for_each(
  env: "test",
  name: name
)

Source:

https://github.com/rails/rails/blob/v7.2.3.2/activerecord/lib/active_record/railties/databases.rake#L583-L590

If test.queue is not configured, the lookup returns nil, which eventually causes the TypeError above. If a test configuration exists but no test database is available on the production host, the task may instead fail while trying to connect to it.

Production servers commonly have no test database at all, by design. Requiring one merely to initialize a production queue database makes this an unsuitable deployment workaround.

I understand that this prerequisite comes from Active Record rather than Solid Queue. I also noticed that Rails PR https://github.com/rails/rails/pull/54853 removes this test-database purge behavior. However, affected released Rails versions are still in use, and Solid Queue supports Rails 7.1 and later, so a reliable installation path is still needed for those versions.

Other available commands do not provide a complete alternative

  • db:schema:load is not queue-scoped and may load every configured production schema, including the primary schema.

  • db:migrate:queue cannot perform the initial installation from the generated db/queue_schema.rb when db/queue_migrate contains no initial migration.

  • Rails 7.2 does not provide a db:prepare:queue task.

  • Manually establishing a connection and loading db/queue_schema.rb through rails runner or rails console works as a workaround, but it is not a clear, supported installation procedure and is easy to execute against the wrong database.

Request

Could Solid Queue provide an official queue-scoped setup command, for example solid_queue:setup, with the following behavior?

  1. Create only the configured queue database if it does not exist.

  2. Load only db/queue_schema.rb when the queue database needs initialization.

  3. Never execute the application's db/seeds.rb.

  4. Never run migrations for the primary or other unrelated databases.

  5. Never require or connect to a test database.

Alternatively, a documented migration-based installation path for existing production applications would also solve this problem.

At minimum, it would be helpful for the installation guide to warn that db:prepare may execute application seeds and unrelated pending migrations, and to document a safe queue-only alternative for existing production applications.

Related reports:

主要言語
Ruby
スター
2.5k
フォーク
271
平均マージ
5日 6時間
マージ済み PR(30日)
5

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

rails/solid_queue のほかの issue

rails/solid_queue の issue をすべて見る

似ている issue

Ruby の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。