janus-ar 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02c92206a54d203c923936849e6fd8c5621c8da702c4f0e327680a6084f86a75
-  data.tar.gz: b0e4746b02cf9e1bdf123cf7ad8b0e5ec0485bbb1433d6e9b6e98483b2afd132
+  metadata.gz: c7f4d589060d390c2a1c0697cdde34bb36e92a4daed4ab477d8fa543de113ae1
+  data.tar.gz: dd3e5fc8957cc36e5a06684934b7a9e41f37b5f5a2c749c686e42d77d49a650b
 SHA512:
-  metadata.gz: 228491371a233938062950c382d31e5a68bbf6e60c20c659ffd97920e2b2b8beaab5df874ddc6d4ce5eee15a7efab7776eae5fe6e547e60a91173ba72341d654
-  data.tar.gz: 9bd2c0749f350bfe663d4d64b2125c6fcc7bb10293b712178b2a6361f6f5a7ae4178b3651c0bca332e35a9180e555af9fb6c7f6e618a1f5911eb8427daf3b34b
+  metadata.gz: 68e6fab5ad4a07f4b872f9ddd76d0c74847380d6a2f690d98646a7d2b2d9110eb4fb9a095b8f42bd7912aaeb0774e239bbd9a9cbef9c65fa9fb6e9a9b386b54e
+  data.tar.gz: df1f1b37c36dea944d5ce6c1f05080eb119461f0e180edd6dcdb63768bf1f16101644eebc41d302f46c414219fd5cf28cddf6c7a2e9a3ac0632b2cd46627e494

data/.github/workflows/ci.yml

@@ -19,8 +19,10 @@ jobs:
       mysql:
         image: mysql:5.7
         env:
-          MYSQL_ALLOW_EMPTY_PASSWORD: yes
-          MYSQL_DATABASE: janus_test
+          MYSQL_DATABASE: test
+          MYSQL_ROOT_PASSWORD: password
+          MYSQL_USER: primary
+          MYSQL_PASSWORD: primary_password
         ports:
           - 3306:3306
         options: >-
@@ -34,6 +36,8 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
+      - run: |
+          mysql -u root -p${{ env.MYSQL_PASSWORD || 'password' }} -h 127.0.0.1 -e "CREATE USER 'replica'@'%' IDENTIFIED BY 'replica_password';GRANT SELECT ON test.* TO 'replica'@'%';FLUSH PRIVILEGES;"
       - run: |
           bundle exec rspec
         env:

data/.github/workflows/publish.yml

@@ -0,0 +1,20 @@
+name: Publish GEM
+
+on:
+  push:
+    tags:
+      - v*
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Release GEM
+        if: contains(github.ref, 'refs/tags/v')
+        uses: cadwallion/publish-rubygems-action@master
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          RELEASE_COMMAND: gem build && gem push janus-ar-*.gem

data/.gitignore

@@ -1 +1,3 @@
 janus-ar-*.gem
+.bundle/
+.rubocop-*

data/.rubocop.yml

@@ -1,3 +1,6 @@
+inherit_from:
+  - https://tech.olioex.com/.support/rubocop-styling-v1.0
+
 require:
   - rubocop-rails
 
@@ -11,5 +14,9 @@ Metrics/BlockLength:
   Exclude:
     - spec/**/*
 
+Style/GlobalVars:
+  Exclude:
+    - 'spec/**/*'
+
 Metrics/AbcSize:
   Max: 22

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    janus-ar (0.4.0)
+    janus-ar (0.7.0)
 
 GEM
   remote: http://rubygems.org/
@@ -25,6 +25,7 @@ GEM
     ast (2.4.2)
     base64 (0.2.0)
     bigdecimal (3.1.7)
+    coderay (1.1.3)
     concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
     diff-lcs (1.5.1)
@@ -33,6 +34,7 @@ GEM
       concurrent-ruby (~> 1.0)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
+    method_source (1.0.0)
     minitest (5.22.3)
     mutex_m (0.2.0)
     mysql2 (0.5.6)
@@ -40,6 +42,9 @@ GEM
     parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     racc (1.7.3)
     rack (3.0.10)
     rainbow (3.1.1)
@@ -72,11 +77,27 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.2)
       parser (>= 3.3.0.4)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-performance (1.21.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rails (2.24.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (2.29.1)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.3)
+      rubocop (~> 1.40)
+    rubocop-thread_safety (0.5.1)
+      rubocop (>= 0.90.0)
     ruby-progressbar (1.13.0)
     timeout (0.4.1)
     tzinfo (2.0.6)
@@ -92,10 +113,14 @@ DEPENDENCIES
   activesupport (>= 7.1.0)
   janus-ar!
   mysql2
+  pry
   rake
   rspec (~> 3)
   rubocop (~> 1.63.0)
+  rubocop-performance
   rubocop-rails (~> 2.24.0)
+  rubocop-rspec
+  rubocop-thread_safety
 
 BUNDLED WITH
    2.4.22

data/README.md

@@ -6,7 +6,8 @@
      style="float: left; margin: 0 auto; height: 500px;" />
 </p>
 
-![Build Status](https://github.com/OLIOEX/janus-ar/actions/workflows/ci.yml/badge.svg)
+[![CI](https://github.com/OLIOEX/janus-ar/actions/workflows/ci.yml/badge.svg)](https://github.com/OLIOEX/janus-ar/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/janus-ar.svg)](https://badge.fury.io/rb/janus-ar)
 
 > In ancient Roman religion and myth, Janus (/ˈdʒeɪnəs/ JAY-nəs; Latin: Ianvs [ˈi̯aːnʊs]) is the god of beginnings, gates, transitions, time, duality, doorways,[2] passages, frames, and endings. [(wikipedia)](https://en.wikipedia.org/wiki/Janus)
 

data/janus-ar.gemspec

@@ -5,18 +5,18 @@ require File.expand_path('lib/janus/version.rb', __dir__)
 Gem::Specification.new do |gem|
   gem.authors       = ['Lloyd Watkin']
   gem.email         = ['lloyd@olioex.com']
-  gem.description   = 'Read/Write proxy for ActiveRecord using primary/replca databases'
-  gem.summary       = 'Read/Write proxy for ActiveRecord using primary/replca databases'
+  gem.description   = 'Read/Write proxy for ActiveRecord using primary/replica databases'
+  gem.summary       = 'Read/Write proxy for ActiveRecord using primary/replica databases'
   gem.homepage      = 'https://github.com/olioex/janus-ar'
-  gem.licenses      = ['MIT']
+  gem.licenses      = %w(MIT)
   gem.metadata      = {
-    'source_code_uri' => 'https://github.com/olioex/janus-ar'
+    'source_code_uri' => 'https://github.com/olioex/janus-ar',
   }
 
   gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.name          = 'janus-ar'
-  gem.require_paths = ['lib']
+  gem.require_paths = %w(lib)
   gem.version       = Janus::VERSION
 
   gem.required_ruby_version = '>= 3.2.0'
@@ -24,8 +24,12 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'activerecord', '>= 7.1.0'
   gem.add_development_dependency 'activesupport', '>= 7.1.0'
   gem.add_development_dependency 'mysql2'
+  gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 3'
   gem.add_development_dependency 'rubocop', '~> 1.63.0'
   gem.add_development_dependency 'rubocop-rails', '~> 2.24.0'
+  gem.add_development_dependency 'rubocop-rspec'
+  gem.add_development_dependency 'rubocop-thread_safety'
+  gem.add_development_dependency 'rubocop-performance'
 end

data/lib/active_record/connection_adapters/janus_mysql2_adapter.rb

@@ -15,6 +15,7 @@ end
 module ActiveRecord
   module ConnectionAdapters
     class JanusMysql2Adapter < ActiveRecord::ConnectionAdapters::Mysql2Adapter
+      FOUND_ROWS = 'FOUND_ROWS'
       SQL_PRIMARY_MATCHERS = [
         /\A\s*select.+for update\Z/i, /select.+lock in share mode\Z/i,
         /\A\s*select.+(nextval|currval|lastval|get_lock|release_lock|pg_advisory_lock|pg_advisory_unlock)\(/i,
@@ -23,6 +24,9 @@ module ActiveRecord
       SQL_REPLICA_MATCHERS = [/\A\s*(select|with.+\)\s*select)\s/i].freeze
       SQL_ALL_MATCHERS = [/\A\s*set\s/i].freeze
       SQL_SKIP_ALL_MATCHERS = [/\A\s*set\s+local\s/i].freeze
+      WRITE_PREFIXES = %w(INSERT UPDATE DELETE LOCK CREATE GRANT DROP).freeze
+
+      attr_reader :config
 
       def initialize(*args)
         args[0][:janus]['replica']['database'] = args[0][:database]
@@ -30,6 +34,7 @@ module ActiveRecord
 
         @replica_config = args[0][:janus]['replica']
         args[0] = args[0][:janus]['primary']
+
         super(*args)
         @connection_parameters ||= args[0]
         update_config
@@ -48,7 +53,7 @@ module ActiveRecord
         super(sql)
       end
 
-      def execute_and_free(sql, name = nil, async: false) # :nodoc:#
+      def execute_and_free(sql, name = nil, async: false)
         if should_send_to_all?(sql)
           send_to_replica(sql, name, connection: :all)
           return super(sql, name, async:)
@@ -81,6 +86,10 @@ module ActiveRecord
         super
       end
 
+      def replica_connection
+        @replica_connection ||= ActiveRecord::ConnectionAdapters::Mysql2Adapter.new(@replica_config)
+      end
+
       private
 
       def should_send_to_all?(sql)
@@ -108,18 +117,14 @@ module ActiveRecord
       end
 
       def write_query?(sql)
-        %w[INSERT UPDATE DELETE LOCK CREATE GRANT].include?(sql.split(' ').first)
-      end
-
-      def replica_connection
-        @replica_connection ||= ActiveRecord::ConnectionAdapters::Mysql2Adapter.new(@replica_config)
+        WRITE_PREFIXES.include?(sql.split(' ').first)
       end
 
       def update_config
         @config[:flags] ||= 0
 
         if @config[:flags].is_a? Array
-          @config[:flags].push 'FOUND_ROWS'
+          @config[:flags].push FOUND_ROWS
         else
           @config[:flags] |= ::Mysql2::Client::FOUND_ROWS
         end

data/lib/janus/logging/subscriber.rb

@@ -3,7 +3,7 @@
 module Janus
   module Logging
     module Subscriber
-      IGNORE_PAYLOAD_NAMES = %w[SCHEMA EXPLAIN].freeze
+      IGNORE_PAYLOAD_NAMES = %w(SCHEMA EXPLAIN).freeze
 
       def sql(event)
         name = event.payload[:name]

data/lib/janus/version.rb

@@ -4,7 +4,7 @@ module Janus
   unless defined?(::Janus::VERSION)
     module VERSION
       MAJOR = 0
-      MINOR = 6
+      MINOR = 7
       PATCH = 0
       PRE = nil
 

data/spec/lib/active_record/connection_adapters/janus_mysql_adapter_spec.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+RSpec.describe ActiveRecord::ConnectionAdapters::JanusMysql2Adapter do
+  subject { described_class.new(config) }
+
+  it { expect(described_class::FOUND_ROWS).to eq 'FOUND_ROWS' }
+  it { expect(described_class::SQL_SKIP_ALL_MATCHERS).to eq [/\A\s*set\s+local\s/i] }
+  it {
+    expect(described_class::SQL_PRIMARY_MATCHERS).to eq(
+      [
+        /\A\s*select.+for update\Z/i, /select.+lock in share mode\Z/i,
+        /\A\s*select.+(nextval|currval|lastval|get_lock|release_lock|pg_advisory_lock|pg_advisory_unlock)\(/i,
+        /\A\s*show/i
+      ]
+    )
+  }
+  it { expect(described_class::SQL_REPLICA_MATCHERS).to eq([/\A\s*(select|with.+\)\s*select)\s/i]) }
+  it { expect(described_class::SQL_ALL_MATCHERS).to eq([/\A\s*set\s/i]) }
+  it { expect(described_class::WRITE_PREFIXES).to eq %w(INSERT UPDATE DELETE LOCK CREATE GRANT DROP) }
+
+  let(:database) { 'test' }
+  let(:primary_config) do
+    {
+      'username' => 'primary',
+      'password' => 'primary_password',
+      'host' => '127.0.0.1',
+    }
+  end
+  let(:replica_config) do
+    {
+      'username' => 'replica',
+      'password' => 'replica_password',
+      'host' => '127.0.0.1',
+      'pool' => 500,
+    }
+  end
+  let(:config) do
+    {
+      database:,
+      adapter: 'janus_mysql2',
+      janus: {
+        'primary' => primary_config,
+        'replica' => replica_config,
+      },
+    }
+  end
+
+  describe 'Configuration' do
+    it 'creates primary connection as expected' do
+      config = primary_config.dup.freeze
+      expect(subject.config).to eq config.merge('database' => database,
+                                                'flags' => ::Mysql2::Client::FOUND_ROWS).symbolize_keys
+    end
+
+    it 'creates replica connection as expected' do
+      config = replica_config.dup.freeze
+      expect(
+        subject.replica_connection.instance_variable_get(:@config)
+      ).to eq config.merge('database' => database, 'flags' => ::Mysql2::Client::FOUND_ROWS).symbolize_keys
+    end
+
+    context 'Rails sets empty database for server connection' do
+      let(:database) { nil }
+
+      it 'creates primary connection as expected' do
+        config = primary_config.dup.freeze
+        expect(subject.config).to eq config.merge(
+          'database' => nil,
+          'flags' => ::Mysql2::Client::FOUND_ROWS
+        ).symbolize_keys
+      end
+
+      it 'creates replica connection as expected' do
+        config = replica_config.dup.freeze
+        expect(
+          subject.replica_connection.instance_variable_get(:@config)
+        ).to eq config.merge('database' => nil, 'flags' => ::Mysql2::Client::FOUND_ROWS).symbolize_keys
+      end
+    end
+  end
+
+  describe 'Integration tests' do
+    let(:create_test_table) { ActiveRecord::Base.connection.execute('CREATE TABLE test_table (id INT);') }
+
+    before(:each) do
+      $query_logger.flush_all
+      ActiveRecord::Base.establish_connection(config)
+    end
+
+    after(:each) do
+      ActiveRecord::Base.connection.execute(<<-SQL
+        SELECT CONCAT('DROP TABLE IF EXISTS `', table_name, '`;')
+        FROM information_schema.tables
+        WHERE table_schema = '#{database}';
+        SQL
+                                           ).to_a.map { |row| ActiveRecord::Base.connection.execute(row[0]) }
+    end
+
+    it 'can list tables' do
+      expect(ActiveRecord::Base.connection.execute('SHOW TABLES;').to_a).to eq []
+    end
+
+    it 'can create table' do
+      create_test_table
+      expect(ActiveRecord::Base.connection.execute('SHOW TABLES;').to_a).to eq [%w(test_table)]
+    end
+
+    describe 'SELECT' do
+      it 'reads from `replica` by default' do
+        create_test_table
+        Janus::Context.release_all
+        $query_logger.flush_all
+        ActiveRecord::Base.connection.execute('SELECT * FROM test_table;')
+        expect($query_logger.queries.first).to include '[replica]'
+      end
+
+      it 'will read from primary after a write operation' do
+        create_test_table
+        $query_logger.flush_all
+        ActiveRecord::Base.connection.execute('SELECT * FROM test_table;')
+        expect($query_logger.queries.first).to include '[primary]'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,40 @@
 # frozen_string_literal: true
 
+require 'pry'
+
+require 'active_record'
+
 require './lib/janus'
+require './lib/active_record/connection_adapters/janus_mysql2_adapter'
+
+class QueryLogger
+  def initialize
+    @_logs = []
+  end
+
+  def flush_all
+    @_logs = []
+  end
+
+  def log(level, message)
+    @_logs << "#{level}: #{message}"
+  end
+
+  def error(message)
+    log('error', message)
+  end
+
+  def queries
+    @_logs
+  end
+
+  def debug?
+    true
+  end
+
+  def debug(message)
+    log('debug', message)
+  end
+end
+
+$query_logger = ActiveRecord::Base.logger = QueryLogger.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: janus-ar
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Lloyd Watkin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-09 00:00:00.000000000 Z
+date: 2024-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +122,49 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.24.0
-description: Read/Write proxy for ActiveRecord using primary/replca databases
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Read/Write proxy for ActiveRecord using primary/replica databases
 email:
 - lloyd@olioex.com
 executables: []
@@ -117,6 +173,7 @@ extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -134,6 +191,7 @@ files:
 - lib/janus/logging/logger.rb
 - lib/janus/logging/subscriber.rb
 - lib/janus/version.rb
+- spec/lib/active_record/connection_adapters/janus_mysql_adapter_spec.rb
 - spec/lib/janus/context_spec.rb
 - spec/lib/janus/logging/logger_spec.rb
 - spec/spec_helper.rb
@@ -160,5 +218,5 @@ requirements: []
 rubygems_version: 3.5.7
 signing_key:
 specification_version: 4
-summary: Read/Write proxy for ActiveRecord using primary/replca databases
+summary: Read/Write proxy for ActiveRecord using primary/replica databases
 test_files: []