hanami-events-cloud_pubsub 2.6.2 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a98d3008033cab806ac81b85a905da7b99b4004d05aa2f66ebace18393e06661
-  data.tar.gz: 0b5f35229ed7284a4cf31fe019b7332e95c33157c1c0c4910340059f8babc152
+  metadata.gz: a5ffe95cabc82141bd06ee9514ad0af66aaba9c5ebc719190e7cc9efba855274
+  data.tar.gz: 119b219d3294f50b37a13daa36a4a55edf0d85f5ac14e82676fee3cad62f135a
 SHA512:
-  metadata.gz: 204b4a858ddc8dada4ab5a7ccf6959dd9a5e25e579cfc96c562a20f7ca8138201f32ef8568859a27e51071ead172272acfa6c0b5090fc373946d25aa353d9c9d
-  data.tar.gz: 5f0d93acec60125c75b4c0b489cccd9fe282edcfc0918a850d8cbf9b828f700a0ba5061c4b6d68b96a1fa8c5998bec0597043ae11c70c05f755c7cbfd2c44851
+  metadata.gz: a3475491db3dab17ab2fd423c056dca407977321223bd457903b3773bdbd7ef9080b2446e70305e8e64f136d6bd434c157b90ae72bd48f91bd388cb060005ee3
+  data.tar.gz: 93bd30e26d6a85281f21dfd394f6aa7ea41a340459426f8b280f798e56b1fb3dc857390e6384e8d4605a286cbd313174eab2207e971e0c02374663cd91180744

data/.tool-versions

@@ -1 +1 @@
-ruby 2.6.6
+ruby 2.7.1

data/.travis.yml

@@ -9,8 +9,9 @@ env:
     - CC_TEST_REPORTER_ID=7ab310950456b913cd7e947f6671e3e9c16822f33bd8c572dadcc14593fe4fb5
     - COVERAGE=true
 rvm:
-  - 2.4
+  - 2.5
   - 2.6
+  - 2.7
 before_install:
   - gem install bundler -v 1.16.1
 before_script:

data/Gemfile

@@ -11,3 +11,5 @@ gem 'hanami-events', github: 'hanami/events'
 gem 'pry'
 gem 'rubocop'
 gem 'simplecov', require: false
+
+gem 'request_id', '~> 0.4.3'

data/Gemfile.lock

@@ -8,9 +8,9 @@ GIT
 PATH
   remote: .
   specs:
-    hanami-events-cloud_pubsub (2.6.2)
+    hanami-events-cloud_pubsub (2.9.0)
       dry-configurable (>= 0.8)
-      google-cloud-pubsub (>= 0.38.1, < 1.4)
+      google-cloud-pubsub (>= 0.38.1, < 1.7)
       hanami-cli (~> 0.2)
       hanami-events (~> 0.2.0)
       rack
@@ -20,12 +20,12 @@ GEM
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    coderay (1.1.2)
+    ast (2.4.1)
+    coderay (1.1.3)
     concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     docile (1.3.2)
-    dry-configurable (0.11.5)
+    dry-configurable (0.11.6)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.7)
       dry-equalizer (~> 0.2)
@@ -40,10 +40,10 @@ GEM
     google-cloud-core (1.5.0)
       google-cloud-env (~> 1.0)
       google-cloud-errors (~> 1.0)
-    google-cloud-env (1.3.1)
+    google-cloud-env (1.3.3)
       faraday (>= 0.17.3, < 2.0)
-    google-cloud-errors (1.0.0)
-    google-cloud-pubsub (1.3.1)
+    google-cloud-errors (1.0.1)
+    google-cloud-pubsub (1.6.1)
       concurrent-ruby (~> 1.1)
       google-cloud-core (~> 1.2)
       google-gax (~> 1.8)
@@ -56,22 +56,22 @@ GEM
       googleauth (~> 0.9)
       grpc (~> 1.24)
       rly (~> 0.2.3)
-    google-protobuf (3.11.4)
+    google-protobuf (3.12.4)
     googleapis-common-protos (1.3.10)
       google-protobuf (~> 3.11)
       googleapis-common-protos-types (>= 1.0.5, < 2.0)
       grpc (~> 1.27)
     googleapis-common-protos-types (1.0.5)
       google-protobuf (~> 3.11)
-    googleauth (0.12.0)
+    googleauth (0.13.1)
       faraday (>= 0.17.3, < 2.0)
       jwt (>= 1.4, < 3.0)
       memoist (~> 0.16)
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
       signet (~> 0.14)
-    grpc (1.28.0)
-      google-protobuf (~> 3.11)
+    grpc (1.30.2)
+      google-protobuf (~> 3.12)
       googleapis-common-protos-types (~> 1.0)
     grpc-google-iam-v1 (0.6.10)
       google-protobuf (~> 3.11)
@@ -83,47 +83,51 @@ GEM
     hanami-utils (1.3.6)
       concurrent-ruby (~> 1.0)
       transproc (~> 1.0)
-    jaro_winkler (1.5.4)
     jwt (2.2.1)
     memoist (0.16.2)
     method_source (1.0.0)
-    multi_json (1.14.1)
+    multi_json (1.15.0)
     multipart-post (2.1.1)
-    os (1.1.0)
-    parallel (1.19.1)
-    parser (2.7.1.1)
-      ast (~> 2.4.0)
-    prometheus-client (2.0.0)
+    os (1.1.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    prometheus-client (2.1.0)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.4)
-    rack (2.2.2)
+    public_suffix (4.0.5)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.7.1)
+    request_id (0.4.3)
     rexml (3.2.4)
     rly (0.2.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.82.0)
-      jaro_winkler (~> 1.5.1)
+    rspec-support (3.9.3)
+    rubocop (0.89.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
     signet (0.14.0)
       addressable (~> 2.3)
@@ -147,6 +151,7 @@ DEPENDENCIES
   prometheus-client
   pry
   rake (~> 13.0)
+  request_id (~> 0.4.3)
   rspec (~> 3.0)
   rubocop
   simplecov

data/README.md

@@ -106,6 +106,19 @@ Then, run the worker process:
 bundle exec cloudpubsub run
 ```
 
+# `RequestId` Integration
+
+To gem has an integration with [request_id](https://github.com/remind101/request_id), so you can trace interactions between various components in your app. To make it work properly, make sure the `request_id` is added to your Gemfile, then require the middleware:
+
+```ruby
+require 'hanami/events/cloud_pubsub/middleware/request_id'
+
+Hanami::Events::CloudPubsub.configure do |config|
+  # ...
+end
+```
+
+
 # Prometheus Integration
 
 If you have the `prometheus-client` gem installed, a `/metrics` endpoint will

data/hanami-events-cloud_pubsub.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'dry-configurable', '>= 0.8'
-  spec.add_dependency 'google-cloud-pubsub', '>= 0.38.1', '< 1.4'
+  spec.add_dependency 'google-cloud-pubsub', '>= 0.38.1', '< 1.7'
   spec.add_dependency 'hanami-cli', '~> 0.2'
   spec.add_dependency 'hanami-events', '~> 0.2.0'
   spec.add_dependency 'rack'

data/lib/hanami/events/adapter/cloud_pubsub.rb

@@ -11,7 +11,7 @@ module Hanami
       #
       # @api private
       class CloudPubsub
-        attr_reader :subscribers, :listeners, :topic_registry
+        attr_reader :subscribers, :listeners, :topic_registry, :middleware
 
         def initialize(params)
           @pubsub = params[:pubsub]
@@ -22,20 +22,23 @@ module Hanami
           @serializer_type = params.fetch(:serializer, :json).to_sym
           @topic_registry = {}
           @mutex = Mutex.new
+          @middleware = ::Hanami::Events::CloudPubsub.config.client_middleware
         end
 
         # Brodcasts event to all subscribes
         #
         # @param event [Symbol, String] the event name
         # @param payload [Hash] the event data
-        def broadcast(name, payload)
+        def broadcast(name, payload, **message_opts)
           event_name = namespaced(name)
           topic = topic_for event_name
           payload = serializer.serialize(payload)
           attributes = { id: SecureRandom.uuid, event_name: event_name }
 
-          topic.publish_async(payload, attributes) do |result|
-            logger.info "Published event #{result.inspect}"
+          middleware.invoke(payload, **attributes, **message_opts) do |*args|
+            topic.publish_async(*args) do |result|
+              logger.info "Published event #{result.inspect}"
+            end
           end
         end
 
@@ -97,11 +100,15 @@ module Hanami
 
         # rubocop:disable Metrics/LineLength
         def topic_for(name)
-          @topic_registry[name.to_s] ||= begin
-            @pubsub.find_topic(name) ||
-              (Hanami::Events::CloudPubsub.auto_create_topics && @pubsub.create_topic(name)) ||
-              raise(::Hanami::Events::CloudPubsub::Errors::TopicNotFoundError, "no topic named: #{name}")
-          end
+          return @topic_registry[name.to_s] if @topic_registry[name.to_s]
+
+          topic = @pubsub.find_topic(name) ||
+                  (Hanami::Events::CloudPubsub.auto_create_topics && @pubsub.create_topic(name)) ||
+                  raise(::Hanami::Events::CloudPubsub::Errors::TopicNotFoundError, "no topic named: #{name}")
+
+          topic.enable_message_ordering!
+
+          @topic_registry[name.to_s] = topic
         end
         # rubocop:enable Metrics/LineLength
 

data/lib/hanami/events/cloud_pubsub.rb

@@ -72,6 +72,21 @@ module Hanami
 
       setting :middleware, middleware_stack
 
+      client_middleware_stack = Middleware::Stack.new
+
+      begin
+        require 'request_id'
+        require 'hanami/events/cloud_pubsub/middleware/client/request_id'
+        require 'hanami/events/cloud_pubsub/middleware/request_id'
+
+        client_middleware_stack.prepend(Middleware::Client::RequestId.new)
+        middleware_stack.prepend(Middleware::RequestId.new)
+      rescue LoadError
+        # ok
+      end
+
+      setting :client_middleware, client_middleware_stack
+
       setting :on_shutdown_handlers, [], reader: true
 
       def self.finalize_settings!

data/lib/hanami/events/cloud_pubsub/listener.rb

@@ -36,7 +36,7 @@ module Hanami
         def register
           subscription = subscription_for(subscriber_id)
 
-          listener = subscription.listen(subscriber_opts) do |message|
+          listener = subscription.listen(**subscriber_opts) do |message|
             handle_message(message)
           end
 

data/lib/hanami/events/cloud_pubsub/middleware/auto_retry.rb

@@ -14,10 +14,10 @@ module Hanami
             @max_attempts = max_attempts
           end
 
-          def call(message, args = {})
+          def call(message, **args)
             succeeded = false
             failed = false
-            yield(args)
+            yield(**args)
             succeeded = true
           rescue StandardError => e
             failed = true

data/lib/hanami/events/cloud_pubsub/middleware/client/request_id.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Hanami
+  module Events
+    module CloudPubsub
+      module Middleware
+        module Client
+          # Broadcasts events with current request id
+          class RequestId
+            def call(payload, attributes = {})
+              attributes.merge!(
+                request_id: ::RequestId.request_id || SecureRandom.uuid
+              )
+
+              yield(payload, **attributes)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/events/cloud_pubsub/middleware/logging.rb

@@ -10,9 +10,9 @@ module Hanami
             @logger = logger
           end
 
-          def call(msg, opts = {})
+          def call(msg, **opts)
             started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-            yield(opts)
+            yield(**opts)
           ensure
             ended_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
             seconds = ended_at - started_at

data/lib/hanami/events/cloud_pubsub/middleware/prometheus.rb

@@ -14,16 +14,26 @@ module Hanami
             @events_counter = prometheus.counter(
               :received_pubsub_events,
               docstring: 'A counter of received pubsub events',
-              labels: %i[event_name subscription]
+              labels: %i[event_name subscription status]
             )
           end
 
-          def call(msg, opts = {})
-            yield(opts)
+          def call(msg, **opts)
+            status = :running
+
+            begin
+              ret = yield(**opts)
+              status = :succeeded
+              ret
+            rescue StandardError
+              status = :failed
+              raise
+            end
           ensure
             sub = msg.subscription.subscriber.subscription_name
             event_name = msg.attributes['event_name']
-            events_counter.increment(labels: { event_name: event_name, subscription: sub })
+            labels = { event_name: event_name, subscription: sub, status: status }
+            events_counter.increment(labels: labels)
           end
         end
       end

data/lib/hanami/events/cloud_pubsub/middleware/request_id.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+begin
+  require 'request_id'
+rescue LoadError
+  abort 'Please add "request_id" to your Gemfile to use this middleware'
+end
+
+module Hanami
+  module Events
+    module CloudPubsub
+      module Middleware
+        # Middleware used for logging useful information about an event
+        class RequestId
+          def call(msg, **opts)
+            setup_request_id(msg)
+            yield(**opts)
+          ensure
+            clear_request_id(msg)
+          end
+
+          private
+
+          def setup_request_id(msg)
+            id = msg.attributes['request_id'] || msg.attributes[:request_id]
+
+            ::RequestId.request_id = id || SecureRandom.uuid
+          rescue StandardError => e
+            warn "Could not set request_id (#{e.message})"
+          end
+
+          def clear_request_id(_msg)
+            ::RequestId.request_id = nil
+          rescue StandardError => e
+            warn "Could not clear request_id (#{e.message})"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/events/cloud_pubsub/middleware/stack.rb

@@ -40,14 +40,14 @@ module Hanami
             @entries.shift
           end
 
-          def invoke(message)
+          def invoke(*args)
             stack = entries.dup
 
             traverse_stack = proc do |**opts|
               if stack.empty?
-                yield(message)
+                yield(*args)
               else
-                stack.shift.call(message, **opts, &traverse_stack)
+                stack.shift.call(*args, **opts, &traverse_stack)
               end
             end
 

data/lib/hanami/events/cloud_pubsub/version.rb

@@ -3,7 +3,7 @@
 module Hanami
   module Events
     module CloudPubsub
-      VERSION = '2.6.2'
+      VERSION = '2.9.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-events-cloud_pubsub
 version: !ruby/object:Gem::Version
-  version: 2.6.2
+  version: 2.9.0
 platform: ruby
 authors:
 - Ian Ker-Seymer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -33,7 +33,7 @@ dependencies:
         version: 0.38.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: 0.38.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: hanami-cli
   requirement: !ruby/object:Gem::Requirement
@@ -179,8 +179,10 @@ files:
 - lib/hanami/events/cloud_pubsub/integration.rb
 - lib/hanami/events/cloud_pubsub/listener.rb
 - lib/hanami/events/cloud_pubsub/middleware/auto_retry.rb
+- lib/hanami/events/cloud_pubsub/middleware/client/request_id.rb
 - lib/hanami/events/cloud_pubsub/middleware/logging.rb
 - lib/hanami/events/cloud_pubsub/middleware/prometheus.rb
+- lib/hanami/events/cloud_pubsub/middleware/request_id.rb
 - lib/hanami/events/cloud_pubsub/middleware/stack.rb
 - lib/hanami/events/cloud_pubsub/register.rb
 - lib/hanami/events/cloud_pubsub/runner.rb
@@ -208,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Google Cloud Pub/Sub adapter for the hanami-events gem