lhm-shopify 3.5.1 → 3.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b5fbf9905c14cd938075e3f6b930de0b52cdbc7c048f8ed572c654824681d99
-  data.tar.gz: c950dd9650c4e04412a91a9d21b6bbff3b3f092ecbbce1474a77518716737d62
+  metadata.gz: 1ad526041b49fe42d906fc27a697c3d0982332a7f256f40c179071e954a33d37
+  data.tar.gz: 35647043caa59111fd09770a38f160e959baa2022d73d82e1061777423fdc6bb
 SHA512:
-  metadata.gz: e92c7cc7cefa85e18a9c5b3d17966574324c8fe8e067f4ac4203241d18e8dae836c82554f92685e90978af26451422852c654fed8f0b855032dee0ac3d0f130d
-  data.tar.gz: 8755a2814d7d92d015d35ae3636993e39a66b5d27d1980a002eec96a2e33012350310d5f903b5f3b225d6b4bf60295841ee4e35919b927914a0cc700683d357b
+  metadata.gz: efce8e7d38b5f5e9769675e423e73d784837b8493d70f11e349041e9356a28078216784b670e246f4adffe8bd594a885ef86148a8da01c0356392219f8e94a40
+  data.tar.gz: 4bb36dd1c70a509dcbf3802c2ed2a9ad788253fdb7414e0c7bb3838fe8f68156a2782a3377f3ec1da472e50a463e6d6577330119f41b726c94499f8a7d2a40bf

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 3.5.2 (Dec, 2021)
+* Fixed error on undefined connection, when calling `Lhm.connection` without calling `Lhm.setup` first
+* Changed `Lhm.connection.connection` to `lhm.connection.ar_connection` for increased clarity and readability
+
+# 3.5.1 (Dec , 2021)
+* Add better logging to the LHM components (https://github.com/Shopify/lhm/pull/112)
+* Slave lag throttler now supports ActiveRecord > 6.0
+* [Dev] Add `Appraisals` to test against multiple version
+
+# 3.5.0 (Dec , 2021)
+* Duplicate of 3.4.2 (unfortunate mistake)
+
+# 3.4.2 (Sept, 2021)
+* Fixed Chunker's undefined name error (https://github.com/Shopify/lhm/pull/110)
+
 # 3.4.1 (Sep 22, 2021)
 
 * Add better logging to the LHM components (https://github.com/Shopify/lhm/pull/108)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lhm-shopify (3.5.1)
+    lhm-shopify (3.5.2)
       retriable (>= 3.0.0)
 
 GEM

data/Rakefile

@@ -23,7 +23,6 @@ Rake::TestTask.new('dev') do |t|
   t.libs << 'spec'
   t.test_files = FileList[
     'spec/test_helper.rb',
-    'spec/integration/lhm_spec.rb'
   #  Add file to test individually
   ]
   t.verbose = true

data/gemfiles/activerecord_5.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    lhm-shopify (3.5.1)
+    lhm-shopify (3.5.2)
       retriable (>= 3.0.0)
 
 GEM

data/gemfiles/activerecord_6.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    lhm-shopify (3.5.1)
+    lhm-shopify (3.5.2)
       retriable (>= 3.0.0)
 
 GEM

data/gemfiles/activerecord_6.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    lhm-shopify (3.5.1)
+    lhm-shopify (3.5.2)
       retriable (>= 3.0.0)
 
 GEM

data/gemfiles/activerecord_7.0.0.alpha2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    lhm-shopify (3.5.1)
+    lhm-shopify (3.5.2)
       retriable (>= 3.0.0)
 
 GEM

data/lib/lhm/chunk_insert.rb

@@ -3,12 +3,12 @@ require 'lhm/proxysql_helper'
 
 module Lhm
   class ChunkInsert
-    def initialize(migration, connection, lowest, highest, options = {})
+    def initialize(migration, connection, lowest, highest, retry_options = {})
       @migration = migration
       @connection = connection
       @lowest = lowest
       @highest = highest
-      @retry_options = options[:retriable] || {}
+      @retry_options = retry_options
     end
 
     def insert_and_return_count_of_rows_created

data/lib/lhm/chunker.rb

@@ -31,7 +31,7 @@ module Lhm
       @retry_options = options[:retriable] || {}
       @retry_helper = SqlRetry.new(
         @connection,
-        options: {
+        retry_options: {
           log_prefix: "Chunker"
         }.merge!(@retry_options)
       )

data/lib/lhm/connection.rb

@@ -2,19 +2,15 @@ require 'delegate'
 require 'lhm/sql_retry'
 
 module Lhm
-  class Connection < SimpleDelegator
-
     # Lhm::Connection inherits from SingleDelegator. It will forward any unknown method calls to the ActiveRecord
     # connection.
-    alias connection __getobj__
-    alias connection= __setobj__
+  class Connection < SimpleDelegator
 
-    def initialize(connection:, default_log_prefix: nil, options: {}, retry_config: {})
+    def initialize(connection:, default_log_prefix: nil, options: {})
       @default_log_prefix = default_log_prefix
-      @retry_options = retry_config || default_retry_config
       @sql_retry = Lhm::SqlRetry.new(
         connection,
-        options: retry_config,
+        retry_options: options[:retriable] || {},
         reconnect_with_consistent_host: options[:reconnect_with_consistent_host] || false
       )
 
@@ -22,7 +18,20 @@ module Lhm
       super(connection)
     end
 
-    def options=(options)
+    def ar_connection
+      # Get object from the simple delegator
+      __getobj__
+    end
+
+    def ar_connection=(connection)
+      raise Lhm::Error.new("Lhm::Connection requires an active record connection to operate") if connection.nil?
+
+      @sql_retry.connection = connection
+      # Sets connection as the delegated object
+      __setobj__(connection)
+    end
+
+    def process_connection_options(options)
       # If any other flags are added. Add the "processing" here
       @sql_retry.reconnect_with_consistent_host = options[:reconnect_with_consistent_host] || false
     end
@@ -70,7 +79,7 @@ module Lhm
     private
 
     def exec(method, sql)
-      connection.public_send(method, Lhm::ProxySQLHelper.tagged(sql))
+      ar_connection.public_send(method, Lhm::ProxySQLHelper.tagged(sql))
     end
 
     def exec_with_retries(method, sql, retry_options = {})

data/lib/lhm/sql_retry.rb

@@ -28,10 +28,10 @@ module Lhm
     # This internal error is used to trigger retries from the parent Retriable.retriable in #with_retries
     class ReconnectToHostSuccessful < Lhm::Error; end
 
-    def initialize(connection, options: {}, reconnect_with_consistent_host: true)
+    def initialize(connection, retry_options: {}, reconnect_with_consistent_host: false)
       @connection = connection
-      @log_prefix = options.delete(:log_prefix)
-      @global_retry_config = default_retry_config.dup.merge!(options)
+      @log_prefix = retry_options.delete(:log_prefix)
+      @global_retry_config = default_retry_config.dup.merge!(retry_options)
       if (@reconnect_with_consistent_host = reconnect_with_consistent_host)
         @initial_hostname = hostname
         @initial_server_id = server_id
@@ -63,7 +63,7 @@ module Lhm
     end
 
     attr_reader :global_retry_config
-    attr_accessor :reconnect_with_consistent_host
+    attr_accessor :connection, :reconnect_with_consistent_host
 
     private
 

data/lib/lhm/version.rb

@@ -2,5 +2,5 @@
 # Schmidt
 
 module Lhm
-  VERSION = '3.5.1'
+  VERSION = '3.5.2'
 end

data/lib/lhm.rb

@@ -28,7 +28,7 @@ module Lhm
   extend Throttler
   extend self
 
-  DEFAULT_LOGGER_OPTIONS =  { level: Logger::INFO, file: STDOUT }
+  DEFAULT_LOGGER_OPTIONS = { level: Logger::INFO, file: STDOUT }
 
   # Alters a table with the changes described in the block
   #
@@ -99,12 +99,13 @@ module Lhm
   # @option connection_options [Boolean] :reconnect_with_consistent_host
   #   Active / Deactivate ProxySQL-aware reconnection procedure (default to: false)
   def connection(connection_options = nil)
-    if @@connection.nil?
+    @@connection ||= begin
       raise 'Please call Lhm.setup' unless defined?(ActiveRecord)
       @@connection = Connection.new(connection: ActiveRecord::Base.connection, options: connection_options || {})
-    else
-      @@connection.options = connection_options unless connection_options.nil?
     end
+
+    @@connection.process_connection_options(connection_options) unless connection_options.nil?
+
     @@connection
   end
 

data/spec/integration/sql_retry/lock_wait_spec.rb

@@ -55,7 +55,7 @@ describe Lhm::SqlRetry do
   it "successfully executes the SQL despite the errors encountered" do
     # Start a thread to retry, once the lock is held, execute the block
     @helper.with_waiting_lock do |waiting_connection|
-      sql_retry = Lhm::SqlRetry.new(waiting_connection, options: {
+      sql_retry = Lhm::SqlRetry.new(waiting_connection, retry_options: {
         base_interval: 0.2, # first retry after 200ms
         multiplier: 1, # subsequent retries wait 1x longer than first retry (no change)
         tries: 3, # we only need 3 tries (including the first) for the scenario described below
@@ -98,7 +98,7 @@ describe Lhm::SqlRetry do
     puts "*" * 64
     # Start a thread to retry, once the lock is held, execute the block
     @helper.with_waiting_lock do |waiting_connection|
-      sql_retry = Lhm::SqlRetry.new(waiting_connection, options: {
+      sql_retry = Lhm::SqlRetry.new(waiting_connection, retry_options: {
         base_interval: 0.2, # first retry after 200ms
         multiplier: 1, # subsequent retries wait 1x longer than first retry (no change)
         tries: 2, # we need 3 tries (including the first) for the scenario described below, but we only get two...we will fail

data/spec/integration/sql_retry/retry_with_proxysql_spec.rb

@@ -18,7 +18,7 @@ describe Lhm::SqlRetry, "ProxiSQL tests for LHM retry" do
 
     @connection = DBConnectionHelper::new_mysql_connection(:proxysql, true, true)
 
-    @lhm_retry = Lhm::SqlRetry.new(@connection, options: {},
+    @lhm_retry = Lhm::SqlRetry.new(@connection, retry_options: {},
                                    reconnect_with_consistent_host: true)
   end
 
@@ -63,7 +63,7 @@ describe Lhm::SqlRetry, "ProxiSQL tests for LHM retry" do
     Lhm::SqlRetry.any_instance.stubs(:hostname).returns("mysql-1").then.returns("mysql-2")
 
     # Need new instance for stub to take into effect
-    lhm_retry = Lhm::SqlRetry.new(@connection, options: {},
+    lhm_retry = Lhm::SqlRetry.new(@connection, retry_options: {},
                                   reconnect_with_consistent_host: true)
 
     e = assert_raises Lhm::Error do

data/spec/unit/lhm_spec.rb

@@ -26,4 +26,21 @@ describe Lhm do
       value(Lhm.logger.instance_eval { @logdev }.dev.path).must_equal 'omg.ponies'
     end
   end
+
+  describe 'api' do
+
+    before(:each) do
+      @connection = mock()
+    end
+
+    it 'should create a new connection when calling setup' do
+      Lhm.setup(@connection)
+      value(Lhm.connection).must_be_kind_of(Lhm::Connection)
+    end
+
+    it 'should create a new connection when none is created' do
+      ActiveRecord::Base.stubs(:connection).returns(@connection)
+      value(Lhm.connection).must_be_kind_of(Lhm::Connection)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lhm-shopify
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.5.2
 platform: ruby
 authors:
 - SoundCloud
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: retriable