switchman 3.3.7 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07ef0eeff511916fa7913f453f2b3cde7d5317dfee9e03b58cf3645b2830c845
-  data.tar.gz: 2c2c12374387e6856674f14cf965087a0d27c1ccdacc6470b69aec0eb77af22f
+  metadata.gz: e080637567925bab42e7d6c87a2963486b16fb5a09eab87ef61fd8056d773ddf
+  data.tar.gz: 2694d7353b3cb7df6976aa812897540f1a9fc2188c5a6d2cc15bebfbbabb1371
 SHA512:
-  metadata.gz: d62c36fe017fbf801312eb13295e19fbb66c5e9b2aa23996400c3654acca130525580728602328377f4b601d5a9ba09847ef6082948f29af7d1217d7471ffa70
-  data.tar.gz: b6afb2bd1e0f69d93dd7b1e7a739cd7a1b6896eee43be063f8452d102de21991f8ab49da3fecc65859e24d66dd54e19f49c6352e22a50dcbd1add00518f154c0
+  metadata.gz: b3318e8323ebda712ad41873279793ddd5b0d5849a536c9f2dc0fcd3addefb35ff4d364882f27eb59d0c8e27e7c5d79e5c5edc6de66a73024746f79fed23170f
+  data.tar.gz: a2d2a1b1682febaffe2856dbdee8eca77241d5781e60fe037677f39c5c77b30d4d4ec5d6b0ff5e8c6cdd947fa79171fc99f0b19ffc3a5a77185bb400069ab537

data/lib/switchman/active_record/associations.rb

@@ -50,7 +50,7 @@ module Switchman
         def shard
           if @owner.class.sharded_column?(@reflection.foreign_key) &&
              (foreign_id = @owner[@reflection.foreign_key])
-            Shard.shard_for(foreign_id, @owner.shard)
+            Shard.shard_for(foreign_id, @owner.loaded_from_shard)
           else
             super
           end

data/lib/switchman/active_record/attribute_methods.rb

@@ -46,7 +46,6 @@ module Switchman
           raise if connection.open_transactions.positive?
         end
 
-        # rubocop:disable Naming/MethodParameterName
         def define_cached_method(owner, name, namespace:, as:, &block)
           if ::Rails.version < '7.0'
             yield owner
@@ -55,7 +54,6 @@ module Switchman
             owner.define_cached_method(name, namespace: namespace, as: as, &block)
           end
         end
-        # rubocop:enable Naming/MethodParameterName
 
         def define_method_global_attribute(attr_name, owner:)
           if sharded_column?(attr_name)
@@ -136,7 +134,7 @@ module Switchman
 
               abs_raw_value = raw_value.abs
               current_shard = ::Switchman::Shard.current(#{attr_connection_class})
-              same_shard = shard == current_shard
+              same_shard = loaded_from_shard == current_shard
               return raw_value if same_shard && abs_raw_value < ::Switchman::Shard::IDS_PER_SHARD
 
               value_shard_id = abs_raw_value / ::Switchman::Shard::IDS_PER_SHARD
@@ -144,9 +142,9 @@ module Switchman
               # of a local id
               return raw_value % ::Switchman::Shard::IDS_PER_SHARD if value_shard_id == current_shard.id
               return raw_value if !same_shard && abs_raw_value > ::Switchman::Shard::IDS_PER_SHARD
-              return shard.global_id_for(raw_value) if !same_shard && abs_raw_value < ::Switchman::Shard::IDS_PER_SHARD
+              return loaded_from_shard.global_id_for(raw_value) if !same_shard && abs_raw_value < ::Switchman::Shard::IDS_PER_SHARD
 
-              ::Switchman::Shard.relative_id_for(raw_value, shard, current_shard)
+              ::Switchman::Shard.relative_id_for(raw_value, loaded_from_shard, current_shard)
             end
           RUBY
         end
@@ -173,7 +171,7 @@ module Switchman
         def build_sharded_setter(attr_name, attr_field, attr_connection_class)
           <<-RUBY
             def #{attr_name}=(new_value)
-              self.original_#{attr_field} = ::Switchman::Shard.relative_id_for(new_value, ::Switchman::Shard.current(#{attr_connection_class}), shard)
+              self.original_#{attr_field} = ::Switchman::Shard.relative_id_for(new_value, ::Switchman::Shard.current(#{attr_connection_class}), loaded_from_shard)
             end
           RUBY
         end

data/lib/switchman/active_record/base.rb

@@ -142,6 +142,8 @@ module Switchman
                    else
                      Shard.current(self.class.connection_class_for_self)
                    end
+
+        @loaded_from_shard ||= Shard.current(self.class.connection_class_for_self)
         readonly! if shadow_record? && !Switchman.config[:writable_shadow_records]
         super
       end
@@ -169,27 +171,53 @@ module Switchman
         end
       end
 
+      def destroy_shadow_records(target_shards: [Shard.current])
+        raise Errors::ShadowRecordError, 'Cannot be called on a shadow record.' if shadow_record?
+        raise Errors::MethodUnsupportedForUnshardedTableError, 'Cannot be called on a record belonging to an unsharded table.' unless self.class.sharded_column?(self.class.primary_key)
+
+        Array(target_shards).each do |target_shard|
+          next if target_shard == shard
+
+          target_shard.activate { self.class.where('id = ?', global_id).delete_all }
+        end
+      end
+
+      # Returns "the shard that this record was actually loaded from" , as
+      # opposed to "the shard this record belongs on", which might be
+      # different if this is a shadow record.
+      def loaded_from_shard
+        @loaded_from_shard || fallback_shard
+      end
+
       def shard
-        @shard || Shard.current(self.class.connection_class_for_self) || Shard.default
+        @shard || fallback_shard
       end
 
       def shard=(new_shard)
         raise ::ActiveRecord::ReadOnlyRecord if !new_record? || @shard_set_in_stone
 
-        return if shard == new_shard
+        if shard == new_shard
+          @loaded_from_shard = new_shard
+          return
+        end
 
         attributes.each do |attr, value|
           self[attr] = Shard.relative_id_for(value, shard, new_shard) if self.class.sharded_column?(attr)
         end
+        @loaded_from_shard = new_shard
         @shard = new_shard
       end
 
       def save(*, **)
+        raise Errors::ManuallyCreatedShadowRecordError if creating_shadow_record?
+
         @shard_set_in_stone = true
         super
       end
 
       def save!(*, **)
+        raise Errors::ManuallyCreatedShadowRecordError if creating_shadow_record?
+
         @shard_set_in_stone = true
         super
       end
@@ -221,7 +249,7 @@ module Switchman
       end
 
       def hash
-        self.class.sharded_primary_key? ? self.class.hash ^ global_id.hash : super
+        self.class.sharded_primary_key? ? [self.class, global_id].hash : super
       end
 
       def to_param
@@ -270,6 +298,16 @@ module Switchman
           self.class.connection_class_for_self
         end
       end
+
+      private
+
+      def fallback_shard
+        Shard.current(self.class.connection_class_for_self) || Shard.default
+      end
+
+      def creating_shadow_record?
+        new_record? && shadow_record?
+      end
     end
   end
 end

data/lib/switchman/active_record/persistence.rb

@@ -16,6 +16,14 @@ module Switchman
         db = shard.database_server
         db.unguard { super }
       end
+
+      def reload(*)
+        res = super
+        # When a shadow record is reloaded the real record is returned. So
+        # we need to ensure the loaded_from_shard is set correctly after a reload.
+        @loaded_from_shard = @shard
+        res
+      end
     end
   end
 end

data/lib/switchman/active_record/relation.rb

@@ -4,7 +4,7 @@ module Switchman
   module ActiveRecord
     module Relation
       def self.prepended(klass)
-        klass::SINGLE_VALUE_METHODS.concat %i[shard shard_source]
+        klass::SINGLE_VALUE_METHODS.push(:shard, :shard_source)
       end
 
       def initialize(*, **)

data/lib/switchman/errors.rb

@@ -2,8 +2,18 @@
 
 module Switchman
   module Errors
+    class ManuallyCreatedShadowRecordError < RuntimeError
+      def initialize(msg = "It looks like you're trying to manually create a shadow record. Please use Switchman::ActiveRecord::Base#save_shadow_record instead.")
+        super
+      end
+    end
+
     class NonExistentShardError < RuntimeError; end
 
     class ParallelShardExecError < RuntimeError; end
+
+    class ShadowRecordError < RuntimeError; end
+
+    class UnshardedTableError < RuntimeError; end
   end
 end

data/lib/switchman/parallel.rb

@@ -65,4 +65,4 @@ module Switchman
   end
 end
 
-::Parallel::UndumpableException.prepend(::Switchman::Parallel::UndumpableException)
+Parallel::UndumpableException.prepend(Switchman::Parallel::UndumpableException)

data/lib/switchman/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Switchman
-  VERSION = '3.3.7'
+  VERSION = '3.4.1'
 end

data/lib/tasks/switchman.rake

@@ -3,9 +3,9 @@
 # In rails 7.0+ if you have only 1 db in the env it doesn't try to do explicit activation
 # (and for rails purposes we only have one db per env because each database server is a separate env)
 if Rails.version < '7.0'
-  task_prefix = ::Rake::Task.task_defined?('app:db:migrate') ? 'app:db' : 'db'
-  ::Rake::Task["#{task_prefix}:migrate"].clear_actions.enhance do
-    ::ActiveRecord::Tasks::DatabaseTasks.migrate
+  task_prefix = Rake::Task.task_defined?('app:db:migrate') ? 'app:db' : 'db'
+  Rake::Task["#{task_prefix}:migrate"].clear_actions.enhance do
+    ActiveRecord::Tasks::DatabaseTasks.migrate
     # Ensure this doesn't blow up when running inside the dummy app
     Rake::Task["#{task_prefix}:_dump"].invoke
   end
@@ -19,8 +19,8 @@ module Switchman
     end
 
     def self.scope(base_scope = Shard,
-                   database_server: ENV['DATABASE_SERVER'],
-                   shard: ENV['SHARD'])
+                   database_server: ENV.fetch('DATABASE_SERVER', nil),
+                   shard: ENV.fetch('SHARD', nil))
       servers = DatabaseServer.all
 
       if database_server

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: switchman
 version: !ruby/object:Gem::Version
-  version: 3.3.7
+  version: 3.4.1
 platform: ruby
 authors:
 - Cody Cutrer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2023-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -192,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement