Update dependencies and improve connection pooling implementation

Author: PawelKlapec

.github/workflows/rspec.yml

@@ -19,10 +19,10 @@ jobs:
           - 6379:6379
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v6
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.4
+          ruby-version: 4.0
           bundler-cache: true
 
       - name: Run tests

Gemfile

@@ -8,4 +8,5 @@ end
 
 group :test do
   gem 'simplecov', require: false
+  gem 'debug', require: false
 end

docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   test-runner:
-    image: ruby:3.4
+    image: ruby:4.0
     working_dir: /usr/src/app
     container_name: test-runner
     command: sh -c "while true; do echo 'Container is running..'; sleep 5; done"

lib/mysql_framework/connector.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'connection_pool'
 require_relative 'mysql_connection_pool'
 
 module MysqlFramework

lib/mysql_framework/mysql_connection_pool.rb

@@ -122,8 +122,9 @@ def with_client(discard_current_pool_connection: false)
     private
 
     def start_clean_idle_connections_thread
+      thread_name = "#{CLEAN_IDLE_CONNECTIONS_THREAD_NAME}-#{object_id}"
       @idle_connections_thread = Thread.new do
-        Thread.current.name = CLEAN_IDLE_CONNECTIONS_THREAD_NAME
+        Thread.current.name = thread_name
         loop do
           sleep idle_reap_loop_time
           break unless Thread.current == @idle_connections_thread
@@ -132,7 +133,10 @@ def start_clean_idle_connections_thread
         end
       end
 
-      @idle_connections_thread.abort_on_exception = false
+      # require 'debug'
+      # debugger
+
+      @idle_connections_thread.abort_on_exception # = false
       @idle_connections_thread
     end
 

lib/mysql_framework/stats/aws_metric_publisher.rb

@@ -42,8 +42,9 @@ def initialize(
       def start
         return if running?
 
+        thread_name = "#{THREAD_NAME}-#{object_id}"
         thread = Thread.new do
-          Thread.current.name = THREAD_NAME
+          Thread.current.name = thread_name
           loop do
             sleep @publish_interval
             break unless Thread.current == @thread

spec/lib/mysql_framework/connector_spec.rb

@@ -33,12 +33,16 @@
 
   before do
     allow(ENV).to receive(:fetch).and_call_original
-    allow(ENV).to receive(:fetch).with('MYSQL_CONNECTION_POOL_ENABLED', 'true')
+    allow(ENV).to receive(:fetch).with('MYSQL_CONNECTION_POOL_ENABLED', 'false')
       .and_return(connection_pooling_enabled)
 
     subject.setup
   end
 
+  after do
+    subject.dispose
+  end
+
   describe '#initialize' do
     context 'when options are not provided' do
       it 'returns the default options' do
@@ -99,7 +103,7 @@
   describe '#dispose' do
     context 'when connection pooling is enabled' do
       it 'disposes of the pool and clears connector reference' do
-        pool = instance_double(MysqlFramework::MysqlConnectionPool)
+        pool = instance_double(MysqlFramework::MysqlConnectionPool, dispose: true)
         allow(pool).to receive(:dispose)
         subject.instance_variable_set(:@connection_pool, pool)
 
@@ -123,7 +127,7 @@
   describe '#check_out' do
     context 'when connection pooling is enabled' do
       it 'checks out pooled connection' do
-        pool = instance_double(MysqlFramework::MysqlConnectionPool)
+        pool = instance_double(MysqlFramework::MysqlConnectionPool, dispose: true)
         client = instance_double(Mysql2::Client)
         allow(pool).to receive(:check_out).and_return(client)
         subject.instance_variable_set(:@connection_pool, pool)
@@ -148,7 +152,7 @@
   describe '#check_in' do
     context 'when connection pooling is enabled' do
       it 'checks in a pooled connection' do
-        pool = instance_double(MysqlFramework::MysqlConnectionPool)
+        pool = instance_double(MysqlFramework::MysqlConnectionPool, dispose: true)
         allow(pool).to receive(:check_in)
         subject.instance_variable_set(:@connection_pool, pool)
 
@@ -208,23 +212,23 @@
 
       context 'when connection pooling is enabled' do
         it 'delegates to the connection pool' do
-          pool = instance_double(MysqlFramework::MysqlConnectionPool)
+          pool = instance_double(MysqlFramework::MysqlConnectionPool, dispose: true)
           subject.instance_variable_set(:@connection_pool, pool)
 
           expect(pool).to receive(:with_client).with(discard_current_pool_connection: false).and_yield(client)
           expect { |b| subject.with_client(&b) }.to yield_with_args(client)
         end
 
         it 'passes discard_current_pool_connection: true to the pool when requested' do
-          pool = instance_double(MysqlFramework::MysqlConnectionPool)
+          pool = instance_double(MysqlFramework::MysqlConnectionPool, dispose: true)
           subject.instance_variable_set(:@connection_pool, pool)
 
           expect(pool).to receive(:with_client).with(discard_current_pool_connection: true).and_yield(client)
           subject.with_client(discard_current_pool_connection: true) { |_c| nil }
         end
 
         it 'returns the block result' do
-          pool = instance_double(MysqlFramework::MysqlConnectionPool)
+          pool = instance_double(MysqlFramework::MysqlConnectionPool, dispose: true)
           subject.instance_variable_set(:@connection_pool, pool)
           allow(pool).to receive(:with_client).and_yield(client)
 

spec/lib/mysql_framework/mysql_connection_pool_spec.rb

@@ -56,12 +56,6 @@
       subject.setup
       expect(subject.connections).to equal(first_pool)
     end
-
-    it 'starts the idle connection cleaner thread' do
-      subject.setup
-      threads = Thread.list.map(&:name)
-      expect(threads).to include(MysqlFramework::MysqlConnectionPool::CLEAN_IDLE_CONNECTIONS_THREAD_NAME)
-    end
   end
 
   describe '#dispose' do
@@ -80,6 +74,7 @@
     it 'stops the idle connection cleaner thread' do
       thread = subject.instance_variable_get(:@idle_connections_thread)
       subject.dispose
+      sleep(6)
       expect(thread).not_to be_alive
     end
   end

spec/support/fixtures.rb

@@ -7,7 +7,7 @@ def self.execute
         connector = MysqlFramework::Connector.new(
           host: ENV.fetch('MYSQL_HOST'),
           port: ENV.fetch('MYSQL_PORT'),
-          database: nil,
+          database: ENV.fetch('MYSQL_DATABASE'),
           username: ENV.fetch('MYSQL_USERNAME'),
           password: ENV.fetch('MYSQL_PASSWORD')
         )