pub_sub_model_sync 1.6.4 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79bf4750adcd186e0c14bd8c092012a6a9455dd6affcabf603e72e9a011f9bb1
-  data.tar.gz: 9d8efba465a451c7ffe3bd04400cd3efa2e6dfee31fa45885035da744ce88104
+  metadata.gz: 4dbf0fae81e981722c2a5dc1023dc3db9c369cfcdc5558ef727e59b1d6c87a8a
+  data.tar.gz: 340032eb2b9d47de47aa4e57c3db389c5571280df75a92fee96b52de2cc8c19e
 SHA512:
-  metadata.gz: f5ab4a0ffdc1b4e2eea91f6889211b04150f0a1857e4d0bc50ab6f1a9894811c0afedb22f3bbce84ee14bf668d24801e98cf512ef657b56a2c2bb4333deb78e7
-  data.tar.gz: 28bf0020235c4b7e6a6b8d54758daa0e72d2a61a55014bfa0646f028cac8227fed6c68df2f4a46effa447854910c2010258280c325f4aa8ea17bfe6cd2d50072
+  metadata.gz: f65eac76d6e247c89d863f75476539bf75324b12c510bdce2eaedc9667168381df82a39f3a2ee24c6da1c39b447159981512d9c744233b835c7000a95b514ac1
+  data.tar.gz: 1e549a6a809ecb162eaf6c4101a9a379f2ea2a1cccacb975854de02c1ddf928a54a05b9c432cdd26ac31863fcf5cffbefaa3baf0753f4301054fc509167d3316

data/.github/workflows/release.yml

@@ -1,43 +1,11 @@
+name: Create release from tag
 on:
   push:
-    tags: # triggered once a git tag is published
+    tags: # Create a release once a git tag is published
       - '*'
 
-name: Create Release
-
 jobs:
-  build:
-    name: Create Release
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-
-      # Changelog action adaptations
-      - name: Create required package.json
-        run: test -f package.json || echo '{}' >package.json
-      - name: Detect Previous Tag (action not detecting very well)
-        run: echo "::set-output name=previous_tag::$(git describe --abbrev=0 --tags `git rev-list --tags --skip=1 --max-count=1`)"
-        id: tag_checker
-
-      - name: Generate Changelog
-        uses: scottbrenner/generate-changelog-action@master
-        id: Changelog
-        with:
-          from-tag: ${{steps.tag_checker.outputs.previous_tag}}
-          to-tag: HEAD
-
-      - name: Create Release
-        id: create_release
-        uses: actions/create-release@latest
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
-        with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ github.ref }}
-          body: |
-            ${{ steps.Changelog.outputs.changelog }}
-          draft: false
-          prerelease: false
+  release-builder:
+    uses: owen2345/reusable-ci-cd-actions/.github/workflows/release_builder_from_tag.yml@main
+    with:
+      commit_mode: true # If true, then fetches all commit titles from all changes. If false, then fetches only the PR titles from all changes.

data/Gemfile.lock

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

data/README.md

@@ -335,7 +335,8 @@ Note: To reduce Payload size, some header info are not delivered (Enable debug m
     payload.publish! # publishes notification data. It raises exception if fails and does not call ```:on_error_publishing``` callback
     payload.publish # publishes notification data. On error does not raise exception but calls ```:on_error_publishing``` callback
     payload.process! # process a notification data. It raises exception if fails and does not call ```.on_error_processing``` callback
-    payload.publish # process a notification data. It does not raise exception if fails but calls ```.on_error_processing``` callback
+    payload.process # process a notification data. It does not raise exception if fails but calls ```.on_error_processing``` callback
+    payload.retry_publish! # allows to retry publishing a failed payload (All callbacks are ignored)
   ```
 
 ## **Transactions**   
@@ -538,7 +539,7 @@ config.debug = true
     (Proc) => called before publishing a notification (:cancel can be returned to skip publishing)
 - ```.on_after_publish = ->(payload) { puts payload }```
     (Proc) => called after publishing a notification
-- ```.on_error_publish = ->(exception, {payload:}) { payload.delay(...).publish! }```
+- ```.on_error_publish = ->(exception, {payload:}) { payload.delay(...).retry_publish! }```
     (Proc) => called when failed publishing a notification (delayed_job or similar can be used for retrying)
 - ```.skip_cache = false```
     (true/false*) => Allow to skip payload optimization (cache settings)
@@ -581,7 +582,7 @@ config.debug = true
     end
 
     PubSubModelSync::Config.on_error_publish = lambda do |_e, data|
-      PubSubRecovery.perform_async(data[:payload].to_h, :publish!)
+      PubSubRecovery.perform_async(data[:payload].to_h, :retry_publish!)
     end
     PubSubModelSync::Config.on_error_processing = lambda do |_e, data|
       PubSubRecovery.perform_async(data[:payload].to_h, :process!)

data/lib/pub_sub_model_sync/message_processor.rb

@@ -21,12 +21,14 @@ module PubSubModelSync
       log("No subscribers found for #{payload_info}", :warn) if config.debug && subscribers.empty?
       subscribers.each(&method(:run_subscriber))
     rescue => e
-      notify_error(e)
+      print_error(e)
       raise
     end
 
     def process
-      process! rescue nil # rubocop:disable Style/RescueModifier
+      process!
+    rescue => e
+      config.on_error_processing.call(e, { payload: payload })
     end
 
     private
@@ -51,14 +53,10 @@ module PubSubModelSync
     end
 
     # @param error (StandardError, Exception)
-    def notify_error(error)
-      error_msg = 'Error processing message: '
+    def print_error(error)
+      error_msg = 'Error processing message:'
       error_details = [payload, error.message, error.backtrace]
-      res = config.on_error_processing.call(error, { payload: payload })
-      log("#{error_msg} #{error_details}", :error) if res != :skip_log
-    rescue => e
       log("#{error_msg} #{error_details}", :error)
-      raise(e)
     end
 
     # @param error [StandardError]

data/lib/pub_sub_model_sync/message_publisher.rb

@@ -80,6 +80,17 @@ module PubSubModelSync
         current_transaction ? current_transaction.add_payload(payload) : connector_publish(payload)
         block&.call
         payload
+      rescue => e
+        print_error(e, payload)
+        raise
+      end
+
+      # Similar to :publish! method but ignores the error if failed
+      # @return Payload
+      def publish(payload, &block)
+        publish!(payload, &block)
+      rescue => e
+        config.on_error_publish.call(e, { payload: payload })
       end
 
       def connector_publish(payload)
@@ -89,22 +100,13 @@ module PubSubModelSync
         config.on_after_publish.call(payload)
       end
 
-      # Similar to :publish! method
-      # Notifies error via :on_error_publish instead of raising error
-      # @return Payload
-      def publish(payload, &block)
-        publish!(payload, &block)
-      rescue => e
-        notify_error(e, payload)
-      end
-
       private
 
       def ensure_publish(payload)
         cache_klass = PubSubModelSync::PayloadCacheOptimizer
-        cancelled = payload.cache_settings ? cache_klass.new(payload).call == :already_sent : false
-        cancelled ||= config.on_before_publish.call(payload) == :cancel
-        log_msg = "Publish cancelled by config.on_before_publish or cache checker: #{[payload]}"
+        cancelled_cache = payload.cache_settings ? cache_klass.new(payload).call == :already_sent : false
+        cancelled = cancelled_cache || config.on_before_publish.call(payload) == :cancel
+        log_msg = "Publish cancelled by #{cancelled_cache ? 'cache checker' : 'config.on_before_publish'}: #{[payload]}"
         log(log_msg) if config.debug && cancelled
         !cancelled
       end
@@ -124,10 +126,11 @@ module PubSubModelSync
         !cancelled
       end
 
-      def notify_error(exception, payload)
-        info = [payload, exception.message, exception.backtrace]
-        res = config.on_error_publish.call(exception, { payload: payload })
-        log("Error publishing: #{info}", :error) if res != :skip_log
+      # @param error (StandardError, Exception)
+      def print_error(error, payload)
+        error_msg = 'Error publishing:'
+        error_details = [payload, error.message, error.backtrace]
+        log("#{error_msg} #{error_details}", :error)
       end
 
       def define_transaction_key(payload)

data/lib/pub_sub_model_sync/mock_google_service.rb

@@ -43,6 +43,10 @@ module PubSubModelSync
         yield(OpenStruct.new(succeeded?: true)) if block_given?
       end
 
+      def resume_publish(_ordering_key)
+        true
+      end
+
       def enable_message_ordering!
         true
       end

data/lib/pub_sub_model_sync/payload.rb

@@ -72,15 +72,18 @@ module PubSubModelSync
     # Publish payload to pubsub
     #   (If error will raise exception and wont call on_error_publish callback)
     def publish!
-      klass = PubSubModelSync::MessagePublisher
-      klass.publish!(self)
+      PubSubModelSync::MessagePublisher.publish!(self)
     end
 
     # Publish payload to pubsub
     #   (If error will call on_error_publish callback)
     def publish
-      klass = PubSubModelSync::MessagePublisher
-      klass.publish(self)
+      PubSubModelSync::MessagePublisher.publish(self)
+    end
+
+    # allows to retry publishing a failed payload
+    def retry_publish!
+      PubSubModelSync::MessagePublisher.connector_publish(self)
     end
 
     # @param attr_keys (Array<Symbol>) List of attributes to be excluded from payload

data/lib/pub_sub_model_sync/payload_cache_optimizer.rb

@@ -19,14 +19,14 @@ module PubSubModelSync
       return payload if cache_disabled?
       return :already_sent if previous_payload_data == payload.data
 
-      optimize_payload if optimization_enabled?
+      optimize_payload if optimization_allowed?
       Rails.cache.write(cache_key, backup_data, expires_in: 1.week)
       payload
     end
 
     private
 
-    def optimization_enabled?
+    def optimization_allowed?
       previous_payload_data && payload.cache_settings.is_a?(Hash)
     end
 

data/lib/pub_sub_model_sync/service_google.rb

@@ -35,11 +35,7 @@ module PubSubModelSync
     def publish(payload)
       p_topic_names = Array(payload.headers[:topic_name] || config.default_topic_name)
       message_topics = p_topic_names.map(&method(:find_topic))
-      message_topics.each do |topic|
-        topic.publish_async(encode_payload(payload), message_headers(payload)) do |res|
-          raise StandardError, 'Failed to publish the message.' unless res.succeeded?
-        end
-      end
+      message_topics.each { |topic| publish_to_topic(topic, payload) }
     end
 
     def stop
@@ -56,6 +52,19 @@ module PubSubModelSync
       topics[topic_name] || publish_topics[topic_name] || init_topic(topic_name, only_publish: true)
     end
 
+    def publish_to_topic(topic, payload)
+      retries ||= 0
+      topic.publish_async(encode_payload(payload), message_headers(payload)) do |res|
+        raise StandardError, "Failed to publish the message. #{res.error}" unless res.succeeded?
+      end
+    rescue Google::Cloud::PubSub::OrderingKeyError => e
+      raise if (retries += 1) > 1
+
+      log("Resuming ordering_key and retrying OrderingKeyError for #{payload.headers[:uuid]}: #{e.message}")
+      topic.resume_publish(message_headers(payload)[:ordering_key])
+      retry
+    end
+
     # @param only_publish (Boolean): if false is used to listen and publish messages
     # @return (Topic): returns created or loaded topic
     def init_topic(topic_name, only_publish: false)

data/lib/pub_sub_model_sync/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pub_sub_model_sync
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.7.1
 platform: ruby
 authors:
 - Owen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-29 00:00:00.000000000 Z
+date: 2022-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails