feature_flagger 2.0.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89d925393dab41d5de3c0fd8872e9d0914936ed98140d5dea69e9ff9286cde7f
-  data.tar.gz: 68cd51804dbc9a1b8547ed1ddbd0be9630704afd0493e99b3c1a740f4c460c99
+  metadata.gz: 00bb78fb3108046b58f0f12ad0f961e064704e5fb7e4a52e7599554cf256603a
+  data.tar.gz: 84ddec88634be5e22845e2f93dd6d90893bf04475e7ec02e1389eb045eda3a8b
 SHA512:
-  metadata.gz: 6d1be4855ef2b133f1c0233f12f21833bdfd81bf35b3dd172e562fdd404bd6d674c429aeef4ec67a0f3062741b84f1ee99ba5bf6d317ec12b7f6517a9ab77ce1
-  data.tar.gz: 434ad5fda2e78b6bc63157bdee07000fcfde62ae102db74e543a09852914441c4bdd72fd15ddbf72bf1dec55e7acc2ff735d69bf9ca49e8482d56356ea032d6c
+  metadata.gz: 9f425c46c9c74000b1fdbc456d17db656665b7020c28f76812ec323b807d7b40b235b8bd9c8ca44d6b85fd209faafb856aa15909bf3b045ee6c6353603f43151
+  data.tar.gz: d55017ad557e4775638dc909cb5348afaa260c5941e0be777ef2ccfdaeb676533b59efcf384187e009bdfcad6f4c76330ae552a42abd7d81f8e51a7895e8ffb3

data/README.md

@@ -43,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
@@ -96,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
@@ -108,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
@@ -123,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
@@ -140,6 +161,32 @@ to ensure the data stored in Redis storage is right. Check [#67](https://github.
 
     $ bundle exec rake feature_flagger:migrate_to_resource_keys
 
+## Extra options
+
+There are a few options to store/retrieve your rollout manifest (a.k.a rollout.yml):
+
+If you have a rollout.yml file and want to use Redis to keep a backup, add the follow code to the configuration block:
+
+```ruby
+FeatureFlagger.configure do |config|
+  ...
+  config.manifest_source = FeatureFlagger::ManifestSources::YAMLWithBackupToStorage.new(config.storage)
+  ...
+end
+```
+
+If you already have your manifest on Redis and prefer not to keep a copy in your application, add the following code to the configuration block:
+
+```ruby
+FeatureFlagger.configure do |config|
+  ...
+  config.manifest_source = FeatureFlagger::ManifestSources::StorageOnly.new(config.storage)
+  ...
+end
+```
+
+If you have the YAML file and don't need a backup, it is unnecessary to do any different configuration.
+
 ## Contributing
 
 Bug reports and pull requests are welcome!

data/lib/feature_flagger/configuration.rb

@@ -1,15 +1,23 @@
 module FeatureFlagger
   class Configuration
-    attr_accessor :storage, :yaml_filepath, :notifier_callback
+    attr_accessor :storage, :cache_store, :manifest_source, :notifier_callback
 
     def initialize
       @storage       ||= Storage::Redis.default_client
-      @yaml_filepath ||= default_yaml_filepath
+      @manifest_source ||= FeatureFlagger::ManifestSources::WithYamlFile.new
       @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
-      @info ||= YAML.load_file(yaml_filepath) if yaml_filepath
+      @manifest_source.resolved_info
     end
 
     def mapped_feature_keys(resource_name = nil)
@@ -21,10 +29,6 @@ module FeatureFlagger
 
     private
 
-    def default_yaml_filepath
-      "#{Rails.root}/config/rollout.yml" if defined?(Rails)
-    end
-
     def make_keys_recursively(hash, keys = [], composed_key = [])
       unless hash.values[0].is_a?(Hash)
         keys.push(composed_key)

data/lib/feature_flagger/control.rb

@@ -4,13 +4,16 @@ module FeatureFlagger
 
     RELEASED_FEATURES = 'released_features'
 
-    def initialize(storage, notifier)
+    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)
@@ -22,8 +25,10 @@ module FeatureFlagger
       @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)
@@ -44,16 +49,22 @@ module FeatureFlagger
       @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.
@@ -65,5 +76,16 @@ module FeatureFlagger
     def 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/manifest_sources/storage_only.rb

@@ -0,0 +1,13 @@
+module FeatureFlagger
+  module ManifestSources
+    class StorageOnly
+      def initialize(storage)
+        @storage = storage
+      end
+
+      def resolved_info
+        YAML.load(@storage.read_manifest_backup)
+      end
+    end
+  end
+end

data/lib/feature_flagger/manifest_sources/with_yaml_file.rb

@@ -0,0 +1,14 @@
+module FeatureFlagger
+  module ManifestSources
+    class WithYamlFile
+      def initialize(yaml_path = nil)
+        @yaml_path = yaml_path
+        @yaml_path ||= "#{Rails.root}/config/rollout.yml" if defined?(Rails)
+      end
+
+      def resolved_info
+        @resolved_info ||= ::YAML.load_file(@yaml_path) if @yaml_path
+      end
+    end
+  end
+end

data/lib/feature_flagger/manifest_sources/yaml_with_backup_to_storage.rb

@@ -0,0 +1,18 @@
+module FeatureFlagger
+  module ManifestSources
+    class YAMLWithBackupToStorage
+      def initialize(storage, yaml_path = nil)
+        @yaml_path = yaml_path || ("#{Rails.root}/config/rollout.yml" if defined?(Rails))
+        @storage   = storage
+      end
+
+      def resolved_info
+        @resolved_info ||= begin
+          yaml_data = YAML.load_file(@yaml_path) if @yaml_path
+          @storage.write_manifest_backup(YAML.dump(yaml_data))
+          yaml_data
+        end
+      end
+    end
+  end
+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/storage/redis.rb

@@ -5,8 +5,10 @@ require_relative './keys'
 module FeatureFlagger
   module Storage
     class Redis
-      DEFAULT_NAMESPACE = :feature_flagger
-      RESOURCE_PREFIX = "_r".freeze
+      DEFAULT_NAMESPACE    = :feature_flagger
+      RESOURCE_PREFIX      = "_r".freeze
+      MANIFEST_PREFIX      = "_m".freeze
+      MANIFEST_KEY         = "manifest_file".freeze
       SCAN_EACH_BATCH_SIZE = 1000.freeze
 
       def initialize(redis)
@@ -75,6 +77,7 @@ module FeatureFlagger
           # Reject keys related to feature responsible for return
           # released features for a given account.
           next if key.start_with?("#{RESOURCE_PREFIX}:")
+          next if key.start_with?("#{MANIFEST_PREFIX}:")
 
           feature_keys << key
         end
@@ -89,6 +92,14 @@ module FeatureFlagger
         ).call
       end
 
+      def read_manifest_backup
+        @redis.get("#{MANIFEST_PREFIX}:#{MANIFEST_KEY}")
+      end
+
+      def write_manifest_backup(yaml_as_string)
+        @redis.set("#{MANIFEST_PREFIX}:#{MANIFEST_KEY}", yaml_as_string)
+      end
+
       private
 
       def resource_key(resource_name, resource_id)

data/lib/feature_flagger/version.rb

@@ -1,3 +1,3 @@
 module FeatureFlagger
-  VERSION = "2.0.1"
+  VERSION = "2.2.1"
 end

data/lib/feature_flagger.rb

@@ -11,6 +11,9 @@ require 'feature_flagger/configuration'
 require 'feature_flagger/manager'
 require 'feature_flagger/railtie'
 require 'feature_flagger/notifier'
+require 'feature_flagger/manifest_sources/with_yaml_file'
+require 'feature_flagger/manifest_sources/yaml_with_backup_to_storage'
+require 'feature_flagger/manifest_sources/storage_only'
 
 module FeatureFlagger
   class << self
@@ -30,7 +33,7 @@ module FeatureFlagger
     end
 
     def control
-      @@control ||= Control.new(config.storage, notifier)
+      @@control ||= Control.new(config.storage, notifier, config.cache_store)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feature_flagger
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.2.1
 platform: ruby
 authors:
 - Nando Sousa
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-27 00:00:00.000000000 Z
+date: 2022-01-10 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
@@ -125,6 +139,9 @@ files:
 - lib/feature_flagger/core_ext.rb
 - lib/feature_flagger/feature.rb
 - lib/feature_flagger/manager.rb
+- lib/feature_flagger/manifest_sources/storage_only.rb
+- lib/feature_flagger/manifest_sources/with_yaml_file.rb
+- lib/feature_flagger/manifest_sources/yaml_with_backup_to_storage.rb
 - lib/feature_flagger/model.rb
 - lib/feature_flagger/model_settings.rb
 - lib/feature_flagger/notifier.rb
@@ -153,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Partial release your features.