determinator 2.6.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fe6fd684f160e1d955e9528bd225942068320361d554102b63667125503e610
-  data.tar.gz: f70731d2a63bffa170ee0d545fa9efbc2271fc32995c6635fc4feea33ac38c65
+  metadata.gz: f7c5b0103e26f752c64d792674d30d854f7265f2a48ad3d546e4f2a758bb811a
+  data.tar.gz: 99f0c278fd6b91fb1f20fcced167dcd8b70020b78d80be9803bc88ecdadfc7ae
 SHA512:
-  metadata.gz: 0debe679036a419091917171e90ce4360ec0ea8afdc3d2b0d536b1796cd93b2ffe1fe3b6dc933cfe03642be61bde94c12b471a6aca2d7a04c087f24e6b6b8e94
-  data.tar.gz: 423c16ff61e48e2da9e8883329b70a031819be4741b2f9031fe0cd6c1681e0df43d52f98028b5002a6e6ad82f6774aa24fed5ddf227b56a8d75bb59e3a81ccde
+  metadata.gz: ed644f22e58a4d761eae0cff9d8f14b5ab257fd962d2d3bd5734679b38b5ba12d7dee61632710dbd0b116c0dd846ca2952b12ad0184252f8789b74a8fc62847b
+  data.tar.gz: 78fd4b1d2de15e59fe1f417dc2703b37e643d8a08af493bcd1c4c51208493eab2fba82ab37b8b60af420b9d22e6402f4b570291a4d437d51172496ffd1e59e97

data/.github/workflows/gem-push.yml

@@ -0,0 +1,33 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set git user
+      run: |
+        git config user.email "rooci@deliveroo.co.uk"
+        git config user.name "Determinator Release Github Action"
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        rake release
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+# 2.9.0
+
+Feature:
+- When an app_version does not comply with semantic versioning specifications (e.g.: 2021.11.05 with a trailing zero instead of the correct 2021.11.5), return false.
+
+# 2.8.0
+
+Feature:
+- When a GUID bucketed feature is misconfigured, handle the error and return false.
+
+# 2.7.1
+
+Feature:
+- Add `before_retrieve` and `after_retrieve` hooks for `Determinator::Retrieve::HttpRetriever`
+
+# 2.7.0
+
+⚠️ This release includes breaking changes ⚠️
+
+Interface change:
+- Constraints which are not arrays of strings are no longer accepted; if present, the library returns false and logs an error.
+
 # 2.6.0
 
 Interface change:

data/README.md

@@ -156,6 +156,23 @@ or in instances where the event bus provides a full feature object with a name i
 
 This will expire both the limited local cache and the larger shared cache.
 
+### Using hooks for retriever
+
+```HttpRetriever``` has ```before_retrieve``` and ```after_retrieve``` hooks.
+
+Example of usage:
+```ruby
+http_retriever = Determinator::Retrieve::HttpRetriever.new(faraday_connection)
+
+http_retriever.before_retrieve do 
+  do_something
+end
+
+http_retriever.after_retrieve do |status, err|
+  raise err if err
+  do_something(status)
+end
+```
 ## Further Usage
 
 Once this is done you can ask for a determination like this:

data/determinator.gemspec

@@ -23,12 +23,12 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "faraday"
   spec.add_runtime_dependency "semantic", "~> 1.6"
 
-  spec.add_development_dependency "bundler", "~> 2.1.4"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 12.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 "factory_bot", "~> 4.8"
   spec.add_development_dependency 'webmock'
-  spec.add_development_dependency "sidekiq"
+  spec.add_development_dependency 'sidekiq'
 end

data/examples/determinator-rails/Gemfile

@@ -1,8 +1,7 @@
 source 'https://rubygems.org'
 
-gem 'rails', '~> 5.0.2'
+gem 'rails', '~> 5.1'
 gem 'puma', '~> 3.0'
-gem 'sidekiq'
 
 gem 'determinator', path: '../..'
 

data/examples/determinator-rails/Gemfile.lock

@@ -1,140 +1,144 @@
 PATH
   remote: ../..
   specs:
-    determinator (1.2.0)
+    determinator (2.6.0)
       faraday
+      semantic (~> 1.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.0.7)
-      actionpack (= 5.0.7)
-      nio4r (>= 1.2, < 3.0)
-      websocket-driver (~> 0.6.1)
-    actionmailer (5.0.7)
-      actionpack (= 5.0.7)
-      actionview (= 5.0.7)
-      activejob (= 5.0.7)
+    actioncable (5.2.4.4)
+      actionpack (= 5.2.4.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.4.4)
+      actionpack (= 5.2.4.4)
+      actionview (= 5.2.4.4)
+      activejob (= 5.2.4.4)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.0.7)
-      actionview (= 5.0.7)
-      activesupport (= 5.0.7)
-      rack (~> 2.0)
-      rack-test (~> 0.6.3)
+    actionpack (5.2.4.4)
+      actionview (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.0.7)
-      activesupport (= 5.0.7)
+    actionview (5.2.4.4)
+      activesupport (= 5.2.4.4)
       builder (~> 3.1)
-      erubis (~> 2.7.0)
+      erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.0.7)
-      activesupport (= 5.0.7)
+    activejob (5.2.4.4)
+      activesupport (= 5.2.4.4)
       globalid (>= 0.3.6)
-    activemodel (5.0.7)
-      activesupport (= 5.0.7)
-    activerecord (5.0.7)
-      activemodel (= 5.0.7)
-      activesupport (= 5.0.7)
-      arel (~> 7.0)
-    activesupport (5.0.7)
+    activemodel (5.2.4.4)
+      activesupport (= 5.2.4.4)
+    activerecord (5.2.4.4)
+      activemodel (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
+      arel (>= 9.0)
+    activestorage (5.2.4.4)
+      actionpack (= 5.2.4.4)
+      activerecord (= 5.2.4.4)
+      marcel (~> 0.3.1)
+    activesupport (5.2.4.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    arel (7.1.4)
-    builder (3.2.3)
-    byebug (10.0.2)
-    concurrent-ruby (1.0.5)
-    connection_pool (2.2.2)
-    crass (1.0.4)
-    dotenv (2.4.0)
-    dotenv-rails (2.4.0)
-      dotenv (= 2.4.0)
-      railties (>= 3.2, < 6.0)
-    erubis (2.7.0)
-    faraday (0.15.4)
+    arel (9.0.0)
+    builder (3.2.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    dotenv (2.7.6)
+    dotenv-rails (2.7.6)
+      dotenv (= 2.7.6)
+      railties (>= 3.2)
+    erubi (1.10.0)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    globalid (0.4.1)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.0.1)
+    i18n (1.8.7)
       concurrent-ruby (~> 1.0)
-    loofah (2.2.2)
+    loofah (2.9.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    mail (2.7.0)
+    mail (2.7.1)
       mini_mime (>= 0.1.1)
-    method_source (0.9.0)
-    mini_mime (1.0.0)
-    mini_portile2 (2.3.0)
-    minitest (5.11.3)
-    multipart-post (2.0.0)
-    nio4r (2.3.1)
-    nokogiri (1.8.2)
-      mini_portile2 (~> 2.3.0)
-    puma (3.11.4)
-    rack (2.0.5)
-    rack-protection (2.0.3)
-      rack
-    rack-test (0.6.3)
-      rack (>= 1.0)
-    rails (5.0.7)
-      actioncable (= 5.0.7)
-      actionmailer (= 5.0.7)
-      actionpack (= 5.0.7)
-      actionview (= 5.0.7)
-      activejob (= 5.0.7)
-      activemodel (= 5.0.7)
-      activerecord (= 5.0.7)
-      activesupport (= 5.0.7)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    minitest (5.14.3)
+    multipart-post (2.1.1)
+    nio4r (2.5.4)
+    nokogiri (1.11.1-x86_64-darwin)
+      racc (~> 1.4)
+    puma (3.12.6)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.4.4)
+      actioncable (= 5.2.4.4)
+      actionmailer (= 5.2.4.4)
+      actionpack (= 5.2.4.4)
+      actionview (= 5.2.4.4)
+      activejob (= 5.2.4.4)
+      activemodel (= 5.2.4.4)
+      activerecord (= 5.2.4.4)
+      activestorage (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
       bundler (>= 1.3.0)
-      railties (= 5.0.7)
+      railties (= 5.2.4.4)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.0.7)
-      actionpack (= 5.0.7)
-      activesupport (= 5.0.7)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.4.4)
+      actionpack (= 5.2.4.4)
+      activesupport (= 5.2.4.4)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (12.3.1)
-    redis (4.0.1)
-    sidekiq (5.1.3)
-      concurrent-ruby (~> 1.0)
-      connection_pool (~> 2.2, >= 2.2.0)
-      rack-protection (>= 1.5.0)
-      redis (>= 3.3.5, < 5)
-    sprockets (3.7.1)
+      thor (>= 0.19.0, < 2.0)
+    rake (13.0.3)
+    ruby2_keywords (0.0.4)
+    semantic (1.6.1)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.1)
+    sprockets-rails (3.2.2)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    thor (0.20.0)
+    thor (1.1.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
-    websocket-driver (0.6.5)
+    websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
+    websocket-extensions (0.1.5)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
   byebug
   determinator!
   dotenv-rails
   puma (~> 3.0)
-  rails (~> 5.0.2)
-  sidekiq
+  rails (~> 5.1)
 
 BUNDLED WITH
-   1.17.3
+   2.2.7

data/examples/determinator-rails/app/controllers/index_controller.rb

@@ -5,9 +5,13 @@ class IndexController < ApplicationController
 
     message = [
       is_colloquial ? "hi world" : "hello world",
-      emoji
+      (emoji if emoji)
     ].compact.join(" ")
 
-    render json: { welcome: message }
+    explain = "An experiment and a feature flag are being checked for the user with guid #{guid}. "
+    explain += "The feature flag (colloquial_welcome) is #{is_colloquial ? 'on' : 'off'}. "
+    explain += "The experiment (welcome_emoji) returned #{emoji}#{", so is omitted" unless emoji}."
+
+    render json: { welcome: message, explanation: explain }
   end
 end

data/examples/determinator-rails/config/initializers/determinator.rb

@@ -1,7 +1,9 @@
-require 'determinator/retrieve/dynaconf'
+require 'determinator/retrieve/file'
 require 'active_support/cache'
 
-retrieval = Determinator::Retrieve::Dynaconf.new(base_url: 'http://localhost:2345', service_name: 'determinator-rails')
+# File retriever just for example; use a Dynaconf retriever in your app
+# retrieval = Determinator::Retrieve::Dynaconf.new(base_url: ENV['DYNACONF_URL'], service_name: 'determinator-rails')
+retrieval = Determinator::Retrieve::File.new(root: File.join(__dir__, "../../example_features"))
 feature_cache = Determinator::Cache::FetchWrapper.new(
   ActiveSupport::Cache::MemoryStore.new(expires_in: 1.minute)
 )

data/examples/determinator-rails/config/initializers/new_framework_defaults.rb

@@ -1,3 +1,2 @@
 ActiveSupport.to_time_preserves_timezone = true
-ActiveSupport.halt_callback_chains_on_return_false = false
 Rails.application.config.ssl_options = { hsts: { subdomains: true } }

data/examples/determinator-rails/example_features/colloquial_welcome

@@ -0,0 +1,14 @@
+{
+  "id": "colloquial_welcome",
+  "identifier": "colloquial_welcome",
+  "name": "Whether a colloquial welcome should be used",
+  "active": true,
+  "bucket_type": "guid",
+  "target_groups": [
+    {
+      "name": "50% of users",
+      "rollout": 32768,
+      "constraints": {}
+    }
+  ]
+}

data/examples/determinator-rails/example_features/welcome_emoji

@@ -0,0 +1,19 @@
+{
+  "id": "welcome_emoji",
+  "identifier": "welcome_emoji",
+  "name": "What emoji should be used for the example hello",
+  "active": true,
+  "bucket_type": "guid",
+  "variants": {
+    "👋": 1,
+    "🎉": 1
+  },
+  "winning_variant": null,
+  "target_groups": [
+    {
+      "name": "50% of users",
+      "rollout": 32768,
+      "constraints": {}
+    }
+  ]
+}

data/lib/determinator/control.rb

@@ -124,13 +124,9 @@ module Determinator
       # require_variant_determination?
       return true unless require_variant_determination?(feature)
 
-
-
       explainer.log(:chosen_variant) {
         variant_for(feature, indicators.variant)
       }
-    rescue ArgumentError
-      raise
 
     rescue => e
       Determinator.notice_error(e)
@@ -219,6 +215,9 @@ module Determinator
     end
 
     def matches_constraints(normalised_properties, constraints)
+      unless constraints.all?{ |k, v| k.is_a?(String) && v.all?{ |vv| vv.is_a?(String) } }
+        raise "Constraints must by arrays of strings"
+      end
       constraints.reduce(true) do |fit, (scope, *required)|
         present = [*normalised_properties[scope]]
         fit && matches_requirements?(scope, required, present)
@@ -242,7 +241,9 @@ module Determinator
         !v.match?(Semantic::Version::SemVerRegexp)
       end
       invalid_groups = required.flatten.select do |v|
-        !v.match?(/\d/)
+        version_sections = v.split(/(\d(.+)?)/, 2)
+        without_operator = version_sections[1]&.strip || ''
+        !without_operator.match?(Semantic::Version::SemVerRegexp)
       end
 
       return false if (invalid_properties + invalid_groups).any?

data/lib/determinator/feature.rb

@@ -84,7 +84,7 @@ module Determinator
       TargetGroup.new(
         name: target_group['name'],
         rollout: target_group['rollout'].to_i,
-        constraints: parse_constraints(constraints)
+        constraints: constraints
       )
 
     # Invalid target groups are ignored
@@ -111,17 +111,11 @@ module Determinator
         name: fixed_determination['name'],
         feature_on: fixed_determination['feature_on'],
         variant: variant,
-        constraints: parse_constraints(constraints)
+        constraints: constraints
       )
     # Invalid fixed determinations are ignored
     rescue
       nil
     end
-
-    def parse_constraints(constraints)
-      constraints.each_with_object({}) do |(key, value), hash|
-        hash[key.to_s] = [*value].map(&:to_s)
-      end
-    end
   end
 end

data/lib/determinator/retrieve/http_retriever.rb

@@ -10,11 +10,14 @@ module Determinator
       end
 
       def retrieve(name)
+        before_hook
         response = @connection.get("/features/#{name}")
+        after_hook(response.status)
         return Determinator::Serializers::JSON.load(response.body) if response.status == 200
         return MissingResponse.new if response.status == 404
       rescue => e
         Determinator.notice_error(e)
+        after_hook(500, e)
         ErrorResponse.new
       end
 
@@ -29,6 +32,28 @@ module Determinator
       def get_name(url)
         (url.match('features\/(.*)\z') || [])[1]
       end
+
+      def before_retrieve(&block)
+        @before_retrieve = block
+      end
+
+      def after_retrieve(&block)
+        @after_retrieve = block
+      end
+
+      private
+
+      def after_hook(status, error = nil)
+        return unless @after_retrieve
+
+        @after_retrieve.call(status, error)
+      end
+
+      def before_hook
+        return unless @before_retrieve
+
+        @before_retrieve.call
+      end
     end
   end
 end

data/lib/determinator/version.rb

@@ -1,3 +1,3 @@
 module Determinator
-  VERSION = '2.6.0'
+  VERSION = '2.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: determinator
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.9.0
 platform: ruby
 authors:
 - JP Hastings-Spital
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-26 00:00:00.000000000 Z
+date: 2022-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -42,30 +42,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.7'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - jp@deliveroo.co.uk
 executables: []
@@ -159,6 +159,7 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".circleci/config.yml.erb"
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
@@ -175,7 +176,6 @@ files:
 - docs/background.md
 - docs/img/determinator.jpg
 - docs/local_development.md
-- examples/determinator-rails/.env
 - examples/determinator-rails/.gitignore
 - examples/determinator-rails/Gemfile
 - examples/determinator-rails/Gemfile.lock
@@ -202,6 +202,8 @@ files:
 - examples/determinator-rails/config/puma.rb
 - examples/determinator-rails/config/routes.rb
 - examples/determinator-rails/config/secrets.yml
+- examples/determinator-rails/example_features/colloquial_welcome
+- examples/determinator-rails/example_features/welcome_emoji
 - examples/determinator-rails/public/favicon.ico
 - examples/determinator-rails/public/robots.txt
 - lib/determinator.rb
@@ -234,7 +236,7 @@ homepage: https://github.com/deliveroo/determinator
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -249,8 +251,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Determine which experiments and features a specific actor should see.
 test_files: []

data/examples/determinator-rails/.env

@@ -1,7 +0,0 @@
-ROUTEMASTER_DRAIN_TOKENS=demo
-ROUTEMASTER_DRAIN_REDIS=redis://localhost/0/routemaster/drain
-ROUTEMASTER_CACHE_REDIS=redis://localhost/0/routemaster/cache
-ROUTEMASTER_CACHE_AUTH=
-ROUTEMASTER_QUEUE_ADAPTER=sidekiq
-ROUTEMASTER_QUEUE_NAME=routemaster
-ROUTEMASTER_CALLBACK_URL=https://determinator-example.dev/events