dry-monitor 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e25e7f449ab08998c06d514cb55595116e776f6
-  data.tar.gz: e8d85581444bcadcfa5a1217d97ce7563c5ac4e2
+  metadata.gz: ea5ea283589f7fcf5e657a51044c7085348464de
+  data.tar.gz: 70cb63d6bea9a42c7002b90cd994bd4a6cc549d9
 SHA512:
-  metadata.gz: 50186476dfcdd3ebc7eff4c16379a0439aa7c8b0d6334d68ae772cc6c97c6aca87ead6d8e298f92f9e12a5ee264b5cfca7afb084c97e4d99e04560d6e0a4a58a
-  data.tar.gz: 64b53c3ee78d4b2d7d18286f0e4504f20d09bd6fcfcb12cdee9f3e5fa94a8296fa7e3929450e2a1c7c37987d268d5a0ef09ce18e75400c66c9340027350488dd
+  metadata.gz: 5383bf2d033695ea44b7404bbc04f59bb412bf0cde5449e1b279aa9be147044205ab1d027b746345f837db25d9975975068c0a2e041cb580cfeccaa3205e25d1
+  data.tar.gz: 1b3952264e029600d2aba9baf9c96bae93766a420c87492f31c0734a8e479a00879cf796467bccac584f4d809482b4e73ea4500e4a42fd70e25ff490648f0b1f

data/.travis.yml

@@ -1,20 +1,17 @@
 language: ruby
-dist: trusty
-sudo: required
 cache: bundler
-bundler_args: --without sql benchmarks console tools
+bundler_args: --without benchmarks console tools
 script: "bundle exec rake ci"
+before_install: gem update --system
 after_success:
   - '[ "${TRAVIS_JOB_NUMBER#*.}" = "1" ] && [ "$TRAVIS_BRANCH" = "master" ] && bundle exec codeclimate-test-reporter'
 rvm:
-  - 2.4.0
-  - 2.3
-  - 2.2
-  - rbx-3
-  - jruby
+  - 2.5.0
+  - 2.4.3
+  - 2.3.6
+  - jruby-9.1.9.0
 env:
   global:
-    - JRUBY_OPTS='--dev -J-Xmx1024M'
     - COVERAGE='true'
 notifications:
   webhooks:

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# v0.1.0 2018-01-02
+
+### Fixed
+
+* Query params are logged correctly via rack middleware (solnic)
+
+### Changed
+
+* Uses `dry-events` for notifications (solnic)
+
 # v0.0.3 2017-08-28
 
 ### Changed

data/Gemfile

@@ -2,6 +2,8 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'dry-events', git: 'https://github.com/dry-rb/dry-events.git', branch: 'master'
+
 group :test do
   gem 'rack'
   gem 'simplecov', platform: :mri, require: false

data/dry-monitor.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rouge', '~> 2.0', '>= 2.2.1'
   spec.add_runtime_dependency 'dry-equalizer', '~> 0.2'
   spec.add_runtime_dependency 'dry-configurable', '~> 0.5'
+  spec.add_runtime_dependency 'dry-events', '~> 0.1'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

data/lib/dry/monitor/notifications.rb

@@ -1,3 +1,5 @@
+require 'dry/events/publisher'
+
 module Dry
   module Monitor
     class Clock
@@ -15,40 +17,18 @@ module Dry
 
     CLOCK = Clock.new
 
-    class Event
-      attr_reader :id
-
-      attr_reader :info
-
-      def initialize(id, info = {})
-        @id = id
-        @info = info
-      end
-    end
-
     class Notifications
+      include Events::Publisher['Dry::Monitor::Notifications']
+
       attr_reader :id
-      attr_reader :events
-      attr_reader :listeners
+
       attr_reader :clock
 
       def initialize(id)
         @id = id
-        @listeners = Hash.new { |h, k| h[k] = [] }
-        @events = {}
         @clock = CLOCK
       end
 
-      def event(id, info = {})
-        events[id] = Event.new(id, info) unless events.key?(id)
-        self
-      end
-
-      def subscribe(event_id, listener = nil, &block)
-        listeners[event_id] << (listener || block)
-        self
-      end
-
       def start(event_id, payload)
         instrument(event_id, payload)
       end
@@ -57,18 +37,16 @@ module Dry
         instrument(event_id, payload)
       end
 
-      def instrument(event_id, payload = nil, &block)
-        event = events[event_id]
-
+      def instrument(event_id, payload = EMPTY_HASH, &block)
         if block
           result, time = clock.measure(&block)
         end
 
-        listeners[event_id].each do |listener|
+        process(event_id, payload) do |event, listener|
           if time
-            listener.(time, event.id, payload.merge(event.info))
+            listener.(event.payload(payload.merge(time: time)))
           else
-            listener.(event.id, payload.merge(event.info))
+            listener.(event)
           end
         end
 

data/lib/dry/monitor/rack/logger.rb

@@ -11,12 +11,10 @@ module Dry
         REQUEST_METHOD = 'REQUEST_METHOD'.freeze
         PATH_INFO = 'PATH_INFO'.freeze
         REMOTE_ADDR = 'REMOTE_ADDR'.freeze
-        RACK_INPUT = 'rack.input'.freeze
-        QUERY_PARAMS = 'QUERY_PARAMS'.freeze
+        QUERY_STRING = 'QUERY_STRING'.freeze
 
         START_MSG = %(Started %s "%s" for %s at %s).freeze
         STOP_MSG = %(Finished %s "%s" for %s in %sms [Status: %s]\n).freeze
-        PARAMS_MSG = %(  Parameters %s).freeze
         QUERY_MSG = %(  Query parameters %s).freeze
         FILTERED = '[FILTERED]'.freeze
 
@@ -30,22 +28,22 @@ module Dry
         end
 
         def attach(rack_monitor)
-          rack_monitor.on(:start) do |id, payload|
-            log_start_request(payload[:env])
+          rack_monitor.on(:start) do |env:|
+            log_start_request(env)
           end
 
-          rack_monitor.on(:stop) do |id, payload|
-            log_stop_request(payload[:env], payload[:status], payload[:time])
+          rack_monitor.on(:stop) do |env:, status:, time:|
+            log_stop_request(env, status, time)
           end
 
-          rack_monitor.on(:error) do |id, payload|
-            log_exception(payload[:exception], payload[:name])
+          rack_monitor.on(:error) do |exception:|
+            log_exception(exception)
           end
         end
 
-        def log_exception(e, app_name)
+        def log_exception(e)
           logger.error e.message
-          logger.error filter_backtrace(e.backtrace, app_name).join("\n")
+          logger.error filter_backtrace(e.backtrace).join("\n")
         end
 
         def log_start_request(request)
@@ -69,7 +67,7 @@ module Dry
         end
 
         def log_request_params(request)
-          with_http_params(request[QUERY_PARAMS]) do |params|
+          with_http_params(request[QUERY_STRING]) do |params|
             info QUERY_MSG % [params.inspect]
           end
         end
@@ -80,12 +78,13 @@ module Dry
 
         def with_http_params(params)
           params = ::Rack::Utils.parse_nested_query(params)
+
           if params.size > 0
             yield(filter_params(params))
           end
         end
 
-        def filter_backtrace(backtrace, app_name)
+        def filter_backtrace(backtrace)
           # TODO: what do we want to do with this?
           backtrace.reject { |l| l.include?('gems') }
         end

data/lib/dry/monitor/rack/middleware.rb

@@ -1,4 +1,5 @@
 require 'rack/utils'
+require 'dry/monitor/notifications'
 
 module Dry
   module Monitor
@@ -8,15 +9,16 @@ module Dry
         REQUEST_STOP = :'rack.request.stop'
         REQUEST_ERROR = :'rack.request.error'
 
+        Notifications.register_event(REQUEST_START)
+        Notifications.register_event(REQUEST_STOP)
+        Notifications.register_event(REQUEST_ERROR)
+
         attr_reader :app
+
         attr_reader :notifications
 
         def initialize(*args)
           @notifications, @app = *args
-
-          notifications.event(REQUEST_START)
-          notifications.event(REQUEST_STOP)
-          notifications.event(REQUEST_ERROR)
         end
 
         def new(app)

data/lib/dry/monitor/sql/logger.rb

@@ -1,8 +1,11 @@
 require 'dry-configurable'
 require 'rouge'
+require 'dry/monitor/notifications'
 
 module Dry
   module Monitor
+    Notifications.register_event(:sql)
+
     module SQL
       class Logger
         extend Dry::Configurable
@@ -26,8 +29,8 @@ module Dry
         end
 
         def subscribe(notifications)
-          notifications.event(:sql).subscribe(:sql) do |time, id, payload|
-            log_query(time, payload[:name], payload[:query])
+          notifications.subscribe(:sql) do |time:, name:, query:|
+            log_query(time, name, query)
           end
         end
 

data/lib/dry/monitor/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module Monitor
-    VERSION = '0.0.3'.freeze
+    VERSION = '0.1.0'.freeze
   end
 end

data/spec/integration/instrumentation_spec.rb

@@ -3,45 +3,37 @@ require 'spec_helper'
 RSpec.describe 'Subscribing to instrumentation events' do
   subject(:notifications) { Dry::Monitor::Notifications.new(:app) }
 
-  describe '#instrument' do
-    it 'allows subscribing listeners to specific events' do
-      payload = { query: 'SELECT 1 FROM users' }
-      captured = []
-      listener = -> id, payload { captured << [id, payload] }
-
-      notifications.event(:sql, { name: 'rom[sql]' }).subscribe(:sql, listener)
-
-      notifications.instrument(:sql, payload)
-
-      expect(captured).to eql([[:sql, { name: 'rom[sql]', query: 'SELECT 1 FROM users'}]])
-    end
+  before do
+    Dry::Monitor::Notifications.register_event(:sql, { name: 'rom[sql]' })
+  end
 
+  describe '#instrument' do
     it 'allows subscribing via block' do
       captured = []
       payload = { query: 'SELECT 1 FROM users' }
 
-      notifications.event(:sql, { name: 'rom[sql]' }).subscribe(:sql) do |id, payload|
-        captured << [id, payload]
+      notifications.subscribe(:sql) do |event|
+        captured << [event.id, event[:query]]
       end
 
       notifications.instrument(:sql, payload)
 
-      expect(captured).to eql([[:sql, { name: 'rom[sql]', query: 'SELECT 1 FROM users'}]])
+      expect(captured).to eql([[:sql, 'SELECT 1 FROM users']])
     end
 
     it 'allows instrumenting via block' do
       captured = []
       payload = { query: 'SELECT 1 FROM users' }
 
-      notifications.event(:sql, { name: 'rom[sql]' }).subscribe(:sql) do |time, id, payload|
-        captured << [id, payload]
+      notifications.subscribe(:sql) do |event|
+        captured << [event.id, event[:query]]
       end
 
       notifications.instrument(:sql, payload) do
         payload
       end
 
-      expect(captured).to eql([[:sql, { name: 'rom[sql]', query: 'SELECT 1 FROM users'}]])
+      expect(captured).to eql([[:sql, 'SELECT 1 FROM users']])
     end
   end
 end

data/spec/integration/rack_middleware_spec.rb

@@ -21,7 +21,7 @@ RSpec.describe Dry::Monitor::Rack::Middleware do
 
   describe '#call' do
     let(:env) do
-      { 'REQUEST_METHOD' => 'GET', 'PATH_INFO' => '/hello-world', 'REMOTE_ADDR' => '0.0.0.0', 'QUERY_PARAMS' => query_params }
+      { 'REQUEST_METHOD' => 'GET', 'PATH_INFO' => '/hello-world', 'REMOTE_ADDR' => '0.0.0.0', 'QUERY_STRING' => query_params }
     end
 
     let(:query_params) do
@@ -53,8 +53,8 @@ RSpec.describe Dry::Monitor::Rack::Middleware do
     it 'subscribe a listener to a specific request event' do
       captured = []
 
-      middleware.on(:error) do |id, payload|
-        captured << payload
+      middleware.on(:error) do |event|
+        captured << event.payload
       end
 
       middleware.instrument(:error, exception: 'oops')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-monitor
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-28 00:00:00.000000000 Z
+date: 2018-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rouge
@@ -58,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: dry-events
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement