retry_on_deadlock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38dd996dd0e58a3b8294ee3fc9bdea8ed750ffc27520ab7257af6a0ef7a75222
+  data.tar.gz: 8da1c9f9caa2df8f84231a1757758378b81fab67414ef25cc60e7f136efc1a7c
+SHA512:
+  metadata.gz: f33f305002535c421a484316d48c4066d9dc6a069685875fbbef3d8a13f0d296913e0c797562c1d05bcac6624b6aee9a90ac265a48d9f7d44ddcb5d005fa3cdd
+  data.tar.gz: 1bd6fc143aaa5a8ff94c9fc92b0b75c1f6e924f528abb46cdb4b84c46d1984617a3c2e7f633662946ee282c8ae29ad88743c175b6d91c9f9996754f4f2a518c3

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-02-28
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at aiman.abutalaah@jisr.net. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Aiman Abu Talaah
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,94 @@
+# RetryOnDeadlock
+
+RetryOnDeadlock is a Ruby gem designed to handle deadlocks in ActiveRecord transactions by automatically retrying them with exponential backoff. This gem is particularly useful in high-concurrency environments where deadlocks are common.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'retry_on_deadlock'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install retry_on_deadlock
+```
+
+## Usage
+
+To use RetryOnDeadlock, simply include it in your ActiveRecord transactions. By default, the gem retries transactions up to 3 times when a deadlock occurs.
+
+Here is an example:
+
+```ruby
+Car.transaction(retry_on_deadlock: true) do
+  car = Car.find(1)
+  car.update!(name: "Updated Name")
+end
+```
+
+### Configuration
+
+You can configure the gem to suit your needs. For example:
+
+```ruby
+RetryOnDeadlock.configure do |config|
+  config.max_retries = 5 # Number of retries before giving up
+  config.enable_logging = true # Enable logging of retry attempts
+  config.log_level = :info # Log level for retry logs
+  config.logger = Logger.new(STDOUT) # Custom logger
+  config.always_retry = false # Always retry transactions unless explicitly disabled
+end
+```
+
+### Nested Transactions
+
+RetryOnDeadlock does not retry nested transactions. If a deadlock occurs within a nested transaction, the error will be raised immediately.
+
+## Potential Risks
+
+1. **Increased Database Load**:
+   - Retrying transactions can increase the load on your database, especially if retries are frequent. Use with caution in high-traffic applications.
+
+2. **Nested Transactions**:
+   - The gem does not retry nested transactions. Ensure your application can handle errors in such cases.
+
+3. **Exceeding Max Retries**:
+   - If the maximum number of retries is exceeded, the original `ActiveRecord::Deadlocked` error will be raised. Make sure your application handles this scenario gracefully.
+
+4. **Compatibility**:
+   - The gem is designed for ActiveRecord and assumes a PostgreSQL database. It may not work as expected with other databases or ORMs.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run:
+
+```bash
+$ bundle exec rake install
+```
+
+To release a new version, update the version number in `version.rb`, and then run:
+
+```bash
+$ bundle exec rake release
+```
+
+This will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/retry_on_deadlock. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/retry_on_deadlock/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/retry_on_deadlock/configuration.rb

@@ -0,0 +1,13 @@
+module RetryOnDeadlock
+  class Configuration
+    attr_accessor :max_retries, :logger, :enable_logging, :log_level, :always_retry
+
+    def initialize
+      @max_retries = 3
+      @enable_logging = true
+      @log_level = :warning
+      @logger = Logger.new(STDOUT)
+      @always_retry = false
+    end
+  end
+end

data/lib/retry_on_deadlock/core.rb

@@ -0,0 +1,69 @@
+module RetryOnDeadlock
+  WAIT_TIMES = [0, 1, 2, 4, 8, 16, 32]
+
+  # Helper method to determine if retry should be attempted
+  def should_retry?(kwargs)
+    kwargs[:retry_on_deadlock] != false && (RetryOnDeadlock.configuration.always_retry || kwargs[:retry_on_deadlock])
+  end
+
+  # Retries a transaction if a deadlock is detected.
+  # @param [Array] args Arguments passed to the transaction.
+  # @param [Hash] kwargs Keyword arguments, including `retry_on_deadlock`.
+  # @param [Proc] block The block to execute within the transaction.
+  def transaction(*args, **kwargs, &block)
+    if should_retry?(kwargs)
+      transaction_with_lock_handling(*args, **kwargs.merge(retry_count: 0), &block)
+    else
+      super(*args, **kwargs.except(:retry_on_deadlock), &block)
+    end
+  end
+
+  private
+
+  # Safely retries the transaction in case of a deadlock.
+  # @param [Array] args Arguments passed to the transaction.
+  # @param [Hash] kwargs Keyword arguments, including `retry_count`.
+  # @param [Proc] block The block to execute within the transaction.
+  def transaction_with_lock_handling(*args, **kwargs, &block)
+    retry_count = kwargs[:retry_count]
+    loop do
+      begin
+        return transaction(*args, **kwargs.except(:retry_count).merge(retry_on_deadlock: false), &block)
+      rescue ActiveRecord::Deadlocked => error
+        raise error if inner_transaction?
+        raise error if retry_count >= RetryOnDeadlock.configuration.max_retries
+
+        log_details(error, retry_count) if RetryOnDeadlock.configuration.enable_logging
+        retry_count += 1
+        exponential_backoff(retry_count)
+      end
+    end
+  end
+
+  # Implements exponential backoff based on the retry count.
+  # @param [Integer] count The current retry count.
+  def exponential_backoff(count)
+    sec = WAIT_TIMES[count - 1] || WAIT_TIMES.max
+    sleep(sec) if sec != 0
+  end
+
+  # Checks if the current transaction is nested.
+  # @return [Boolean] True if the transaction is nested, false otherwise.
+  def inner_transaction?
+    connection.open_transactions != 0
+  end
+
+  # Logs details about the deadlock and retry attempt.
+  # @param [Exception] exception The exception that triggered the retry.
+  # @param [Integer] retry_count The current retry count.
+  def log_details(exception, retry_count)
+    if RetryOnDeadlock.configuration.logger
+      log_level = RetryOnDeadlock.configuration.log_level
+      message = <<~TXT
+        RetryOnDeadlock: retry triggered, count #{retry_count}
+        #{exception.message}
+      TXT
+      RetryOnDeadlock.configuration.logger.send(log_level, message)
+    end
+  end
+end

data/lib/retry_on_deadlock/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RetryOnDeadlock
+  VERSION = "0.1.0"
+end

data/lib/retry_on_deadlock.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# Copyright (c) 2025 Aiman Abu Talaah. Licensed under the MIT License.
+
+require "active_record"
+require "logger"
+require "retry_on_deadlock/version"
+require "retry_on_deadlock/configuration"
+require "retry_on_deadlock/core"
+require 'byebug'
+
+module RetryOnDeadlock
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+
+    # Configure the gem
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+  end
+end
+ActiveRecord::Base.send(:extend, RetryOnDeadlock)
+

data/retry_on_deadlock.gemspec

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "lib/retry_on_deadlock/version"
+# Gem::Specification.new do |spec|
+#   spec.name          = "deadlock_retry"
+#   spec.version       = "0.1.0"
+#   spec.authors       = ["Your Name"]
+#   spec.email         = ["your.email@example.com"]
+
+#   spec.summary       = "Automatically retry ActiveRecord transactions on deadlocks."
+#   spec.description   = "A gem to handle deadlocks in ActiveRecord by retrying transactions and logging details."
+#   spec.homepage      = "https://github.com/yourusername/deadlock_retry"
+#   spec.license       = "MIT"
+
+#   spec.files         = Dir["lib/**/*", "README.md", "LICENSE.txt"]
+#   spec.require_paths = ["lib"]
+
+#   spec.add_dependency "activerecord", ">= 5.0"
+#   spec.add_dependency "activesupport", ">= 5.0"
+
+#   spec.add_development_dependency "rspec", "~> 3.0"
+#   spec.add_development_dependency "pg", "~> 1.0"
+#   spec.add_development_dependency "pry", "~> 0.13"
+# end
+Gem::Specification.new do |spec|
+  spec.name = "retry_on_deadlock"
+  spec.version = RetryOnDeadlock::VERSION
+  spec.authors = ["Aiman Abu Talaah"]
+  spec.email = ["aiman.abutalaah@gmail.com"]
+
+  spec.summary       = "Automatically retry ActiveRecord transactions on deadlocks."
+  spec.description   = "A gem to handle deadlocks in ActiveRecord by retrying transactions and logging details."
+  spec.homepage      = "https://github.com/yourusername/deadlock_retry"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/yourusername/deadlock_retry"
+  spec.metadata["changelog_uri"] = "https://github.com/yourusername/deadlock_retry"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activerecord", "~> 5.0"
+  spec.add_runtime_dependency "activesupport", "~> 5.0"
+
+  spec.add_development_dependency "byebug", "~> 11.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pg", "~> 1.0"
+  spec.add_development_dependency "pry", "~> 0.13"
+end

data/sig/retry_on_deadlock.rbs

@@ -0,0 +1,4 @@
+module RetryOnDeadlock
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: retry_on_deadlock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aiman Abu Talaah
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: A gem to handle deadlocks in ActiveRecord by retrying transactions and
+  logging details.
+email:
+- aiman.abutalaah@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/retry_on_deadlock.rb
+- lib/retry_on_deadlock/configuration.rb
+- lib/retry_on_deadlock/core.rb
+- lib/retry_on_deadlock/version.rb
+- retry_on_deadlock.gemspec
+- sig/retry_on_deadlock.rbs
+homepage: https://github.com/yourusername/deadlock_retry
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yourusername/deadlock_retry
+  source_code_uri: https://github.com/yourusername/deadlock_retry
+  changelog_uri: https://github.com/yourusername/deadlock_retry
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.21
+signing_key:
+specification_version: 4
+summary: Automatically retry ActiveRecord transactions on deadlocks.
+test_files: []