pub_sub_model_sync 0.5.8.2 → 0.5.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ae06ef31975d868894ce10558fe100df08710d50ba356318c57e71f5e3e687b
-  data.tar.gz: 3b218c8f1f973a0a4db79d747dd05f0d191dab9a684d15d88b84c7de261eff6f
+  metadata.gz: cb036497d0e5f977a99a7a4b18b766ae910ed8f72775deac8b5e4d862277085b
+  data.tar.gz: 3eac2629bf814e169199bd95fece47eaf032d10a7a2e311a81e46d50255947b2
 SHA512:
-  metadata.gz: aadd4d7095dc9114fd1f645bbe8c6105c0ffc0fff44cd3bcbf10b7d170ccc8c45257d07b2375b88e413ddc0a6b2bcf54293958bde10603dd7485b4adf1bbd2da
-  data.tar.gz: c4fd4aff648b7a9c504e2a7d81982aa1238ef47be387198e11d9c9f3f0325fb719faaa70a2ce93693526dae8ee578e03d4e2a2c62a5ceb24ee59f0d172444cf2
+  metadata.gz: 1e34579693469d286ed7fdb6346ac4e4bdf3c000f98d96a4a4b143a0c9c71b3d5df7c441e9069bea4661f5ac7ea8bf2db41f5ad8c55e41a66585602a4bb3d275
+  data.tar.gz: f13e18fe535720ca299dcd65f76a24c3aae44df0dd3e2515adf5c3095f21d19ad5f16246447d7b15f4c03867495c36b18869cde78e6fbaec573493d340890db6

data/CHANGELOG.md

@@ -1,7 +1,12 @@
 # Change Log
 
+# 0.5.9 (February 10, 2021)
+- feat: reformat :publish and :process methods to include non silence methods
+- feat: add notification key to payloads (can be used for caching strategies)
+
 # 0.5.8.2 (February 05, 2021)
 - fix: restore google pubsub topic settings
+
 # 0.5.8.1 (February 05, 2021)
 - fix: keep message ordering with google pubsub
 

data/Gemfile.lock

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

data/README.md

@@ -50,7 +50,19 @@ And then execute: $ bundle install
     PubSubModelSync::Config.kafka_connection = [["kafka1:9092", "localhost:2121"], { logger: Rails.logger }]
     PubSubModelSync::Config.topic_name = 'sample-topic'
     ```
-    See details here: https://github.com/zendesk/ruby-kafka    
+    See details here: https://github.com/zendesk/ruby-kafka
+    
+    Kafka Confluence example:
+    ```ruby
+      kafka_settings = {
+        sasl_plain_username: '...',
+        sasl_plain_password: '...',
+        ssl_ca_certs_from_system: true,
+        logger: Rails.logger, client_id: 'my-app-name'
+      }
+      PubSubModelSync::Config.kafka_connection = [['...confluent.cloud:9092'], kafka_settings]  
+    ```    
+    Note: You need to create the topic manually on Kafka Confluence
 
 - Add publishers/subscribers to your models (See examples below)
 
@@ -315,6 +327,12 @@ config.debug = true
     PubSubModelSync::MessagePublisher.batch_publish({ same_keys: :use_last_as_first|:use_last|:use_first_as_last|:keep*, same_data: :use_last_as_first*|:use_last|:use_first_as_last|:keep })
 - Add DB table to use as a shield to skip publishing similar notifications or publish partial notifications (similar idea when processing notif)
 - add callback: on_message_received(payload)
+- Sometimes the listener service stops listening, debug idea:
+```subscriber.on_error do
+     log('error gogooogle')
+   end
+   loop{ log(['loooooop:', {l: subscriber.last_error, stopped: subscriber.stopped?, started: subscriber.started?}]); sleep 2 }
+```
 
 ## Q&A
 - Error "could not obtain a connection from the pool within 5.000 seconds"    

data/lib/pub_sub_model_sync/message_processor.rb

@@ -2,7 +2,7 @@
 
 module PubSubModelSync
   class MessageProcessor < PubSubModelSync::Base
-    attr_accessor :payload, :raise_error
+    attr_accessor :payload
 
     # @param payload (Payload): payload to be delivered
     # @Deprecated: def initialize(data, klass, action)
@@ -15,10 +15,16 @@ module PubSubModelSync
       @payload = PubSubModelSync::Payload.new(payload, { klass: klass, action: action })
     end
 
-    def process
+    def process!
       filter_subscribers.each(&method(:run_subscriber))
     end
 
+    def process
+      process!
+    rescue => e
+      notify_error(e)
+    end
+
     private
 
     def run_subscriber(subscriber)
@@ -29,8 +35,6 @@ module PubSubModelSync
         res = config.on_success_processing.call(payload, { subscriber: subscriber })
         log "processed message with: #{payload.inspect}" if res != :skip_log
       end
-    rescue => e
-      raise_error ? raise : print_subscriber_error(e, subscriber)
     end
 
     def processable?(subscriber)
@@ -40,9 +44,9 @@ module PubSubModelSync
     end
 
     # @param error (Error)
-    def print_subscriber_error(error, subscriber)
+    def notify_error(error)
       info = [payload, error.message, error.backtrace]
-      res = config.on_error_processing.call(error, { payload: payload, subscriber: subscriber })
+      res = config.on_error_processing.call(error, { payload: payload })
       log("Error processing message: #{info}", :error) if res != :skip_log
     end
 

data/lib/pub_sub_model_sync/message_publisher.rb

@@ -7,14 +7,20 @@ module PubSubModelSync
         @connector ||= PubSubModelSync::Connector.new
       end
 
+      # Publishes any value to pubsub
+      # @param klass (String): Class name
+      # @param data (Hash): Data to be delivered
+      # @param action (:symbol): action name
       def publish_data(klass, data, action)
-        payload = PubSubModelSync::Payload.new(data, { klass: klass.to_s, action: action.to_sym })
+        attrs = { klass: klass.to_s, action: action.to_sym, key: [klass.to_s, action].join('/') }
+        payload = PubSubModelSync::Payload.new(data, attrs)
         publish(payload)
       end
 
-      # @param model: ActiveRecord model
-      # @param action: (Sym) Action name
-      # @param publisher: (Publisher, optional) Publisher to be used
+      # Publishes model info to pubsub
+      # @param model (ActiveRecord model)
+      # @param action (Sym): Action name
+      # @param publisher (Publisher, optional): Publisher to be used
       def publish_model(model, action, publisher = nil)
         return if model.ps_skip_sync?(action)
 
@@ -27,7 +33,10 @@ module PubSubModelSync
         model.ps_after_sync(action, payload.data)
       end
 
-      def publish(payload, raise_error: false)
+      # Publishes payload to pubsub
+      # @attr payload (PubSubModelSync::Payload)
+      # Raises error if exist
+      def publish!(payload)
         if config.on_before_publish.call(payload) == :cancel
           log("Publish message cancelled: #{payload}") if config.debug
           return
@@ -36,8 +45,14 @@ module PubSubModelSync
         log("Publishing message: #{[payload]}")
         connector.publish(payload)
         config.on_after_publish.call(payload)
+      end
+
+      # Similar to :publish! method
+      # Notifies error via :on_error_publish instead of raising error
+      def publish(payload)
+        publish!(payload)
       rescue => e
-        raise_error ? raise : notify_error(e, payload)
+        notify_error(e, payload)
       end
 
       private

data/lib/pub_sub_model_sync/payload.rb

@@ -6,7 +6,7 @@ module PubSubModelSync
     attr_reader :data, :attributes, :headers
 
     # @param data (Hash: { any value }):
-    # @param attributes (Hash: { klass: string, action: :sym }):
+    # @param attributes (Hash: { klass*: string, action*: :sym, key?: string }):
     def initialize(data, attributes, headers = {})
       @data = data
       @attributes = attributes
@@ -31,16 +31,14 @@ module PubSubModelSync
     # Process payload data
     #   (If error will raise exception and wont call on_error_processing callback)
     def process!
-      process do |publisher|
-        publisher.raise_error = true
-      end
+      publisher = PubSubModelSync::MessageProcessor.new(self)
+      publisher.process!
     end
 
     # Process payload data
     #   (If error will call on_error_processing callback)
     def process
       publisher = PubSubModelSync::MessageProcessor.new(self)
-      yield(publisher) if block_given?
       publisher.process
     end
 
@@ -48,7 +46,7 @@ module PubSubModelSync
     #   (If error will raise exception and wont call on_error_publish callback)
     def publish!
       klass = PubSubModelSync::MessagePublisher
-      klass.publish(self, raise_error: true)
+      klass.publish!(self)
     end
 
     # Publish payload to pubsub

data/lib/pub_sub_model_sync/publisher.rb

@@ -11,6 +11,7 @@ module PubSubModelSync
       @as_klass = as_klass || klass
     end
 
+    # Builds the payload with model information defined for :action (:create|:update|:destroy)
     def payload(model, action)
       PubSubModelSync::Payload.new(payload_data(model), payload_attrs(model, action))
     end
@@ -29,7 +30,11 @@ module PubSubModelSync
     end
 
     def payload_attrs(model, action)
-      { klass: (as_klass || model.class.name).to_s, action: action.to_sym }
+      {
+        klass: (as_klass || model.class.name).to_s,
+        action: action.to_sym,
+        key: [model.class.name, action, model.id].join('/')
+      }
     end
   end
 end

data/lib/pub_sub_model_sync/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pub_sub_model_sync
 version: !ruby/object:Gem::Version
-  version: 0.5.8.2
+  version: 0.5.9
 platform: ruby
 authors:
 - Owen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails