pub_sub_model_sync 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ba16c2e3129caa85cf184030955e6a1de130b23b9b552a620c1354234eb5376
-  data.tar.gz: a4b3eb7514efe123a38fb46ed933bf9ac0b1f418f1675d73b13e2cee25e6fe03
+  metadata.gz: 3016ebc69eba9ccb8b168734db1b947b77a4c9400f48d8228f979a7c1ec9eab8
+  data.tar.gz: 82187606c0411ece3eb0d78db59a8794019e80acd5374ffd92b95b0eee4368f7
 SHA512:
-  metadata.gz: b55d2b5f1bdd763061e0c2ea60f9fe080bdb1db26e5cdb20adf33973524612d2041b0c4dab1ec1afc90e4f7a91ea8327b41ef8c9ecf53ba8bafe543b92dd74e9
-  data.tar.gz: 218f2d41a1fcb04d240a4c3e91daa58b989555f9a97dc488fbc0bd627c0db412e3de224afc31a02c73bfa123f8817705811da1f3e7d20d240036f00de4ccb11d
+  metadata.gz: f4335695f26d69f091a2ea1726221aab4b07b712827318adfe16f2d1275cde21a0860ce7562ed266f6a0661eb2b8d634abea0956a4478ad55f70e6c199c8a364
+  data.tar.gz: 9252e45ab27b332d9b50afc93da62a0a039c707a1bb3b219ff4e60c1c4f3dae8eb7a85024fc3d1dab87c006e448e60cf3d1f3d953dad8cc8fced24bd375b47cd

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+# 0.2.3 (April 15, 2020)
+- Improve helper names
+- feat: perform manual sync with custom settings
+- fix for "IO timeout when reading 7 bytes" error (Rabbit)
+- style: do not print processed message when failed
+- feat: retry delivery message when failed (RabbitMQ)
+
+
 # 0.2.2 (March 27, 2020)
 - fix default value for cattr_accessor in ror < 5.2
 - add callbacks when publishing a message

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pub_sub_model_sync (0.2.2)
+    pub_sub_model_sync (0.2.3)
       activesupport
       rails
 

data/README.md

@@ -97,9 +97,13 @@ class User < ActiveRecord::Base
   include PubSubModelSync::PublisherConcern
   ps_publish(%i[name:full_name email], actions: %i[update], as_klass: 'Client', id: :client_id)
   
-  def ps_skip_for?(_action)
+  def ps_skip_callback?(_action)
     false # here logic with action to skip push message
   end
+  
+  def ps_skip_sync?(_action)
+      false # here logic with action to skip push message
+    end
 end
 
 # App 2 (Subscriber)
@@ -115,18 +119,38 @@ class User < ActiveRecord::Base
 end
 ```
 
+Note: Be careful with collision of names
+```
+class User
+    # ps_publish %i[name_data:name name:key] # key will be replaced with name_data 
+    ps_publish %i[name_data:name key_data:key] # use alias to avoid collision
+    
+    def key_data
+      name
+    end
+end
+``` 
+
 ## API
-- To perform a callback before publishing message (CRUD)
+- Permit to cancel sync called after create/update/destroy (Before initializing sync service)
+  ```model.ps_skip_callback?(action)```    
+  Note: Return true to cancel sync
+  
+- Callback called before preparing data for sync (Permit to stop sync)
+  ```model.ps_skip_sync?(action)```     
+  Note: return true to cancel sync
+  
+- Callback called before sync (After preparing data)
   ```model.ps_before_sync(action, data_to_deliver)```  
-  Note: If the method returns ```false```, the message will not be published
+  Note: If the method returns ```:cancel```, the sync will be stopped (message will not be published)
 
-- To perform a callback after publishing message (CRUD)
-  ```model.ps_after_sync(action, data_to_deliver)```  
-  Note: If the method returns ```false```, the message will not be published  
+- Callback called after sync
+  ```model.ps_after_sync(action, data_delivered)```  
 
 - Perform sync on demand (:create, :update, :destroy):   
   The target model will receive a notification to perform the indicated action  
-  ```my_model.ps_perform_sync(action_name)```
+  ```my_model.ps_perform_sync(action_name, custom_settings = {})```  
+  * custom_settings: override default settings defined for action_name ({ attrs: [], as_klass: nil, id: nil })
     
 - Class level notification:     
   ```User.ps_class_publish(data, action: action_name, as_klass: custom_klass_name)```

data/lib/pub_sub_model_sync/message_processor.rb

@@ -13,10 +13,13 @@ module PubSubModelSync
     end
 
     def process
+      @failed = false
       log 'processing message'
       listeners = filter_listeners
-      eval_message(listeners) if listeners.any?
-      log 'processed message'
+      return log 'Skipped: No listeners' unless listeners.any?
+
+      eval_message(listeners)
+      log 'processed message' unless @failed
     end
 
     private
@@ -36,6 +39,7 @@ module PubSubModelSync
       model_class.send(listener[:action], data)
     rescue => e
       log("Error listener (#{listener}): #{e.message}", :error)
+      @failed = true
     end
 
     # support for: create, update, destroy
@@ -49,13 +53,13 @@ module PubSubModelSync
       end
     rescue => e
       log("Error listener (#{listener}): #{e.message}", :error)
+      @failed = true
     end
 
     def find_model(listener)
       model_class = listener[:klass].constantize
       identifier = listener[:settings][:id] || :id
-      model_class.where(identifier => attrs[:id]).first ||
-        model_class.new(identifier => attrs[:id])
+      model_class.where(identifier => attrs[:id]).first_or_initialize
     end
 
     def populate_model(model, listener)

data/lib/pub_sub_model_sync/mock_rabbit_service.rb

@@ -30,6 +30,10 @@ module PubSubModelSync
       def topic(*_args)
         @topic ||= MockTopic.new
       end
+
+      def close
+        true
+      end
     end
 
     def create_channel(*_args)

data/lib/pub_sub_model_sync/publisher.rb

@@ -14,12 +14,14 @@ module PubSubModelSync
 
     # @param settings (Hash): { attrs: [], as_klass: nil, id: nil }
     def publish_model(model, action, settings = nil)
+      return if model.ps_skip_sync?(action)
+
       settings ||= model.class.ps_publisher_info(action)
       attributes = build_model_attrs(model, action, settings)
       data = {}
       data = build_model_data(model, settings[:attrs]) if action != :destroy
       res_before = model.ps_before_sync(action, data)
-      return if res_before == false
+      return if res_before == :cancel
 
       connector.publish(data.symbolize_keys, attributes)
       model.ps_after_sync(action, data)

data/lib/pub_sub_model_sync/publisher_concern.rb

@@ -6,18 +6,28 @@ module PubSubModelSync
       base.extend(ClassMethods)
     end
 
-    # Permit to skip a publish callback
-    def ps_skip_for?(_action)
+    # Before initializing sync service (callbacks: after create/update/destroy)
+    def ps_skip_callback?(_action)
       false
     end
 
+    # before preparing data to sync
+    def ps_skip_sync?(_action)
+      false
+    end
+
+    # before delivering data
     def ps_before_sync(_action, _data); end
 
+    # after delivering data
     def ps_after_sync(_action, _data); end
 
-    def ps_perform_sync(action = :create)
+    # To perform sync on demand
+    # @param custom_settings (Hash): { attrs: [], as_klass: nil, id: nil }
+    def ps_perform_sync(action = :create, custom_settings = {})
       service = self.class.ps_publisher_service
-      service.publish_model(self, action, self.class.ps_publisher_info(action))
+      model_settings = self.class.ps_publisher_info(action) || {}
+      service.publish_model(self, action, model_settings.merge(custom_settings))
     end
 
     module ClassMethods
@@ -32,12 +42,14 @@ module PubSubModelSync
         end
       end
 
+      # Publisher info for specific action
       def ps_publisher_info(action = :create)
         PubSubModelSync::Config.publishers.select do |listener|
           listener[:klass] == name && listener[:action] == action
         end.last
       end
 
+      # On demand class level publisher
       def ps_class_publish(data, action:, as_klass: nil)
         as_klass = (as_klass || name).to_s
         ps_publisher_service.publish_data(as_klass, data, action.to_sym)
@@ -51,7 +63,7 @@ module PubSubModelSync
 
       def ps_register_callback(action, info)
         after_commit(on: action) do |model|
-          unless model.ps_skip_for?(action)
+          unless model.ps_skip_callback?(action)
             service = model.class.ps_publisher_service
             service.publish_model(model, action.to_sym, info)
           end

data/lib/pub_sub_model_sync/service_rabbit.rb

@@ -28,9 +28,12 @@ module PubSubModelSync
 
     def publish(data, attributes)
       log("Publishing: #{[data, attributes]}")
-      subscribe_to_queue
-      payload = { data: data, attributes: attributes }
-      topic.publish(payload.to_json, message_settings)
+      deliver_data(data, attributes)
+    # TODO: max retry
+    rescue Timeout::Error => e
+      log("Error publishing (retrying....): #{e.message}", :error)
+      initialize
+      retry
     rescue => e
       info = [data, attributes, e.message, e.backtrace]
       log("Error publishing: #{info}", :error)
@@ -72,5 +75,16 @@ module PubSubModelSync
     def log(msg, kind = :info)
       config.log("Rabbit Service ==> #{msg}", kind)
     end
+
+    def deliver_data(data, attributes)
+      subscribe_to_queue
+      payload = { data: data, attributes: attributes }
+      topic.publish(payload.to_json, message_settings)
+
+      # Ugly fix: "IO timeout when reading 7 bytes"
+      # https://stackoverflow.com/questions/39039129/rabbitmq-timeouterror-io-timeout-when-reading-7-bytes
+      channel.close
+      service.close
+    end
   end
 end

data/lib/pub_sub_model_sync/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pub_sub_model_sync
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Owen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-28 00:00:00.000000000 Z
+date: 2020-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport