global_uid 4.0.0.beta1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a02789fdd302a6dbc207c590c60ce5b5909f8430e3432813af90d0373efd71b
-  data.tar.gz: 4cf5cd96f7b8855b546a1741c67dac5db6bb9b42cca3105bbe741423a2f2e66e
+  metadata.gz: 98380377dabc356230fb10d765ea683777d64e89626597fd030c848f4e3e2048
+  data.tar.gz: c361fed08769004591c58f40ca4b79d67f6aec19e0e1f22d2bb357f9392edc55
 SHA512:
-  metadata.gz: 9e36b732bbea40d81423498b9ec9365e39688601691524b615a9b1cc0955b5dbcbf7b9788128bcb5673b08ccd37c49b44a7990d8a62f578358cd9ca8116d17fb
-  data.tar.gz: 73b1d6ff9808d94c14e1618b7da2137e0ad9c2b02442941b788519ebdc77daec7bfc8be67715ec16294062ea8ae334c1b437a198342f096623bd4f124585385c
+  metadata.gz: '0298584b7b7a01105723caffe1770b4c1a448798335f38a2de67cce712031d9232267f4fdefba1fc7e2d642ec624c750e5b6b24d5ea1c0e57639fc40af588015'
+  data.tar.gz: 7f69e85213c62c30b14679993fc86eedf58e737b31557812a3de53a607f246b755287ddf9ded039836069cf3ed41572acf341ed298bfba56f23c5ccc84d76f92

data/lib/global_uid.rb

@@ -23,6 +23,22 @@ module GlobalUid
     yield configuration if block_given?
   end
 
+  def self.disable!
+    self.configuration.disabled = true
+  end
+
+  def self.enable!
+    self.configuration.disabled = false
+  end
+
+  def self.enabled?
+    !self.disabled?
+  end
+
+  def self.disabled?
+    self.configuration.disabled
+  end
+
   # @private
   def self.reset_configuration
     @configuration = nil

data/lib/global_uid/active_record_extension.rb

@@ -8,7 +8,7 @@ module GlobalUid
     end
 
     def global_uid_before_create
-      return if GlobalUid.configuration.disabled?
+      return if GlobalUid.disabled?
       return if self.class.global_uid_disabled
 
       self.id = self.class.generate_uid
@@ -35,7 +35,7 @@ module GlobalUid
 
       def generate_many_uids(count)
         GlobalUid::Base.with_servers do |server|
-          return server.allocate(self, count: count)
+          return Array(server.allocate(self, count: count))
         end
       end
 
@@ -48,7 +48,7 @@ module GlobalUid
       end
 
       def global_uid_table
-        GlobalUid::Base.id_table_from_name(self.table_name)
+        @_global_uid_table ||= GlobalUid::Base.id_table_from_name(self.table_name)
       end
     end
   end

data/lib/global_uid/allocator.rb

@@ -1,26 +1,26 @@
 module GlobalUid
   class Allocator
-    attr_reader :recent_allocations, :max_window_size, :incrementing_by, :connection
+    attr_reader :recent_allocations, :max_window_size, :incrementing_by, :connection, :table_name
 
-    def initialize(incrementing_by:, connection:)
+    def initialize(incrementing_by:, connection:, table_name:)
       @recent_allocations = []
       @max_window_size = 5
       @incrementing_by = incrementing_by
       @connection = connection
-      validate_connection_increment
+      @table_name = table_name
     end
 
-    def allocate_one(table)
-      identifier = connection.insert("REPLACE INTO #{table} (stub) VALUES ('a')")
+    def allocate_one
+      identifier = connection.insert("REPLACE INTO #{table_name} (stub) VALUES ('a')")
       allocate(identifier)
     end
 
-    def allocate_many(table, count:)
+    def allocate_many(count:)
       return [] unless count > 0
 
-      increment_by = validate_connection_increment
+      increment_by = connection.select_value("SELECT @@auto_increment_increment")
 
-      start_id = connection.insert("REPLACE INTO #{table} (stub) VALUES " + (["('a')"] * count).join(','))
+      start_id = connection.insert("REPLACE INTO #{table_name} (stub) VALUES " + (["('a')"] * count).join(','))
       identifiers = start_id.step(start_id + (count - 1) * increment_by, increment_by).to_a
       identifiers.each { |identifier| allocate(identifier) }
       identifiers
@@ -34,8 +34,8 @@ module GlobalUid
 
       if !valid_allocation?
         db_increment = connection.select_value("SELECT @@auto_increment_increment")
-        message = "Configured: '#{incrementing_by}', Found: '#{db_increment}' on '#{connection.current_database}'. Recently allocated IDs: #{recent_allocations}"
-        alert(InvalidIncrementException.new(message))
+        message = "Configured: '#{incrementing_by}', Found: '#{db_increment}' on '#{connection.current_database}'. Recently allocated IDs: #{recent_allocations} using table '#{table_name}'"
+        GlobalUid::Base.alert(InvalidIncrementException.new(message))
       end
 
       identifier
@@ -47,23 +47,5 @@ module GlobalUid
           (identifier - recent_allocations[0]) % incrementing_by == 0
       end
     end
-
-    def validate_connection_increment
-      db_increment = connection.select_value("SELECT @@auto_increment_increment")
-
-      if db_increment != incrementing_by
-        alert(InvalidIncrementException.new("Configured: '#{incrementing_by}', Found: '#{db_increment}' on '#{connection.current_database}'"))
-      end
-
-      db_increment
-    end
-
-    def alert(exception)
-      if GlobalUid.configuration.suppress_increment_exceptions?
-        GlobalUid.configuration.notifier.call(exception)
-      else
-        raise exception
-      end
-    end
   end
 end

data/lib/global_uid/base.rb

@@ -68,5 +68,13 @@ module GlobalUid
     def self.id_table_from_name(name)
       "#{name}_ids".to_sym
     end
+
+    def self.alert(exception)
+      if GlobalUid.configuration.suppress_increment_exceptions?
+        GlobalUid.configuration.notifier.call(exception)
+      else
+        raise exception
+      end
+    end
   end
 end

data/lib/global_uid/configuration.rb

@@ -11,7 +11,6 @@ module GlobalUid
     attr_accessor :suppress_increment_exceptions
     attr_accessor :storage_engine
 
-    alias_method :disabled?, :disabled
     alias_method :connection_shuffling?, :connection_shuffling
     alias_method :suppress_increment_exceptions?, :suppress_increment_exceptions
 

data/lib/global_uid/migration_extension.rb

@@ -3,7 +3,7 @@ module GlobalUid
   module MigrationExtension
 
     def create_table(name, options = {}, &blk)
-      uid_enabled = !(GlobalUid.configuration.disabled? || options[:use_global_uid] == false)
+      uid_enabled = GlobalUid.enabled? && options[:use_global_uid] != false
 
       # rules for stripping out auto_increment -- enabled and not a "PK-less" table
       remove_auto_increment = uid_enabled && !(options[:id] == false)
@@ -20,9 +20,8 @@ module GlobalUid
         GlobalUid::Base.with_servers do |server|
           server.create_uid_table!(
             name: id_table_name,
-            uid_type: options[:uid_type] || "bigint(21) UNSIGNED",
-            start_id: options[:start_id] || 1,
-            storage_engine: GlobalUid.configuration.storage_engine
+            uid_type: options[:uid_type],
+            start_id: options[:start_id]
           )
         end
       end
@@ -30,7 +29,7 @@ module GlobalUid
     end
 
     def drop_table(name, options = {})
-      if !GlobalUid.configuration.disabled? && options[:use_global_uid] == true
+      if GlobalUid.enabled? && options[:use_global_uid] == true
         id_table_name = options[:global_uid_table] || GlobalUid::Base.id_table_from_name(name)
         GlobalUid::Base.with_servers do |server|
           server.drop_uid_table!(name: id_table_name)

data/lib/global_uid/server.rb

@@ -7,7 +7,7 @@ module GlobalUid
       @connection = nil
       @name = name
       @retry_at = nil
-      @allocator = nil
+      @allocators = {}
       @increment_by = increment_by
       @connection_retry = connection_retry
       @connection_timeout = connection_timeout
@@ -19,7 +19,7 @@ module GlobalUid
       @connection = mysql2_connection(name)
 
       begin
-        @allocator = Allocator.new(incrementing_by: increment_by, connection: @connection) if active?
+        validate_connection_increment if active?
       rescue InvalidIncrementException => e
         GlobalUid.configuration.notifier.call(e)
         disconnect!
@@ -42,16 +42,19 @@ module GlobalUid
 
     def disconnect!
       @connection = nil
-      @allocator = nil
+      @allocators = {}
     end
 
-    def create_uid_table!(name:, uid_type:, start_id:, storage_engine:)
+    def create_uid_table!(name:, uid_type: nil, start_id: nil)
+      uid_type ||= "bigint(21) UNSIGNED"
+      start_id ||= 1
+
       connection.execute("CREATE TABLE IF NOT EXISTS `#{name}` (
       `id` #{uid_type} NOT NULL AUTO_INCREMENT,
       `stub` char(1) NOT NULL DEFAULT '',
       PRIMARY KEY (`id`),
       UNIQUE KEY `stub` (`stub`)
-      ) ENGINE=#{storage_engine}")
+      ) ENGINE=#{GlobalUid.configuration.storage_engine}")
 
       # prime the pump on each server
       connection.execute("INSERT IGNORE INTO `#{name}` VALUES(#{start_id}, 'a')")
@@ -66,16 +69,21 @@ module GlobalUid
       #   Timeout.timeout is unpredictable
       Timeout.timeout(query_timeout, TimeoutException) do
         if count == 1
-          allocator.allocate_one(klass.global_uid_table)
+          allocator(klass).allocate_one
         else
-          allocator.allocate_many(klass.global_uid_table, count: count)
+          allocator(klass).allocate_many(count: count)
         end
       end
     end
 
     private
 
-    attr_accessor :connection_retry, :connection_timeout, :retry_at, :increment_by, :query_timeout, :allocator
+    attr_accessor :connection_retry, :connection_timeout, :retry_at, :increment_by, :query_timeout, :allocators
+
+    def allocator(klass)
+      table_name = klass.global_uid_table
+      @allocators[table_name] ||= Allocator.new(incrementing_by: increment_by, connection: connection, table_name: table_name)
+    end
 
     def retry_connection?
       return Time.now > retry_at if retry_at
@@ -85,11 +93,7 @@ module GlobalUid
     end
 
     def mysql2_connection(name)
-      raise "No id server '#{name}' configured in database.yml" unless ActiveRecord::Base.configurations.to_h.has_key?(name)
-      config = ActiveRecord::Base.configurations.to_h[name]
-      c = config.symbolize_keys
-
-      raise "No global_uid support for adapter #{c[:adapter]}" if c[:adapter] != 'mysql2'
+      config = mysql2_config(name)
 
       Timeout.timeout(connection_timeout, ConnectionTimeoutException) do
         ActiveRecord::Base.mysql2_connection(config)
@@ -102,5 +106,33 @@ module GlobalUid
       nil
     end
 
+    if ActiveRecord.version < Gem::Version.new('6.1.0')
+      def mysql2_config(name)
+        raise "No id server '#{name}' configured in database.yml" unless ActiveRecord::Base.configurations.to_h.has_key?(name)
+        config = ActiveRecord::Base.configurations.to_h[name]
+
+        c = config.symbolize_keys
+        raise "No global_uid support for adapter #{c[:adapter]}" if c[:adapter] != 'mysql2'
+
+        config
+      end
+    else
+      def mysql2_config(name)
+        config = ActiveRecord::Base.configurations.configs_for(env_name: name, name: 'primary')
+
+        raise "No id server '#{name}' configured in database.yml" if config.nil?
+        raise "No global_uid support for adapter #{config.adapter}" if config.adapter != 'mysql2'
+
+        config.configuration_hash
+      end
+    end
+
+    def validate_connection_increment
+      db_increment = connection.select_value("SELECT @@auto_increment_increment")
+
+      if db_increment != increment_by
+        GlobalUid::Base.alert(InvalidIncrementException.new("Configured: '#{increment_by}', Found: '#{db_increment}' on '#{connection.current_database}'"))
+      end
+    end
   end
 end

data/lib/global_uid/test_support.rb

@@ -0,0 +1,44 @@
+module GlobalUid
+  module TestSupport
+    # Tables should be created through the MigrationExtension but
+    # if you want to manually create and drop the '_id' tables,
+    # you can do so via this module
+    class << self
+      def create_uid_tables(tables: [], uid_type: nil, start_id: nil)
+        return if GlobalUid.disabled?
+
+        GlobalUid::Base.with_servers do |server|
+          tables.each do |table|
+            server.create_uid_table!(
+              name: GlobalUid::Base.id_table_from_name(table),
+              uid_type: uid_type,
+              start_id: start_id
+            )
+          end
+        end
+      end
+
+      def drop_uid_tables(tables: [])
+        return if GlobalUid.disabled?
+
+        GlobalUid::Base.with_servers do |server|
+          tables.each do |table|
+            server.drop_uid_table!(
+              name: GlobalUid::Base.id_table_from_name(table)
+            )
+          end
+        end
+      end
+
+      def recreate_uid_tables(tables: [], uid_type: nil, start_id: nil)
+        return if GlobalUid.disabled?
+
+        drop_uid_tables(tables: tables)
+        create_uid_tables(tables: tables, uid_type: nil, start_id: start_id)
+
+        # Reset the servers, clearing any allocations from memory
+        GlobalUid::Base.disconnect!
+      end
+    end
+  end
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: global_uid
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta1
+  version: 4.1.0
 platform: ruby
 authors:
 - Benjamin Quorning
 - Gabe Martin-Dempesy
 - Pierre Schambacher
 - Ben Osheroff
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -22,7 +22,7 @@ dependencies:
         version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -32,7 +32,7 @@ dependencies:
         version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -220,11 +220,12 @@ files:
 - lib/global_uid/migration_extension.rb
 - lib/global_uid/schema_dumper_extension.rb
 - lib/global_uid/server.rb
+- lib/global_uid/test_support.rb
 homepage: https://github.com/zendesk/global_uid
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -235,12 +236,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.2
+signing_key:
 specification_version: 4
 summary: GUID
 test_files: []