pub_sub_model_sync 1.0.beta → 1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 906ba0cfabbe20b6043f277795255a587f4e3f6c535f602ffb6be1dbca6e7d1f
-  data.tar.gz: 27e291f2bd5054cb1d3b9724d0e3a7e228ff29a833c0905af9ead58b93f84e6c
+  metadata.gz: 13b5f627ef31865359d033508451bca2297f99cf2cba31d2d3b1a0edb5e0120e
+  data.tar.gz: e273ff16f01bda1cae1ec2d78b8fd33174dadccdc78b4430503bd5ae40a35988
 SHA512:
-  metadata.gz: 6982c9ad491fcba5967a42e26e922d9d19aa6e03ca48ea84c174301ca133e5890dffdf6ce138624610c341b7fb26bb2131495f7617b9fbe819ef28e8d10324b3
-  data.tar.gz: 75274215f707809a35f44d26c31ec6543a8487924c8e28b860dd27422348a5071874dc969c36fb9ce6f5a4d197872e2470b97f5983ae199d900438d2e8602178
+  metadata.gz: 8bbff15963073476121be61b70abc9899b34c88f12d4b0c75e658f9554cb97b7a6adfeeff7eb1b265fcdd46d3ab2a9bfe97274fc9cd2d67b3a7192d28cf52fb8
+  data.tar.gz: dea3272e6930728975dfa140e5b49355ce799c9361d892f0d2acd5a665a699f16383a930db714f64746f03185726abaa1a477da1ae03a3ca22730e750397dccc

data/.rubocop.yml

@@ -7,8 +7,7 @@ AllCops:
     - 'Gemfile'
     - 'Rakefile'
     - 'bin/*'
-    - 'blog/*'
-    - 'blog/**/*'
+    - 'samples/**/*'
 
 Metrics/BlockLength:
   Exclude:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pub_sub_model_sync (1.0.beta)
+    pub_sub_model_sync (1.0.beta1)
       rails
 
 GEM
@@ -115,6 +115,7 @@ GEM
       gapic-common (~> 0.3)
       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)
@@ -129,6 +130,9 @@ GEM
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
       signet (~> 0.14)
+    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)
@@ -152,7 +156,7 @@ GEM
     multi_json (1.15.0)
     multipart-post (2.1.1)
     nio4r (2.5.7)
-    nokogiri (1.11.3-x86_64-linux)
+    nokogiri (1.11.3-x86_64-darwin)
       racc (~> 1.4)
     os (1.1.1)
     parallel (1.20.1)
@@ -244,6 +248,7 @@ GEM
     zeitwerk (2.4.2)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -364,9 +364,9 @@ Any notification before delivering is transformed as a Payload for a better port
     **Note**: When any error is raised when saving user or posts, the transaction is cancelled and thus all notifications wont be delivered (customizable by `PubSubModelSync::Config.transactions_use_buffer`).    
   
   - Manual transactions   
-    `PubSubModelSync::MessagePublisher::transaction(key, use_buffer: , &block)`
+    `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)  
-    - `use_buffer:` (Boolean, default: `PubSubModelSync::Config.transactions_use_buffer`)     
+    - `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)  
     Sample:
@@ -479,7 +479,9 @@ config.debug = true
     (Proc) => called after publishing a message
 - ```.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_use_buffer = true``` (true*|false) Default value for `use_buffer` in transactions.
+- ```.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` which will not rollback sql transactions if fails.
 
 ## **TODO**
 - Auto publish update only if payload has changed (see ways to compare previous payload vs new payload)

data/lib/pub_sub_model_sync/config.rb

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

data/lib/pub_sub_model_sync/initializers/before_commit.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Rails 4 backward compatibility (Add "simple" ps_before_*_commit callbacks)
+ActiveRecord::ConnectionAdapters::RealTransaction.class_eval do
+  alias_method :commit_with_before_commit, :commit
+
+  def commit
+    call_before_commit_records if Rails::VERSION::MAJOR == 4
+    commit_with_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/lib/pub_sub_model_sync/message_publisher.rb

@@ -22,7 +22,7 @@ module PubSubModelSync
       def transaction(key, settings = {}, &block)
         t = init_transaction(key, settings)
         block.call
-        t.deliver_all
+        t.finish
       rescue
         t.rollback
         raise

data/lib/pub_sub_model_sync/publisher_concern.rb

@@ -55,14 +55,17 @@ module PubSubModelSync
 
       # @param crud_actions (Symbol|Array<Symbol>): :create, :update, :destroy
       # @param method_name (Symbol, optional) method to be called
-      def ps_on_crud_event(crud_actions, method_name = nil, &block)
-        crud_actions = Array(crud_actions)
+      def ps_on_crud_event(crud_actions, method_name = nil, &block) # rubocop:disable Metrics/MethodLength
         callback = ->(action) { method_name ? send(method_name, action) : instance_exec(action, &block) }
         commit_name = respond_to?(:before_commit) ? :before_commit : :after_commit
-        crud_actions.each do |action|
-          send(commit_name, on: :create) { instance_exec(action, &callback) } if action == :create
-          send(commit_name, on: :update) { instance_exec(action, &callback) } if action == :update
-          after_destroy { instance_exec(action, &callback) } if action == :destroy
+        Array(crud_actions).each do |action|
+          if action == :destroy
+            after_destroy { instance_exec(action, &callback) }
+          elsif PubSubModelSync::Config.enable_rails4_before_commit # rails 4 compatibility
+            define_method("ps_before_#{action}_commit") { instance_exec(action, &callback) }
+          else
+            send(commit_name, on: action) { instance_exec(action, &callback) }
+          end
         end
       end
 
@@ -77,7 +80,7 @@ module PubSubModelSync
         after_create start_transaction, prepend: true # wait for ID
         before_update start_transaction, prepend: true
         before_destroy start_transaction, prepend: true
-        after_commit { @ps_transaction.deliver_all }
+        after_commit { @ps_transaction.finish }
         after_rollback(prepend: true) { @ps_transaction.rollback }
       end
     end

data/lib/pub_sub_model_sync/railtie.rb

@@ -2,6 +2,7 @@
 
 require 'pub_sub_model_sync'
 require 'rails'
+require 'pub_sub_model_sync/config'
 module PubSubModelSync
   class Railtie < ::Rails::Railtie
     railtie_name :pub_sub_model_sync
@@ -9,5 +10,9 @@ module PubSubModelSync
     rake_tasks do
       load 'pub_sub_model_sync/tasks/worker.rake'
     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/transaction.rb

@@ -3,55 +3,65 @@
 module PubSubModelSync
   class Transaction < Base
     PUBLISHER_KLASS = PubSubModelSync::MessagePublisher
-    attr_accessor :key, :payloads, :use_buffer, :parent, :children
+    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 use_buffer (Boolean, default: true) If false, payloads are delivered immediately
-    #   (no way to cancel/rollback if transaction failed)
-    def initialize(key, use_buffer: config.transactions_use_buffer)
+    # @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)
       @key = key
-      @use_buffer = use_buffer
+      @max_buffer = max_buffer
       @children = []
       @payloads = []
     end
 
     # @param payload (Payload)
     def add_payload(payload)
-      use_buffer ? payloads << payload : deliver_payload(payload)
+      payloads << payload
+      deliver_payloads if payloads.count >= max_buffer
     end
 
-    def deliver_all
-      if parent
-        parent.children = parent.children.reject { |t| t == self }
-        parent.deliver_all
+    def finish # rubocop:disable Metrics/AbcSize
+      if root
+        root.children = root.children.reject { |t| t == self }
+        root.deliver_all if root.finished && root.children.empty?
       end
-      payloads.each(&method(:deliver_payload)) if children.empty?
-      clean_publisher
+      self.finished = true
+      deliver_all if children.empty?
     end
 
     def add_transaction(transaction)
-      transaction.parent = self
+      transaction.root = self
       children << transaction
       transaction
     end
 
     def rollback
-      log("rollback #{children.count} notifications", :warn) if children.any? && debug?
+      log("rollback #{payloads.count} notifications", :warn) if children.any? && debug?
       self.children = []
-      parent&.rollback
+      root&.rollback
       clean_publisher
     end
 
     def clean_publisher
-      PUBLISHER_KLASS.current_transaction = nil if !parent && children.empty?
+      PUBLISHER_KLASS.current_transaction = nil if !root && children.empty?
+    end
+
+    def deliver_all
+      deliver_payloads
+      clean_publisher
     end
 
     private
 
-    def deliver_payload(payload)
-      PUBLISHER_KLASS.connector_publish(payload)
-    rescue => e
-      PUBLISHER_KLASS.send(:notify_error, e, payload)
+    def deliver_payloads
+      payloads.each do |payload|
+        PUBLISHER_KLASS.connector_publish(payload)
+      rescue => e
+        PUBLISHER_KLASS.send(:notify_error, e, payload)
+      end
+      self.payloads = []
     end
   end
 end

data/lib/pub_sub_model_sync/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pub_sub_model_sync
 version: !ruby/object:Gem::Version
-  version: 1.0.beta
+  version: 1.0.beta1
 platform: ruby
 authors:
 - Owen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-13 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -110,6 +110,7 @@ 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