hanami-events-cloud_pubsub 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2113da2784c067da73a9d9c37990f8c2406bd1e0ff6c25ab17576f786863ef9
-  data.tar.gz: b2bb4eb5f8e5b8ca1e8dcac4c150b210d2e108e075dbd6d7abb419afab452516
+  metadata.gz: 7ba6ce6fe08440e7ac49969a63b2b6f4e2412c24a3fa45effbf11563f8c6f5cd
+  data.tar.gz: c072c528e2379cb1a32a1e7aef86858315e3638c856488e4967cdbe62696312f
 SHA512:
-  metadata.gz: c51521fa3b75dd6bbbc7e79c227d1ea53f3cd5623eb874b28972fc713b656baacd2fda7f34fce2b515ced410a5d4f1e1ae69df47bfae476557dcc0956548c5c5
-  data.tar.gz: 320daaad0c019fcb38e07c993e7bd8c71804d51ce0ee27767627b6a1c1cb97eef78cc4b99724e57ccb222d0cce9c1d7ab93838e03605a06e6d0b917d620d562d
+  metadata.gz: b76340517e3a21af94fc94deb6a2dd0cf93ca46c86a285e64b7ed516b3501ab355fc22cfae7b9a8ef9085909fc454583ced8ae16e666f8a2cd5200d931cad362
+  data.tar.gz: acdce37077630472a14d0a2b4c7179a4535e72a5f7c0a890752cc525909d4d91b6ce3d56a705459d57d4bd6ee48571b2c25cfe177e5b819c7219bb1010d2f619

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+coverage

data/.travis.yml

@@ -4,10 +4,20 @@ cache: bundler
 services:
   - docker
 language: ruby
+env:
+  global:
+    - CC_TEST_REPORTER_ID=7ab310950456b913cd7e947f6671e3e9c16822f33bd8c572dadcc14593fe4fb5
+    - COVERAGE=true
 rvm:
   - 2.4
 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:

data/Gemfile

@@ -11,4 +11,5 @@ group :test do
   gem 'hanami-events', github: 'ianks/events', branch: 'args-to-subscribe'
   gem 'pry'
   gem 'rubocop'
+  gem 'simplecov', require: false
 end

data/Gemfile.lock

@@ -9,7 +9,8 @@ GIT
 PATH
   remote: .
   specs:
-    hanami-events-cloud_pubsub (0.1.5)
+    hanami-events-cloud_pubsub (0.2.0)
+      dry-configurable
       google-cloud-pubsub (~> 0.30.2)
       hanami-cli
       hanami-events
@@ -23,6 +24,7 @@ GEM
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
+    docile (1.3.1)
     dry-configurable (0.7.0)
       concurrent-ruby (~> 1.0)
     dry-container (0.6.0)
@@ -74,6 +76,7 @@ GEM
       concurrent-ruby (~> 1.0)
       transproc (~> 1.0)
     jaro_winkler (1.4.0)
+    json (2.1.0)
     jwt (2.1.0)
     little-plugger (1.1.4)
     logging (2.2.2)
@@ -122,6 +125,11 @@ GEM
       faraday (~> 0.9)
       jwt (>= 1.5, < 3.0)
       multi_json (~> 1.10)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     transproc (1.0.2)
     unicode-display_width (1.4.0)
 
@@ -136,6 +144,7 @@ DEPENDENCIES
   rake (~> 12.3)
   rspec (~> 3.0)
   rubocop
+  simplecov
 
 BUNDLED WITH
    1.16.1

data/README.md

@@ -52,19 +52,40 @@ First, create a config file:
 require 'config/environment'
 
 Hanami.boot
+
+Hanami::Events::CloudPubsub.configure do |config|
+  # required
+  config.subscriptions_loader = -> do
+    # Ensure these files are not loaded until *after* the subscriptions are
+    # setup, or else you will have an undefined reference to `$events`
+    Hanami::Utils.require! 'apps/web/subscriptions'
+  end
+
+  # (optional)
+  config.logger = Hanami.logger
+
+  # (optional)
+  config.error_handlers << lambda do |err, message|
+    Honeybadger.notify(err, context: message.attributes)
+  end
+end
+
 ```
 
 Then, run the worker process:
 
 ```sh
-bundle exec exe/cloudpubsub run --config config/cloudpubsub.rb
+bundle exec cloudpubsub run
 ```
 
+# Testing
+
 If you would like to use an emulator process for testing:
 
 ```sh
-docker run -p 8085:8085 adhawk/google-pubsub-emulator # start the emulator
-bundle exec exe/cloudpubsub run --emulator --config config/cloudpubsub.rb # use emulator for the worker
+$(gcloud beta emulators pubsub env-init)
+gcloud beta emulators pubsub start
+bundle exec cloudpubsub run --emulator
 ```
 
 ## Development

data/examples/server.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
-# To run this server:
-# bundle exec exe/cloudpubsub run --emulator --config examples/server.rb
-
-$events.subscribe('user.deleted', id: 'testing-1') do |payload|
-  puts "Deleted user: #{payload}"
-end
-
-$events.subscribe('user.deleted', id: 'testing-2') do |payload|
-  puts "Deleted2 user: #{payload}"
+Hanami::Events::CloudPubsub.configure do |config|
+  config.subscriptions_loader = -> do
+    $events.subscribe('user.deleted', id: 'testing-2') do |payload|
+      puts "Deleted2 user: #{payload}"
+    end
+  end
 end

data/hanami-events-cloud_pubsub.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'dry-configurable'
   spec.add_dependency 'google-cloud-pubsub', '~> 0.30.2'
   spec.add_dependency 'hanami-cli'
   spec.add_dependency 'hanami-events'

data/lib/hanami/events/cloud_pubsub.rb

@@ -5,11 +5,39 @@ require 'hanami/events/cloud_pubsub/version'
 require 'hanami/events/cloud_pubsub/runner'
 require 'hanami/events/cloud_pubsub/mixin'
 require 'google/cloud/pubsub'
+require 'dry-configurable'
 
 module Hanami
   module Events
     # CloudPubsub
     module CloudPubsub
+      extend Dry::Configurable
+
+      setting :logger, Logger.new(STDOUT), reader: true
+      setting :subscriptions_loader, proc {
+        abort <<~MSG
+          ┌────────────────────────────────────────────────────────────────────────────────┐
+          │ You must configure subscriptions_loader param in order to be able to subscribe │
+          │ to events. When the worker is setup and ready to subscribe to events, this     │
+          │ loader will be called. It must respond to `#call`.                             │
+          │                                                                                │
+          │ Example                                                                        │
+          │ ═══════                                                                        │
+          │                                                                                │
+          │ Hanami::Events::CloudPubsub.configure do │config│                              │
+          │   config.subscriptions_loader = proc do                                        │
+          │     Hanami::Utils.require! 'apps/web/subscriptions'                            │
+          │   end                                                                          │
+          │ end                                                                            │
+          └────────────────────────────────────────────────────────────────────────────────┘
+        MSG
+      }, reader: true
+      setting :error_handlers, [
+        ->(err, msg) do
+          logger.error "Message(#{msg.message_id}) failed with exception #{err.inspect}"
+        end
+      ], reader: true
+
       def self.setup
         Hanami::Events::Adapter.register(:cloud_pubsub) do
           require_relative 'adapter/cloud_pubsub'

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

@@ -26,36 +26,25 @@ module Hanami
             def call(opts)
               setup_env(opts)
               parse_opts(opts)
+              load_config
               build_runner
+              load_subscriptions
               setup_signal_handlers
-              load_config
               start_runner
               sleep_forever
             end
 
             private
 
+            def load_subscriptions
+              CloudPubsub.subscriptions_loader.call
+            end
+
             def setup_env(opts)
               ENV['PUBSUB_EMULATOR_HOST'] ||= 'localhost:8085' if opts[:emulator]
-              try_load_environment
-              resolve_components
               CloudPubsub.setup
             end
 
-            def try_load_environment
-              boot_file = Bundler.default_gemfile.parent.join('config', 'environment.rb')
-              load boot_file.to_s
-            rescue LoadError
-              logger.warn <<~MSG
-                Could not load config/environment.rb, assuming we are not in a Hanami project
-              MSG
-            end
-
-            def resolve_components
-              return unless defined?(Hanami::Components)
-              Hanami::Components.resolve('logger')
-            end
-
             def sleep_forever
               thread = Thread.new do
                 loop do
@@ -71,19 +60,20 @@ module Hanami
             end
 
             def load_config
-              load @config
+              load String(@config)
+            rescue LoadError
+              logger.warn "No config file found (tried #{@config}), using default"
             end
 
             def start_runner
-              logger.info "Starting CloudPubsub runner (pid: #{Process.pid})"
+              logger.debug 'Running in emulator mode' if @emulator
+              logger.info "Starting worker (pid: #{Process.pid})"
               @runner.start
             end
 
             def parse_opts(opts)
               @emulator = opts[:emulator]
-              logger.info 'Running in emulator mode' if @emulator
               @config = opts[:config]
-              logger.debug "Using config file: #{@config}"
             end
 
             def build_runner
@@ -100,11 +90,7 @@ module Hanami
             end
 
             def logger
-              @logger ||= if defined?(Hanami.logger)
-                            Hanami.logger
-                          else
-                            Logger.new(STDOUT)
-                          end
+              CloudPubsub.logger
             end
 
             def setup_signal_handlers

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'hanami/events/cloud_pubsub/safe_error_handler'
+
 module Hanami
   module Events
     module CloudPubsub
@@ -70,17 +72,15 @@ module Hanami
 
         #:reek:TooManyStatements
         #:reek:DuplicateMethodCall
-        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        # rubocop:disable Metrics/MethodLength
         def run_handler(message)
-          id = message.message_id
           succeeded = false
           failed = false
-
           handler.call(message)
           succeeded = true
         rescue Exception => err # rubocop:disable all
           failed = true
-          logger.error "Message(#{id}) failed with exception #{err.inspect}"
+          run_error_handlers(err, message)
           raise err
         ensure
           id = message.message_id
@@ -92,7 +92,7 @@ module Hanami
             logger.warn "Message(#{id}) was terminated from outside, rescheduling"
           end
         end
-        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+        # rubocop:enable Metrics/MethodLength
 
         def subscription_for(name)
           topic.find_subscription(name) || topic.create_subscription(name)
@@ -101,6 +101,12 @@ module Hanami
         def ensure_subscriber!
           raise NoSubscriberError, 'No subsriber has been registered' unless @subscriber
         end
+
+        def run_error_handlers(err, message)
+          CloudPubsub.error_handlers.each do |handler|
+            SafeErrorHandler.call(handler, err, message)
+          end
+        end
       end
     end
   end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Hanami
+  module Events
+    module CloudPubsub
+      # Safely run error_handlers
+      module SafeErrorHandler
+        def self.call(handler, err, message)
+          handler.call(err, message)
+        rescue StandardError => ex
+          CloudPubsub.logger.error '!!! ERROR HANDLER THREW AN ERROR !!!'
+          CloudPubsub.logger.error ex
+          CloudPubsub.logger.error ex.backtrace.join("\n") unless ex.backtrace.nil?
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module Hanami
   module Events
     module CloudPubsub
-      VERSION = '0.1.5'
+      VERSION = '0.2.0'
     end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: hanami-events-cloud_pubsub
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Ian Ker-Seymer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-06 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: google-cloud-pubsub
   requirement: !ruby/object:Gem::Requirement
@@ -127,6 +141,7 @@ files:
 - lib/hanami/events/cloud_pubsub/listener.rb
 - lib/hanami/events/cloud_pubsub/mixin.rb
 - lib/hanami/events/cloud_pubsub/runner.rb
+- lib/hanami/events/cloud_pubsub/safe_error_handler.rb
 - lib/hanami/events/cloud_pubsub/thread_inspector.rb
 - lib/hanami/events/cloud_pubsub/version.rb
 - log/.keep