ros-apartment 3.4.0 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af86a04df8bf00d04859470cd76a8228d6b984da90e1324ed9eff43cbd0db0ac
-  data.tar.gz: 905caaf498b70015ddccc9d8846ec18384fac0a98f6dd1010890a8fa2fb19e97
+  metadata.gz: 2ff5e16756f5fc42560082bd07204b8853c85a4b4d15ce38664585b2e6631ccc
+  data.tar.gz: 168b28a0141dca9bdbdc80ea6ecf3247677b7dc138ca6d3feed213d24c11b454
 SHA512:
-  metadata.gz: dfea9df160a8eb0e400f215eada4ecfb41852ab4d92123e1ee51bf2f1a25069c24a36a6b471048d70091a03af5efd420af6657e6bba38748630f285a5aa344cf
-  data.tar.gz: 9a521c51af92800ac7b42a2f7f7ef48322d075095aed7868807caecc248958fc0667e3c0ae22b14e17d9df44ada1c325ca9804e03bdc9947a2f90bcf1a6bb27a
+  metadata.gz: c8899404718944dae59cc218ac48c558f6005cce6bb6f61357bca1f3a69e8e9a0bbef7950d60effcc1a02efde0ecc65062fc258565a5375a7991cc3ad2d0a293
+  data.tar.gz: 4b4aa74a1194609b254a3e08c00d493243842396f045560d6909ae3c67751dbb183d56545046bb61508f61e039ee2159875fe8fb2766d15f20cea28068a8504a

data/RELEASING.md

@@ -0,0 +1,106 @@
+# Releasing ros-apartment
+
+This document describes the release process for the `ros-apartment` gem.
+
+## Overview
+
+Releases are automated via GitHub Actions. Pushing to `main` triggers the `gem-publish.yml` workflow, which publishes to RubyGems using trusted publishing (no API key required).
+
+## Prerequisites
+
+- All changes merged to `development` branch
+- CI passing on `development`
+- Version number updated in `lib/apartment/version.rb`
+
+## Release Steps
+
+### 1. Bump the version
+
+Update `lib/apartment/version.rb` on the `development` branch:
+
+```ruby
+module Apartment
+  VERSION = 'X.Y.Z'
+end
+```
+
+Follow [Semantic Versioning](https://semver.org/):
+- **MAJOR** (X): Breaking changes
+- **MINOR** (Y): New features, backwards compatible
+- **PATCH** (Z): Bug fixes, backwards compatible
+
+### 2. Create release PR
+
+Create a PR from `development` to `main`:
+
+```bash
+gh pr create --base main --head development --title "Release vX.Y.Z"
+```
+
+Include a summary of changes in the PR description.
+
+### 3. Merge the release PR
+
+Once CI passes and the PR is approved, merge it. This triggers the publish workflow.
+
+**Important**: The workflow creates the git tag automatically. Do not create the tag manually beforehand or the workflow will fail.
+
+### 4. Verify the publish
+
+Monitor the `gem-publish.yml` workflow run. It will:
+1. Build the gem
+2. Create and push the `vX.Y.Z` tag
+3. Publish to RubyGems
+4. Wait for RubyGems indexes to update
+
+Verify at: https://rubygems.org/gems/ros-apartment
+
+### 5. Create GitHub Release
+
+After the workflow completes:
+
+1. Go to https://github.com/rails-on-services/apartment/releases/new
+2. Select the `vX.Y.Z` tag (created by the workflow)
+3. Click "Generate release notes" for a starting point
+4. Edit the release notes to highlight key changes
+5. Publish the release
+
+We use GitHub Releases as our changelog (no CHANGELOG.md file).
+
+### 6. Sync branches
+
+Merge `main` back into `development` to keep them in sync:
+
+```bash
+git checkout development
+git pull origin development
+git merge origin/main --no-edit
+git push
+```
+
+## Workflow Details
+
+The `gem-publish.yml` workflow uses:
+- **Trusted publishing**: Configured via RubyGems.org OIDC, no API key needed
+- **rubygems/release-gem@v1**: Official RubyGems action
+- **rake release**: Builds gem, creates tag, pushes to RubyGems
+
+## Troubleshooting
+
+### Workflow fails with "tag already exists"
+
+The tag was created manually before the workflow ran. Delete the tag and re-run:
+
+```bash
+git push origin --delete vX.Y.Z
+```
+
+Then re-trigger the workflow by pushing to main again (or re-run from GitHub Actions UI).
+
+### Gem published but GitHub Release missing
+
+The GitHub Release is created manually (step 5). The gem is already available on RubyGems; the release is just for documentation.
+
+### RubyGems trusted publishing fails
+
+Verify the GitHub environment `production` is configured correctly in repository settings, and that RubyGems.org has the trusted publisher configured for this repository.

data/context7.json

@@ -0,0 +1,4 @@
+{
+  "url": "https://context7.com/rails-on-services/apartment",
+  "public_key": "pk_EQhqzkh8FktmxBU0mbzmZ"
+}

data/lib/apartment/active_record/postgresql_adapter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# rubocop:disable Style/ClassAndModuleChildren
+# rubocop:disable Style/ClassAndModuleChildren, Style/OneClassPerFile
 
 # NOTE: This patch is meant to remove any schema_prefix appart from the ones for
 # excluded models. The schema_prefix would be resolved by apartment's setting
@@ -55,4 +55,4 @@ require 'active_record/connection_adapters/postgresql_adapter'
 class ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
   include Apartment::PostgreSqlAdapterPatch
 end
-# rubocop:enable Style/ClassAndModuleChildren
+# rubocop:enable Style/ClassAndModuleChildren, Style/OneClassPerFile

data/lib/apartment/adapters/jdbc_postgresql_adapter.rb

@@ -41,7 +41,7 @@ module Apartment
         raise(ActiveRecord::StatementInvalid, "Could not find schema #{tenant}") unless schema_exists?(tenant)
 
         @current = tenant.is_a?(Array) ? tenant.map(&:to_s) : tenant.to_s
-        Apartment.connection.schema_search_path = full_search_path
+        set_schema_search_path(full_search_path)
       rescue ActiveRecord::StatementInvalid, ActiveRecord::JDBCError
         raise(TenantNotFound, "One of the following schema(s) is invalid: #{full_search_path}")
       end

data/lib/apartment/adapters/postgresql_adapter.rb

@@ -41,12 +41,12 @@ module Apartment
       #
       def reset
         @current = default_tenant
-        Apartment.connection.schema_search_path = full_search_path
+        set_schema_search_path(full_search_path)
       end
 
       def init
         super
-        Apartment.connection.schema_search_path = full_search_path
+        set_schema_search_path(full_search_path)
       end
 
       def current
@@ -76,13 +76,35 @@ module Apartment
         raise(ActiveRecord::StatementInvalid, "Could not find schema #{tenant}") unless schema_exists?(tenant)
 
         @current = tenant.is_a?(Array) ? tenant.map(&:to_s) : tenant.to_s
-        Apartment.connection.schema_search_path = full_search_path
+        set_schema_search_path(full_search_path)
       rescue *rescuable_exceptions => e
         raise_schema_connect_to_new(tenant, e)
       end
 
       private
 
+      # Force a fresh +SET search_path+ even when ActiveRecord's
+      # +@schema_search_path+ cache still matches +value+. Rails 8.1 added a
+      # memoization early-return to PostgreSQLAdapter#schema_search_path= (see
+      # rails/rails#54698), which makes the assignment a no-op when the ivar
+      # is unchanged. After a transactional ROLLBACK or a connection reconnect
+      # the ivar can hold a stale value while the actual session search_path
+      # has reverted, so we must invalidate the ivar before reassigning.
+      # This is a cache-invalidating wrapper, not a plain writer.
+      #
+      # Maintenance note: this couples us to Rails' private
+      # +@schema_search_path+ ivar. Watch rails/rails#54698 for an upstream
+      # fix or a public invalidation API -- once one ships, this workaround
+      # should be dropped in favor of the public path. If a future Rails
+      # release renames or removes the ivar, this helper degrades silently
+      # back to the memoization no-op; the regression specs under
+      # +describe '#switch!'+ and +describe '#reset'+ in
+      # +spec/examples/schema_adapter_examples.rb+ are the canary.
+      def set_schema_search_path(value) # rubocop:disable Naming/AccessorMethodName
+        Apartment.connection.instance_variable_set(:@schema_search_path, nil)
+        Apartment.connection.schema_search_path = value
+      end
+
       def tenant_exists?(tenant)
         return true unless Apartment.tenant_presence_check
 

data/lib/apartment/migrator.rb

@@ -8,37 +8,47 @@ module Apartment
 
     # Migrate to latest
     def migrate(database)
-      Tenant.switch(database) do
-        version = ENV['VERSION']&.to_i
+      # Pin a connection for the entire migration to ensure Tenant.switch
+      # sets search_path on the same connection used by migration_context.
+      # Without this, connection pool may return different connections
+      # for the switch vs the actual migration operations.
+      ActiveRecord::Base.connection_pool.with_connection do
+        Tenant.switch(database) do
+          version = ENV['VERSION']&.to_i
 
-        migration_scope_block = ->(migration) { ENV['SCOPE'].blank? || (ENV['SCOPE'] == migration.scope) }
+          migration_scope_block = ->(migration) { ENV['SCOPE'].blank? || (ENV['SCOPE'] == migration.scope) }
 
-        if ActiveRecord.version >= Gem::Version.new('7.2.0')
-          ActiveRecord::Base.connection_pool.migration_context.migrate(version, &migration_scope_block)
-        else
-          ActiveRecord::Base.connection.migration_context.migrate(version, &migration_scope_block)
+          if ActiveRecord.version >= Gem::Version.new('7.2.0')
+            ActiveRecord::Base.connection_pool.migration_context.migrate(version, &migration_scope_block)
+          else
+            ActiveRecord::Base.connection.migration_context.migrate(version, &migration_scope_block)
+          end
         end
       end
     end
 
     # Migrate up/down to a specific version
     def run(direction, database, version)
-      Tenant.switch(database) do
-        if ActiveRecord.version >= Gem::Version.new('7.2.0')
-          ActiveRecord::Base.connection_pool.migration_context.run(direction, version)
-        else
-          ActiveRecord::Base.connection.migration_context.run(direction, version)
+      ActiveRecord::Base.connection_pool.with_connection do
+        Tenant.switch(database) do
+          if ActiveRecord.version >= Gem::Version.new('7.2.0')
+            ActiveRecord::Base.connection_pool.migration_context.run(direction, version)
+          else
+            ActiveRecord::Base.connection.migration_context.run(direction, version)
+          end
         end
       end
     end
 
     # rollback latest migration `step` number of times
     def rollback(database, step = 1)
-      Tenant.switch(database) do
-        if ActiveRecord.version >= Gem::Version.new('7.2.0')
-          ActiveRecord::Base.connection_pool.migration_context.rollback(step)
-        else
-          ActiveRecord::Base.connection.migration_context.rollback(step)
+      ActiveRecord::Base.connection_pool.with_connection do
+        Tenant.switch(database) do
+          if ActiveRecord.version >= Gem::Version.new('7.2.0')
+            ActiveRecord::Base.connection_pool.migration_context.rollback(step)
+          else
+            ActiveRecord::Base.connection.migration_context.rollback(step)
+          end
         end
       end
     end

data/lib/apartment/tasks/enhancements.rb

@@ -2,12 +2,26 @@
 
 # Require this file to append Apartment rake tasks to ActiveRecord db rake tasks
 # Enabled by default in the initializer
+#
+# ## Multi-Database Support (Rails 7+)
+#
+# When a Rails app has multiple databases configured in database.yml, Rails creates
+# namespaced rake tasks like `db:migrate:primary`, `db:rollback:primary`, etc.
+# This enhancer automatically detects databases with `database_tasks: true` and
+# enhances their namespaced tasks to also run the corresponding apartment task.
+#
+# Example: Running `rails db:rollback:primary` will also invoke `apartment:rollback`
+# to rollback all tenant schemas.
 
 module Apartment
   class RakeTaskEnhancer
     module TASKS
       ENHANCE_BEFORE = %w[db:drop].freeze
       ENHANCE_AFTER  = %w[db:migrate db:rollback db:migrate:up db:migrate:down db:migrate:redo db:seed].freeze
+
+      # Base tasks that have namespaced variants in multi-database setups
+      # db:seed is excluded because Rails doesn't create db:seed:primary
+      NAMESPACED_AFTER = %w[db:migrate db:rollback db:migrate:up db:migrate:down db:migrate:redo].freeze
       freeze
     end
 
@@ -18,36 +32,89 @@ module Apartment
       def enhance!
         return unless should_enhance?
 
-        # insert task before
+        enhance_base_tasks!
+        enhance_namespaced_tasks!
+      end
+
+      def should_enhance?
+        Apartment.db_migrate_tenants
+      end
+
+      private
+
+      # Enhance standard db:* tasks (backward compatible behavior)
+      def enhance_base_tasks!
         TASKS::ENHANCE_BEFORE.each do |name|
-          task = Rake::Task[name]
-          enhance_before_task(task)
+          enhance_task_before(name)
         end
 
-        # insert task after
         TASKS::ENHANCE_AFTER.each do |name|
-          task = Rake::Task[name]
-          enhance_after_task(task)
+          enhance_task_after(name)
         end
       end
 
-      def should_enhance?
-        Apartment.db_migrate_tenants
+      # Enhance namespaced db:*:database_name tasks for multi-database setups
+      # Maps namespaced tasks to base apartment tasks:
+      #   db:migrate:primary    -> apartment:migrate
+      #   db:rollback:primary   -> apartment:rollback
+      #   db:migrate:up:primary -> apartment:migrate:up
+      def enhance_namespaced_tasks!
+        database_names_with_tasks.each do |db_name|
+          TASKS::NAMESPACED_AFTER.each do |base_task|
+            namespaced_task = "#{base_task}:#{db_name}"
+            next unless task_defined?(namespaced_task)
+
+            apartment_task = base_task.sub('db:', 'apartment:')
+            enhance_namespaced_task_after(namespaced_task, apartment_task)
+          end
+        end
       end
 
-      def enhance_before_task(task)
+      def enhance_task_before(name)
+        return unless task_defined?(name)
+
+        task = Rake::Task[name]
         task.enhance([inserted_task_name(task)])
       end
 
-      def enhance_after_task(task)
+      def enhance_task_after(name)
+        return unless task_defined?(name)
+
+        task = Rake::Task[name]
         task.enhance do
           Rake::Task[inserted_task_name(task)].invoke
         end
       end
 
+      def enhance_namespaced_task_after(namespaced_task_name, apartment_task_name)
+        Rake::Task[namespaced_task_name].enhance do
+          Rake::Task[apartment_task_name].invoke
+        end
+      end
+
       def inserted_task_name(task)
         task.name.sub('db:', 'apartment:')
       end
+
+      def task_defined?(name)
+        Rake::Task.task_defined?(name)
+      end
+
+      # Returns database names that have database_tasks enabled and are not replicas.
+      # These are the databases for which Rails creates namespaced rake tasks.
+      #
+      # @return [Array<String>] database names (e.g., ['primary', 'secondary'])
+      def database_names_with_tasks
+        return [] unless defined?(Rails) && Rails.respond_to?(:env)
+
+        configs = ActiveRecord::Base.configurations.configs_for(env_name: Rails.env)
+        configs
+          .select { |c| c.database_tasks? && !c.replica? }
+          .map(&:name)
+      rescue StandardError
+        # Fail gracefully if configurations unavailable (e.g., during early boot)
+        []
+      end
     end
   end
 end

data/lib/apartment/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Apartment
-  VERSION = '3.4.0'
+  VERSION = '3.4.2'
 end

data/lib/apartment.rb

@@ -164,17 +164,22 @@ module Apartment
   end
 
   # Exceptions
-  ApartmentError = Class.new(StandardError)
+  class ApartmentError < StandardError
+  end
 
   # Raised when apartment cannot find the adapter specified in <tt>config/database.yml</tt>
-  AdapterNotFound = Class.new(ApartmentError)
+  class AdapterNotFound < ApartmentError
+  end
 
   # Raised when apartment cannot find the file to be loaded
-  FileNotFound = Class.new(ApartmentError)
+  class FileNotFound < ApartmentError
+  end
 
   # Tenant specified is unknown
-  TenantNotFound = Class.new(ApartmentError)
+  class TenantNotFound < ApartmentError
+  end
 
   # The Tenant attempting to be created already exists
-  TenantExists = Class.new(ApartmentError)
+  class TenantExists < ApartmentError
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ros-apartment
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.4.2
 platform: ruby
 authors:
 - Ryan Brunner
@@ -129,7 +129,9 @@ files:
 - Gemfile
 - Guardfile
 - README.md
+- RELEASING.md
 - Rakefile
+- context7.json
 - docs/adapters.md
 - docs/architecture.md
 - docs/elevators.md