mysql_framework 2.0.0 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67610b6f4fad6d1ae4feca440f9952c02c92e56dc9add1f8ae65c5258cbb70e5
-  data.tar.gz: d27443bd3f0d37eecc86471f43a9a67047dea2a873b122851cb32b3f41062c47
+  metadata.gz: 38653f6e3d1d849566574e58eb8386b4c32890370404cb3eade583b0070f5041
+  data.tar.gz: 5534eca9f224d13580cfd09f4e2478208857e5b353c9a664ed7b772bf8a088e1
 SHA512:
-  metadata.gz: def004956a96d594de0afe4e6b2f6033d539b0affc5ba08e9a83813f46dd8f0beaa9d0e6e65d45bb985cbd931c5d33c39a0b093412850fb8e7acd33130418893
-  data.tar.gz: bb88d080d02dbf476de3f7c94ff4982b93fb92ac63aaf7a472944a13859de7bf01458e1cb8b6e9af6c2b38e2b49e277c610abaed4d078f6a43d9df01ba2f6517
+  metadata.gz: aa4e726ac90ac8b1ecd8ca20a64b4c33e81d003c395b49c340f712df500fc7879956f5479f9c23e53fe20ca947d41d2798ad42732c596a03ab219129f02a7dbd
+  data.tar.gz: ba2080bb5f7595b82996a48a0316ed70cf7560b5687abb9d5c9768c73f5e2b296e42378aa9139c80e2d5f705a8fa7bdb08167a740c019a6d5d0a0825436873e7

data/lib/mysql_framework/connector.rb

@@ -59,10 +59,9 @@ module MysqlFramework
 
     # 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?
-
-      client = new_client if client.closed?
+      return client&.close unless connection_pool_enabled?
 
+      client = new_client if client.nil? || client.closed?
       @connection_pool.push(client)
     end
 
@@ -75,10 +74,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/sql_query.rb

@@ -120,11 +120,14 @@ module MysqlFramework
     end
 
     # This method is called to specify a where clause for a query.
+    #
+    # Condition values are added to @params unless the value is nil.
     def where(*conditions)
       @sql += ' WHERE' unless @sql.include?('WHERE')
       @sql += " (#{conditions.join(' AND ')}) "
 
       conditions.each do |condition|
+        next if condition.value.nil?
         if condition.value.is_a?(Enumerable)
           @params.concat(condition.value)
         else

data/lib/mysql_framework/version.rb

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

data/spec/lib/mysql_framework/connector_spec.rb

@@ -232,6 +232,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 +290,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
 

data/spec/lib/mysql_framework/sql_query_spec.rb

@@ -50,6 +50,19 @@ describe MysqlFramework::SqlQuery do
       expect(subject.params).to eq(['9876'])
     end
 
+    context 'when a select query contains conditions with nil values' do
+      it 'does not store them as parameters' do
+        subject.select('*')
+          .from(gems, 40)
+          .where(
+            MysqlFramework::SqlCondition.new(column: 'id', comparison: '=', value: 9876),
+            MysqlFramework::SqlCondition.new(column: 'foo', comparison: 'IS NOT NULL'),
+          )
+        expect(subject.sql).to eq('SELECT * FROM `gems` PARTITION (p40) WHERE (id = ? AND foo IS NOT NULL)')
+        expect(subject.params.size).to eq 1
+      end
+    end
+
     it 'builds a joined select query as expected' do
       subject.select('*')
         .from(gems, 40)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysql_framework
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.3
 platform: ruby
 authors:
 - Sage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2021-03-11 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.