determinator 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08378908b45b61bc3c88232e1e480db1200acfe98d3b42dfd10e27420067b5e8'
-  data.tar.gz: ee822d9401d3c8a0019ae45ecdebd1f2becd56e7081764dd92ecbba9a30b6fa5
+  metadata.gz: 63baaf3ee379eef31694ec105e48407970d0e53e6906af8e9a1746cfac5ca5e4
+  data.tar.gz: 88b70dc55dedc32c98dc1eb3619fd420471127c812a7cdda7086c13349d3bdca
 SHA512:
-  metadata.gz: '0288df451ba45366adfb9ffb1f76147c0e565ee647d278f00b23877490cdbb7ebd4fd1b832e46f3812616894d576ee285f509df67e54a68a69415ce6370bfc65'
-  data.tar.gz: 93cc9692b60bc97bfcf629995bfd38afdbf00161864bec8b5b15568a0b409470d17b52ad1673270444afd7080ff857b10605cea4c0d733b41fbb633a8bf13dd5
+  metadata.gz: 1ea1835cd7e0953c5d6747bbcbddfc43804cd33ffc3ed136c72ede003c2a24c9357c7746081370404b9851788a0b64b9d45a633657365524ed77cf6a5a69bf67
+  data.tar.gz: 2db13fd8793c724554c2ba4766e3e769eb5d9e4042481b153a205337c5b0cfaad1bd6a691b552ee9a25109f9b8bb7b6dc6837570e909bf5d60fab1f4fe056e86

data/.circleci/config.yml

@@ -10,6 +10,10 @@ jobs:
     steps:
       - checkout
 
+      - run:
+          name: Install bundler
+          command: gem install bundler -v 2.1.4
+
       - run:
           name: Bundle Install
           command: bundle install
@@ -30,6 +34,10 @@ jobs:
     steps:
       - checkout
 
+      - run:
+          name: Install bundler
+          command: gem install bundler -v 2.1.4
+
       - run:
           name: Bundle Install
           command: bundle install
@@ -50,6 +58,10 @@ jobs:
     steps:
       - checkout
 
+      - run:
+          name: Install bundler
+          command: gem install bundler -v 2.1.4
+
       - run:
           name: Bundle Install
           command: bundle install

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2.4.0
+
+Feature:
+- Add tracker middleware
+
 # v2.3.1 (2019-05-25)
 
 Feature:

data/README.md

@@ -204,7 +204,7 @@ variant = determinator.which_variant(
     app_version: "1.2.3"
   }
 )
-``` 
+```
 The `app_version` constraint for that flag needs to follow ruby gem version constraints. We support the following operators: `>, <, >=, <=, ~>`. For example:
 `app_version: ">=1.2.0"`
 
@@ -220,6 +220,8 @@ Determinator.configure(retrieval: nil)
 
 * Tag your rspec test with `:determinator_support`, so the `forced_determination` helper method will be available.
 
+  Please note, `RSpec::Determinator` mocks a determination _outcome_, not the process of choosing one. Set the `only_for` argument to be the properties you require for Determinator to return the specified outcome. At the moment this mock does not allow for the testing of the `id` or `guid` arguments (only the properties).
+
 ```ruby
 RSpec.describe "something", :determinator_support do
 
@@ -251,6 +253,70 @@ end
 
 * Check out [the specs for `RSpec::Determinator`](spec/rspec/determinator_spec.rb) to find out what you can do!
 
+## Tracking
+
+The library includes a middleware to track all determinations being made, allowing logging them at the end of the request
+(including some useful request metrics).
+
+To enable it, e.g. in Rails:
+
+```ruby
+# config/application.rb
+
+require 'determinator/tracking/rack/middleware'
+
+# possibly near the top of your stack, in case other middlewares make determinations
+config.middleware.use Determinator::Tracking::Rack::Middleware
+```
+
+or for Sidekiq:
+
+```ruby
+# config/initializers/sidekiq.rb
+
+require 'determinator/tracking/sidekiq/middleware'
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Determinator::Tracking::Sidekiq::Middleware
+  end
+end
+```
+
+```ruby
+# config/initializers/determinator.rb
+
+require 'determinator/tracking'
+
+Determinator::Tracking.on_request do |r|
+  Rails.logger.info("tag=determinator_request type=#{r.type} request_time=#{r.time} error=#{r.error?} response_status=#{r.attributes[:status]} sidekiq_queue=#{r.attributes[:queue]}")
+  r.determinations.each do |d|
+    Rails.logger.info("tag=determination id=#{d.id} guid=#{d.guid} flag=#{d.feature_id} result=#{d.determination}")
+  end
+end
+
+# If using an APM, you can provide trace information on the request by providing a get_context hook: e.g.
+
+Determinator::Tracking.get_context do
+  span = Datadog.tracer.active_root_span
+  return unless span
+  Determinator::Tracking::Context.new(
+    request_id: span.trace_id,
+    service: span.service,
+    resource: span.resource,
+    type: span.type,
+    meta: span.meta
+  )
+end
+```
+
+NOTE: this is implemented by keeping the list of requests in a per-request thread-local variable, which means that determinations will only be tracked on the main thread.
+
+If your application is spinning out worker threads, you should make the determinations in the main thread if possible; or collect them from your worker threads and track them in the main thread with
+```
+Determinator::Tracking.track(id, guid, feature, determination)
+```
+
 ## Testing this library
 
 This library makes use of the [Determinator Standard Tests](https://github.com/deliveroo/determinator-standard-tests) to ensure that it conforms to the same specification as determinator libraries in other languages. The standard tests can be updated to the latest ones available by updating the submodule:

data/determinator.gemspec

@@ -23,11 +23,12 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "faraday"
   spec.add_runtime_dependency "semantic", "~> 1.6"
 
-  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-its", "~> 1.2"
   spec.add_development_dependency "guard-rspec", "~> 4.7"
   spec.add_development_dependency "factory_girl", "~> 4.8"
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency "sidekiq"
 end

data/lib/determinator.rb

@@ -6,6 +6,7 @@ require 'determinator/cache/fetch_wrapper'
 require 'determinator/serializers/json'
 require 'determinator/missing_response'
 require 'determinator/error_response'
+require 'determinator/tracking'
 
 
 module Determinator
@@ -83,6 +84,7 @@ module Determinator
     end
 
     def notice_determination(id, guid, feature, determination)
+      Determinator::Tracking.track(id, guid, feature, determination)
       return unless @determination_callback
       @determination_callback.call(id, guid, feature, determination)
     end

data/lib/determinator/tracking.rb

@@ -0,0 +1,62 @@
+require 'determinator/tracking/tracker'
+require 'determinator/tracking/context'
+
+module Determinator
+  module Tracking
+    class << self
+      def instance
+        Thread.current[:determinator_tracker]
+      end
+
+      def start!(type)
+        Thread.current[:determinator_tracker] = Tracker.new(type)
+      end
+
+      def finish!(error:, **attributes)
+        return false unless started?
+        request = instance.finish!(error: error, **attributes)
+        clear!
+        report(request)
+        request
+      end
+
+      def clear!
+        Thread.current[:determinator_tracker] = nil
+      end
+
+      def started?
+        !!instance
+      end
+
+      def track(id, guid, feature, determination)
+        return false unless started?
+        instance.track(id, guid, feature, determination)
+      end
+
+      def on_request(&block)
+        @on_request = block
+      end
+
+      def report(request)
+        return unless @on_request
+        @on_request.call(request)
+      end
+
+      def get_context(&block)
+        @get_context = block
+      end
+
+      def context
+        return unless @get_context
+        @get_context.call
+      rescue
+        nil
+      end
+
+      def clear_hooks!
+        @on_request = nil
+        @get_context = nil
+      end
+    end
+  end
+end

data/lib/determinator/tracking/context.rb

@@ -0,0 +1,15 @@
+module Determinator
+  module Tracking
+    class Context
+      attr_reader :request_id, :service, :resource
+
+      def initialize(request_id: nil, service: nil, resource: nil, type: nil, meta: {})
+        @request_id = request_id
+        @service = service
+        @resource = resource
+        @type = type
+        @meta = meta
+      end
+    end
+  end
+end

data/lib/determinator/tracking/determination.rb

@@ -0,0 +1,18 @@
+module Determinator
+  module Tracking
+    class Determination
+      attr_reader :id, :guid, :feature_id, :determination
+
+      def initialize(id:, guid:, feature_id:, determination:)
+        @id = id
+        @guid = guid
+        @feature_id = feature_id
+        @determination = determination
+      end
+
+      def ==(other)
+        id == other.id && guid == other.guid && feature_id == other.feature_id && determination == other.determination
+      end
+    end
+  end
+end

data/lib/determinator/tracking/rack/middleware.rb

@@ -0,0 +1,24 @@
+require 'determinator/tracking'
+
+module Determinator
+  module Tracking
+    module Rack
+      class Middleware
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          Determinator::Tracking.start!(:rack)
+          status, headers, response = @app.call(env)
+          [status, headers, response]
+        rescue
+          error = true
+          raise
+        ensure
+          Determinator::Tracking.finish!(status: status, error: !!error)
+        end
+      end
+    end
+  end
+end

data/lib/determinator/tracking/request.rb

@@ -0,0 +1,20 @@
+module Determinator
+  module Tracking
+    class Request
+      attr_reader :type, :time, :error, :attributes, :determinations, :context
+
+      def initialize(type:, time:, error:, attributes:, determinations:, context: nil)
+        @type = type
+        @time = time
+        @error = error
+        @attributes = attributes
+        @determinations = determinations
+        @context = context
+      end
+
+      def error?
+        error
+      end
+    end
+  end
+end

data/lib/determinator/tracking/sidekiq/middleware.rb

@@ -0,0 +1,27 @@
+require 'determinator/tracking'
+
+module Determinator
+  module Tracking
+    module Sidekiq
+      class Middleware
+        # @param [Object] worker the worker instance
+        # @param [Hash] job the full job payload
+        #   * @see https://github.com/mperham/sidekiq/wiki/Job-Format
+        # @param [String] queue the name of the queue the job was pulled from
+        # @yield the next middleware in the chain or worker `perform` method
+        # @return [Void]
+        def call(worker, job, queue)
+          begin
+            Determinator::Tracking.start!(:sidekiq)
+            yield
+          rescue => ex
+            error = true
+            raise
+          ensure
+            Determinator::Tracking.finish!(queue: queue, error: !!error)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/determinator/tracking/tracker.rb

@@ -0,0 +1,43 @@
+require 'determinator/tracking/determination'
+require 'determinator/tracking/request'
+
+module Determinator
+  module Tracking
+    class Tracker
+      attr_reader :type, :determinations
+
+      def initialize(type)
+        @determinations = []
+        @type = type
+        @start = now
+      end
+
+      def track(id, guid, feature, determination)
+        determinations << Determinator::Tracking::Determination.new(
+          id: id,
+          guid: guid,
+          feature_id: feature.identifier,
+          determination: determination
+        )
+      end
+
+      def finish!(error:, **attributes)
+        request_time = now - @start
+        Determinator::Tracking::Request.new(
+          type: type,
+          time: request_time,
+          error: error,
+          attributes: attributes,
+          determinations: determinations,
+          context: Determinator::Tracking.context
+        )
+      end
+
+      private
+
+      def now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    end
+  end
+end

data/lib/determinator/version.rb

@@ -1,3 +1,3 @@
 module Determinator
-  VERSION = '2.3.1'
+  VERSION = '2.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: determinator
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - JP Hastings-Spital
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-25 00:00:00.000000000 Z
+date: 2020-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - jp@deliveroo.co.uk
@@ -204,6 +218,13 @@ files:
 - lib/determinator/retrieve/null_retriever.rb
 - lib/determinator/serializers/json.rb
 - lib/determinator/target_group.rb
+- lib/determinator/tracking.rb
+- lib/determinator/tracking/context.rb
+- lib/determinator/tracking/determination.rb
+- lib/determinator/tracking/rack/middleware.rb
+- lib/determinator/tracking/request.rb
+- lib/determinator/tracking/sidekiq/middleware.rb
+- lib/determinator/tracking/tracker.rb
 - lib/determinator/version.rb
 - lib/rspec/determinator.rb
 homepage: https://github.com/deliveroo/determinator
@@ -225,8 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Determine which experiments and features a specific actor should see.