feature_flagger 1.2.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de6dae8c2c1631e95a47c0a6bb99f5e42c3ca2716f7ac4feb045fbd72a279133
-  data.tar.gz: 8619614ec4718f56ca20e1617d398ddb69bd1a81f0412568ed95c2215f7e7c2c
+  metadata.gz: 8d02210f5b573bd3ebb01a75794885b729981a740412bf045b713a8d9db37a75
+  data.tar.gz: cd9f4ab0e6058029e8a5cab354d98a0b676363a05582169f52d90578c2613b37
 SHA512:
-  metadata.gz: e930f492fd481b66cd8924b603a4e067872ab2b2d864de8402bfb28e24504d81c5b3149596f0c08c255eaf84b74ca98a82657d3ac2f1ef54c9c538facfcf3428
-  data.tar.gz: 851c0d1b9eab08442232ee9c3681b3e90b559ed0fc01e4e631c7e3ec26915731682b393ceb1d5d447d1565c20896fbd138fcd18c7678aabfd2047a5158867250
+  metadata.gz: d10511abc507466990deaae846843474ebeb9e3ace09e61b2e08bead320a26849f1e8cf04b8ecc52a91de7e7e01348435e5d92332dd98ceea878866da3548be6
+  data.tar.gz: 3c3564c0c34b2ed86552637a47b4af544f66c22100d31d7b89e54d22316e7fa4049118f7973fe1cdf05c837ce0668aa163720fe8bebb43f86011c1d3e9abeeda

data/README.md

@@ -28,7 +28,6 @@ Or install it yourself as:
 
     $ gem install feature_flagger
 
-
 ## Configuration
 
 By default, feature_flagger uses the REDIS_URL env var to setup it's storage.
@@ -44,6 +43,15 @@ FeatureFlagger.configure do |config|
 end
 ```
 
+It's also possible to configure an additional cache layer by using ActiveSupport::Cache APIs. You can configure it the same way you would setup cache_store for Rails Apps. Caching is not enabled by default.
+
+
+```ruby
+configuration.cache_store = :memory_store, { expires_in: 100 }
+
+```
+
+
 1. Create a `rollout.yml` in _config_ path and declare a rollout:
 ```yml
 account: # model name
@@ -60,6 +68,29 @@ class Account < ActiveRecord::Base
   # ....
 end
 ```
+#### Notifier
+The notifier_callback property in config, enables the dispatch of events when a release operation happens.
+```ruby
+config.notifier_callback = -> {|event| do something with event }
+```
+
+
+It accepts a lambda function that will receive a hash with the operation triggered like:
+```ruby
+{
+  type: 'release',
+  model: 'account',
+  key: 'somefeature:somerolloutkey'
+  id: 'account_id' #In realease_to_all and unrelease_to_all operations id will be nil 
+}
+```
+
+The supported operations are:
+* release
+* unrelease
+* release_to_all
+* unrelease_to_all 
+
 
 ## Usage
 
@@ -74,6 +105,10 @@ account.release(:email_marketing, :new_email_flow)
 account.released?(:email_marketing, :new_email_flow)
 #=> true
 
+# In order to bypass the cache if cache_store is configured
+account.released?(:email_marketing, :new_email_flow, skip_cache: true)
+#=> true
+
 # Remove feature for given account
 account.unrelease(:email_marketing, :new_email_flow)
 #=> true
@@ -86,6 +121,10 @@ FeatureFlagger::KeyNotFoundError: ["account", "email_marketing", "new_email_flo"
 Account.released_id?(42, :email_marketing, :new_email_flow)
 #=> true
 
+# In order to bypass the cache if cache_store is configured
+Account.released_id?(42, :email_marketing, :new_email_flow, skip_cache: true)
+#=> true
+
 # Release a feature for a specific account id
 Account.release_id(42, :email_marketing, :new_email_flow)
 #=> true
@@ -101,6 +140,10 @@ Account.unrelease_to_all(:email_marketing, :new_email_flow)
 
 # Return an array with all features released for all
 Account.released_features_to_all
+
+# In order to bypass the cache if cache_store is configured
+Account.released_features_to_all(skip_cache: true)
+
 ```
 
 ## Clean up action

data/lib/feature_flagger.rb

@@ -2,6 +2,7 @@ require 'yaml'
 
 require 'feature_flagger/version'
 require 'feature_flagger/storage/redis'
+require 'feature_flagger/storage/feature_keys_migration'
 require 'feature_flagger/control'
 require 'feature_flagger/model'
 require 'feature_flagger/model_settings'
@@ -9,12 +10,14 @@ require 'feature_flagger/feature'
 require 'feature_flagger/configuration'
 require 'feature_flagger/manager'
 require 'feature_flagger/railtie'
+require 'feature_flagger/notifier'
 
 module FeatureFlagger
   class << self
     def configure
       @@configuration = nil
       @@control = nil
+      @@notifier = nil
       yield config if block_given?
     end
 
@@ -22,8 +25,12 @@ module FeatureFlagger
       @@configuration ||= Configuration.new
     end
 
+    def notifier
+      @@notifier ||= Notifier.new(config.notifier_callback)
+    end
+
     def control
-      @@control ||= Control.new(config.storage)
+      @@control ||= Control.new(config.storage, notifier, config.cache_store)
     end
   end
 end

data/lib/feature_flagger/configuration.rb

@@ -1,10 +1,19 @@
 module FeatureFlagger
   class Configuration
-    attr_accessor :storage, :yaml_filepath
+    attr_accessor :storage, :cache_store, :yaml_filepath, :notifier_callback
 
     def initialize
       @storage       ||= Storage::Redis.default_client
       @yaml_filepath ||= default_yaml_filepath
+      @notifier_callback = nil
+      @cache_store = nil
+    end
+
+    def cache_store=(cache_store)
+      raise ArgumentError, "Cache is only support when used with ActiveSupport" unless defined?(ActiveSupport)
+
+      cache_store = :null_store if cache_store.nil?
+      @cache_store = ActiveSupport::Cache.lookup_store(*cache_store)
     end
 
     def info

data/lib/feature_flagger/control.rb

@@ -4,12 +4,16 @@ module FeatureFlagger
 
     RELEASED_FEATURES = 'released_features'
 
-    def initialize(storage)
+    def initialize(storage, notifier, cache_store = nil)
       @storage = storage
+      @notifier = notifier
+      @cache_store = cache_store
     end
 
-    def released?(feature_key, resource_id)
-      @storage.has_value?(RELEASED_FEATURES, feature_key) || @storage.has_value?(feature_key, resource_id)
+    def released?(feature_key, resource_id, options = {})
+      cache "released/#{feature_key}/#{resource_id}", options do
+        @storage.has_value?(RELEASED_FEATURES, feature_key) || @storage.has_value?(feature_key, resource_id)
+      end
     end
 
     def release(feature_key, resource_id)
@@ -17,14 +21,18 @@ module FeatureFlagger
         feature_key
       )
 
+      @notifier.send(FeatureFlagger::Notifier::RELEASE, feature_key, resource_id)
       @storage.add(feature_key, resource_name, resource_id)
     end
 
-    def releases(resource_name, resource_id)
-      @storage.fetch_releases(resource_name, resource_id, RELEASED_FEATURES)
+    def releases(resource_name, resource_id, options = {})
+      cache "releases/#{resource_name}/#{resource_id}", options do
+        @storage.fetch_releases(resource_name, resource_id, RELEASED_FEATURES)
+      end
     end
 
     def release_to_all(feature_key)
+      @notifier.send(FeatureFlagger::Notifier::RELEASE_TO_ALL, feature_key)
       @storage.add_all(RELEASED_FEATURES, feature_key)
     end
 
@@ -32,24 +40,31 @@ module FeatureFlagger
       resource_name = Storage::Keys.extract_resource_name_from_feature_key(
         feature_key
       )
-
+      @notifier.send(FeatureFlagger::Notifier::UNRELEASE, feature_key, resource_id)
       @storage.remove(feature_key, resource_name, resource_id)
     end
 
     def unrelease_to_all(feature_key)
+      @notifier.send(FeatureFlagger::Notifier::UNRELEASE_TO_ALL, feature_key)
       @storage.remove_all(RELEASED_FEATURES, feature_key)
     end
 
-    def resource_ids(feature_key)
-      @storage.all_values(feature_key)
+    def resource_ids(feature_key, options = {})
+      cache "all_values/#{feature_key}", options do
+        @storage.all_values(feature_key)
+      end
     end
 
-    def released_features_to_all
-      @storage.all_values(RELEASED_FEATURES)
+    def released_features_to_all(options = {})
+      cache "released_features_to_all/#{RELEASED_FEATURES}", options do
+        @storage.all_values(RELEASED_FEATURES)
+      end
     end
 
-    def released_to_all?(feature_key)
-      @storage.has_value?(RELEASED_FEATURES, feature_key)
+    def released_to_all?(feature_key, options = {})
+      cache "has_value/#{RELEASED_FEATURES}/#{feature_key}", options do
+        @storage.has_value?(RELEASED_FEATURES, feature_key)
+      end
     end
 
     # DEPRECATED: this method will be removed from public api on v2.0 version.
@@ -59,7 +74,18 @@ module FeatureFlagger
     end
 
     def feature_keys
-      @storage.feature_keys
+      @storage.feature_keys - [FeatureFlagger::Control::RELEASED_FEATURES]
+    end
+
+    def cache(name, options, &block)
+      if @cache_store
+        @cache_store.fetch(name, force: options[:skip_cache]) do
+          block.call
+        end
+      else
+        block.call
+      end
     end
+
   end
 end

data/lib/feature_flagger/manager.rb

@@ -4,7 +4,7 @@ module FeatureFlagger
     def self.detached_feature_keys
       persisted_features = FeatureFlagger.control.feature_keys
       mapped_feature_keys = FeatureFlagger.config.mapped_feature_keys
-      
+
       persisted_features - mapped_feature_keys
     end
 

data/lib/feature_flagger/model.rb

@@ -12,8 +12,8 @@ module FeatureFlagger
       base.extend ClassMethods
     end
 
-    def released?(*feature_key)
-      self.class.released_id?(feature_flagger_identifier, feature_key)
+    def released?(*feature_key, **options)
+      self.class.released_id?(feature_flagger_identifier, feature_key, options)
     end
 
     def release(*feature_key)
@@ -26,9 +26,9 @@ module FeatureFlagger
       FeatureFlagger.control.unrelease(feature.key, id)
     end
 
-    def releases
+    def releases(options = {})
       resource_name = self.class.feature_flagger_model_settings.entity_name
-      FeatureFlagger.control.releases(resource_name, id)
+      FeatureFlagger.control.releases(resource_name, id, options)
     end
 
     private
@@ -43,9 +43,9 @@ module FeatureFlagger
         yield feature_flagger_model_settings
       end
 
-      def released_id?(resource_id, *feature_key)
+      def released_id?(resource_id, *feature_key, **options)
         feature = Feature.new(feature_key, feature_flagger_model_settings.entity_name)
-        FeatureFlagger.control.released?(feature.key, resource_id)
+        FeatureFlagger.control.released?(feature.key, resource_id, options)
       end
 
       def release_id(resource_id, *feature_key)
@@ -58,10 +58,10 @@ module FeatureFlagger
         FeatureFlagger.control.unrelease(feature.key, resource_id)
       end
 
-      def all_released_ids_for(*feature_key)
+      def all_released_ids_for(*feature_key, **options)
         feature_key.flatten!
         feature = Feature.new(feature_key, feature_flagger_model_settings.entity_name)
-        FeatureFlagger.control.resource_ids(feature.key)
+        FeatureFlagger.control.resource_ids(feature.key, options)
       end
 
       def release_to_all(*feature_key)
@@ -74,13 +74,13 @@ module FeatureFlagger
         FeatureFlagger.control.unrelease_to_all(feature.key)
       end
 
-      def released_features_to_all
-        FeatureFlagger.control.released_features_to_all
+      def released_features_to_all(options = {})
+        FeatureFlagger.control.released_features_to_all(options)
       end
 
-      def released_to_all?(*feature_key)
+      def released_to_all?(*feature_key, **options)
         feature = Feature.new(feature_key, feature_flagger_model_settings.entity_name)
-        FeatureFlagger.control.released_to_all?(feature.key)
+        FeatureFlagger.control.released_to_all?(feature.key, options)
       end
 
       def detached_feature_keys

data/lib/feature_flagger/notifier.rb

@@ -0,0 +1,45 @@
+module FeatureFlagger
+  class Notifier
+    attr_reader :notify
+
+    RELEASE = 'release'.freeze
+    UNRELEASE = 'unrelease'.freeze
+    RELEASE_TO_ALL = 'release_to_all'.freeze
+    UNRELEASE_TO_ALL = 'unrelease_to_all'.freeze
+
+    def initialize(notify = nil)
+      @notify = valid_notify?(notify) ? notify : nullNotify
+    end
+
+    def send(operation, feature_key, resource_id = nil)
+      @notify.call(build_event(operation, extract_resource_from_key(feature_key), feature_key, resource_id))
+    end
+
+    private
+
+    def nullNotify
+      lambda {|e| }
+    end
+
+    def valid_notify?(notify)
+      !notify.nil? && notify.is_a?(Proc)
+    end
+
+    def extract_resource_from_key(key)
+      Storage::Keys.extract_resource_name_from_feature_key(
+        key
+      )
+    rescue FeatureFlagger::Storage::Keys::InvalidResourceNameError
+      "legacy key"
+    end
+
+    def build_event(operation, resource_name, feature_key, resource_id)
+      {
+        type: operation,
+        model: resource_name,
+        feature: feature_key,
+        id: resource_id
+      }
+    end
+  end
+end

data/lib/feature_flagger/storage/feature_keys_migration.rb

@@ -48,7 +48,9 @@ module FeatureFlagger
         def migrate_release(key)
           resource_ids = @from_redis.smembers(key)
 
-          @to_control.release(key, resource_ids)
+          resource_ids.each do |id|
+            @to_control.release(key, id)
+          end
         end
       end
     end

data/lib/feature_flagger/storage/keys.rb

@@ -9,7 +9,6 @@ module FeatureFlagger
 
       def self.extract_resource_name_from_feature_key(feature_key)
         feature_paths = feature_key.split(':')
-
         raise InvalidResourceNameError if feature_paths.size < MINIMUM_VALID_FEATURE_PATH
 
         feature_paths.first

data/lib/feature_flagger/storage/redis.rb

@@ -21,7 +21,9 @@ module FeatureFlagger
 
       def fetch_releases(resource_name, resource_id, global_key)
         resource_key = resource_key(resource_name, resource_id)
-        @redis.sunion(resource_key, global_key)
+        releases = @redis.sunion(resource_key, global_key)
+
+        releases.select{ |release| release.start_with?(resource_name) }
       end
 
       def has_value?(key, value)

data/lib/feature_flagger/version.rb

@@ -1,3 +1,3 @@
 module FeatureFlagger
-  VERSION = "1.2.0"
+  VERSION = "2.1.1"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: feature_flagger
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Nando Sousa
 - Geison Biazus
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-03 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -39,6 +39,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -87,14 +101,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
   name: fakeredis
   requirement: !ruby/object:Gem::Requirement
@@ -127,6 +141,7 @@ files:
 - lib/feature_flagger/manager.rb
 - lib/feature_flagger/model.rb
 - lib/feature_flagger/model_settings.rb
+- lib/feature_flagger/notifier.rb
 - lib/feature_flagger/railtie.rb
 - lib/feature_flagger/storage/feature_keys_migration.rb
 - lib/feature_flagger/storage/keys.rb
@@ -137,7 +152,7 @@ homepage: http://github.com/ResultadosDigitais/feature_flagger
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,8 +167,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Partial release your features.
 test_files: []