active_record_proxy_adapters 0.1.0.rc2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a84998cef36e3e7ba5c4e69909a41db4641a22aaa2b589988fe38f74abefa600
-  data.tar.gz: e0ab2ac9b05420d952c89f7259c6d3539eadf7b44fd791bb178dc28e91066b30
+  metadata.gz: 6f1bd3461586c7443e358fe82092039c05dd7cba760b4e4b7660ce6ecbd928e4
+  data.tar.gz: a8b40dce128c9449744ef8725bc6baa446ba8f4119e64c068a3d553e74b6fd1e
 SHA512:
-  metadata.gz: 39d6c4508378596812e6dbdf523e05ff662b279ace17f6ec0ec2db24171645374e9447fe5aff6e6a9f9f2bfb227fce4a0dddc6deebe016b2d2a1f62234f198f9
-  data.tar.gz: 8b423c0d1464157eff63c0c161481acb2a2ba55e95f9337c4a27819c1acbfe41ccf83e7e59bdb98cea1e80419159b475060a166336251c59759d4298fe0c502f
+  metadata.gz: 4a50dc55929c1d7c57f5278788d23240314660eba4ceb17335ac079740265b77042a35900ab64482073fabf79cc0612a7a38de9521f0cf5676a30b6545c5811a
+  data.tar.gz: 35ec9da8d5d1f4703129e66fa79f2f872bf5e36e053b38ea5abb25383e11980bbb19febee7c579d4e7b9905971b99e58be15d748ca13bafa064470bd873cc138

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.1.0] - 2024-11-19
+
+- Add PostgreSQLProxyAdapter
+
 ## [0.1.0.rc2] - 2024-10-28
 
 - Add PostgreSQLProxyAdapter

data/ci/stages/build.yml

@@ -0,0 +1,91 @@
+.build_app_base:
+  extends: .build_base
+  stage: build
+  variables:
+    DOCKERFILE: Dockerfile
+    DOCKER_REGISTRY: registry.git.nasdaq.com/smp/common
+  rules:
+    - changes:
+        - Dockerfile
+        - Gemfile
+        - active_record_proxy_adapters.gemspec
+        - ci/stages/build.yml
+  retry: 2
+  script:
+    - echo "CI_JOB_NAME=${CI_JOB_NAME}"
+    - SUFFIX="-rails${RAILS_VERSION}-ruby${RUBY_VERSION}"
+    - SUFFIX=$(echo $SUFFIX | tr -d '~> ' | tr -d '>=' | tr -d '<=' | tr -d '>' | tr -d '<' | tr -d ' ' )
+    - APP_IMAGE=${ENV_IMAGE_PREFIX}${SUFFIX}
+    - echo "APP_IMAGE=${APP_IMAGE}"
+    - echo "RAILS_VERSION=${RAILS_VERSION}"
+    - echo "RUBY_VERSION=${RUBY_VERSION}"
+    - buildah_build -t $APP_IMAGE --build-arg DOCKER_REGISTRY="${DOCKER_REGISTRY}" --build-arg RUBY_VERSION="${RUBY_VERSION}" --build-arg RAILS_VERSION="${RAILS_VERSION}" -f $DOCKERFILE .
+    - buildah push $APP_IMAGE
+
+env-rails-7.0.x 316 / 3:
+  extends: .build_app_base
+  variables:
+    RAILS_VERSION: '~> 7.0.0'
+    RUBY_VERSION: '3.1.6'
+
+env-rails-7.0.x 325 / 3:
+  extends: .build_app_base
+  variables:
+    RAILS_VERSION: '~> 7.0.0'
+    RUBY_VERSION: '3.2.5'
+
+env-rails-7.0.x 335 / 3:
+  extends: .build_app_base
+  variables:
+    RAILS_VERSION: '~> 7.0.0'
+    RUBY_VERSION: '3.3.5'
+
+env-rails-7.1.x 316 / 3:
+  extends: .build_app_base
+  variables:
+    RAILS_VERSION: '~> 7.1.0'
+    RUBY_VERSION: '3.1.6'
+
+env-rails-7.1.x 325 / 3:
+  extends: .build_app_base
+  variables:
+    RAILS_VERSION: '~> 7.1.0'
+    RUBY_VERSION: '3.2.5'
+
+env-rails-7.1.x 335 / 3:
+  extends: .build_app_base
+  variables:
+    RUBY_VERSION: '3.3.5'
+    RAILS_VERSION: '~> 7.1.0'
+
+env-rails-7.2.x 316 / 3:
+  extends: .build_app_base
+  variables:
+    RAILS_VERSION: '~> 7.2.0'
+    RUBY_VERSION: '3.1.6'
+
+env-rails-7.2.x 325 / 3:
+  extends: .build_app_base
+  variables:
+    RAILS_VERSION: '~> 7.2.0'
+    RUBY_VERSION: '3.2.5'
+
+env-rails-7.2.x 335 / 3:
+  extends: .build_app_base
+  variables:
+    RAILS_VERSION: '~> 7.2.0'
+    RUBY_VERSION: '3.3.5'
+
+# Rails 8.0.x does not support Ruby 3.1.6
+
+env-rails-8.0.x 325 / 3:
+  extends: .build_app_base
+  variables:
+    RAILS_VERSION: '~> 8.0.0'
+    RUBY_VERSION: '3.2.5'
+
+env-rails-8.0.x 335 / 3:
+  extends: .build_app_base
+  variables:
+    RAILS_VERSION: '~> 8.0.0'
+    RUBY_VERSION: '3.3.5'

data/ci/stages/env_vars.yml

@@ -0,0 +1,18 @@
+export:
+  stage: env_vars
+  image: registry.git.nasdaq.com/gitlab/ci/buildah/stable:v1.30.0
+  artifacts:
+    reports:
+      dotenv: build.env
+  script:
+    - !reference [.checksums, functions]
+    - POSTGRES_PRIMARY_TAG=$(checksum postgres_primary.dockerfile)
+    - POSTGRES_REPLICA_TAG=$(checksum postgres_replica.dockerfile)
+    - DOCKERFILE_CHECKSUM=$(checksum Dockerfile)
+    - GEMFILE_CHECKSUM=$(checksum Gemfile)
+    - GEMSPEC_CHECKSUM=$(checksum active_record_proxy_adapters.gemspec)
+    - TAG_PREFIX=$(checksum_join $DOCKERFILE_CHECKSUM $GEMFILE_CHECKSUM $GEMSPEC_CHECKSUM)
+    - ENV_IMAGE_PREFIX=${CI_REGISTRY_IMAGE}/env:${TAG_PREFIX}
+    - echo "POSTGRES_PRIMARY_IMAGE=${CI_REGISTRY_IMAGE}/postgres_primary:${POSTGRES_PRIMARY_TAG}" >> build.env
+    - echo "POSTGRES_REPLICA_IMAGE=${CI_REGISTRY_IMAGE}/postgres_replica:${POSTGRES_REPLICA_TAG}" >> build.env
+    - echo "ENV_IMAGE_PREFIX=${ENV_IMAGE_PREFIX}" >> build.env

data/ci/stages/lint.yml

@@ -0,0 +1,12 @@
+.lint_base:
+  stage: lint
+  image: ${ENV_IMAGE_PREFIX}-rails7.0.0-ruby3.1.6
+  needs:
+    - export
+    - job: env-rails-7.0.x 316 / 3
+      optional: true
+
+rubocop:
+  extends: .lint_base
+  script:
+    - rubocop

data/ci/stages/prebuild.yml

@@ -0,0 +1,28 @@
+
+
+postgres_primary:
+  extends: .build_base
+  stage: prebuild
+  variables:
+    DOCKERFILE: postgres_primary.dockerfile
+    REPLICA_USER: replicator
+    REPLICA_PASSWORD: replicator
+  script:
+    - echo "POSTGRES_PRIMARY_IMAGE=${POSTGRES_PRIMARY_IMAGE}"
+    - echo "DOCKERFILE=${DOCKERFILE}"
+    - buildah_build -t $POSTGRES_PRIMARY_IMAGE --build-arg REPLICA_USER=${REPLICA_USER} --build-arg REPLICA_PASSWORD=${REPLICA_PASSWORD} -f $DOCKERFILE .
+    - buildah push $POSTGRES_PRIMARY_IMAGE
+  rules:
+    - changes:
+        - postgres_primary.dockerfile
+postgres_replica:
+  extends: .build_base
+  stage: prebuild
+  variables:
+    DOCKERFILE: postgres_replica.dockerfile
+  script:
+    - buildah_build -t $POSTGRES_REPLICA_IMAGE -f $DOCKERFILE .
+    - buildah push $POSTGRES_REPLICA_IMAGE
+  rules:
+    - changes:
+        - postgres_replica.dockerfile

data/ci/stages/push.yml

@@ -0,0 +1,23 @@
+push_to_rubygems:
+  stage: push
+  image: ruby:alpine
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      when: manual
+      allow_failure: true
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+      when: never
+    - if: $CI_COMMIT_TAG
+      when: always
+  script: |
+    apk add git curl
+    GEM_VERSION="${CI_COMMIT_TAG:-$(grep VERSION lib/active_record_proxy_adapters/version.rb | tr -d 'VERSION=' | tr -d ' ' | tr -d '"')}"
+    mkdir ~/.gem
+    echo "---" > ~/.gem/credentials
+    echo "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/rubygems: '${CI_JOB_TOKEN}'" >> ~/.gem/credentials
+    chmod 0600 ~/.gem/credentials
+    echo "------------------"
+    echo "building gem"
+    gem build active_record_proxy_adapters.gemspec
+    echo "Uploading to rubygems"
+    curl --verbose --fail --user "$NEXUS_USER_ID:$NEXUS_PASSWORD" --upload-file "${CI_PROJECT_DIR}/active_record_proxy_adapters-${GEM_VERSION}.gem" "https://pro.nexus.aws.nasdaq.com/repository/smp-second-market-gems/active_record_proxy_adapters/"

data/ci/stages/test.yml

@@ -0,0 +1,133 @@
+.test_base:
+  stage: test
+  needs:
+    - export
+    - job: postgres_primary
+      optional: true
+    - job: postgres_replica
+      optional: true
+  services:
+    - name: $POSTGRES_PRIMARY_IMAGE
+      alias: postgres-primary
+      variables:
+        POSTGRES_DB: postgres_primary_test
+        POSTGRES_USER: postgres_primary_test
+        POSTGRES_PASSWORD: postgres_primary_test
+        POSTGRES_HOST_AUTH_METHOD: "scram-sha-256\nhost replication all 0.0.0.0/0 md5"
+        POSTGRES_INITDB_ARGS: "--auth-host=scram-sha-256"
+    - name: $POSTGRES_REPLICA_IMAGE
+      alias: postgres-replica
+      variables:
+        PGUSER: replicator
+        PGPASSWORD: replicator
+        PGPORT: 5433
+        PRIMARY_DATABASE_HOST: postgres-primary
+  variables:
+    PGHOST: postgres-primary
+    PG_PRIMARY_USER: postgres_primary_test
+    PG_PRIMARY_PASSWORD: postgres_primary_test
+    PG_PRIMARY_HOST: postgres-primary
+    PG_PRIMARY_PORT: 5432
+    PG_REPLICA_USER: postgres_primary_test
+    PG_REPLICA_PASSWORD: postgres_primary_test
+    PG_REPLICA_HOST: postgres-replica
+    PG_REPLICA_PORT: 5433
+
+
+.rspec:
+  extends: .test_base
+  retry: 2
+  script:
+    - echo "Ruby version => $(ruby -v)"
+    - echo "ActiveRecord Version => $(gem list | grep activerecord)"
+    - rspec --format progress
+
+rspec-rails-7.0.x 316 / 3:
+  extends: .rspec
+  needs:
+    - !reference [.test_base, needs]
+    - job: env-rails-7.0.x 316 / 3
+      optional: true
+  image: ${ENV_IMAGE_PREFIX}-rails7.0.0-ruby3.1.6
+
+rspec-rails-7.0.x 325 / 3:
+  extends: .rspec
+  needs:
+    - !reference [.test_base, needs]
+    - job: env-rails-7.0.x 325 / 3
+      optional: true
+  image: ${ENV_IMAGE_PREFIX}-rails7.0.0-ruby3.2.5
+
+rspec-rails-7.0.x 335 / 3:
+  extends: .rspec
+  needs:
+    - !reference [.test_base, needs]
+    - job: env-rails-7.0.x 335 / 3
+      optional: true
+  image: ${ENV_IMAGE_PREFIX}-rails7.0.0-ruby3.3.5
+
+rspec-rails-7.1.x 316 / 3:
+  extends: .rspec
+  needs:
+    - !reference [.test_base, needs]
+    - job: env-rails-7.1.x 316 / 3
+      optional: true
+  image: ${ENV_IMAGE_PREFIX}-rails7.1.0-ruby3.1.6
+
+rspec-rails-7.1.x 325 / 3:
+  extends: .rspec
+  needs:
+    - !reference [.test_base, needs]
+    - job: env-rails-7.1.x 325 / 3
+      optional: true
+  image: ${ENV_IMAGE_PREFIX}-rails7.1.0-ruby3.2.5
+
+rspec-rails-7.1.x 335 / 3:
+  extends: .rspec
+  needs:
+    - !reference [.test_base, needs]
+    - job: env-rails-7.1.x 335 / 3
+      optional: true
+  image: ${ENV_IMAGE_PREFIX}-rails7.1.0-ruby3.3.5
+
+rspec-rails-7.2.x 316 / 3:
+  extends: .rspec
+  needs:
+    - !reference [.test_base, needs]
+    - job: env-rails-7.2.x 316 / 3
+      optional: true
+  image: ${ENV_IMAGE_PREFIX}-rails7.2.0-ruby3.1.6
+
+rspec-rails-7.2.x 325 / 3:
+  extends: .rspec
+  needs:
+    - !reference [.test_base, needs]
+    - job: env-rails-7.2.x 325 / 3
+      optional: true
+  image: ${ENV_IMAGE_PREFIX}-rails7.2.0-ruby3.2.5
+
+rspec-rails-7.2.x 335 / 3:
+  extends: .rspec
+  needs:
+    - !reference [.test_base, needs]
+    - job: env-rails-7.2.x 335 / 3
+      optional: true
+  image: ${ENV_IMAGE_PREFIX}-rails7.2.0-ruby3.3.5
+
+# Rails 8.0.x does not support Ruby 3.1.6
+
+rspec-rails-8.0.x 325 / 3:
+  extends: .rspec
+  needs:
+    - !reference [.test_base, needs]
+    - job: env-rails-8.0.x 325 / 3
+      optional: true
+  image: ${ENV_IMAGE_PREFIX}-rails8.0.0-ruby3.2.5
+
+rspec-rails-8.0.x 335 / 3:
+  extends: .rspec
+  needs:
+    - !reference [.test_base, needs]
+    - job: env-rails-8.0.x 335 / 3
+      optional: true
+  image: ${ENV_IMAGE_PREFIX}-rails8.0.0-ruby3.3.5

data/lib/active_record/connection_adapters/postgresql_proxy_adapter.rb

@@ -2,8 +2,9 @@
 
 require "active_record/tasks/postgresql_proxy_database_tasks"
 require "active_record/connection_adapters/postgresql_adapter"
-require "active_record_proxy_adapters/postgresql_proxy"
+require "active_record_proxy_adapters/active_record_context"
 require "active_record_proxy_adapters/hijackable"
+require "active_record_proxy_adapters/postgresql_proxy"
 
 module ActiveRecord
   module ConnectionAdapters
@@ -14,7 +15,11 @@ module ActiveRecord
 
       ADAPTER_NAME = "PostgreSQLProxy"
 
-      delegate_to_proxy :execute, :exec_query, :exec_no_cache, :exec_cache
+      delegate_to_proxy :execute, :exec_query
+
+      unless ActiveRecordProxyAdapters::ActiveRecordContext.active_record_v8_0_or_greater?
+        delegate_to_proxy :exec_no_cache, :exec_cache
+      end
 
       def initialize(...)
         @proxy = ActiveRecordProxyAdapters::PostgreSQLProxy.new(self)
@@ -29,7 +34,7 @@ module ActiveRecord
   end
 end
 
-if ActiveRecordProxyAdapters::ActiveRecordContext.active_record_v7_2?
+if ActiveRecordProxyAdapters::ActiveRecordContext.active_record_v7_2_or_greater?
   ActiveRecord::ConnectionAdapters.register(
     "postgresql_proxy",
     "ActiveRecord::ConnectionAdapters::PostgreSQLProxyAdapter",

data/lib/active_record_proxy_adapters/active_record_context.rb

@@ -4,7 +4,7 @@ module ActiveRecordProxyAdapters
   # Collection of helpers to handle common active record methods that are defined in different places in different
   # versions of rails.
   class ActiveRecordContext
-    delegate :reading_role, :reading_role=, :writing_role, :writing_role=, to: :role_context
+    delegate :reading_role, :reading_role=, :writing_role, :writing_role=, to: :ActiveRecord
     delegate :legacy_connection_handling, :legacy_connection_handling=, to: :connection_handling_context
     delegate :version, to: :ActiveRecord, prefix: :active_record
 
@@ -22,45 +22,27 @@ module ActiveRecordProxyAdapters
       end
     end
 
-    def reading_role
-      role_context.reading_role
-    end
-
-    def writing_role
-      role_context.writing_role
-    end
-
     def connection_class_for(connection)
-      klass = active_record_v6_1? ? connection.connection_klass : connection.connection_class
-
-      klass || ActiveRecord::Base
+      connection.connection_class || ActiveRecord::Base
     end
 
     def connection_handling_context
       # This config option has been removed in Rails 7.1+
-      return NullConnectionHandlingContext.new if active_record_v7_1? || active_record_v7_2?
-
-      global_configuration_context
-    end
-
-    def role_context
-      global_configuration_context
-    end
+      return NullConnectionHandlingContext.new if active_record_v7_1_or_greater?
 
-    def global_configuration_context
-      active_record_v6_1? ? ActiveRecord::Base : ActiveRecord
+      ActiveRecord
     end
 
-    def active_record_v6_1?
-      active_record_version >= Gem::Version.new("6.1") && active_record_version < Gem::Version.new("7.0")
+    def active_record_v7_1_or_greater?
+      active_record_version >= Gem::Version.new("7.1")
     end
 
-    def active_record_v7_1?
-      active_record_version >= Gem::Version.new("7.1") && active_record_version < Gem::Version.new("7.2")
+    def active_record_v7_2_or_greater?
+      active_record_version >= Gem::Version.new("7.2")
     end
 
-    def active_record_v7_2?
-      active_record_version >= Gem::Version.new("7.2") && active_record_version < Gem::Version.new("8.0")
+    def active_record_v8_0_or_greater?
+      active_record_version >= Gem::Version.new("8.0")
     end
   end
 end

data/lib/active_record_proxy_adapters/postgresql_proxy.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 require "active_record_proxy_adapters/primary_replica_proxy"
+require "active_record_proxy_adapters/active_record_context"
 
 module ActiveRecordProxyAdapters
   # Proxy to the original PostgreSQLAdapter, allowing the use of the ActiveRecordProxyAdapters::PrimaryReplicaProxy.
   class PostgreSQLProxy < PrimaryReplicaProxy
     # ActiveRecord::PostgreSQLAdapter methods that should be proxied.
-    hijack_method :execute, :exec_query, :exec_no_cache, :exec_cache
+    hijack_method :execute, :exec_query
+
+    hijack_method :exec_no_cache, :exec_cache unless ActiveRecordContext.active_record_v8_0_or_greater?
   end
 end

data/lib/active_record_proxy_adapters/primary_replica_proxy.rb

@@ -29,7 +29,10 @@ module ActiveRecordProxyAdapters
 
     # Defines which methods should be hijacked from the original adapter and use the proxy
     # @param method_names [Array<Symbol>] the list of method names from the adapter
-    def self.hijack_method(*method_names)
+    def self.hijack_method(*method_names) # rubocop:disable Metrics/MethodLength
+      @hijacked_methods ||= Set.new
+      @hijacked_methods += Set.new(method_names)
+
       method_names.each do |method_name|
         define_method(method_name) do |*args, **kwargs, &block|
           proxy_bypass_method = "#{method_name}#{UNPROXIED_METHOD_SUFFIX}"
@@ -44,6 +47,10 @@ module ActiveRecordProxyAdapters
       end
     end
 
+    def self.hijacked_methods
+      @hijacked_methods.to_a
+    end
+
     # @param primary_connection [ActiveRecord::ConnectionAdatpers::AbstractAdapter]
     def initialize(primary_connection)
       @primary_connection    = primary_connection

data/lib/active_record_proxy_adapters/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordProxyAdapters
-  VERSION = "0.1.0.rc2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_proxy_adapters
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc2
+  version: 0.1.0
 platform: ruby
 authors:
 - Matt Cruz
@@ -16,40 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.a
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.a
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.a
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.1.a
+        version: 7.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.1'
 description: |-
   This gem allows automatic connection switching between a primary and one read replica database in ActiveRecord.
   It pattern matches the SQL statement being sent to decide whether it should go to the replica (SELECT) or the
@@ -68,6 +68,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- ci/stages/build.yml
+- ci/stages/env_vars.yml
+- ci/stages/lint.yml
+- ci/stages/prebuild.yml
+- ci/stages/push.yml
+- ci/stages/test.yml
 - docker-compose.yml
 - lib/active_record/connection_adapters/postgresql_proxy_adapter.rb
 - lib/active_record/tasks/postgresql_proxy_database_tasks.rb
@@ -87,10 +93,10 @@ homepage: https://github.com/Nasdaq/active_record_proxy_adapters
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org/
+  allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/Nasdaq/active_record_proxy_adapters
   source_code_uri: https://github.com/Nasdaq/active_record_proxy_adapters
-  changelog_uri: https://github.com/Nasdaq/active_record_proxy_adapters/blob/main/CHANGELOG.md
+  changelog_uri: https://github.com/Nasdaq/active_record_proxy_adapters/-/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: