mongoid-locking 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7295a06524fd71fe15ceb6891b452cbd698459e7ebd9105dcad9b36fd438952
-  data.tar.gz: 241baea11c9c0bd16525f94d72d3358ea5eeae2cd1f24d9a715bdc5cb085b5dc
+  metadata.gz: 896cdc8de472341f894c24adbedf92e07bc88a0d13c602f75233e052391d505b
+  data.tar.gz: 545fb0a99ca2280c696ec2eccab487a1f6b8a5bd898be20707f2cb3406296ff8
 SHA512:
-  metadata.gz: 2c109c5fcbe7110c1b2c7507e3bf651f72659639b5b39b1e91acdf07997ffc772661ac627ab3a9c46ebeb4cdd4b119440724d9de6ab8f0507ee8e2d20b59e248
-  data.tar.gz: eed71b3a4074bbdd5a9753317d12f39a0bbc56879f523a71d209547e1270e0a29d7fe4007b8e1b18831d1d6f66ee9a9c38f74964a0ddc49a3cff1b86a8136993
+  metadata.gz: 51aa29f8661bb0e4c257c22137eff2342b308deb47c8c1c1b68ffeaec32767985e55741011978d427c2333f422abe18e4731a0e91bab186df71180d8e6734e15
+  data.tar.gz: 3b23274fb66538af4dfd938af8f6824dce5d3439f82cbabf6041d15d6f36f1d1fa4e37195d3e5ef3151bae04014d51577bb77ccb5701c44ed7b84b951aeb1ecf

data/.rubocop.yml

@@ -30,3 +30,6 @@ RSpec/DescribeClass:
 
 RSpec/MultipleExpectations:
   Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10

data/CHANGELOG.md

@@ -1,4 +1,18 @@
-## [Unreleased]
+## [1.3.0]
+
+- Add: delay between retries for `with_locking` method [#8](https://github.com/fullhealthmedical/mongoid-locking/pull/8)
+
+## [1.2.0]
+
+- Add: with_locking method [#6](https://github.com/fullhealthmedical/mongoid-locking/pull/6)
+
+## [1.1.1]
+
+- Fix: Fix update embedded association [#5](https://github.com/fullhealthmedical/mongoid-locking/pull/5)
+
+## [1.1.0]
+
+- Add: Support for Mongoid 7.3 [#3](https://github.com/fullhealthmedical/mongoid-locking/pull/3)
 
 ## [0.1.0] - 2022-08-03
 

data/Gemfile.lock

@@ -1,20 +1,19 @@
 PATH
   remote: .
   specs:
-    mongoid-locking (1.1.1)
+    mongoid-locking (1.3.0)
       mongoid (~> 7.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.7.6)
-      activesupport (= 6.1.7.6)
-    activesupport (6.1.7.6)
+    activemodel (7.0.8)
+      activesupport (= 7.0.8)
+    activesupport (7.0.8)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
     bson (4.15.0)
     byebug (11.1.3)
@@ -24,10 +23,10 @@ GEM
       concurrent-ruby (~> 1.0)
     json (2.6.2)
     minitest (5.20.0)
-    mongo (2.19.2)
+    mongo (2.19.3)
       bson (>= 4.14.1, < 5.0.0)
-    mongoid (7.2.6)
-      activemodel (>= 5.1, < 6.2)
+    mongoid (7.5.4)
+      activemodel (>= 5.1, < 7.1, != 7.0.0)
       mongo (>= 2.10.5, < 3.0.0)
       ruby2_keywords (~> 0.0.5)
     parallel (1.22.1)
@@ -69,7 +68,6 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.2.0)
-    zeitwerk (2.6.12)
 
 PLATFORMS
   arm64-darwin-21

data/README.md

@@ -19,7 +19,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 - Include `Mongoid::Locking` module
 
-```
+```ruby
   class Order
     include Mongoid::Document
     include Mongoid::Locking
@@ -28,16 +28,66 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 - Handle `Mongoid::StaleObjectError` when performing updates
 
-```
+```ruby
   # ...
   def update_order
-    order.update(attributes)
+    Order.update(attributes)
   rescue Mongoid::StaleObjectError => e
     add_error("This order has been changed ...")
   end
 end
 ```
 
+- Use `with_locking` to automatically handle `Mongoid::StaleObjectError`
+
+By default, `with_locking` will retry the update 3 times in case of a
+`Mongoid::StaleObjectError`.
+
+```ruby
+  def process_with_locking
+    Order.with_locking do
+      # Ensure the block is idempotent
+      # Reload object(s) within the block to get the latest changes
+      order.reload
+      # Your code here
+      # ...
+    end
+  end
+```
+
+Adjust the `max_retries` parameter to control the number of retry attempts in
+case of a `Mongoid::StaleObjectError`.
+
+```ruby
+  # ...
+  def update_order
+    order.with_locking(max_retries: 2) do
+      order.update(attributes)
+    end
+  end
+end
+```
+
+- Use `with_locking` at the instance level to automatically reload the instance
+  on each retry
+
+```ruby
+def process_with_locking
+  order.with_locking do
+    # The instance is automatically reloaded for each retry
+    # Your code here
+    # ...
+  end
+end
+````
+
+The with_locking method at the instance level combines class-level locking with
+automatic reloading on each retry. This ensures that the instance reflects the
+latest changes, providing seamless control over optimistic locking.
+
+NOTE: The `with_locking` method will add a delay between retries to avoid
+contention. [More info](https://github.com/fullhealthmedical/mongoid-locking/pull/8).
+
 ## 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.

data/lib/mongoid/locking/retry.rb

@@ -0,0 +1,67 @@
+module Mongoid
+  module Locking
+    ##
+    # Gives the ability to retry a block of code a specified number of times
+    # when a Mongoid::StaleObjectError is raised.
+    module Retry
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      ##
+      # Retries the block of code a specified number of times when a
+      # Mongoid::StaleObjectError is raised.
+      #
+      # This method will reload the document before each block execution.
+      #
+      # @example
+      #   person = Person.find(existing.id)
+      #   person.with_locking do
+      #     person.update!(name: "Person 1 updated")
+      #   end
+      #
+      # @param [ Integer ] max_retries The maximum number of times to retry
+      #
+      # @return [ Object ] The result of the block
+      def with_locking(max_retries: 3)
+        self.class.with_locking(max_retries: max_retries) do
+          reload
+          yield
+        end
+      end
+
+      module ClassMethods # :nodoc:
+        ##
+        # Retries the block of code a specified number of times when a
+        # Mongoid::StaleObjectError is raised.
+        #
+        # @example
+        #   Person.with_locking do
+        #     person = Person.find(existing.id)
+        #     Person.update!(name: "Person 1 updated")
+        #   end
+        #
+        # @param [ Integer ] max_retries The maximum number of times to retry
+        #
+        # @return [ Object ] The result of the block
+        def with_locking(max_retries: 3)
+          retries = 0
+
+          begin
+            yield
+          rescue Mongoid::StaleObjectError
+            retries += 1
+            raise if retries > max_retries
+
+            sleep Mongoid::Locking.backoff_algorithm(retries)
+            retry
+          end
+        end
+
+        def backoff_algorithm(retries)
+          (2 + rand)**retries
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/locking/version.rb

@@ -2,6 +2,6 @@
 
 module Mongoid
   module Locking
-    VERSION = "1.1.1"
+    VERSION = "1.3.0"
   end
 end

data/lib/mongoid/locking.rb

@@ -9,6 +9,7 @@ require_relative "locking/reloadable"
 require_relative "locking/persistable/creatable"
 require_relative "locking/persistable/updatable"
 require_relative "locking/persistable"
+require_relative "locking/retry"
 
 module Mongoid
   ##
@@ -16,13 +17,19 @@ module Mongoid
   #
   # @since 0.1.0
   module Locking
-    def self.included(base)
-      base.field :lock_version, type: Integer
-      base.before_create { self.lock_version = 0 }
+    class << self
+      def included(base)
+        base.field :lock_version, type: Integer
+        base.before_create { self.lock_version = 0 }
 
-      base.include Mongoid::Locking::Selectable
-      base.include Mongoid::Locking::Reloadable
-      # base.include Mongoid::Locking::Reloadable if Mongoid::VERSION >= "7"
+        base.include Mongoid::Locking::Selectable
+        base.include Mongoid::Locking::Reloadable
+        base.include Mongoid::Locking::Retry
+      end
+
+      def backoff_algorithm(retries)
+        (2**retries) + rand
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-locking
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Rodrigo RA
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-08 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -121,6 +121,7 @@ files:
 - lib/mongoid/locking/persistable/creatable.rb
 - lib/mongoid/locking/persistable/updatable.rb
 - lib/mongoid/locking/reloadable.rb
+- lib/mongoid/locking/retry.rb
 - lib/mongoid/locking/selectable.rb
 - lib/mongoid/locking/version.rb
 - lib/mongoid/stale_object_error.rb