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

Ouverte
#836 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 4 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
45/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
mysql, rails, ruby
Domaine
backend, databases

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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:

Langage dominant
Ruby
Étoiles
2.5k
Forks
271
Merge moyen
5 j 6 h
PR mergées (30 j)
5

Préparer son environnement

Ouvrir dans Codespaces

Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.

  • Fournit un Dockerfile ou un fichier Docker Compose
  • Aucun modèle de pull request
  • Aucun guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de rails/solid_queue

Toutes les issues de rails/solid_queue

Issues similaires

Plus d'issues Ruby

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.