pub_sub_model_sync 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 815981bccbd5dd0a03a603a2883b18c94bc321b37ed44623df65635ba645ea6f
-  data.tar.gz: b6e1bc85b69ce30df24f27726bb6e9950699799ddb67b313d8d9434284783f28
+  metadata.gz: 84f478587ccd28d92b653744e72d338cf53818e5286544ff2c6e1e982a5a12a7
+  data.tar.gz: 32266d8a3ba69cad2e716c4861914b62e87ee96cf226ecf8f67dab3f909d9856
 SHA512:
-  metadata.gz: e7f94f4d387baa8143f2fd2686a739bebefe12c247c48e6e85a3c7880efecaf02d5f01eb1770627cb06dbaeb9251f39a0052d715278c57e2c2771ca5fa342f61
-  data.tar.gz: 54a48c91cfc4cea1dd1e40583f9ac737dc324c0007e3bd8acb88599bb0322d1e3535c8d2dfe24d9023ebd51bd4abe9e7687974ee7d17028161757d267ce538b3
+  metadata.gz: 02a727027a13d0b55f330395c95f9077568efb74fae3927c941211a4d849910fd6c071dae5fdd9386b3bb34c5257389cd74e4fcf5979e29f665a9b8e9e93aa95
+  data.tar.gz: 896f7430fbc83640ef3141a9e24413de69034ebc2d9e6a66987d734e25e9c41e52f03aa23faa494d9f05d0e4628acd058082e729a1de00c513fb0fb1c2cca70e

data/CHANGELOG.md

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pub_sub_model_sync (1.1.0)
+    pub_sub_model_sync (1.1.1)
       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.5.2)
-      activesupport (>= 5.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
     google-cloud-core (1.6.0)
       google-cloud-env (~> 1.0)
       google-cloud-errors (~> 1.0)
@@ -139,27 +139,27 @@ GEM
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     jwt (2.2.3)
-    loofah (2.12.0)
+    loofah (2.9.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (1.0.2)
+    marcel (1.0.1)
     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.8)
-    nokogiri (1.12.5-x86_64-linux)
+    nio4r (2.5.7)
+    nokogiri (1.11.3-x86_64-darwin)
       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.6.0)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -181,7 +181,7 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
+    rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
     railties (6.1.3.2)
       actionpack (= 6.1.3.2)
@@ -238,7 +238,7 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
-    websocket-driver (0.7.5)
+    websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     zeitwerk (2.4.2)

data/README.md

@@ -311,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.         
+    - `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).    
+      Note: Final `ordering_key` is calculated as: `payload.headers[:forced_ordering_key] || current_transaction&.key || payload.headers[:ordering_key]`
+    - `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
@@ -528,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
@@ -537,17 +540,17 @@ 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)
+    (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.      
@@ -555,7 +558,7 @@ config.debug = true
 
 ## **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)
@@ -563,7 +566,7 @@ 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
+- Add subscription liveness checker using thread without db connection to check periodically pending notifications from google pubsub
 - Unify .stop() and 'Listener stopped' 
 
 ## **Q&A**

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)

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/transaction.rb

@@ -5,7 +5,7 @@ module PubSubModelSync
     PUBLISHER_KLASS = PubSubModelSync::MessagePublisher
     attr_accessor :key, :payloads, :max_buffer, :root, :children, :finished
 
-    # @param key (String,Null) 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.1.0'
+  VERSION = '1.1.1'
 end

metadata

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