pgbus 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44b8e6016eb94d129ba3f90831ee6e3f8eb213c928e61766c35fa4641f0a518b
-  data.tar.gz: d35475deb1eaaf59e893c7096b10bc85498482f5940fc099e5add48af54aecbd
+  metadata.gz: a52dc949281b6f2f1e9c847d38709fcc2723badd12370486faeb68b40ed55c42
+  data.tar.gz: 70a75a14bfe2225f63846314cbb60c0942e86b966c14b20e43eec74afc63adef
 SHA512:
-  metadata.gz: db2122fe97f2b77dd6812e5e9a5264850b4eb84ff3c6094cc2c0e11a148989fa3ae502664e040da26b1ea1bf11b764c2b1f9659a58f9d4a6b663be54c1027cba
-  data.tar.gz: 597210a0238131f0a7912b0cf135dc4d89ce66ab830354dca3b3805dbc70a9ccbd2106830dea85b17c68be73fb79868ff9c43d27813e84e6f457dfbe996107d3
+  metadata.gz: dc59f389bf2b5e20b2e75a7a2c47301c242ea0b5857a240e5a59db3177effe34cbe694903d4396b07ef3ca67699f578a5d6b6d95f61d4318169ac477f237b526
+  data.tar.gz: a5a6a076c6cadb857c8690ef7d1363934c7f73bd76e8d91a87a936a91d05c4146c12bb67b5637204995d0ddef540833a8983ca4dd3d5ef1034a7b88473aa1e61

data/CHANGELOG.md

@@ -32,6 +32,8 @@
 
 ### Fixed
 
+- **Migration generators now route to the pgbus database when `connects_to` is configured, even without an explicit `--database` (issue #344).** `rails g pgbus:add_stream_queues` (and every sibling generator via `Generators::MigrationPath`) keyed the separate-database decision purely on the `--database` flag. An app that had already set `config.connects_to = { database: { writing: :pgbus } }` (so its pgbus migrations live in `db/pgbus_migrate/` per database.yml's `migrations_paths:`) still got the migration written to the **primary** DB's `db/migrate/` on a bare invocation — where it then ran against the wrong database — and the "Next steps" output told the operator to run `rails db:migrate` instead of `rails db:migrate:pgbus`. `MigrationPath` now auto-detects the target database from `connects_to` (via the existing `DatabaseTargetDetector`: runtime config → initializer scan → application.rb scan) when `--database` is absent; an explicit `--database` still wins. The detected name drives both the migration path (resolving `migrations_paths` for that database, falling back to the `db/pgbus_migrate` convention) and the `db:migrate:<name>` suffix in every generator's post-install output. An app with no separate database is unaffected. Refs #344.
+- **`extract_ar_connection_hash` no longer forces `host: "localhost"` / `port: 5432` on a socket-based (host-less) database.yml — pgmq's connections now match ActiveRecord's on Unix-socket dev setups (issue #343).** A local database.yml with no `host:` is a Unix-socket connection: ActiveRecord connects via libpq's default socket (`PGHOST` / the default socket dir), but pgbus's AR-config extraction defaulted the absent `host`/`port` to TCP `localhost:5432`, silently diverging from AR and pointing pgmq's dedicated raw connections at a *different* server (or nothing) on any machine where the socket dir isn't `localhost`. Apps on socket-based dev DBs therefore couldn't use the AR-extraction path at all and had to pin an explicit `connection_params` Hash whose only real job was *not* defaulting `host` (cosmos carried an `after_initialize` block for exactly this). The two fallbacks are dropped: `host`/`port` now pass through as-is and `.compact` removes them when absent, so libpq applies its own socket defaults and matches AR. A config that *does* set `host`/`port` is byte-identical to before. Refs #343.
 - **`config.log_format` no longer breaks `ActiveSupport::TaggedLogging` — tags are preserved instead of dropped, and `logger.tagged` no longer raises (issue #334).** TaggedLogging works by extending the logger's formatter instance with a module that prepends the current tags. Installing a fresh pgbus formatter (`LogFormatter::JSON`/`Text`) stripped that extension, so `logger.tagged("req-42") { ... }` dropped the tag — and, worse, raised `NoMethodError: undefined method 'tagged'` on the pgbus formatter (a deploy-breaker several apps hit, then worked around with a dedicated `$stdout` logger). `log_format=` now re-extends the replacement formatter with `ActiveSupport::TaggedLogging::Formatter` when the previous one carried it, so tagging keeps working. Refs #334.
 - **The "Dashboard is accessible without authentication" warning is no longer a false positive when a gating `base_controller_class` is set (issue #334).** The warning fired whenever `web_auth` was nil, ignoring that a non-default `base_controller_class` (e.g. an `AdminController` with its own `before_action`) already gates the dashboard — so apps set a redundant `web_auth` lambda purely to silence the log line. The warning now stays quiet when `base_controller_class` is anything other than the default `::ActionController::Base`. Refs #334.
 - **`retry_on` on an `:until_executed` job no longer dead-letters the job instead of retrying (issue #333).** The uniqueness key is released only on success or DLQ, but ActiveJob's `retry_on` re-enqueues from *inside* `perform_now` (after incrementing `executions`), while the executor still holds the key. That retry re-enqueue hit the job's own still-held key, was rejected as a duplicate (`JobNotUnique` under `on_conflict: :reject`), and the original message dead-lettered — so a job with both `ensures_uniqueness :until_executed` and `retry_on` lost its retry and DLQ'd on the first transient failure. A retry re-enqueue (`executions > 0`) is now recognized as the same logical job re-acquiring its own key and is allowed through; the existing key row correctly stays held until the job finally succeeds or dead-letters. Cross-job uniqueness (a genuine fresh duplicate, `executions == 0`) is still rejected. Proven end-to-end with a DB-gated integration test (fail-once-then-succeed runs to success exactly once, no `JobNotUnique`, no DLQ, key cleaned up). Refs #333.

data/lib/generators/pgbus/add_failed_events_index_generator.rb

@@ -29,7 +29,7 @@ module Pgbus
         say "Pgbus failed events unique index added!", :green
         say ""
         say "Next steps:"
-        say "  1. Run: rails db:migrate#{":#{options[:database]}" if separate_database?}"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
         say "  2. Failed jobs will now be tracked in the dashboard"
         say ""
       end

data/lib/generators/pgbus/add_job_stats_generator.rb

@@ -29,7 +29,7 @@ module Pgbus
         say "Pgbus job stats table installed!", :green
         say ""
         say "Next steps:"
-        say "  1. Run: rails db:migrate#{":#{options[:database]}" if separate_database?}"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
         say "  2. Stats collection is enabled by default"
         say "  3. View insights at /pgbus/insights"
         say ""

data/lib/generators/pgbus/add_job_stats_latency_generator.rb

@@ -29,7 +29,7 @@ module Pgbus
         say "Pgbus job stats latency columns installed!", :green
         say ""
         say "Next steps:"
-        say "  1. Run: rails db:migrate#{":#{options[:database]}" if separate_database?}"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
         say "  2. Queue latency and retry metrics are now tracked automatically"
         say "  3. View latency insights at /pgbus/insights"
         say ""

data/lib/generators/pgbus/add_job_stats_queue_index_generator.rb

@@ -29,7 +29,7 @@ module Pgbus
         say "Pgbus job stats queue index added!", :green
         say ""
         say "Next steps:"
-        say "  1. Run: rails db:migrate#{":#{options[:database]}" if separate_database?}"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
         say "  2. The Insights 'latency by queue' aggregation will now use the index"
         say "     instead of sequentially scanning pgbus_job_stats. Install this on"
         say "     heavy-traffic deployments with a large job stats retention window."

data/lib/generators/pgbus/add_outbox_generator.rb

@@ -29,7 +29,7 @@ module Pgbus
         say "Pgbus outbox installed!", :green
         say ""
         say "Next steps:"
-        say "  1. Run: rails db:migrate#{":#{options[:database]}" if separate_database?}"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
         say "  2. Enable in config: config.outbox_enabled = true"
         say "  3. Restart pgbus: bin/pgbus start"
         say ""

data/lib/generators/pgbus/add_presence_generator.rb

@@ -29,7 +29,7 @@ module Pgbus
         say "Pgbus presence installed!", :green
         say ""
         say "Next steps:"
-        say "  1. Run: rails db:migrate#{":#{options[:database]}" if separate_database?}"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
         say "  2. Use in your code:"
         say "       Pgbus.stream(@room).presence.join(member_id: current_user.id.to_s)"
         say "       Pgbus.stream(@room).presence.members"

data/lib/generators/pgbus/add_queue_states_generator.rb

@@ -29,7 +29,7 @@ module Pgbus
         say "Pgbus queue states table installed!", :green
         say ""
         say "Next steps:"
-        say "  1. Run: rails db:migrate#{":#{options[:database]}" if separate_database?}"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
         say "  2. Restart pgbus: bin/pgbus start"
         say ""
       end

data/lib/generators/pgbus/add_recurring_generator.rb

@@ -33,7 +33,7 @@ module Pgbus
         say "Pgbus recurring jobs installed!", :green
         say ""
         say "Next steps:"
-        say "  1. Run: rails db:migrate#{":#{options[:database]}" if separate_database?}"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
         say "  2. Edit config/recurring.yml to define your recurring tasks"
         say "  3. Restart pgbus: bin/pgbus start"
         say ""

data/lib/generators/pgbus/add_stream_queues_generator.rb

@@ -35,7 +35,7 @@ module Pgbus
         say "streams register themselves on their next broadcast after migrating."
         say ""
         say "Next steps:"
-        say "  1. Run: rails db:migrate#{":#{options[:database]}" if separate_database?}"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
         say "  2. Restart pgbus: bin/pgbus start"
         say ""
       end

data/lib/generators/pgbus/add_stream_stats_generator.rb

@@ -29,7 +29,7 @@ module Pgbus
         say "Pgbus stream stats table installed!", :green
         say ""
         say "Next steps:"
-        say "  1. Run: rails db:migrate#{":#{options[:database]}" if separate_database?}"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
         say "  2. Opt in by setting `config.streams_stats_enabled = true` in your"
         say "     pgbus initializer (disabled by default — stream event volume can"
         say "     be high, so stats recording is off unless you ask for it)."

data/lib/generators/pgbus/add_uniqueness_keys_generator.rb

@@ -29,7 +29,7 @@ module Pgbus
         say "Pgbus uniqueness keys table installed!", :green
         say ""
         say "Next steps:"
-        say "  1. Run: rails db:migrate#{":#{options[:database]}" if separate_database?}"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
         say "  2. Add `ensures_uniqueness` to your job classes (DSL is auto-included)"
         say "  3. Restart pgbus: bin/pgbus start"
         say ""

data/lib/generators/pgbus/install_generator.rb

@@ -99,7 +99,7 @@ module Pgbus
 
         say ""
         say "Next steps:"
-        say "  1. Run: rails db:migrate#{":#{database_name}" if separate_database?}"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
         say "  2. Edit config/initializers/pgbus.rb to configure workers"
         say "  3. Start processing: bin/pgbus start"
         say ""
@@ -115,8 +115,11 @@ module Pgbus
         options[:pgmq_schema_mode]
       end
 
+      # An explicit --database wins; otherwise fall back to a database already
+      # configured via connects_to so a bare re-install targets the right DB
+      # and its setup hints/output name it (issue #344).
       def database_name
-        options[:database]
+        effective_database_name
       end
     end
   end

data/lib/generators/pgbus/migrate_job_locks_generator.rb

@@ -34,7 +34,7 @@ module Pgbus
         say "  3. Drop the old pgbus_job_locks table (8 columns, 3 indexes)"
         say ""
         say "Next steps:"
-        say "  1. Run: rails db:migrate#{":#{options[:database]}" if separate_database?}"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
         say "  2. Restart pgbus: bin/pgbus start"
         say ""
       end

data/lib/generators/pgbus/migration_path.rb

@@ -1,27 +1,93 @@
 # frozen_string_literal: true
 
+require "pgbus/generators/database_target_detector"
+
 module Pgbus
   module Generators
     # Shared migration path logic for all pgbus generators.
     #
-    # When --database is passed, uses Rails' built-in db_migrate_path which
-    # reads migrations_paths from database.yml. This is the standard Rails
-    # multi-database mechanism and respects custom paths like db/pgbus_migrate/.
+    # A separate pgbus database can be selected two ways:
+    #
+    #   1. --database=pgbus explicitly on the generator invocation, or
+    #   2. the host app has already configured Pgbus with a dedicated database
+    #      (config.connects_to = { database: { writing: :pgbus } }).
     #
-    # Falls back to db/migrate/ when no --database is set (single-database mode).
+    # When either applies, migrations go to the separate-database path (e.g.
+    # db/pgbus_migrate) and the post-install output names the db:migrate:<name>
+    # task. When neither applies, everything falls back to db/migrate.
+    #
+    # Auto-detecting from connects_to (case 2) fixes issue #344: a bare
+    # `rails g pgbus:add_*` in an app configured for a separate database used to
+    # silently write to db/migrate and run against the WRONG database.
     module MigrationPath
       private
 
       def pgbus_migrate_path
-        if separate_database?
+        return "db/migrate" unless separate_database?
+
+        # --database was passed: Rails' db_migrate_path reads options[:database]
+        # and resolves migrations_paths from database.yml. When the database was
+        # instead auto-detected from connects_to, options[:database] is nil, so
+        # db_migrate_path can't see it — resolve the path for the detected
+        # database ourselves.
+        if options[:database].present?
           db_migrate_path
         else
-          "db/migrate"
+          resolve_detected_migrate_path
         end
       end
 
       def separate_database?
-        options[:database].present?
+        effective_database_name.present?
+      end
+
+      # The database name that migrations should target: an explicit --database
+      # wins; otherwise auto-detect from the app's connects_to configuration.
+      def effective_database_name
+        return @effective_database_name if defined?(@effective_database_name)
+
+        @effective_database_name =
+          if options[:database].present?
+            options[:database]
+          else
+            DatabaseTargetDetector.new(destination_root: destination_root).detect
+          end
+      end
+
+      # The `:name` suffix appended to `rails db:migrate` in post-install
+      # output. Empty string for single-database mode so the line reads a plain
+      # `rails db:migrate`.
+      def migrate_command_suffix
+        separate_database? ? ":#{effective_database_name}" : ""
+      end
+
+      # Migrations path for an auto-detected separate database. Rails' own
+      # db_migrate_path is keyed on options[:database], which is nil here, so
+      # look up migrations_paths for the detected database directly and fall
+      # back to the db/pgbus_migrate convention if it isn't in database.yml.
+      def resolve_detected_migrate_path
+        migrations_path_for(effective_database_name) || "db/pgbus_migrate"
+      end
+
+      def migrations_path_for(database_name)
+        return nil unless defined?(::ActiveRecord::Base) && defined?(::Rails) && ::Rails.respond_to?(:env)
+
+        config = ::ActiveRecord::Base.configurations.configs_for(
+          env_name: ::Rails.env,
+          name: database_name
+        )
+        Array(config&.migrations_paths).first
+      rescue StandardError => e
+        # A missing config for `database_name` isn't an error — configs_for
+        # returns nil and we fall back to the db/pgbus_migrate convention. But a
+        # genuine failure here (malformed database.yml, an AR API change) would
+        # otherwise be invisible, so surface it via the generator's own output
+        # the way update_generator#resolve_connection does — not Pgbus.logger
+        # (unavailable/inappropriate at generate time; pgbus_failed_events is the
+        # runtime job-failure table, not a generator diagnostics sink).
+        say "  !  could not resolve migrations_paths for #{database_name.inspect}: " \
+            "#{e.class}: #{e.message} (falling back to db/pgbus_migrate)", :yellow
+        nil
       end
     end
   end

data/lib/generators/pgbus/tune_autovacuum_generator.rb

@@ -33,7 +33,7 @@ module Pgbus
         say "automatically receive these settings."
         say ""
         say "Next steps:"
-        say "  1. Run: rails db:migrate#{":#{options[:database]}" if separate_database?}"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
         say "  2. Restart pgbus: bin/pgbus start"
         say ""
       end

data/lib/generators/pgbus/tune_fillfactor_generator.rb

@@ -36,7 +36,7 @@ module Pgbus
         say "this setting."
         say ""
         say "Next steps:"
-        say "  1. Run: rails db:migrate#{":#{options[:database]}" if separate_database?}"
+        say "  1. Run: rails db:migrate#{migrate_command_suffix}"
         say "  2. Restart pgbus: bin/pgbus start"
         say ""
       end

data/lib/generators/pgbus/upgrade_pgmq_generator.rb

@@ -31,7 +31,7 @@ module Pgbus
         say ""
         say "Next steps:"
         say "  1. Review the migration in db/#{separate_database? ? "pgbus_migrate" : "migrate"}/"
-        say "  2. Run: rails db:migrate#{":#{options[:database]}" if separate_database?}"
+        say "  2. Run: rails db:migrate#{migrate_command_suffix}"
         say ""
       end
 

data/lib/pgbus/configuration.rb

@@ -1439,9 +1439,15 @@ module Pgbus
       # Rails 7.1+ db_config.configuration_hash returns the full config
       config_hash = db_config.configuration_hash
 
+      # Do NOT default host/port here. An absent `host:` in database.yml is a
+      # Unix-socket connection; AR connects via libpq's socket default, so pgmq's
+      # raw connections must too. Forcing TCP localhost:5432 diverges from AR on
+      # socket-based configs (issue #343). `.compact` drops the absent keys and
+      # libpq applies its own defaults (PGHOST / default socket dir). A
+      # present-but-nil port is preserved as nil (also dropped by compact).
       base = {
-        host: config_hash[:host] || "localhost",
-        port: (config_hash[:port] || 5432).to_i,
+        host: config_hash[:host],
+        port: config_hash[:port]&.to_i,
         dbname: config_hash[:database],
         user: config_hash[:username],
         password: config_hash[:password]

data/lib/pgbus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pgbus
-  VERSION = "0.11.0"
+  VERSION = "0.11.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pgbus
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Mikael Henriksson