pub_sub_model_sync 1.6.3 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7ea520bc38ca14cb53e4163ed40fb3d2393fc7eff35effedf379e56f25e8372
-  data.tar.gz: ddbec139ee891136fc5cba84cb90a7a3828ab4de17b971ac6a33039d8070d165
+  metadata.gz: d12a6ec76834fc6254b81fdfb02f2fce4515b3cd388255a9dd0738983c5d6bfb
+  data.tar.gz: 9e75e804660fdf8c5d572fe7498e6e11a72a8ccd35f55ec2c006e308da9d9733
 SHA512:
-  metadata.gz: f3b5c26a832cd758abc4fa66e23698cf7fcc44b4c81f4701b372eb20ce99553a8abfdbb4d94c15d4aa788af347078f1068998ec41c866235d4413aac871057cc
-  data.tar.gz: 98b36dd457b82fd78b383ab98eb73f10115fc1650cf0b00d1041f9e87afef797c72e0eb17fdca2333fe923ad9df0aed5e63916043ac31d8cb3a64e4dbc463038
+  metadata.gz: cdec845c99322bf054087336aab30ce13aebab93b1c498ca099df5c74e86c0a40be3edf96b0af2762aaafa5eada55cf8ef004890edc28bbf04518d53fcd6796b
+  data.tar.gz: 179990f6e198177919394d100052c923d12a8553fe04c6fc5c6e06655bfb2b852d717494878e2beebda82e37e57de0320a3e3dd5393bca030cc130db518bf392

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pub_sub_model_sync (1.6.3)
+    pub_sub_model_sync (1.6.4)
       rails
 
 GEM

data/README.md

@@ -318,7 +318,7 @@ Any notification before delivering is transformed as a Payload for a better port
     - `ordering_key`: (String, optional): notifications with the same `ordering_key` are processed in the same order they were delivered, default: `<model.class.name>/<model.id>` when instance notification and `klass_name` when class notification.    
       Note: Final `ordering_key` is calculated as: `payload.headers[:forced_ordering_key] || current_transaction&.key || payload.headers[:ordering_key]`         
     - `topic_name`: (String|Array<String>, optional): Specific topic name where to deliver the notification (default `PubSubModelSync::Config.topic_name`).
-    - `forced_ordering_key`: (String, optional): Overrides `ordering_key` with the provided value even withing transactions. Default `nil`.
+    - `forced_ordering_key`: (String, optional): Overrides `ordering_key` with the provided value even withing transactions. Default `nil` (if `true`, prevails the payload's `ordering_key`).
     - `target_app_key`: (String, optional): Allows to send the notification to a specific app (includes the application key, separated by comma when multiple apps). Default `nil`.
     - `cache` (Boolean | Hash, Default false) Cache settings   
         - `true`: Skip publishing similar payloads
@@ -335,7 +335,8 @@ Note: To reduce Payload size, some header info are not delivered (Enable debug m
     payload.publish! # publishes notification data. It raises exception if fails and does not call ```:on_error_publishing``` callback
     payload.publish # publishes notification data. On error does not raise exception but calls ```:on_error_publishing``` callback
     payload.process! # process a notification data. It raises exception if fails and does not call ```.on_error_processing``` callback
-    payload.publish # process a notification data. It does not raise exception if fails but calls ```.on_error_processing``` callback
+    payload.process # process a notification data. It does not raise exception if fails but calls ```.on_error_processing``` callback
+    payload.retry_publish! # allows to retry publishing a failed payload (All callbacks are ignored)
   ```
 
 ## **Transactions**   
@@ -538,7 +539,7 @@ config.debug = true
     (Proc) => called before publishing a notification (:cancel can be returned to skip publishing)
 - ```.on_after_publish = ->(payload) { puts payload }```
     (Proc) => called after publishing a notification
-- ```.on_error_publish = ->(exception, {payload:}) { payload.delay(...).publish! }```
+- ```.on_error_publish = ->(exception, {payload:}) { payload.delay(...).retry_publish! }```
     (Proc) => called when failed publishing a notification (delayed_job or similar can be used for retrying)
 - ```.skip_cache = false```
     (true/false*) => Allow to skip payload optimization (cache settings)
@@ -581,7 +582,7 @@ config.debug = true
     end
 
     PubSubModelSync::Config.on_error_publish = lambda do |_e, data|
-      PubSubRecovery.perform_async(data[:payload].to_h, :publish!)
+      PubSubRecovery.perform_async(data[:payload].to_h, :retry_publish!)
     end
     PubSubModelSync::Config.on_error_processing = lambda do |_e, data|
       PubSubRecovery.perform_async(data[:payload].to_h, :process!)

data/lib/pub_sub_model_sync/message_publisher.rb

@@ -80,6 +80,15 @@ module PubSubModelSync
         current_transaction ? current_transaction.add_payload(payload) : connector_publish(payload)
         block&.call
         payload
+      rescue => e
+        notify_error(e, payload)
+        raise
+      end
+
+      # Similar to :publish! method but ignores the error if failed
+      # @return Payload
+      def publish(payload, &block)
+        publish!(payload, &block) rescue nil # rubocop:disable Style/RescueModifier
       end
 
       def connector_publish(payload)
@@ -89,28 +98,21 @@ module PubSubModelSync
         config.on_after_publish.call(payload)
       end
 
-      # Similar to :publish! method
-      # Notifies error via :on_error_publish instead of raising error
-      # @return Payload
-      def publish(payload, &block)
-        publish!(payload, &block)
-      rescue => e
-        notify_error(e, payload)
-      end
-
       private
 
       def ensure_publish(payload)
         cache_klass = PubSubModelSync::PayloadCacheOptimizer
-        cancelled = payload.cache_settings ? cache_klass.new(payload).call == :already_sent : false
-        cancelled ||= config.on_before_publish.call(payload) == :cancel
-        log_msg = "Publish cancelled by config.on_before_publish or cache checker: #{[payload]}"
+        cancelled_cache = payload.cache_settings ? cache_klass.new(payload).call == :already_sent : false
+        cancelled = cancelled_cache || config.on_before_publish.call(payload) == :cancel
+        log_msg = "Publish cancelled by #{cancelled_cache ? 'cache checker' : 'config.on_before_publish'}: #{[payload]}"
         log(log_msg) if config.debug && cancelled
         !cancelled
       end
 
       def add_transaction_headers(payload)
-        key = payload.headers[:forced_ordering_key] || current_transaction&.key || payload.headers[:ordering_key]
+        force_key = payload.headers[:forced_ordering_key]
+        key = force_key || current_transaction&.key || payload.headers[:ordering_key]
+        key = payload.headers[:ordering_key] if force_key == true
         payload.headers[:ordering_key] = key
         payload.headers.merge!(current_transaction.headers) if current_transaction
       end

data/lib/pub_sub_model_sync/mock_google_service.rb

@@ -43,6 +43,10 @@ module PubSubModelSync
         yield(OpenStruct.new(succeeded?: true)) if block_given?
       end
 
+      def resume_publish(_ordering_key)
+        true
+      end
+
       def enable_message_ordering!
         true
       end

data/lib/pub_sub_model_sync/payload.rb

@@ -72,15 +72,18 @@ module PubSubModelSync
     # Publish payload to pubsub
     #   (If error will raise exception and wont call on_error_publish callback)
     def publish!
-      klass = PubSubModelSync::MessagePublisher
-      klass.publish!(self)
+      PubSubModelSync::MessagePublisher.publish!(self)
     end
 
     # Publish payload to pubsub
     #   (If error will call on_error_publish callback)
     def publish
-      klass = PubSubModelSync::MessagePublisher
-      klass.publish(self)
+      PubSubModelSync::MessagePublisher.publish(self)
+    end
+
+    # allows to retry publishing a failed payload
+    def retry_publish!
+      PubSubModelSync::MessagePublisher.connector_publish(self)
     end
 
     # @param attr_keys (Array<Symbol>) List of attributes to be excluded from payload

data/lib/pub_sub_model_sync/payload_cache_optimizer.rb

@@ -19,14 +19,14 @@ module PubSubModelSync
       return payload if cache_disabled?
       return :already_sent if previous_payload_data == payload.data
 
-      optimize_payload if optimization_enabled?
+      optimize_payload if optimization_allowed?
       Rails.cache.write(cache_key, backup_data, expires_in: 1.week)
       payload
     end
 
     private
 
-    def optimization_enabled?
+    def optimization_allowed?
       previous_payload_data && payload.cache_settings.is_a?(Hash)
     end
 

data/lib/pub_sub_model_sync/service_google.rb

@@ -35,11 +35,7 @@ module PubSubModelSync
     def publish(payload)
       p_topic_names = Array(payload.headers[:topic_name] || config.default_topic_name)
       message_topics = p_topic_names.map(&method(:find_topic))
-      message_topics.each do |topic|
-        topic.publish_async(encode_payload(payload), message_headers(payload)) do |res|
-          raise StandardError, 'Failed to publish the message.' unless res.succeeded?
-        end
-      end
+      message_topics.each { |topic| publish_to_topic(topic, payload) }
     end
 
     def stop
@@ -56,6 +52,19 @@ module PubSubModelSync
       topics[topic_name] || publish_topics[topic_name] || init_topic(topic_name, only_publish: true)
     end
 
+    def publish_to_topic(topic, payload)
+      retries ||= 0
+      topic.publish_async(encode_payload(payload), message_headers(payload)) do |res|
+        raise StandardError, "Failed to publish the message. #{res.error}" unless res.succeeded?
+      end
+    rescue Google::Cloud::PubSub::OrderingKeyError => e
+      raise if (retries += 1) > 1
+
+      log("Resuming ordering_key and retrying OrderingKeyError for #{payload.headers[:uuid]}: #{e.message}")
+      topic.resume_publish(message_headers(payload)[:ordering_key])
+      retry
+    end
+
     # @param only_publish (Boolean): if false is used to listen and publish messages
     # @return (Topic): returns created or loaded topic
     def init_topic(topic_name, only_publish: false)

data/lib/pub_sub_model_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PubSubModelSync
-  VERSION = '1.6.3'
+  VERSION = '1.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pub_sub_model_sync
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.7.0
 platform: ruby
 authors:
 - Owen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-25 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails