Installation: provide a production-safe, queue-only database setup command
Maintainer antworten meist innerhalb von 4 Tagen
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 45/100
Rechercherichtung
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.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Summary
The installation guide currently recommends running db:prepare in production after configuring a separate Solid Queue database:
Then run
db:preparein 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:
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:
That prerequisite explicitly resolves the database configuration using the test environment:
ActiveRecord::Tasks::DatabaseTasks.with_temporary_pool_for_each(
env: "test",
name: name
)
Source:
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:loadis not queue-scoped and may load every configured production schema, including the primary schema. -
db:migrate:queuecannot perform the initial installation from the generateddb/queue_schema.rbwhendb/queue_migratecontains no initial migration. -
Rails 7.2 does not provide a db:prepare:queue task.
-
Manually establishing a connection and loading
db/queue_schema.rbthrough 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?
-
Create only the configured queue database if it does not exist.
-
Load only
db/queue_schema.rbwhen the queue database needs initialization. -
Never execute the application's
db/seeds.rb. -
Never run migrations for the primary or other unrelated databases.
-
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:
- Vorherrschende Sprache
- Ruby
- Sterne
- 2.5k
- Forks
- 271
- Ø Merge
- 5 T. 6 Std.
- Gemergte PRs (30 T.)
- 5
Entwicklungsumgebung
Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.
- Enthält ein Dockerfile oder eine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Kein Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus rails/solid_queue
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
rails/solid_queue#838 ·
Maintainer antworten meist innerhalb von 4 Tagen
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
rails/solid_queue#834 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 4 Tagen
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
rails/solid_queue#824 · 1 Reaktion ·
Maintainer antworten meist innerhalb von 4 Tagen
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 42/100
rails/solid_queue#808 · 3 Kommentare ·
Maintainer antworten meist innerhalb von 4 Tagen
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100
rails/solid_queue#806 ·
Maintainer antworten meist innerhalb von 4 Tagen
Alle Issues in rails/solid_queue
Ähnliche Issues
-
開発用DockerイメージにPlaywrightのシステム依存を追加するEvtl. vergeben @momocus hat das heute übernommen. Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 85/100
sakazuki-org/sakazuki#1453 ·
Maintainer antworten meist innerhalb von 3 Tagen
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
jenkins-infra/jenkins.io#9615 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
fix(ocr): compile the Tesseract-free pipeline with Tokio runtimeEvtl. vergeben @Goldziher hat das heute übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
Maintainer antworten meist innerhalb von 1 Tag
-
Metric tooltips that contradict how the metric is calculatedEvtl. vergeben @aniadeadu hat das heute übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
WikiEducationFoundation/WikiEduDashboard#7303 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
WhatsApp Cloud template sync saves a partial template list when one page of the Graph API response failsEvtl. vergeben Ein verknüpfter Pull Request ist offen oder bereits gemergt. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
Maintainer antworten meist innerhalb von 2 Tagen