pub_sub_model_sync 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e73c2af5a62d4b0ae32ea40f3c3c369a049edfd47360a50386eeb5e4ff97cd1
-  data.tar.gz: 5d1892ee41ada21c9bf70bcc3601e435edfdf55d7b51b443369bf3307da60436
+  metadata.gz: 815981bccbd5dd0a03a603a2883b18c94bc321b37ed44623df65635ba645ea6f
+  data.tar.gz: b6e1bc85b69ce30df24f27726bb6e9950699799ddb67b313d8d9434284783f28
 SHA512:
-  metadata.gz: 962defddfdc780ce185d01e9069485207bdf66be9b3554a1003b5ec71211c467223c288fbb6c6a59ae819a9ba37ff118a470942bdef9e69c68e94f34ff899c9a
-  data.tar.gz: c6e771a40a96dcdf00161aa49fbe7c1b5f283709d5b42b87421c6655e4cb9972e9f7d3bb7d203d47c9757dc681f8c755c7026447f6582ffa1f43a553ba90197a
+  metadata.gz: e7f94f4d387baa8143f2fd2686a739bebefe12c247c48e6e85a3c7880efecaf02d5f01eb1770627cb06dbaeb9251f39a0052d715278c57e2c2771ca5fa342f61
+  data.tar.gz: 54a48c91cfc4cea1dd1e40583f9ac737dc324c0007e3bd8acb88599bb0322d1e3535c8d2dfe24d9023ebd51bd4abe9e7687974ee7d17028161757d267ce538b3

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+# 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
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pub_sub_model_sync (1.0.1)
+    pub_sub_model_sync (1.1.0)
       rails
 
 GEM
@@ -99,8 +99,8 @@ GEM
       googleapis-common-protos-types (>= 1.0.6, < 2.0)
       googleauth (~> 0.15, >= 0.15.1)
       grpc (~> 1.36)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
     google-cloud-core (1.6.0)
       google-cloud-env (~> 1.0)
       google-cloud-errors (~> 1.0)
@@ -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)
@@ -143,27 +139,27 @@ GEM
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     jwt (2.2.3)
-    loofah (2.9.1)
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (1.0.1)
+    marcel (1.0.2)
     memoist (0.16.2)
     method_source (1.0.0)
     mini_mime (1.0.3)
     minitest (5.14.4)
     multi_json (1.15.0)
     multipart-post (2.1.1)
-    nio4r (2.5.7)
-    nokogiri (1.11.3-x86_64-darwin)
+    nio4r (2.5.8)
+    nokogiri (1.12.5-x86_64-linux)
       racc (~> 1.4)
     os (1.1.1)
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -185,7 +181,7 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
     railties (6.1.3.2)
       actionpack (= 6.1.3.2)
@@ -242,7 +238,7 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
-    websocket-driver (0.7.3)
+    websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     zeitwerk (2.4.2)
@@ -264,4 +260,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.2.17
+   2.2.29

data/README.md

@@ -245,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
@@ -369,9 +369,7 @@ 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)  
+    - `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
@@ -550,9 +548,10 @@ 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_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.
+- ```.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)
@@ -564,6 +563,8 @@ config.debug = true
 - 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 messages 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/publisher_concern.rb

@@ -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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pub_sub_model_sync
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Owen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-20 00:00:00.000000000 Z
+date: 2021-10-25 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

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