pg_eventstore 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12384e5023ddd60d3ff1f70006dcc8cc44d7901e4ddc7c24fcf3ab3772a00daf
-  data.tar.gz: d663c5aaaa96cee4f641710e7206938d9c8b06428c286b292edfaaecaaf0f4b1
+  metadata.gz: 5fce9f1f61310bfc9c12afdb89b0a6589e9116133255eeb62ac406b24e351b72
+  data.tar.gz: 0a03a441f9e26a040f026fc7fac5d034c81b91d6f0e0bee98646b39a2f809147
 SHA512:
-  metadata.gz: e316a1a3d5a9619e4b9637aa411d9ff1cf438d4e210b02d7efd0b25e6bb1b865ff96f0cf8df2729715b5ec0b017b6254fbd51c6db9ad808b9c1a28717f7f65fc
-  data.tar.gz: cfecd6d0c57422130233c1fce18dd94b978c577427684ccff0610c54c8951cfbea0d91904dabfdfc73dbc6b9568fbb1d04b955344cbb53eabc08edefee0b2d16
+  metadata.gz: 26a0a9b9cf70e32fd73d5f729d5d9654ec23cd90aa57a3bfdf4cae5603f58d56d62a1406df477200390497141e5c4bb89f157c749bd1df680c1b404898428094
+  data.tar.gz: 85aeeffcfc9ddfba2733e7362958a9d1528eb043ae5025c2d8bd055aa708e5c20eb2fef555be711174f3c058235c0f5b97c780b9f68b3a52e92592fe58d8f8c3

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [1.1.5]
+- Review the way to handle SubscriptionAlreadyLockedError error. This removes noise when attempting to lock an already locked subscription. 
+
 ## [1.1.4]
 - Add rbs signatures
 

data/docs/subscriptions.md

@@ -47,9 +47,23 @@ After you added all necessary subscriptions, it is time to start them:
 
 ```ruby
 subscriptions_manager.start
+# => PgEventstore::BasicRunner
 ```
 
-After calling `#start` all subscriptions are locked behind the given subscription set and can't be locked by any other subscription set. This measure is needed to prevent running the same subscription under the same subscription set using different processes/subscription managers. Such situation will lead to a malformed subscription state and will break its position, meaning the same event will be processed several times.
+After calling `#start` all subscriptions are locked behind the given subscriptions set and can't be locked by any other subscriptions set. This measure is needed to prevent running the same subscription under the same subscription set using different processes/subscription managers. Such situation will lead to a malformed subscription state and will break its position, meaning the same event will be processed several times. In real world the lock attempt may still happen. This can be common scenario when using kubernetes which rolls out new deployment before shutting down old one. In this case `#start` will return `nil`. You can use this behavior to properly handle such cases. Example:
+
+```ruby
+timeout = 20 # 20 seconds
+deadline = Time.now + timeout
+loop do
+  break if subscriptions_manager.start
+  if Time.now > deadline
+    puts "Failed to acquire subscriptions lock within #{timeout} seconds. Exiting now."
+    exit
+  end
+  sleep 2
+end
+```
 
 To "unlock" the subscription you should gracefully stop the subscription manager:
 
@@ -86,7 +100,16 @@ subscriptions_manager.subscribe(
   }
 )
 subscriptions_manager.force_lock! if ENV['FORCE_LOCK'] == 'true'
-subscriptions_manager.start
+timeout = 20 # 20 seconds
+deadline = Time.now + timeout
+loop do
+  break if subscriptions_manager.start
+  if Time.now > deadline
+    puts "Failed to acquire subscriptions lock within #{timeout} seconds. Exiting now."
+    exit
+  end
+  sleep 2
+end
 
 Kernel.trap('TERM') do
   puts "Received TERM signal. Stopping Subscriptions Manager and exiting..."

data/lib/pg_eventstore/subscriptions/subscription_feeder.rb

@@ -113,6 +113,10 @@ module PgEventstore
       lock_all
       @runners.each(&:start)
       @commands_handler.start
+    rescue PgEventstore::SubscriptionAlreadyLockedError
+      @subscriptions_set&.delete
+      @subscriptions_set = nil
+      raise
     end
 
     # @param error [StandardError]

data/lib/pg_eventstore/subscriptions/subscriptions_manager.rb

@@ -30,7 +30,7 @@ module PgEventstore
     attr_reader :config
     private :config
 
-    def_delegators :@subscription_feeder, :start, :stop, :force_lock!
+    def_delegators :@subscription_feeder, :stop, :force_lock!
 
     # @param config [PgEventstore::Config]
     # @param set_name [String]
@@ -94,6 +94,14 @@ module PgEventstore
       @subscription_feeder.read_only_subscriptions_set
     end
 
+    # @return [PgEventstore::BasicRunner, nil]
+    def start
+      @subscription_feeder.start
+    rescue PgEventstore::SubscriptionAlreadyLockedError => e
+      PgEventstore.logger&.warn(e.message)
+      nil
+    end
+
     private
 
     # @param middlewares [Array<Symbol>, nil]

data/lib/pg_eventstore/version.rb

@@ -2,5 +2,5 @@
 
 module PgEventstore
   # @return [String]
-  VERSION = "1.1.4"
+  VERSION = "1.1.5"
 end

data/sig/pg_eventstore/subscriptions/subscriptions_manager.rbs

@@ -54,6 +54,8 @@ module PgEventstore
     # _@param_ `middlewares`
     def select_middlewares: (?::Array[Symbol]? middlewares) -> ::Array[PgEventstore::Middleware]
 
+    def start: () -> PgEventstore::BasicRunner?
+
     # Returns the value of attribute config.
     attr_accessor config: PgEventstore::Config
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_eventstore
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - Ivan Dzyzenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-24 00:00:00.000000000 Z
+date: 2024-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg