Add support for Rails 7.2 (#39)

* Add support for Rails 7.2+ * Update base file name * Move files to `janus-ar` folder * Update Readme * Sync version with Rails * Updates * Make rubocop happy * Rubocop
OLIOEX · Aug 28, 2024 · ae41f83 · ae41f83
1 parent c7299f0
commit ae41f83
Show file tree

Hide file tree

Showing 22 changed files with 86 additions and 48 deletions.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -18,5 +18,9 @@ Style/GlobalVars:
   Exclude:
     - 'spec/**/*'
 
+Naming/FileName:
+  Exclude:
+    - lib/janus-ar.rb
+
 Metrics/AbcSize:
   Max: 25
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,28 +1,29 @@
 PATH
   remote: .
   specs:
-    janus-ar (0.15.2)
-      activerecord (>= 7.1.0, < 7.2)
+    janus-ar (7.2.0)
+      activerecord (~> 7.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (7.1.3.4)
-      activesupport (= 7.1.3.4)
-    activerecord (7.1.3.4)
-      activemodel (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    activemodel (7.2.1)
+      activesupport (= 7.2.1)
+    activerecord (7.2.1)
+      activemodel (= 7.2.1)
+      activesupport (= 7.2.1)
       timeout (>= 0.4.0)
-    activesupport (7.1.3.4)
+    activesupport (7.2.1)
       base64
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
     ast (2.4.2)
     base64 (0.2.0)
     bigdecimal (3.1.8)
@@ -35,9 +36,9 @@ GEM
       concurrent-ruby (~> 1.0)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
+    logger (1.6.0)
     method_source (1.0.0)
     minitest (5.25.1)
-    mutex_m (0.2.0)
     mysql2 (0.5.6)
     parallel (1.26.3)
     parser (3.3.4.2)
@@ -92,6 +93,7 @@ GEM
     rubocop-thread_safety (0.5.1)
       rubocop (>= 0.90.0)
     ruby-progressbar (1.13.0)
+    securerandom (0.3.1)
     strscan (3.1.0)
     timeout (0.4.1)
     trilogy (2.8.1)
@@ -104,7 +106,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  activesupport (>= 7.1.0, < 7.2)
+  activesupport (>= 7.2.0)
   janus-ar!
   mysql2
   pry

diff --git a/README.md b/README.md
@@ -35,6 +35,22 @@ This project assumes that your read/write endpoints are handled by a separate sy
 
 After a write request during a thread the adapter will continue using the `primary` server, unless the context is specifically released.
 
+## Rails 7.2+
+
+For Rails 7.2 you'll need to manually register the database adaptor in `config/application.rb` after requiring rails but before entering the application configuration, e.g.
+
+```ruby
+require 'rails/all'
+
+ActiveRecord::ConnectionAdapters.register("janus_trilogy", "ActiveRecord::ConnectionAdapters::JanusTrilogyAdapter", 'janus-ar/active_record/connection_adapters/janus_trilogy_adapter')
+# ...or...
+ActiveRecord::ConnectionAdapters.register("janus_mysql2", "ActiveRecord::ConnectionAdapters::JanusMysql2Adapter", 'janus-ar/active_record/connection_adapters/janus_mysql2_adapter')
+```
+
+## Rails <= 7.1
+
+ActiveRecord 7.1 was tested up to releases v0.15.*. After this release we only tested  Rails 7.2+. This does not mean it is not compatible, just not tested.
+
 ### Configuration
 
 Update your **database.yml** as follows:
@@ -104,6 +120,9 @@ There are some edge cases:
 * Calls inside a transaction will always be sent to the primary (otherwise changes from within the transaction could not be read back on most transaction isolation levels)
 * Locking reads (e.g. `SELECT ... FOR UPDATE`) will always be sent to the primary
 
+# Notes
+
+Janus does not support Rails' read/write split or sharding using `with_connection`.
 
 # Acknowlegements
 

diff --git a/janus-ar.gemspec b/janus-ar.gemspec
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path('lib/janus/version.rb', __dir__)
+require File.expand_path('lib/janus-ar/version.rb', __dir__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ['Lloyd Watkin']
@@ -21,8 +21,8 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 3.2.0'
 
-  gem.add_dependency 'activerecord', '>= 7.1.0', '< 7.2'
-  gem.add_development_dependency 'activesupport', '>= 7.1.0', '< 7.2'
+  gem.add_dependency 'activerecord', '~> 7.2'
+  gem.add_development_dependency 'activesupport', '>= 7.2.0'
   gem.add_development_dependency 'mysql2'
   gem.add_development_dependency 'trilogy'
   gem.add_development_dependency 'pry'

diff --git a/lib/janus-ar.rb b/lib/janus-ar.rb
@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'active_support'
+
+module Janus
+  autoload :Context, 'janus-ar/context'
+  autoload :Client, 'janus-ar/client'
+  autoload :QueryDirector, 'janus-ar/query_director'
+  autoload :VERSION, 'janus-ar/version'
+  autoload :DbConsoleConfig, 'janus-ar/db_console_config'
+
+  module Logging
+    autoload :Subscriber, 'janus-ar/logging/subscriber'
+    autoload :Logger, 'janus-ar/logging/logger'
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::LogSubscriber.log_subscribers.each do |subscriber|
+    subscriber.extend Janus::Logging::Subscriber
+  end
+end
diff --git a/...nnection_adapters/janus_mysql2_adapter.rb → ...nnection_adapters/janus_mysql2_adapter.rb b/...nnection_adapters/janus_mysql2_adapter.rb → ...nnection_adapters/janus_mysql2_adapter.rb
@@ -2,7 +2,7 @@
 
 require 'active_record/connection_adapters/abstract_adapter'
 require 'active_record/connection_adapters/mysql2_adapter'
-require_relative '../../janus'
+require_relative '../../../janus-ar'
 
 module ActiveRecord
   module ConnectionHandling
@@ -47,6 +47,10 @@ def initialize(*args)
         update_config
       end
 
+      def with_connection(_args = {})
+        self
+      end
+
       def raw_execute(sql, name, async: false, allow_retry: false, materialize_transactions: true)
         case where_to_send?(sql)
         when :all

diff --git a/...nection_adapters/janus_trilogy_adapter.rb → ...nection_adapters/janus_trilogy_adapter.rb b/...nection_adapters/janus_trilogy_adapter.rb → ...nection_adapters/janus_trilogy_adapter.rb
@@ -2,7 +2,7 @@
 
 require 'active_record/connection_adapters/abstract_adapter'
 require 'active_record/connection_adapters/trilogy_adapter'
-require_relative '../../janus'
+require_relative '../../../janus-ar'
 
 module ActiveRecord
   module ConnectionHandling
@@ -89,6 +89,10 @@ def execute_and_free(sql, name = nil, async: false)
         end
       end
 
+      def with_connection(_args = {})
+        self
+      end
+
       def connect!(...)
         replica_connection.connect!(...)
         super

diff --git a/lib/janus/client.rb → lib/janus-ar/client.rb b/lib/janus/client.rb → lib/janus-ar/client.rb
diff --git a/lib/janus/context.rb → lib/janus-ar/context.rb b/lib/janus/context.rb → lib/janus-ar/context.rb
diff --git a/lib/janus/db_console_config.rb → lib/janus-ar/db_console_config.rb b/lib/janus/db_console_config.rb → lib/janus-ar/db_console_config.rb
diff --git a/lib/janus/logging/logger.rb → lib/janus-ar/logging/logger.rb b/lib/janus/logging/logger.rb → lib/janus-ar/logging/logger.rb
diff --git a/lib/janus/logging/subscriber.rb → lib/janus-ar/logging/subscriber.rb b/lib/janus/logging/subscriber.rb → lib/janus-ar/logging/subscriber.rb
diff --git a/lib/janus/query_director.rb → lib/janus-ar/query_director.rb b/lib/janus/query_director.rb → lib/janus-ar/query_director.rb
diff --git a/lib/janus/version.rb → lib/janus-ar/version.rb b/lib/janus/version.rb → lib/janus-ar/version.rb
@@ -3,9 +3,9 @@
 module Janus
   unless defined?(::Janus::VERSION)
     module VERSION
-      MAJOR = 0
-      MINOR = 15
-      PATCH = 3
+      MAJOR = 7
+      MINOR = 2
+      PATCH = 0
       PRE = nil
 
       def self.to_s

diff --git a/lib/janus.rb b/lib/janus.rb
diff --git a/...tion_adapters/janus_mysql_adapter_spec.rb → ...tion_adapters/janus_mysql_adapter_spec.rb b/...tion_adapters/janus_mysql_adapter_spec.rb → ...tion_adapters/janus_mysql_adapter_spec.rb
diff --git a/...on_adapters/janus_trilogy_adapter_spec.rb → ...on_adapters/janus_trilogy_adapter_spec.rb b/...on_adapters/janus_trilogy_adapter_spec.rb → ...on_adapters/janus_trilogy_adapter_spec.rb
@@ -14,6 +14,7 @@
       'ssl' => true,
       'ssl_mode' => 'REQUIRED',
       'tls_min_version' => Trilogy::TLS_VERSION_12,
+      'found_rows' => true,
     }
   end
   let(:replica_config) do
@@ -25,6 +26,7 @@
       'ssl' => true,
       'ssl_mode' => 'REQUIRED',
       'tls_min_version' => Trilogy::TLS_VERSION_12,
+      'found_rows' => true,
     }
   end
   let(:config) do

diff --git a/spec/lib/janus/client_spec.rb → spec/lib/janus-ar/client_spec.rb b/spec/lib/janus/client_spec.rb → spec/lib/janus-ar/client_spec.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'janus/client'
+require 'janus-ar/client'
 
 RSpec.describe Janus::Client do
   it { expect(described_class::FOUND_ROWS).to eq 2 }

diff --git a/spec/lib/janus/context_spec.rb → spec/lib/janus-ar/context_spec.rb b/spec/lib/janus/context_spec.rb → spec/lib/janus-ar/context_spec.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'janus/context'
+require 'janus-ar/context'
 
 RSpec.describe Janus::Context do
   describe '#initialize' do

diff --git a/spec/lib/janus/logging/logger_spec.rb → spec/lib/janus-ar/logging/logger_spec.rb b/spec/lib/janus/logging/logger_spec.rb → spec/lib/janus-ar/logging/logger_spec.rb
diff --git a/spec/lib/janus/query_director_spec.rb → spec/lib/janus-ar/query_director_spec.rb b/spec/lib/janus/query_director_spec.rb → spec/lib/janus-ar/query_director_spec.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -4,9 +4,12 @@
 
 require 'active_record'
 
-require './lib/janus'
-require './lib/active_record/connection_adapters/janus_mysql2_adapter'
-require './lib/active_record/connection_adapters/janus_trilogy_adapter'
+require './lib/janus-ar'
+require './lib/janus-ar/active_record/connection_adapters/janus_mysql2_adapter'
+require './lib/janus-ar/active_record/connection_adapters/janus_trilogy_adapter'
+
+ActiveRecord::ConnectionAdapters.register("janus_trilogy", "ActiveRecord::ConnectionAdapters::JanusTrilogyAdapter")
+ActiveRecord::ConnectionAdapters.register("janus_mysql2", "ActiveRecord::ConnectionAdapters::JanusMysql2Adapter")
 
 require './spec/shared_examples/a_mysql_like_server.rb'