pub_sub_model_sync 1.5.1pre → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55d5a541d463ac4b23a26bbcb2ba14f5c4d6336d72bde40d1ea9c1ff5bc4b89f
-  data.tar.gz: 496ed96aacf2c6ab74ffb4f997b00cfffc76168f168647f94fec3fa57bc3ae59
+  metadata.gz: ce57b6483f8a2f3fb1a65a2b12a19dd3d7e8ce75afea225ead398980dbfbbf5c
+  data.tar.gz: b86d05d225cb4729c5299d7cd8711fe7523f2b7eb851fd1229e99a6caa008c3d
 SHA512:
-  metadata.gz: 199e1c3841b4038ec67b189b2da974655d7ce87c637297b59c646628e7cba0359f64f11e8b1e0c4d3db65827ffa3a4f81fb52492bb0e5c40e1f9438b894135a6
-  data.tar.gz: 951e65c9e9e7d109b5c3fe9c7e79ffb00ebe7110bbdd7d15c93a1a5c83e460a0512292bfe21b87fc8bba5d11dcf79c75af2723cfc0b61cacef8f6f812cab9834
+  metadata.gz: ce613eb94bde316e2a8211f2efb1f0afcc86542607f80a7f53476afde59d6b6757793de4d2ca658a5c39b690c46a7bc8399e913119f632e06353f71278a55e2c
+  data.tar.gz: d012f277cb251a96e5baee5292c40dd63fdf4710e7fd900a93a1b642ff2b33f2f11f80b4663ea0867fe44f60cfba33886910b49d90d95f853e2fed3aece5ac02

data/Gemfile.lock

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

data/README.md

@@ -271,8 +271,10 @@ PubSubModelSync::Payload.new({ ids: [my_user.id] }, { klass: 'User', action: :ba
   - `as_klass:` (String, default current class name): Class name of the notification
   - `headers:` (Hash, optional): header settings (More in Payload.headers)
 
-- `ps_perform_publish(action = :create)` Permits to perform manually the callback of a specific `ps_after_action`
+- `ps_perform_publish(action = :create, parents_actions: false)` Permits to perform manually the callback of a specific `ps_after_action`
   - `action` (Symbol, default: :create) Only :create|:update|:destroy
+  - `parents_actions` (Boolean, default: false) When `true`, includes inherited PubSub-callbacks from parent classes
+    
   
 #### **Publisher helpers**
 - Publish or republish a notification
@@ -317,6 +319,7 @@ Any notification before delivering is transformed as a Payload for a better port
       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`.
+    - `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
         - `Hash<required: Array<Symbol>>`: Same as `true` and enables payload optimization to exclude unchanged non important attributes. Sample: `{ required: %i[id email] }`
@@ -379,16 +382,17 @@ Note: To reduce Payload size, some header info are not delivered (Enable debug m
   - Manual transactions   
     `PubSubModelSync::MessagePublisher::transaction(key, max_buffer: , &block)`
     - `key` (String|nil) Key used as the ordering_key for all inner notifications (When nil, will use `ordering_key` of the first notification)  
-    - `max_buffer:` (Integer, default: `PubSubModelSync::Config.transactions_max_buffer`) Transaction buffer size (more details in #transactions_max_buffer).     
+    - `max_buffer:` (Integer, default: `PubSubModelSync::Config.transactions_max_buffer`) Transaction buffer size (DEPRECATED).     
+    - `headers:` (Hash) Header settings to be added to each Payload's header inside this transaction     
     Sample:
     ```ruby
-      PubSubModelSync::MessagePublisher::transaction('my-custom-key') do
+      PubSubModelSync::MessagePublisher::transaction('my-custom-key', headers: { key: 'my-key' }) do
         user = User.create(name: 'test') # `User`:`:create` notification
         post = Post.create(title: 'sample') # `Post`:`:create` notification
         PubSubModelSync::Payload.new({ ids: [user.id] }, { klass: 'User', action: :send_welcome, mode: :klass }).publish! # `User`:`:send_welcome` notification
       end
     ```
-    All notifications uses `ordering_key: 'my-custom-key'` and will be processed in the same order they were published.
+    All notifications uses `ordering_key: 'my-custom-key'` and will be processed in the same order they were published (Payload headers will include `key="my-key"`).
 
 ## **Testing with RSpec**
 - Config: (spec/rails_helper.rb)

data/lib/pub_sub_model_sync/message_processor.rb

@@ -23,15 +23,15 @@ module PubSubModelSync
     end
 
     def process
-      retries ||= 0
       process!
     rescue => e
-      retry_process?(e, retries += 1) ? retry : notify_error(e)
+      notify_error(e)
     end
 
     private
 
-    def run_subscriber(subscriber)
+    def run_subscriber(subscriber) # rubocop:disable Metrics/AbcSize
+      retries ||= 0
       processor = PubSubModelSync::RunSubscriber.new(subscriber, payload)
       return unless processable?(subscriber)
 
@@ -39,6 +39,8 @@ module PubSubModelSync
       processor.call
       res = config.on_success_processing.call(payload, { subscriber: subscriber })
       log "processed message with: #{payload.inspect}" if res != :skip_log
+    rescue => e
+      retry_process?(e, retries += 1) ? retry : raise(e)
     end
 
     def processable?(subscriber)
@@ -47,7 +49,7 @@ module PubSubModelSync
       !cancel
     end
 
-    # @param error (StandardError)
+    # @param error (StandardError, Exception)
     def notify_error(error)
       error_msg = 'Error processing message: '
       error_details = [payload, error.message, error.backtrace]
@@ -67,9 +69,6 @@ module PubSubModelSync
 
     def retry_process?(error, retries) # rubocop:disable Metrics/MethodLength
       error_payload = [payload, error.message, error.backtrace]
-      if error.message.include('Connection refused') || error.message.include('no connection to the server')
-        log("Error pubsub: #{[error.class.name, error.message]} (retries: #{retries}) => #{lost_db_connection?(error)}", :error)
-      end
       return false unless lost_db_connection?(error)
 
       if retries <= 5

data/lib/pub_sub_model_sync/message_publisher.rb

@@ -18,6 +18,9 @@ module PubSubModelSync
       #   worker/thread.
       # @see Transaction.new(...)
       # @param key (String|Nil)
+      # @param settings (Hash<:headers, :max_buffer>)
+      #   @option headers [Hash] Headers to be merged for each payload inside this transaction
+      #   @option max_buffer [Integer] Deprecated
       # @param block (Yield) block to be executed
       def transaction(key, settings = {}, &block)
         t = init_transaction(key, settings)
@@ -71,7 +74,7 @@ module PubSubModelSync
       # @return Payload
       # Raises error if exist
       def publish!(payload, &block)
-        payload.headers[:ordering_key] = ordering_key_for(payload)
+        add_transaction_headers(payload)
         return unless ensure_publish(payload)
 
         current_transaction ? current_transaction.add_payload(payload) : connector_publish(payload)
@@ -106,8 +109,10 @@ module PubSubModelSync
         !cancelled
       end
 
-      def ordering_key_for(payload)
-        payload.headers[:forced_ordering_key] || current_transaction&.key || payload.headers[:ordering_key]
+      def add_transaction_headers(payload)
+        key = payload.headers[:forced_ordering_key] || current_transaction&.key || payload.headers[:ordering_key]
+        payload.headers[:ordering_key] = key
+        payload.headers.merge!(current_transaction.headers) if current_transaction
       end
 
       def ensure_model_publish(model, action, payload)

data/lib/pub_sub_model_sync/publisher_concern.rb

@@ -39,11 +39,9 @@ module PubSubModelSync
     # Permits to perform manually the callback for a specific action
     # @param action (Symbol, default: :create) Only :create|:update|:destroy
     def ps_perform_publish(action = :create, parents_actions: false)
-      parent_callbacks = parents_actions ? self.class.superclass.ps_cache_publish_callbacks : []
       callbacks = self.class.ps_cache_publish_callbacks
-      items = (callbacks + parent_callbacks).select { |item| item[:actions].include?(action) }
-      raise(StandardError, "No callback found for action :#{action}") if items.empty?
-
+      callbacks = self.class.ancestors.map { |p| p.try(:ps_cache_publish_callbacks) }.compact.flatten if parents_actions
+      items = callbacks.select { |item| item[:actions].include?(action) }
       items.each { |item| instance_exec(action, &item[:callback]) }
       self
     end

data/lib/pub_sub_model_sync/service_base.rb

@@ -59,8 +59,8 @@ module PubSubModelSync
     end
 
     def target_app_message?(payload)
-      key = payload.headers[:target_app_key]
-      key == config.subscription_key || !key
+      key = payload.headers[:target_app_key].to_s
+      !key.present? || key.split(',').include?(config.subscription_key)
     end
   end
 end

data/lib/pub_sub_model_sync/transaction.rb

@@ -3,17 +3,18 @@
 module PubSubModelSync
   class Transaction < Base
     PUBLISHER_KLASS = PubSubModelSync::MessagePublisher
-    attr_accessor :key, :payloads, :max_buffer, :root, :children, :finished
+    attr_accessor :key, :payloads, :max_buffer, :root, :children, :finished, :headers
 
     # @param key (String,Nil) Transaction key, if empty will use the ordering_key from first payload
     # @param max_buffer (Integer) Once this quantity of notifications is reached, then all notifications
     #   will immediately be delivered.
     #   Note: There is no way to rollback delivered notifications if current transaction fails
-    def initialize(key, max_buffer: config.transactions_max_buffer)
+    def initialize(key, max_buffer: config.transactions_max_buffer, headers: {})
       @key = key
       @max_buffer = max_buffer
       @children = []
       @payloads = []
+      @headers = headers
     end
 
     # @param payload (Payload)

data/lib/pub_sub_model_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PubSubModelSync
-  VERSION = '1.5.1pre'
+  VERSION = '1.6.0'
 end

data/pub_sub_model_sync.gemspec

@@ -4,7 +4,7 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pub_sub_model_sync/version'
 
-Gem::Specification.new do |spec|
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.required_ruby_version = '>= 2.4' # rubocop:disable Gemspec/RequiredRubyVersion
   spec.name          = 'pub_sub_model_sync'
   spec.version       = PubSubModelSync::VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pub_sub_model_sync
 version: !ruby/object:Gem::Version
-  version: 1.5.1pre
+  version: 1.6.0
 platform: ruby
 authors:
 - Owen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-14 00:00:00.000000000 Z
+date: 2022-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -156,9 +156,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.8
 signing_key: