pub_sub_model_sync 1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caaffd468399e03dbf5582bf6973339ec61348a6dcc67a87bda1d930f9271aae
-  data.tar.gz: 9db2cb5f4a70c218d720130761a24ad7f6450531d845f9517e74968f409c9743
+  metadata.gz: ec006984fe2bf9c33e9992facdd25aa9fdaa3494b6bcaf656592593829429017
+  data.tar.gz: 8ca60de929eb7465c95ff819682af73a9094c60294661e5c823394aeb02ed6a9
 SHA512:
-  metadata.gz: ac6c2b0087e411969e4a0fbe6fa4aa57e3fe46b6ff93f4d675e2a213cd0fd75786b5e16e1a4c1df6aee92296eac0c94a054a6b62543a0f7f643ba2ea0bc8ff7b
-  data.tar.gz: 9816c7cedd0d6289d0d73a55f35ede63a46bca7f38805c4c566012fed04a58595498a80fd272ce89b617e34b1d1487ff2ee7f6e050c9712bfd6d75b364ad910a
+  metadata.gz: d799e1e27c071e18d5d7e15460a7d481b9991b469599356e23c86669fd8de95046b236d4596a5fbc22e93d278548d2b17255262e4f5c67eece7a4f6898ff03ca
+  data.tar.gz: 89f6e95f040919994a0f0397b61b09ac83567b69472ce41aa722b240dba66e8a66d4e7a60cedb0de5f59d671525c4d7ad38b02255e558728f8e34e71e227e1e1

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+# 1.2.0 (October 28, 2021)
+- feat: rename Payload `:key` into `:internal_key` to avoid confusions while debugging
+
+# 1.1.1 (October 25, 2021)
+- feat: include `ordering_key topic_name` when delivering a notification for debugging purposes
+- doc: improve docs
+
+# 1.1.0 (October 25, 2021)
+- feat: change `transactions_max_buffer` default value to 1 to deliver notifications once they were called
+- feat: use `after_commit` instead of `before_commit` callback and remove the horrible AR patch for rails 4
+
+# 1.0.1 (August 20, 2021)
+- refactor: improve service exit when running in k8s
+
 # 1.0 (June 13, 2021)
 This version includes many changes that was refactored from previous version, and thus it needs manual changes to migrate into this version. 
 - Refactor: Subscribers param renamed `from_action` into `to_action` and added support for block or lambda 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pub_sub_model_sync (1.0)
+    pub_sub_model_sync (1.2.0)
       rails
 
 GEM
@@ -116,7 +116,6 @@ GEM
       google-cloud-errors (~> 1.0)
       grpc-google-iam-v1 (>= 0.6.10, < 2.0)
     google-protobuf (3.17.0)
-    google-protobuf (3.17.0-x86_64-linux)
     googleapis-common-protos (1.3.11)
       google-protobuf (~> 3.14)
       googleapis-common-protos-types (>= 1.0.6, < 2.0)
@@ -133,9 +132,6 @@ GEM
     grpc (1.37.1)
       google-protobuf (~> 3.15)
       googleapis-common-protos-types (~> 1.0)
-    grpc (1.37.1-x86_64-linux)
-      google-protobuf (~> 3.15)
-      googleapis-common-protos-types (~> 1.0)
     grpc-google-iam-v1 (0.6.11)
       google-protobuf (~> 3.14)
       googleapis-common-protos (>= 1.3.11, < 2.0)
@@ -158,8 +154,6 @@ GEM
     nio4r (2.5.7)
     nokogiri (1.11.3-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.11.3-x86_64-linux)
-      racc (~> 1.4)
     os (1.1.1)
     parallel (1.20.1)
     parser (3.0.1.1)
@@ -266,4 +260,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.2.17
+   2.2.29

data/README.md

@@ -3,8 +3,8 @@
 ![Ruby badge](https://img.shields.io/badge/Ruby-2.4+-success.png)
 ![Production badge](https://img.shields.io/badge/Production-ready-success.png)
 
-This gem permits to sync automatically models and custom data between multiple Rails applications by publishing notifications via pubsub (Google PubSub, RabbitMQ, or Apache Kafka) and automatically processed by all connected applications. Out of the scope, this gem includes transactions to keep Data consistency by processing notifications in the order they were delivered. 
-These notifications use JSON format to easily be decoded by subscribers (Rails applications and even other languages) 
+This gem permits to sync automatically models and custom data between multiple Rails applications by publishing notifications via pubsub (Google PubSub, RabbitMQ, or Apache Kafka) and automatically processed by all connected applications. Out of the scope, this gem includes transactions to keep Data consistency by processing notifications in the order they were delivered.     
+These notifications use JSON format to easily be decoded by subscribers (Rails applications and even other languages, soon for [Cristal-lang](https://crystal-lang.org/)) 
 
 - [**PubSubModelSync**](#pubsubmodelsync)
   - [**Features**](#features)
@@ -104,6 +104,7 @@ And then execute: $ bundle install
 ![Diagram](/docs/notifications-diagram.png?raw=true)
 
 ## **Examples**
+See sample apps in [/samples](/samples/)   
 ### **Basic Example**
 ```ruby
 # App 1 (Publisher)
@@ -244,7 +245,7 @@ PubSubModelSync::Payload.new({ ids: [my_user.id] }, { klass: 'User', action: :ba
   - `method_name` (Symbol, optional) method to be called to process action callback, sample: `def my_method(action) ... end`
   - `block` (Proc, optional) Block to be called to process action callback, sample: `{ |action| ... }`     
   
-  **Note1**: Due to rails callback ordering, this method uses `before_commit` callback when creating or updating models to ensure expected notifications order (More details [**here**](#transactions)).    
+  **Note1**: Due to rails callback ordering, this method uses `after_commit on: action {...}` callback when creating or updating models to ensure expected notifications order (More details [**here**](#transactions)).    
   **Note2**: Due to rails callback ordering, this method uses `after_destroy` callback when destroying models to ensure the expected notifications order.    
    
 - `ps_publish(action, data: {}, mapping: [], headers: {}, as_klass: nil)` Delivers an instance notification via pubsub
@@ -310,11 +311,14 @@ Any notification before delivering is transformed as a Payload for a better port
     - `klass`: (String) Notification class name
     - `mode`: (Symbol: `:model`|`:class`) Kind of notification
   * `headers`: (Hash) Notification settings that defines how the notification will be processed or delivered. 
-    - `key`: (String, optional) identifier of the payload, default: `<klass_name>/<action>` when class message, `<model.class.name>/<action>/<model.id>` when model message (Useful for caching techniques).
-    - `ordering_key`: (String, optional): messages with the same value are processed in the same order they were delivered, default: `klass_name` when class message, `<model.class.name>/<model.id>` when instance message.     
-      Note: Final `ordering_key` is calculated by this way: `payload.headers[:forced_ordering_key] || current_transaction&.key || payload.headers[:ordering_key]`
-    - `topic_name`: (String|Array<String>, optional): Specific topic name (can be seen as a channel) to be used when delivering the message (default first topic from config).
-    - `forced_ordering_key`: (String, optional): Will force to use this value as the `ordering_key`, even withing transactions. Default `nil`.
+    - `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]`         
+    - `internal_key`: (String, optional) Internal identifier of the payload, default: `<model.class.name>/<action>/<model.id>` when model notification and `<klass_name>/<action>` when class notification (Useful for caching techniques).    
+    - `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`.
+    - `app_key`: (Auto calculated): Name of the application who delivered the notification.   
+    - `uuid`: (Auto calculated): Unique notification identifier (Very useful when debugging).   
+Note: To reduce Payload size, some header info are not delivered (Enable debug mode to deliver all payload info). 
   
 - Actions
   ```ruby
@@ -339,21 +343,21 @@ Any notification before delivering is transformed as a Payload for a better port
       ps_after_action([:create, :update, :destroy]) { |action| ps_publish(action, mapping: %i[id user_id title]) }
     end
     ```
-    - When created (all notifications use the same ordering key to be processed in the same order)
+    - When created (all notifications use the same ordering_key to be processed in the same order)
       ```ruby
         user = User.create!(name: 'test', posts_attributes: [{ title: 'Post 1' }, { title: 'Post 2' }])
         # notification #1 => <Payload data: {id: 1, name: 'sample'}, info: { klass: 'User', action: :create, mode: :model }, headers: { ordering_key = `User/1` }>
         # notification #2 => <Payload data: {id: 1, title: 'Post 1', user_id: 1}, info: { klass: 'Post', action: :create, mode: :model }, headers: { ordering_key = `User/1` }>
         # notification #3 => <Payload data: {id: 2, title: 'Post 2', user_id: 1}, info: { klass: 'Post', action: :create, mode: :model }, headers: { ordering_key = `User/1` }>
       ```
-    - When updated (all notifications use the same ordering key to be processed in the same order)
+    - When updated (all notifications use the same ordering_key to be processed in the same order)
       ```ruby
         user.update!(name: 'changed', posts_attributes: [{ id: 1, title: 'Post 1C' }, { id: 2, title: 'Post 2C' }])
         # notification #1 => <Payload data: {id: 1, name: 'changed'}, info: { klass: 'User', action: :update, mode: :model }, headers: { ordering_key = `User/1` }>
         # notification #2 => <Payload data: {id: 1, title: 'Post 1C', user_id: 1}, info: { klass: 'Post', action: :update, mode: :model }, headers: { ordering_key = `User/1` }>
         # notification #3 => <Payload data: {id: 2, title: 'Post 2C', user_id: 1}, info: { klass: 'Post', action: :update, mode: :model }, headers: { ordering_key = `User/1` }>
       ```
-    - When destroyed (all notifications use the same ordering key to be processed in the same order)   
+    - When destroyed (all notifications use the same ordering_key to be processed in the same order)   
       **Note**: The notifications order were reordered in order to avoid inconsistency in other apps 
       ```ruby
       user.destroy!
@@ -367,10 +371,8 @@ Any notification before delivering is transformed as a Payload for a better port
   
   - 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:` (Boolean, default: `PubSubModelSync::Config.transactions_max_buffer`)     
-        If true: will save all notifications and deliver all them when transaction has successfully finished. If transaction has failed, then all saved notifications will be discarded (not delivered).    
-        If false: will deliver all notifications immediately (no way to rollback notifications if transaction has failed)  
+    - `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).     
     Sample:
     ```ruby
       PubSubModelSync::MessagePublisher::transaction('my-custom-key') do
@@ -529,7 +531,7 @@ config.debug = true
     Topic name(s) to be used to listen all notifications from when listening. Additionally first topic name is used as the default topic name when publishing a notification. 
 - `.subscription_name = "my-app-1"`:  (String, default Rails.application.name)     
     Subscriber's identifier which helps to: 
-    * skip self messages
+    * skip self notifications
     * continue the sync from the last synced notification when service was restarted.
 - `.default_topic_name = "my_topic"`: (String|Array<String>, optional(default first topic from `topic_name`))     
     Topic name used as the default topic if not defined in the payload when publishing a notification
@@ -538,29 +540,34 @@ config.debug = true
 - ```.logger = Rails.logger```
     (Logger) => define custom logger
 - ```.on_before_processing = ->(payload, {subscriber:}) { puts payload }```
-    (Proc) => called before processing received message (:cancel can be returned to skip processing)
+    (Proc) => called before processing a received notification (:cancel can be returned to skip processing)
 - ```.on_success_processing = ->(payload, {subscriber:}) { puts payload }```
-    (Proc) => called when a message was successfully processed
+    (Proc) => called when a notification was successfully processed
 - ```.on_error_processing = ->(exception, {payload:, subscriber:}) { payload.delay(...).process! }```
-    (Proc) => called when a message failed when processing (delayed_job or similar can be used for retrying)
+    (Proc) => called when a notification has failed when processing (delayed_job or similar can be used for retrying)
 - ```.on_before_publish = ->(payload) { puts payload }```
-    (Proc) => called before publishing a message (:cancel can be returned to skip publishing)
+    (Proc) => called before publishing a notification (:cancel can be returned to skip publishing)
 - ```.on_after_publish = ->(payload) { puts payload }```
-    (Proc) => called after publishing a message
+    (Proc) => called after publishing a notification
 - ```.on_error_publish = ->(exception, {payload:}) { payload.delay(...).publish! }```
-    (Proc) => called when failed publishing a message (delayed_job or similar can be used for retrying)
-- ```.transactions_max_buffer = 100``` (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
-- ```.enable_rails4_before_commit = true``` (true*|false) When false will disable rails 4 hack compatibility and then CRUD notifications will be prepared using `after_commit` callback instead of `before_commit` (used in `ps_after_action(...)`) which will not rollback sql transactions if failed when publishing pubsub notification.
+    (Proc) => called when failed publishing a notification (delayed_job or similar can be used for retrying)
+- ```.transactions_max_buffer = 1``` (Integer, default 1) Controls the maximum quantity of notifications to be enqueued to the transaction-buffer before delivering them and thus adds the ability to rollback notifications if the transaction fails.        
+    Once this quantity of notifications is reached, then all notifications of the current transaction will immediately be delivered (can be customized per transaction).    
+    Note: There is no way to rollback delivered notifications if current transaction fails later.      
+    Note2: Only notifications from the buffer can be rollbacked if the current transaction has failed.     
 
 ## **TODO**
 - Auto publish update only if payload has changed (see ways to compare previous payload vs new payload)
-- Improve transactions to exclude similar messages by klass and action. Sample:
+- Improve transactions to exclude similar notifications by klass and action. Sample:
     ```PubSubModelSync::MessagePublisher.transaction(key, { 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 prevent publishing similar notifications and publish partial notifications (similar idea when processing notif)
 - Last notification is not being delivered immediately in google pubsub (maybe force with timeout 10secs and service.deliver_messages)
 - Update folder structure
 - Services support to deliver multiple payloads from transactions
+- Fix deprecation warnings: pub_sub_model_sync/service_google.rb:39: warning: Splitting the last argument into positional and keyword parameters is deprecated
+- Add if/unless to ps_after_action
+- Add subscription liveness checker using thread without db connection to check periodically pending notifications from google pubsub
+- Unify .stop() and 'Listener stopped' 
 
 ## **Q&A**
 - I'm getting error "could not obtain a connection from the pool within 5.000 seconds"... what does this mean?

data/lib/pub_sub_model_sync/config.rb

@@ -8,8 +8,7 @@ module PubSubModelSync
     # customizable callbacks
     cattr_accessor(:debug) { false }
     cattr_accessor :logger # LoggerInst
-    cattr_accessor(:transactions_max_buffer) { 100 }
-    cattr_accessor(:enable_rails4_before_commit) { Rails::VERSION::MAJOR == 4 }
+    cattr_accessor(:transactions_max_buffer) { 1 }
 
     cattr_accessor(:on_before_processing) { ->(_payload, _info) {} } # return :cancel to skip
     cattr_accessor(:on_success_processing) { ->(_payload, _info) {} }

data/lib/pub_sub_model_sync/message_publisher.rb

@@ -31,7 +31,7 @@ module PubSubModelSync
       end
 
       # Starts a new transaction
-      # @param key (String|Nil)
+      # @param key (String, Nil)
       # @return (Transaction)
       def init_transaction(key, settings = {})
         new_transaction = PubSubModelSync::Transaction.new(key, settings)
@@ -54,9 +54,9 @@ module PubSubModelSync
         publish(payload)
       end
 
-      # @param model (ActiveRecord::Base)
-      # @param action (Symbol: @see PublishConcern::ps_publish)
-      # @param settings (Hash: @see PayloadBuilder.settings)
+      # @param model (ActiveRecord::Base,PubSubModelSync::PublisherConcern)
+      # @param action (Symbol,String @see PublishConcern::ps_publish)
+      # @param settings (Hash @see PayloadBuilder.settings)
       def publish_model(model, action, settings = {})
         log("Building payload for: #{[model, action].inspect}") if config.debug
         payload = PubSubModelSync::PayloadBuilder.new(model, action, settings).call
@@ -80,7 +80,7 @@ module PubSubModelSync
       end
 
       def connector_publish(payload)
-        log("Publishing message #{payload.inspect}...") if config.debug
+        log("Publishing message #{[payload]}...") if config.debug
         connector.publish(payload)
         log("Published message: #{[payload]}")
         config.on_after_publish.call(payload)
@@ -99,7 +99,7 @@ module PubSubModelSync
 
       def ensure_publish(payload)
         cancelled = config.on_before_publish.call(payload) == :cancel
-        log("Publish cancelled by config.on_before_publish: #{payload}") if config.debug && cancelled
+        log("Publish cancelled by config.on_before_publish: #{[payload]}") if config.debug && cancelled
         !cancelled
       end
 
@@ -110,7 +110,7 @@ module PubSubModelSync
       def ensure_model_publish(model, action, payload)
         res_before = model.ps_before_publish(action, payload)
         cancelled = res_before == :cancel
-        log("Publish cancelled by model.ps_before_publish: #{payload}") if config.debug && cancelled
+        log("Publish cancelled by model.ps_before_publish: #{[payload]}") if config.debug && cancelled
         !cancelled
       end
 

data/lib/pub_sub_model_sync/payload.rb

@@ -86,7 +86,7 @@ module PubSubModelSync
 
     def build_headers
       headers[:app_key] ||= PubSubModelSync::Config.subscription_key
-      headers[:key] ||= [klass, action].join('/')
+      headers[:internal_key] ||= [klass, action].join('/')
       headers[:ordering_key] ||= klass
       headers[:uuid] ||= SecureRandom.uuid
     end

data/lib/pub_sub_model_sync/payload_builder.rb

@@ -4,7 +4,7 @@ module PubSubModelSync
   class PayloadBuilder < PubSubModelSync::Base
     attr_accessor :model, :action, :data, :mapping, :headers, :as_klass
 
-    # @param model (ActiveRecord::Base)
+    # @param model (ActiveRecord::Base,PubSubModelSync::PublisherConcern)
     # @param action (@see PublishConcern::ps_publish)
     # @param settings (@see PublishConcern::ps_publish): { data:, mapping:, headers:, as_klass: }
     def initialize(model, action, settings = {})
@@ -43,8 +43,8 @@ module PubSubModelSync
 
     def headers_data
       klass_name = model.class.name
-      key = [klass_name, action, model.id || SecureRandom.uuid].join('/')
-      def_data = { ordering_key: self.class.ordering_key_for(model), key: key }
+      internal_key = [klass_name, action, model.id || SecureRandom.uuid].join('/')
+      def_data = { ordering_key: self.class.ordering_key_for(model), internal_key: internal_key }
       def_data.merge(compute_value(headers))
     end
 

data/lib/pub_sub_model_sync/publisher_concern.rb

@@ -18,14 +18,14 @@ module PubSubModelSync
     alias ps_after_sync ps_after_publish # @deprecated
 
     # Delivers a notification via pubsub
-    # @param action (Sym|String) Sample: create|update|save|destroy|<any_other_key>
+    # @param action (Symbol,String) Sample: create|update|save|destroy|<any_other_key>
     # @param mapping? (Array<String>) If present will generate data using the mapping and added to the payload.
     #   Sample: ["id", "full_name:name"]
-    # @param data? (Hash|Symbol|Proc)
+    # @param data? (Hash,Symbol,Proc)
     #   Hash: Data to be added to the payload
     #   Symbol: Method name to be called to retrieve payload data (must return a hash value, receives :action name)
     #   Proc: Block to be called to retrieve payload data
-    # @param headers? (Hash|Symbol|Proc): (All available attributes in Payload.headers)
+    # @param headers? (Hash,Symbol,Proc): (All available attributes in @Payload.headers)
     #   Hash: Data that will be merged with default header values
     #   Symbol: Method name that will be called to retrieve header values (must return a hash, receives :action name)
     #   Proc: Block to be called to retrieve header values
@@ -57,7 +57,7 @@ module PubSubModelSync
         klass.publish_data((as_klass || name).to_s, data, action.to_sym, headers: headers)
       end
 
-      # @param crud_actions (Symbol|Array<Symbol>): :create, :update, :destroy
+      # @param crud_actions (Symbol,Array<Symbol>): :create, :update, :destroy
       # @param method_name (Symbol, optional) method to be called
       def ps_after_action(crud_actions, method_name = nil, &block)
         actions = Array(crud_actions).map(&:to_sym)
@@ -67,7 +67,7 @@ module PubSubModelSync
           if action == :destroy
             after_destroy { instance_exec(action, &callback) }
           else
-            ps_define_commit_action(action, callback)
+            send(:after_commit, on: action) { instance_exec(action, &callback) }
           end
         end
       end
@@ -80,15 +80,6 @@ module PubSubModelSync
 
       private
 
-      def ps_define_commit_action(action, callback)
-        if PubSubModelSync::Config.enable_rails4_before_commit # rails 4 compatibility
-          define_method("ps_before_#{action}_commit") { instance_exec(action, &callback) }
-        else
-          commit_name = respond_to?(:before_commit) ? :before_commit : :after_commit
-          send(commit_name, on: action) { instance_exec(action, &callback) }
-        end
-      end
-
       # Initialize calls to start and end pub_sub transactions and deliver all them in the same order
       def ps_init_transaction_callbacks
         start_transaction = lambda do

data/lib/pub_sub_model_sync/railtie.rb

@@ -13,7 +13,6 @@ module PubSubModelSync
     end
 
     configure do
-      require 'pub_sub_model_sync/initializers/before_commit' if PubSubModelSync::Config.enable_rails4_before_commit
     end
   end
 end

data/lib/pub_sub_model_sync/runner.rb

@@ -3,7 +3,6 @@
 require 'active_support/core_ext/module'
 module PubSubModelSync
   class Runner
-    class ShutDown < StandardError; end
     delegate :preload_listeners, to: :class
     attr_accessor :connector
 
@@ -12,11 +11,10 @@ module PubSubModelSync
     end
 
     def run
+      at_exit { connector.stop }
       trap_signals!
       preload_listeners
       start_listeners
-    rescue ShutDown
-      connector.stop
     end
 
     def self.preload_listeners
@@ -32,8 +30,8 @@ module PubSubModelSync
 
     def trap_signals!
       handler = proc do |signal|
-        puts "received #{Signal.signame(signal)}"
-        raise ShutDown
+        puts "PS_MSYNC ==> received #{Signal.signame(signal)}"
+        exit
       end
       %w[INT QUIT TERM].each { |signal| Signal.trap(signal, handler) }
     end

data/lib/pub_sub_model_sync/service_base.rb

@@ -24,7 +24,7 @@ module PubSubModelSync
     # @return (String): Json Format
     def encode_payload(payload)
       data = payload.to_h
-      not_important_keys = %i[ordering_key topic_name forced_ordering_key]
+      not_important_keys = %i[forced_ordering_key]
       reduce_payload_size = !config.debug
       data[:headers].except!(*not_important_keys) if reduce_payload_size
       data.to_json

data/lib/pub_sub_model_sync/service_google.rb

@@ -44,7 +44,7 @@ module PubSubModelSync
 
     def stop
       log('Listener stopping...')
-      subscribers.each(&:stop!)
+      (subscribers || []).each(&:stop!)
     end
 
     private

data/lib/pub_sub_model_sync/service_kafka.rb

@@ -76,8 +76,8 @@ module PubSubModelSync
     end
 
     # Check topic existence, create if missing topic
-    # @param names (Array<String>|String)
-    # @return (Array|String) return @param names
+    # @param names (Array<String>,String)
+    # @return (Array,String) return @param names
     def ensure_topics(names)
       missing_topics = Array(names) - (@known_topics || service.topics)
       missing_topics.each do |name|

data/lib/pub_sub_model_sync/subscriber_concern.rb

@@ -9,16 +9,16 @@ module PubSubModelSync
     end
 
     module ClassMethods
-      # @param actions (Symbol|Array<Symbol>) Notification.action name: save|create|update|destroy|<any_other_action>
+      # @param actions (Symbol,Array<Symbol>) Notification.action name: save|create|update|destroy|<any_other_action>
       # @param mapping (Array<String,Symbol>) Attributes mapping with aliasing support, sample: ["id", "full_name:name"]
       # @param settings (Hash<:from_klass, :to_action, :id, :if, :unless>)
       #   from_klass (String) Notification.class name
-      #   to_action (Symbol|Proc):
+      #   to_action (Symbol,Proc):
       #     Symbol: Method to process the notification
       #     Proc: Block to process the notification
-      #   id (Symbol|Array<Symbol|String>) attribute(s) DB primary identifier(s). Supports for mapping format.
-      #   if (Symbol|Proc|Array<Symbol>) Method or block called as the conformation before calling the callback
-      #   unless (Symbol|Proc|Array<Symbol>) Method or block called as the negation before calling the callback
+      #   id (Symbol,Array<Symbol,String>) attribute(s) DB primary identifier(s). Supports for mapping format.
+      #   if (Symbol,Proc,Array<Symbol>) Method or block called as the conformation before calling the callback
+      #   unless (Symbol,Proc,Array<Symbol>) Method or block called as the negation before calling the callback
       def ps_subscribe(actions, mapping = [], settings = {}, &block)
         settings[:to_action] ||= block if block
         Array(actions).map do |action|

data/lib/pub_sub_model_sync/transaction.rb

@@ -5,7 +5,7 @@ module PubSubModelSync
     PUBLISHER_KLASS = PubSubModelSync::MessagePublisher
     attr_accessor :key, :payloads, :max_buffer, :root, :children, :finished
 
-    # @param key (String|nil) Transaction key, if empty will use the ordering_key from first payload
+    # @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

data/lib/pub_sub_model_sync/version.rb

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

data/samples/README.md

@@ -6,7 +6,7 @@ This is a sample to sync information between rails applications using RabbitMQ
   ```docker network create shared_app_services```
   
 * Start RabbitMQ server   
-  ```docker-compose up pubsub```
+  ```cd samples/app1 && docker-compose up pubsub```
 
 * In another tab access to App1 to publish notifications (Wait for step 2)  
   - Access to the application    

data/samples/app1/Gemfile

@@ -18,7 +18,7 @@ gem 'bootsnap', '>= 1.4.4', require: false
 # Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
 # gem 'rack-cors'
 
-gem 'pub_sub_model_sync'
+gem 'pub_sub_model_sync', '>= 1.0'
 gem 'bunny' # to use rabbit-mq pub/sub service
 gem 'annotate'
 

data/samples/app1/Gemfile.lock

@@ -96,7 +96,7 @@ GEM
     nokogiri (1.11.3)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
-    pub_sub_model_sync (1.0.beta1)
+    pub_sub_model_sync (1.0)
       rails
     puma (5.3.1)
       nio4r (~> 2.0)
@@ -160,7 +160,7 @@ DEPENDENCIES
   bunny
   byebug
   listen (~> 3.3)
-  pub_sub_model_sync (= 1.0.beta2)
+  pub_sub_model_sync (>= 1.0)
   puma (~> 5.0)
   rails (~> 6.1.3, >= 6.1.3.2)
   spring
@@ -168,4 +168,4 @@ DEPENDENCIES
   tzinfo-data
 
 BUNDLED WITH
-   2.1.4
+   2.2.17

data/samples/app1/config/master.key

@@ -0,0 +1 @@
+f76db08751757e296d844ca18dcdb0a1

data/samples/app2/Gemfile

@@ -18,7 +18,7 @@ gem 'bootsnap', '>= 1.4.4', require: false
 # Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
 # gem 'rack-cors'
 
-gem 'pub_sub_model_sync'
+gem 'pub_sub_model_sync', '>= 1.0'
 gem 'bunny' # to use rabbit-mq pub/sub service
 gem 'annotate'
 

data/samples/app2/Gemfile.lock

@@ -96,7 +96,7 @@ GEM
     nokogiri (1.11.3)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
-    pub_sub_model_sync (1.0.beta1)
+    pub_sub_model_sync (1.0)
       rails
     puma (5.3.1)
       nio4r (~> 2.0)
@@ -160,7 +160,7 @@ DEPENDENCIES
   bunny
   byebug
   listen (~> 3.3)
-  pub_sub_model_sync (= 1.0.beta2)
+  pub_sub_model_sync (>= 1.0)
   puma (~> 5.0)
   rails (~> 6.1.3, >= 6.1.3.2)
   spring
@@ -168,4 +168,4 @@ DEPENDENCIES
   tzinfo-data
 
 BUNDLED WITH
-   2.1.4
+   2.2.17

data/samples/app2/config/master.key

@@ -0,0 +1 @@
+ca702da1b8c8f8405ed03739ca90b0e5

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pub_sub_model_sync
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.2.0
 platform: ruby
 authors:
 - Owen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-13 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -111,7 +111,6 @@ files:
 - lib/pub_sub_model_sync/base.rb
 - lib/pub_sub_model_sync/config.rb
 - lib/pub_sub_model_sync/connector.rb
-- lib/pub_sub_model_sync/initializers/before_commit.rb
 - lib/pub_sub_model_sync/message_processor.rb
 - lib/pub_sub_model_sync/message_publisher.rb
 - lib/pub_sub_model_sync/mock_google_service.rb
@@ -134,8 +133,6 @@ files:
 - lib/pub_sub_model_sync/version.rb
 - pub_sub_model_sync.gemspec
 - samples/README.md
-- samples/app1/.gitattributes
-- samples/app1/.gitignore
 - samples/app1/Dockerfile
 - samples/app1/Gemfile
 - samples/app1/Gemfile.lock
@@ -168,6 +165,7 @@ files:
 - samples/app1/config/initializers/pubsub.rb
 - samples/app1/config/initializers/wrap_parameters.rb
 - samples/app1/config/locales/en.yml
+- samples/app1/config/master.key
 - samples/app1/config/puma.rb
 - samples/app1/config/routes.rb
 - samples/app1/config/spring.rb
@@ -177,8 +175,6 @@ files:
 - samples/app1/db/seeds.rb
 - samples/app1/docker-compose.yml
 - samples/app1/log/.keep
-- samples/app2/.gitattributes
-- samples/app2/.gitignore
 - samples/app2/Dockerfile
 - samples/app2/Gemfile
 - samples/app2/Gemfile.lock
@@ -211,9 +207,11 @@ files:
 - samples/app2/config/initializers/pubsub.rb
 - samples/app2/config/initializers/wrap_parameters.rb
 - samples/app2/config/locales/en.yml
+- samples/app2/config/master.key
 - samples/app2/config/puma.rb
 - samples/app2/config/routes.rb
 - samples/app2/config/spring.rb
+- samples/app2/db/development.sqlite3
 - samples/app2/db/migrate/20210513080956_create_customers.rb
 - samples/app2/db/migrate/20210513135203_create_posts.rb
 - samples/app2/db/schema.rb

data/lib/pub_sub_model_sync/initializers/before_commit.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-# Rails 4 backward compatibility (Add "simple" ps_before_*_commit callbacks)
-ActiveRecord::ConnectionAdapters::RealTransaction.class_eval do
-  alias_method :commit_without_before_commit, :commit
-
-  def commit
-    call_before_commit_records if PubSubModelSync::Config.enable_rails4_before_commit
-    commit_without_before_commit
-  end
-
-  private
-
-  def call_before_commit_records
-    ite = records.uniq
-    ite.each do |record|
-      action = record.previous_changes.include?(:id) ? :create : :update
-      action = :destroy if record.destroyed?
-      callback_name = "ps_before_#{action}_commit".to_sym
-      record.send(callback_name) if record.respond_to?(callback_name)
-    end
-  end
-end

data/samples/app1/.gitattributes

@@ -1,8 +0,0 @@
-# See https://git-scm.com/docs/gitattributes for more about git attribute files.
-
-# Mark the database schema as having been generated.
-db/schema.rb linguist-generated
-
-
-# Mark any vendored files as having been vendored.
-vendor/* linguist-vendored

data/samples/app1/.gitignore

@@ -1,28 +0,0 @@
-# See https://help.github.com/articles/ignoring-files for more about ignoring files.
-#
-# If you find yourself ignoring temporary files generated by your text editor
-# or operating system, you probably want to add a global ignore instead:
-#   git config --global core.excludesfile '~/.gitignore_global'
-
-# Ignore bundler config.
-/.bundle
-
-# Ignore the default SQLite database.
-/db/*.sqlite3
-/db/*.sqlite3-*
-
-# Ignore all logfiles and tempfiles.
-/log/*
-/tmp/*
-!/log/.keep
-!/tmp/.keep
-
-# Ignore pidfiles, but keep the directory.
-/tmp/pids/*
-!/tmp/pids/
-!/tmp/pids/.keep
-
-.byebug_history
-
-# Ignore master key for decrypting credentials and more.
-/config/master.key

data/samples/app2/.gitattributes

@@ -1,8 +0,0 @@
-# See https://git-scm.com/docs/gitattributes for more about git attribute files.
-
-# Mark the database schema as having been generated.
-db/schema.rb linguist-generated
-
-
-# Mark any vendored files as having been vendored.
-vendor/* linguist-vendored

data/samples/app2/.gitignore

@@ -1,28 +0,0 @@
-# See https://help.github.com/articles/ignoring-files for more about ignoring files.
-#
-# If you find yourself ignoring temporary files generated by your text editor
-# or operating system, you probably want to add a global ignore instead:
-#   git config --global core.excludesfile '~/.gitignore_global'
-
-# Ignore bundler config.
-/.bundle
-
-# Ignore the default SQLite database.
-/db/*.sqlite3
-/db/*.sqlite3-*
-
-# Ignore all logfiles and tempfiles.
-/log/*
-/tmp/*
-!/log/.keep
-!/tmp/.keep
-
-# Ignore pidfiles, but keep the directory.
-/tmp/pids/*
-!/tmp/pids/
-!/tmp/pids/.keep
-
-.byebug_history
-
-# Ignore master key for decrypting credentials and more.
-/config/master.key