hanami-events-cloud_pubsub 3.0.5 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d44039a04524e3577341b8dce78ee4479b24b49972d9be9e5353ac8e1186b4c
-  data.tar.gz: 84546314a907e147de4fbbcce02ec85e802c089e7ec2ed5b242e76bc53b63839
+  metadata.gz: c1f785cf3b473394906aadc0906661072aaa1e5721b1a24401fc3333df270e14
+  data.tar.gz: cc270e1411137b1b5bedfbb0b110d8d7dacbdf8f1d217e13b4ae30f9a17f4fa5
 SHA512:
-  metadata.gz: 63555a20d775ee80b5841991b4a2e3176d63e55e447f318a3ffed81f115790ba7e9149c1a170c2fc53b5f03d26dcbd3de679b7c513074213495f193b2960d19f
-  data.tar.gz: 3a21d8e97f431bca8b24cbffb2f09428cc743ff68f85225a0b71435f20196583e390e39c42bf6f1c9d425504ca9324b28310807bb631ddc8caed86a494a22960
+  metadata.gz: 178c1973c428c9bbbdb354526f42304d31a38158c6f4816c502c1772d04b3c99c4f60f9121c771c4307d8aeeaaf0f0e79ae5d6ad81c2feb7b9fe1df2c8b00f8e
+  data.tar.gz: 0d17cd8d26d82f4803d501ac876accaa43d4226a22308dbf99752e5cd7ccff66777cba192f3daba79a43360a21289390c2da34379bf09fa4e55f652ce6b64da3

data/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+---
+name: CI
+on: [push, pull_request]
+env:
+  CC_TEST_REPORTER_ID: "7ab310950456b913cd7e947f6671e3e9c16822f33bd8c572dadcc14593fe4fb5"
+  COVERAGE: "true"
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.5", "2.6", "2.7"]
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Set ENV for codeclimate (pull_request)
+        run: |
+          git fetch --no-tags --prune --depth=1 origin +refs/heads/$GITHUB_HEAD_REF:refs/remotes/origin/$GITHUB_HEAD_REF
+          echo "GIT_BRANCH=$GITHUB_HEAD_REF" >> $GITHUB_ENV
+          echo "GIT_COMMIT_SHA=$(git rev-parse origin/$GITHUB_HEAD_REF)" >> $GITHUB_ENV
+        if: github.event_name == 'pull_request'
+
+      - name: Set ENV for codeclimate (push)
+        run: |
+          echo "GIT_BRANCH=$GITHUB_REF" >> $GITHUB_ENV
+          echo "GIT_COMMIT_SHA=$GITHUB_SHA" >> $GITHUB_ENV
+        if: github.event_name == 'push'
+
+      - name: Prepare for test
+        run: |
+          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+          chmod +x ./cc-test-reporter
+          ./cc-test-reporter before-build
+
+      - name: Run tests
+        run: bundle exec rake
+
+      - name: Report coverage
+        run: ./cc-test-reporter after-build -t simplecov --exit-code $?

data/.gitignore

@@ -11,3 +11,4 @@
 # rspec failure tracking
 .rspec_status
 coverage
+Gemfile.lock

data/Gemfile

@@ -7,9 +7,11 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in hanami-events-cloud_pubsub.gemspec
 gemspec
 
+RUBY_MAJOR = RUBY_VERSION[0].to_i
+
 gem 'hanami-events', github: 'hanami/events'
 gem 'pry'
+gem 'request_id', '~> 0.4.3'
 gem 'rubocop'
 gem 'simplecov', require: false
-
-gem 'request_id', '~> 0.4.3'
+gem 'webrick' if RUBY_MAJOR > 2

data/README.md

@@ -119,12 +119,12 @@ end
 ```
 
 
-# Prometheus Integration
+# Yabeda Prometheus Integration
 
-If you have the `prometheus-client` gem installed, a `/metrics` endpoint will
+If you have the `yabeda-prometheus` gem installed, a `/metrics` endpoint will
 be available on the health check server which can be scraped.
 
-All you need to do to activate this is to make sure to `require 'prometheus/client'`.
+All you need to do to activate this is to make sure to `require 'yabeda/prometheus'`.
 
 # Testing
 

data/hanami-events-cloud_pubsub.gemspec

@@ -31,8 +31,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'hanami-events', '~> 0.2.0'
   spec.add_dependency 'rack'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'prometheus-client'
+  spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yabeda-prometheus-mmap'
 end

data/lib/hanami/events/cloud_pubsub.rb

@@ -60,12 +60,13 @@ module Hanami
         Middleware::Logging.new
       )
 
-      begin
-        require 'prometheus/client'
-        require 'hanami/events/cloud_pubsub/middleware/prometheus'
-        middleware_stack.prepend(Middleware::Prometheus.new)
-      rescue LoadError
-        # ok
+      if defined?(Yabeda::Prometheus::Exporter)
+        begin
+          require 'hanami/events/cloud_pubsub/middleware/prometheus'
+          middleware_stack << Middleware::Prometheus.new
+        rescue LoadError
+          # ok
+        end
       end
 
       setting :middleware, middleware_stack

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

@@ -50,6 +50,7 @@ module Hanami
             end
 
             def setup_env(opts)
+              Process.setproctitle('hanami-events-cloud_pubsub')
               ENV['PUBSUB_EMULATOR_HOST'] ||= 'localhost:8085' if opts[:emulator]
             end
 

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

@@ -6,9 +6,13 @@ module Hanami
       # Errors
       module Errors
         class Error < StandardError; end
+
         class TopicNotFoundError < Error; end
+
         class SubscriptionNotFoundError < Error; end
+
         class SubscriptionTopicNameMismatch < Error; end
+
         class NoSubscriberError < Error; end
       end
     end

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

@@ -54,10 +54,8 @@ module Hanami
 
           Rack::Builder.new do |builder|
             builder.use Rack::Deflater
-            if defined?(::Prometheus::Client)
-              require 'prometheus/middleware/exporter'
-              builder.use ::Prometheus::Middleware::Exporter
-            end
+            builder.use Yabeda::Prometheus::Exporter if defined?(Yabeda::Prometheus::Exporter)
+
             builder.run health_endpoint_app
           end
         end

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

@@ -59,7 +59,8 @@ module Hanami
         end
 
         def shutdown
-          subscriber.stop.wait!
+          stop
+          wait
           self
         end
 
@@ -68,8 +69,8 @@ module Hanami
           self
         end
 
-        def wait
-          subscriber.wait!
+        def wait(timeout = 60)
+          subscriber.wait!(timeout)
           self
         end
 

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

@@ -6,23 +6,31 @@ module Hanami
       module Middleware
         # Middleware used for logging useful information about an event
         class Prometheus
-          attr_reader :events_counter
+          LONG_RUNNING_JOB_RUNTIME_BUCKETS = [
+            0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, # standard (from Prometheus)
+            30, 60, 120, 300, 1800, 3600, 21_600 # Tasks may be very long-running
+          ].freeze
 
-          def initialize
-            require 'prometheus/client'
-            prometheus = ::Prometheus::Client.registry
-            @events_counter = prometheus.counter(
+          Yabeda.configure do
+            counter(
               :received_pubsub_events,
-              docstring: 'A counter of received pubsub events',
-              labels: %i[event_name subscription status]
+              tags: %i[event_name subscription status],
+              comment: 'A counter of received pubsub events'
             )
+
+            histogram :subscriber_runtime, comment: 'A histogram of the subscriber execution time.',
+                                           unit: :seconds,
+                                           per: :message,
+                                           tags: %i[event_name subscription status],
+                                           buckets: LONG_RUNNING_JOB_RUNTIME_BUCKETS
           end
 
           def call(msg, **opts)
+            start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
             status = :running
 
             begin
-              ret = yield(**opts)
+              ret = yield(**opts) if block_given?
               status = :succeeded
               ret
             rescue StandardError
@@ -30,10 +38,20 @@ module Hanami
               raise
             end
           ensure
+            record_metrics(msg, status, start)
+          end
+
+          private
+
+          def record_metrics(msg, status, start)
+            elapsed = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start).round(3)
             sub = msg.subscription.subscriber.subscription_name
             event_name = msg.attributes['event_name']
             labels = { event_name: event_name, subscription: sub, status: status }
-            events_counter.increment(labels: labels)
+            Yabeda.received_pubsub_events.increment(labels, by: 1)
+            Yabeda.subscriber_runtime.measure(labels, elapsed)
+          rescue StandardError
+            # ok
           end
         end
       end

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

@@ -9,7 +9,7 @@ module Hanami
       class Runner
         attr_reader :logger, :adapter
 
-        def initialize(adapter:, logger:, sleep_time: 2)
+        def initialize(adapter:, logger:, sleep_time: 30)
           @logger = logger
           @adapter = adapter
           @sleep_time = sleep_time
@@ -40,9 +40,8 @@ module Hanami
         def gracefully_shutdown
           stop
           logger.info "Gracefully shutting down CloudPubsub runner: #{self}"
-          sleep_for_a_bit
+          adapter.listeners.each { |l| l.wait(@sleep_time) }
           adapter.flush_messages
-          adapter.listeners.each(&:wait)
           handle_on_shutdown
 
           self
@@ -102,10 +101,6 @@ module Hanami
           MSG
         end
 
-        def sleep_for_a_bit
-          sleep @sleep_time
-        end
-
         def handle_on_shutdown
           return if CloudPubsub.on_shutdown_handlers.empty?
 

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

@@ -3,7 +3,7 @@
 module Hanami
   module Events
     module CloudPubsub
-      VERSION = '3.0.5'
+      VERSION = '3.1.2'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-events-cloud_pubsub
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.1.2
 platform: ruby
 authors:
 - Ian Ker-Seymer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-08 00:00:00.000000000 Z
+date: 2021-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -106,56 +106,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: prometheus-client
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: yabeda-prometheus-mmap
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: Makes it easy to use Cloud Pub/Sub with Hanami
 email:
 - i.kerseymer@gmail.com
@@ -164,15 +164,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".tool-versions"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -188,7 +187,6 @@ files:
 - lib/hanami/events/cloud_pubsub.rb
 - lib/hanami/events/cloud_pubsub/cli.rb
 - lib/hanami/events/cloud_pubsub/errors.rb
-- lib/hanami/events/cloud_pubsub/handler.rb
 - lib/hanami/events/cloud_pubsub/health_check_server.rb
 - lib/hanami/events/cloud_pubsub/integration.rb
 - lib/hanami/events/cloud_pubsub/listener.rb
@@ -223,7 +221,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

data/.travis.yml

@@ -1,32 +0,0 @@
----
-sudo: required
-cache: bundler
-services:
-  - docker
-language: ruby
-env:
-  global:
-    - CC_TEST_REPORTER_ID=7ab310950456b913cd7e947f6671e3e9c16822f33bd8c572dadcc14593fe4fb5
-    - COVERAGE=true
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-before_install:
-  - gem install bundler -v 1.16.1
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-after_failure:
-  - cat log/test.log
-deploy:
-  provider: rubygems
-  api_key:
-    secure: q/B3zDEld8yzf1plU1vlnUIhqk7hhdrqdF8uRnSvikweM9MSeGk1x6lcZ4mxnwCVPuQEP49iI4sNtFHiJnP/Dv6f48A6ltpVlyST1vghhXlaIi9+r9pCJqB+vAOii7poq9lWyKWj15MMB5xE52Alz7WzUccOL55gmJ4q+Lia6+z04m+VdOuEY1Lyn38O9jtZJBBfnbjar+qKoHXCNSKuJfXrFBi+2LKvaxJFWS8NBvhnDILNkcooh01rp6/dtNuUMFTLd1i+zMMBYc1PyGP0+fNZE9MXUViy3soDfgXlPDyiwtTzASLCu6HXQg8g9SwBxMnkRQRxAKYzoAPoECcr9NxMR1riH6xaA2wkwW/rKcBP5JPfbRymRgSui4uhYSq7WJR5KNxpH2JYK+rW/EL9SB+7BT67g3ZNL6YGpL3R7/S5RLdHk+lJIY8uFRtzhYgchSa0tkBAm/qbll5d4B9wq7O1/McNwUQJKFs7CsVXL/arZUFgQVGdkQDOIeCITzeFy4iP3JASewOk+yCUyCbBCya2AicU7BOjYpghD0QNmyaunTPhCySdBe4mS3QkAspHGg10H5dggNS0IqHYmUTlmHiYg9Pf9TF85krQih/s3hr/+i13u+y8iBwA7n/mXTt5IQ+NQgXNSC0uJvSjHU2Rzr9yKZ1lLEXMB0y+S9OVeZA=
-  gem: hanami-events-cloud_pubsub
-  on:
-    tags: true
-    repo: adHawk/hanami-events-cloud_pubsub

data/Gemfile.lock

@@ -1,163 +0,0 @@
-GIT
-  remote: https://github.com/hanami/events
-  revision: 59a36d22b75ea045fa8994f4f660a02c0901f8b2
-  specs:
-    hanami-events (0.2.1)
-      dry-container (~> 0.6)
-
-PATH
-  remote: .
-  specs:
-    hanami-events-cloud_pubsub (3.0.5)
-      dry-configurable (>= 0.8)
-      gapic-common (>= 0.3.4)
-      google-cloud-pubsub (>= 0.38.1, < 2.4)
-      hanami-cli (~> 0.2)
-      hanami-events (~> 0.2.0)
-      rack
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
-    coderay (1.1.3)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.4.4)
-    docile (1.3.2)
-    dry-configurable (0.11.6)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-      dry-equalizer (~> 0.2)
-    dry-container (0.7.2)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
-      concurrent-ruby (~> 1.0)
-    dry-equalizer (0.3.0)
-    faraday (1.1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords
-    gapic-common (0.3.4)
-      google-protobuf (~> 3.12, >= 3.12.2)
-      googleapis-common-protos (>= 1.3.9, < 2.0)
-      googleapis-common-protos-types (>= 1.0.4, < 2.0)
-      googleauth (~> 0.9)
-      grpc (~> 1.25)
-    google-cloud-core (1.5.0)
-      google-cloud-env (~> 1.0)
-      google-cloud-errors (~> 1.0)
-    google-cloud-env (1.4.0)
-      faraday (>= 0.17.3, < 2.0)
-    google-cloud-errors (1.0.1)
-    google-cloud-pubsub (2.3.0)
-      concurrent-ruby (~> 1.1)
-      google-cloud-core (~> 1.5)
-      google-cloud-pubsub-v1 (~> 0.0)
-    google-cloud-pubsub-v1 (0.1.2)
-      gapic-common (~> 0.3)
-      google-cloud-errors (~> 1.0)
-      grpc-google-iam-v1 (>= 0.6.10, < 2.0)
-    google-protobuf (3.14.0)
-    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.14.0)
-      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.34.0)
-      google-protobuf (~> 3.13)
-      googleapis-common-protos-types (~> 1.0)
-    grpc-google-iam-v1 (0.6.10)
-      google-protobuf (~> 3.11)
-      googleapis-common-protos (>= 1.3.10, < 2.0)
-      grpc (~> 1.27)
-    hanami-cli (0.3.1)
-      concurrent-ruby (~> 1.0)
-      hanami-utils (~> 1.3)
-    hanami-utils (1.3.6)
-      concurrent-ruby (~> 1.0)
-      transproc (~> 1.0)
-    jwt (2.2.2)
-    memoist (0.16.2)
-    method_source (1.0.0)
-    multi_json (1.15.0)
-    multipart-post (2.1.1)
-    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.6)
-    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)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    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.3)
-    rubocop (0.89.0)
-      parallel (~> 1.10)
-      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)
-    ruby2_keywords (0.0.2)
-    signet (0.14.0)
-      addressable (~> 2.3)
-      faraday (>= 0.17.3, < 2.0)
-      jwt (>= 1.5, < 3.0)
-      multi_json (~> 1.10)
-    simplecov (0.18.5)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    transproc (1.1.1)
-    unicode-display_width (1.7.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  hanami-events!
-  hanami-events-cloud_pubsub!
-  prometheus-client
-  pry
-  rake (~> 13.0)
-  request_id (~> 0.4.3)
-  rspec (~> 3.0)
-  rubocop
-  simplecov
-
-BUNDLED WITH
-   1.17.3