activerecord-retry-reads 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 107348efac31c4aa59343edc97e421b2d67f065998e70e3c10c31880a7dd5ecd
+  data.tar.gz: 44e13abff494439827baeb1b19a9c32f2e6052c410b07c0ac4f1a81ed896132b
+SHA512:
+  metadata.gz: 2f00ca6ff861653defcdcf929aadfbf8fa5a0237006e0daede320c0e67d6d1292bd5517452049281dc9d0c988ad56ede2e6a0fe835df8f6d0ef566431573a899
+  data.tar.gz: 79d8f13f5c2bcca8e5e4d19b5935a32c18373052dbc87b837c758581a9830fbe5071be5810f9d80e8a524ac20ddc7efd8727a4c68b225338abbdc347cbea7cc0

data/README.md

@@ -0,0 +1,33 @@
+# activerecord-retry-reads
+
+Automatically retry read queries.
+
+Supports Rails 7.1+ and the `mysql2`, `postgresql`, `sqlite3`, or `trilogy` adapters.
+
+## Installation
+In your Gemfile:
+
+```
+gem 'activerecord-mysql-reconnect'
+```
+
+## Usage
+
+There is currently no configuration for this gem.
+
+## Why this gem?
+
+Historically, gems like [activerecord-mysql-reconnect](https://github.com/planningcenter/activerecord-mysql-reconnect) have been used to automatically reconnect and retry queries after a disconnect from MySQL. They are not compatible with Rails >= 7.1.
+
+Rails 7.1 added native reconnect and retry functionality, but it is _extremely_ conservative about what queries are automatically retried. In almost every Rails app any _read_ query is idempotent and safe to retry. If this is not true in your app, do not use this gem!
+
+This gem expands the automatic retry functionality added in Rails 7.1 to enable retries for every _read_ query.
+
+## Testing
+
+Run tests with:
+
+```
+bundle exec appraisal install
+bundle exec appraisal rake test
+```

data/lib/activerecord/connection_adapters/auto_retry_all_reads.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module ActiveRecord
+  module ConnectionAdapters
+    module AutoRetryAllReads
+      def raw_execute(sql, name, **kwargs)
+        kwargs[:allow_retry] = true if !write_query?(sql)
+        super(sql, name, **kwargs)
+      end
+    end
+
+    ActiveSupport.on_load(:active_record_mysql2adapter) do
+      Mysql2::DatabaseStatements.prepend(AutoRetryAllReads)
+    end
+    ActiveSupport.on_load(:active_record_postgresqladapter) do
+      PostgreSQL::DatabaseStatements.prepend(AutoRetryAllReads)
+    end
+    ActiveSupport.on_load(:active_record_sqlite3adapter) do
+      Sqlite3::DatabaseStatements.prepend(AutoRetryAllReads)
+    end
+    ActiveSupport.on_load(:active_record_trilogyadapter) do
+      Trilogy::DatabaseStatements.prepend(AutoRetryAllReads)
+    end
+  end
+end

data/lib/activerecord-retry-reads/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module ActiverecordRetryReads
+  VERSION = "1.0.0"
+end

data/lib/activerecord-retry-reads.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require_relative 'activerecord/connection_adapters/auto_retry_all_reads'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-retry-reads
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ben@planningcenter.com
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Retry read queries automatically when disconnected from the database
+email:
+- ben@planningcenter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/activerecord-retry-reads.rb
+- lib/activerecord-retry-reads/version.rb
+- lib/activerecord/connection_adapters/auto_retry_all_reads.rb
+homepage: https://github.com/planningcenter/activerecord-retry-reads
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Retry read queries automatically when disconnected from the database
+test_files: []