mysql_framework 2.0.1 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3694d868584973bdad19a924b7b50961e2c5fcca8ea45e7222605b5145152c24
-  data.tar.gz: d92fe8d7004501fab5e05cd0277f04287bafd3a2352439a1ec4fa5d2cedefe10
+  metadata.gz: 87c4479177595f0b81fd81122c23473b63416ecf3a6427620c3cef4ba25d3e58
+  data.tar.gz: c668c3276dfe1120f7be7f8d30238bd1b8123c5559221ec175a1d3d844cc8e80
 SHA512:
-  metadata.gz: a7c05de40f9bcecbbef52444d78a3d07cde007aa7122da4eebc94d411deee65e9805c42bf2f4ead59150668346108348eca7cb04e264aa36882e925a20bd8c60
-  data.tar.gz: abbc47dbbd4a95b3c3e1956089308b7e4f052185698cd36e00d0f887594e17e5491a5ee28e00988cabc24831b76e8a1c5e2ccc2d4fd0dc7517a4ac1bb8bf2598
+  metadata.gz: fc44ac34b35b2c615ce87b8a1a627edc5d9f97c50f14ba3da1cae08e4089b0dcea405c495e48efbba95c852f2418334b3e1c32d029ae3fc4ec09f5d4028cf68d
+  data.tar.gz: 2eba7935da06a55d525b96126655f6a30415a62cf31225f184a0a305571f4e2f83a292a7214c446b63c01cbdd005b652bf30a2796bcb2e24f8644e8a8182830c

data/lib/mysql_framework/connector.rb

@@ -4,6 +4,7 @@ module MysqlFramework
   class Connector
     def initialize(options = {})
       @options = default_options.merge(options)
+      @mutex = Mutex.new
 
       Mysql2::Client.default_query_options.merge!(symbolize_keys: true, cast_booleans: true)
     end
@@ -25,7 +26,7 @@ module MysqlFramework
 
       until @connection_pool.empty?
         conn = @connection_pool.pop(true)
-        conn.close
+        conn&.close
       end
 
       @connection_pool = nil
@@ -38,32 +39,37 @@ module MysqlFramework
 
     # This method is called to fetch a client from the connection pool.
     def check_out
-      return new_client unless connection_pool_enabled?
+      @mutex.synchronize do
+        begin
+          return new_client unless connection_pool_enabled?
 
-      client = @connection_pool.pop(true)
+          client = @connection_pool.pop(true)
 
-      client.ping if @options[:reconnect]
+          client.ping if @options[:reconnect]
 
-      client
-    rescue ThreadError
-      if @created_connections < max_pool_size
-        client = new_client
-        @created_connections += 1
-        return client
-      end
+          client
+        rescue ThreadError
+          if @created_connections < max_pool_size
+            client = new_client
+            @created_connections += 1
+            return client
+          end
 
-      MysqlFramework.logger.error { "[#{self.class}] - Database connection pool depleted." }
+          MysqlFramework.logger.error { "[#{self.class}] - Database connection pool depleted." }
 
-      raise 'Database connection pool depleted.'
+          raise 'Database connection pool depleted.'
+        end
+      end
     end
 
     # This method is called to check a client back in to the connection when no longer needed.
     def check_in(client)
-      return client.close unless connection_pool_enabled?
+      @mutex.synchronize do
+        return client&.close unless connection_pool_enabled?
 
-      client = new_client if client.closed?
-
-      @connection_pool.push(client)
+        client = new_client if client&.closed?
+        @connection_pool.push(client)
+      end
     end
 
     # This method is called to use a client from the connection pool.
@@ -75,10 +81,20 @@ module MysqlFramework
     end
 
     # This method is called to execute a prepared statement
+    #
+    # @note Ensure we free any result and close each statement, otherwise we
+    # can run into a 'Commands out of sync' error if multiple threads are
+    # running different queries at the same time.
     def execute(query, provided_client = nil)
       with_client(provided_client) do |client|
-        statement = client.prepare(query.sql)
-        statement.execute(*query.params)
+        begin
+          statement = client.prepare(query.sql)
+          result = statement.execute(*query.params)
+          result&.to_a
+        ensure
+          result&.free
+          statement&.close
+        end
       end
     end
 

data/lib/mysql_framework/sql_condition.rb

@@ -50,7 +50,12 @@ module MysqlFramework
     end
 
     def invalid_nil_value?(value)
+      return false if skip_nil_validation?
       nil_comparison? == false && value.nil?
     end
+
+    def skip_nil_validation?
+      ENV.fetch('MYSQL_FRAMEWORK_SKIP_NIL_VALUE_VALIDATION', 'false').downcase == 'true'
+    end
   end
 end

data/lib/mysql_framework/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MysqlFramework
-  VERSION = '2.0.1'
+  VERSION = '2.1.4'
 end

data/spec/lib/mysql_framework/connector_spec.rb

@@ -118,6 +118,12 @@ describe MysqlFramework::Connector do
   end
 
   describe '#check_out' do
+    it 'calls synchronize on the mutex' do
+      expect(subject.instance_variable_get(:@mutex)).to receive(:synchronize)
+
+      subject.check_out
+    end
+
     context 'when connection pooling is enabled' do
       context 'when there are available connections' do
         before do
@@ -203,6 +209,12 @@ describe MysqlFramework::Connector do
   end
 
   describe '#check_in' do
+    it 'calls synchronize on the mutex' do
+      expect(subject.instance_variable_get(:@mutex)).to receive(:synchronize)
+
+      subject.check_out
+    end
+
     context 'when connection pooling is enabled' do
       it 'returns the provided client to the connection pool' do
         expect(subject.connections).to receive(:push).with(client)
@@ -232,6 +244,24 @@ describe MysqlFramework::Connector do
         subject.check_in(client)
       end
     end
+
+    context 'when client is nil' do
+      let(:client) { nil }
+
+      context 'when connection pooling is enabled' do
+        it 'does not raise an error' do
+          expect { subject.check_in(client) }.not_to raise_error
+        end
+      end
+
+      context 'when connection pooling is disabled' do
+        let(:connection_pooling_enabled) { 'false' }
+
+        it 'does not raise an error' do
+          expect { subject.check_in(client) }.not_to raise_error
+        end
+      end
+    end
   end
 
   describe '#with_client' do
@@ -272,6 +302,62 @@ describe MysqlFramework::Connector do
       expect(results.length).to eq(1)
       expect(results[0][:id]).to eq(guid)
     end
+
+    context 'when cleaning up resources' do
+      let(:mock_client) { double('client') }
+      let(:mock_statement) { double('statement') }
+      let(:mock_result) { double('result') }
+      let(:select_query) { MysqlFramework::SqlQuery.new.select('*').from('demo') }
+
+      before do
+        allow(mock_result).to receive(:to_a)
+        allow(mock_result).to receive(:free)
+
+        allow(mock_statement).to receive(:close)
+        allow(mock_statement).to receive(:execute).and_return(mock_result)
+
+        allow(mock_client).to receive(:prepare).and_return(mock_statement)
+      end
+
+      it 'frees the result' do
+        expect(mock_result).to receive(:free)
+
+        subject.execute(select_query, mock_client)
+      end
+
+      it 'closes the statement' do
+        expect(mock_statement).to receive(:close)
+
+        subject.execute(select_query, mock_client)
+      end
+    end
+
+    it 'does not raise a commands out of sync error' do
+      threads = []
+      threads << Thread.new do
+        350.times do
+          update_query = MysqlFramework::SqlQuery.new.update('gems')
+                                                 .set(updated_at: Time.now)
+          expect { subject.execute(update_query) }.not_to raise_error
+        end
+      end
+
+      threads << Thread.new do
+        350.times do
+          select_query = MysqlFramework::SqlQuery.new.select('*').from('demo')
+          expect { subject.execute(select_query) }.not_to raise_error
+        end
+      end
+
+      threads << Thread.new do
+        350.times do
+          select_query = MysqlFramework::SqlQuery.new.select('*').from('test')
+          expect { subject.execute(select_query) }.not_to raise_error
+        end
+      end
+
+      threads.each(&:join)
+    end
   end
 
   describe '#query' do

data/spec/lib/mysql_framework/sql_condition_spec.rb

@@ -3,6 +3,12 @@
 describe MysqlFramework::SqlCondition do
   subject { described_class.new(column: 'version', comparison: '=', value: '1.0.0') }
 
+  before :each do
+    allow_any_instance_of(MysqlFramework::SqlCondition).to receive(:skip_nil_validation?).and_return(skip_nil_validation)
+  end
+
+  let(:skip_nil_validation) { false }
+
   describe '#to_s' do
     it 'returns the condition as a string for a prepared statement' do
       expect(subject.to_s).to eq('version = ?')
@@ -16,6 +22,14 @@ describe MysqlFramework::SqlCondition do
       it 'does raises an ArgumentError' do
         expect { subject }.to raise_error(ArgumentError, "Comparison of = requires value to be not nil")
       end
+
+      context 'when skip_nil_validation? is true' do
+        let(:skip_nil_validation) { true }
+
+        it 'does not raise an ArgumentError' do
+          expect(subject.value).to be_nil
+        end
+      end
     end
   end
 
@@ -33,6 +47,14 @@ describe MysqlFramework::SqlCondition do
         it 'raises an ArgumentError if value is set' do
           expect { subject }.to raise_error(ArgumentError, 'Cannot set value when comparison is IS NULL')
         end
+
+        context 'when skip_nil_validation? is true' do
+          let(:skip_nil_validation) { true }
+
+          it 'raises an ArgumentError if value is set' do
+            expect { subject }.to raise_error(ArgumentError, 'Cannot set value when comparison is IS NULL')
+          end
+        end
       end
     end
 
@@ -67,6 +89,14 @@ describe MysqlFramework::SqlCondition do
         it 'raises an ArgumentError if value is set' do
           expect { subject }.to raise_error(ArgumentError, 'Cannot set value when comparison is IS NOT NULL')
         end
+
+        context 'when skip_nil_validation? is true' do
+          let(:skip_nil_validation) { true }
+
+          it 'raises an ArgumentError if value is set' do
+            expect { subject }.to raise_error(ArgumentError, 'Cannot set value when comparison is IS NOT NULL')
+          end
+        end
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysql_framework
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.4
 platform: ruby
 authors:
 - Sage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -137,8 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: A lightweight framework to provide managers for working with MySQL.