feature_flagger 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b54bc71d733eb04b2e52156763557a45f94d9722918b12b09e89a07553b88ee4
-  data.tar.gz: 5984d522ae2d19f324de342db5810cd9bf351c43a9e60e159f8442209f38575f
+  metadata.gz: de6dae8c2c1631e95a47c0a6bb99f5e42c3ca2716f7ac4feb045fbd72a279133
+  data.tar.gz: 8619614ec4718f56ca20e1617d398ddb69bd1a81f0412568ed95c2215f7e7c2c
 SHA512:
-  metadata.gz: ece7587ed9528ca583e61645bc3e5e9fcb710f37308ebbc8bb278390966e8edec6e8dc0a282fbb5864893623da631a1d4f3bffc0876dd484d3523e8008c90c11
-  data.tar.gz: 9ccdf791f1c7b6c5f10674753ecfbbfb81b4fa69546057e8061b8c0c269c347999503cb4fc868a215073e70cd6b8cb1382c39bcccfb8c11a0fcd2a346601f82d
+  metadata.gz: e930f492fd481b66cd8924b603a4e067872ab2b2d864de8402bfb28e24504d81c5b3149596f0c08c255eaf84b74ca98a82657d3ac2f1ef54c9c538facfcf3428
+  data.tar.gz: 851c0d1b9eab08442232ee9c3681b3e90b559ed0fc01e4e631c7e3ec26915731682b393ceb1d5d447d1565c20896fbd138fcd18c7678aabfd2047a5158867250

data/README.md

@@ -111,6 +111,13 @@ To clean it up, execute or schedule the rake:
 
     $ bundle exec rake feature_flagger:cleanup_removed_rollouts
 
+## Upgrading
+
+When upgrading from `1.1.x` to `1.2.x` the following command must be executed
+to ensure the data stored in Redis storage is right. Check [#67](https://github.com/ResultadosDigitais/feature_flagger/pull/67) and [#68](https://github.com/ResultadosDigitais/feature_flagger/pull/68) for more info.
+
+    $ bundle exec rake feature_flagger:migrate_to_resource_keys
+
 ## Contributing
 
 Bug reports and pull requests are welcome!

data/lib/feature_flagger/control.rb

@@ -13,7 +13,15 @@ module FeatureFlagger
     end
 
     def release(feature_key, resource_id)
-      @storage.add(feature_key, resource_id)
+      resource_name = Storage::Keys.extract_resource_name_from_feature_key(
+        feature_key
+      )
+
+      @storage.add(feature_key, resource_name, resource_id)
+    end
+
+    def releases(resource_name, resource_id)
+      @storage.fetch_releases(resource_name, resource_id, RELEASED_FEATURES)
     end
 
     def release_to_all(feature_key)
@@ -21,7 +29,11 @@ module FeatureFlagger
     end
 
     def unrelease(feature_key, resource_id)
-      @storage.remove(feature_key, resource_id)
+      resource_name = Storage::Keys.extract_resource_name_from_feature_key(
+        feature_key
+      )
+
+      @storage.remove(feature_key, resource_name, resource_id)
     end
 
     def unrelease_to_all(feature_key)
@@ -40,8 +52,14 @@ module FeatureFlagger
       @storage.has_value?(RELEASED_FEATURES, feature_key)
     end
 
+    # DEPRECATED: this method will be removed from public api on v2.0 version.
+    # use instead the feature_keys method.
     def search_keys(query)
       @storage.search_keys(query)
     end
+
+    def feature_keys
+      @storage.feature_keys
+    end
   end
 end

data/lib/feature_flagger/core_ext.rb

@@ -0,0 +1,18 @@
+begin
+  require 'active_support/core_ext/string/inflections'
+rescue LoadError
+  unless ''.respond_to?(:constantize)
+    class String
+      def constantize
+        names = split('::')
+        names.shift if names.empty? || names.first.empty?
+
+        constant = Object
+        names.each do |name|
+          constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+        end
+        constant
+      end
+    end
+  end
+end

data/lib/feature_flagger/manager.rb

@@ -2,8 +2,9 @@ module FeatureFlagger
   class Manager
 
     def self.detached_feature_keys
-      persisted_features = FeatureFlagger.control.search_keys("*").to_a
+      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

@@ -26,6 +26,11 @@ module FeatureFlagger
       FeatureFlagger.control.unrelease(feature.key, id)
     end
 
+    def releases
+      resource_name = self.class.feature_flagger_model_settings.entity_name
+      FeatureFlagger.control.releases(resource_name, id)
+    end
+
     private
 
     def feature_flagger_identifier
@@ -48,6 +53,11 @@ module FeatureFlagger
         FeatureFlagger.control.release(feature.key, resource_id)
       end
 
+      def unrelease_id(resource_id, *feature_key)
+        feature = Feature.new(feature_key, feature_flagger_model_settings.entity_name)
+        FeatureFlagger.control.unrelease(feature.key, resource_id)
+      end
+
       def all_released_ids_for(*feature_key)
         feature_key.flatten!
         feature = Feature.new(feature_key, feature_flagger_model_settings.entity_name)

data/lib/feature_flagger/railtie.rb

@@ -2,8 +2,8 @@ if defined?(Rails)
   module FeatureFlagger
     class Railtie < Rails::Railtie
       rake_tasks do
-        load 'tasks/cleanup.rake'
+        load 'tasks/feature_flagger.rake'
       end
     end
   end
-end
+end

data/lib/feature_flagger/storage/feature_keys_migration.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module FeatureFlagger
+    module Storage
+      class FeatureKeysMigration
+
+        def initialize(from_redis, to_control)
+          @from_redis = from_redis
+          @to_control = to_control
+        end
+
+        # call migrates features key from the old fashioned to the new
+        # format.
+        #
+        # It must replicate feature keys with changes:
+        #
+        # from "avenue:traffic_lights" => 42
+        # to   "avenue:42" => traffic_lights
+        def call
+          @from_redis.scan_each(match: "*", count: FeatureFlagger::Storage::Redis::SCAN_EACH_BATCH_SIZE) do |redis_key|
+            # filter out resource_keys
+            next if redis_key.start_with?("#{FeatureFlagger::Storage::Redis::RESOURCE_PREFIX}:")
+
+            migrate_key(redis_key)
+          end
+        end
+
+        private
+
+        def migrate_key(key)
+          return migrate_release_to_all(key) if feature_released_to_all?(key)
+
+          migrate_release(key)
+        end
+
+        def migrate_release_to_all(key)
+          features = @from_redis.smembers(key)
+
+          features.each do |feature_key|
+            @to_control.release_to_all(feature_key)
+          end
+        end
+
+        def feature_released_to_all?(key)
+          FeatureFlagger::Control::RELEASED_FEATURES == key
+        end
+
+        def migrate_release(key)
+          resource_ids = @from_redis.smembers(key)
+
+          @to_control.release(key, resource_ids)
+        end
+      end
+    end
+  end

data/lib/feature_flagger/storage/keys.rb

@@ -0,0 +1,21 @@
+module FeatureFlagger
+  module Storage
+    module Keys
+      MINIMUM_VALID_FEATURE_PATH = 2.freeze
+
+      def self.resource_key(prefix, resource_name, resource_id)
+        "#{prefix}:#{resource_name}:#{resource_id}"
+      end
+
+      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
+      end
+
+      class InvalidResourceNameError < StandardError; end
+    end
+  end
+end

data/lib/feature_flagger/storage/redis.rb

@@ -1,11 +1,13 @@
 require 'redis'
 require 'redis-namespace'
+require_relative './keys'
 
 module FeatureFlagger
   module Storage
     class Redis
-
       DEFAULT_NAMESPACE = :feature_flagger
+      RESOURCE_PREFIX = "_r".freeze
+      SCAN_EACH_BATCH_SIZE = 1000.freeze
 
       def initialize(redis)
         @redis = redis
@@ -17,39 +19,102 @@ module FeatureFlagger
         new(ns)
       end
 
+      def fetch_releases(resource_name, resource_id, global_key)
+        resource_key = resource_key(resource_name, resource_id)
+        @redis.sunion(resource_key, global_key)
+      end
+
       def has_value?(key, value)
         @redis.sismember(key, value)
       end
 
-      def add(key, value)
-        @redis.sadd(key, value)
-      end
+      def add(feature_key, resource_name, resource_id)
+        resource_key = resource_key(resource_name, resource_id)
 
-      def remove(key, value)
-        @redis.srem(key, value)
+        @redis.multi do |redis|
+          redis.sadd(feature_key, resource_id)
+          redis.sadd(resource_key, feature_key)
+        end
       end
 
-      def remove_all(global_key, key)
+      def remove(feature_key, resource_name, resource_id)
+        resource_key = resource_key(resource_name, resource_id)
+
         @redis.multi do |redis|
-          redis.srem(global_key, key)
-          redis.del(key)
+          redis.srem(feature_key, resource_id)
+          redis.srem(resource_key, feature_key)
         end
       end
 
+      def remove_all(global_key, feature_key)
+        @redis.srem(global_key, feature_key)
+        remove_feature_key_from_resources(feature_key)
+      end
+
       def add_all(global_key, key)
-        @redis.multi do |redis|
-          redis.sadd(global_key, key)
-          redis.del(key)
-        end
+        @redis.sadd(global_key, key)
+        remove_feature_key_from_resources(key)
       end
 
       def all_values(key)
         @redis.smembers(key)
       end
 
+      # DEPRECATED: this method will be removed from public api on v2.0 version.
+      # use instead the feature_keys method.
       def search_keys(query)
         @redis.scan_each(match: query)
       end
+
+      def feature_keys
+        feature_keys = []
+
+        @redis.scan_each(match: "*") do |key|
+          # Reject keys related to feature responsible for return
+          # released features for a given account.
+          next if key.start_with?("#{RESOURCE_PREFIX}:")
+
+          feature_keys << key
+        end
+
+        feature_keys
+      end
+
+      def synchronize_feature_and_resource
+        FeatureFlagger::Storage::FeatureKeysMigration.new(
+          @redis,
+          FeatureFlagger.control,
+        ).call
+      end
+
+      private
+
+      def resource_key(resource_name, resource_id)
+        FeatureFlagger::Storage::Keys.resource_key(
+          RESOURCE_PREFIX,
+          resource_name,
+          resource_id,
+        )
+      end
+
+      def remove_feature_key_from_resources(feature_key)
+        cursor = 0
+        resource_name = feature_key.split(":").first
+
+        loop do
+          cursor, resource_ids = @redis.sscan(feature_key, cursor, count: SCAN_EACH_BATCH_SIZE)
+
+          @redis.multi do |redis|
+            resource_ids.each do |resource_id|
+              key = resource_key(resource_name, resource_id)
+              redis.srem(key, feature_key)
+              redis.srem(feature_key, resource_id)
+            end
+          end
+
+          break if cursor == "0"
+        end
+      end
     end
   end
 end

data/lib/feature_flagger/version.rb

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

data/lib/tasks/feature_flagger.rake

@@ -0,0 +1,41 @@
+namespace :feature_flagger do
+  desc "cleaning up keys from storage that are no longer in the rollout.yml file"
+  task :cleanup_removed_rollouts => :environment do
+    keys = FeatureFlagger::Manager.detached_feature_keys
+    puts "Found keys to remove: #{keys}"
+    keys.each do |key|
+      FeatureFlagger::Manager.cleanup_detached key
+    end
+  end
+
+  desc "Synchronizes resource_keys with feature_keys, recommended to apps that installed feature flagger before v.1.2.0"
+  task :migrate_to_resource_keys => :environment do
+    storage = FeatureFlagger.config.storage
+    storage.synchronize_feature_and_resource
+  end
+
+  desc "Release feature to given identifiers, Usage: `$ bundle exec rake feature_flagger:release\[Account,email_marketing:whitelabel,1,2,3,4\]`"
+  task :release, [:entity_name, :feature_key] => :environment do |_, args|
+    entity = args.entity_name.constantize
+    entity_ids = args.extras
+    entity.release_id(entity_ids, *args.feature_key.split(':'))
+  end
+
+  desc "Unrelease feature to given identifiers, Usage: `$ bundle exec rake feature_flagger:unrelease\[Account,email_marketing:whitelabel,1,2,3,4\]`"
+  task :unrelease, [:entity_name, :feature_key] => :environment do |_, args|
+    entity, entity_ids = args.entity_name.constantize, args.extras
+    entity.unrelease_id(entity_ids, *args.feature_key.split(':'))
+  end
+
+  desc "Release one feature to all entity ids, Usage: `$ bundle exec rake feature_flagger:release_to_all\[Account,email_marketing:whitelabel\]`"
+  task :release_to_all, [:entity_name, :feature_key] => :environment do |_, args|
+    entity = args.entity_name.constantize
+    entity.release_to_all(*args.feature_key.split(':'))
+  end
+
+  desc "Unrelease one feature to all entity ids, Usage: `$ bundle exec rake feature_flagger:unrelease_to_all\[Account,email_marketing:whitelabel\]`"
+  task :unrelease_to_all, [:entity_name, :feature_key] => :environment do |_, args|
+    entity = args.entity_name.constantize
+    entity.unrelease_to_all(*args.feature_key.split(':'))
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feature_flagger
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Nando Sousa
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-14 00:00:00.000000000 Z
+date: 2020-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -43,30 +43,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -81,20 +81,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: fakeredis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
 description: Management tool to make it easier rollouting features to customers.
 email:
 - nandosousafr@gmail.com
@@ -108,14 +122,17 @@ files:
 - lib/feature_flagger.rb
 - lib/feature_flagger/configuration.rb
 - lib/feature_flagger/control.rb
+- lib/feature_flagger/core_ext.rb
 - lib/feature_flagger/feature.rb
 - lib/feature_flagger/manager.rb
 - lib/feature_flagger/model.rb
 - lib/feature_flagger/model_settings.rb
 - lib/feature_flagger/railtie.rb
+- lib/feature_flagger/storage/feature_keys_migration.rb
+- lib/feature_flagger/storage/keys.rb
 - lib/feature_flagger/storage/redis.rb
 - lib/feature_flagger/version.rb
-- lib/tasks/cleanup.rake
+- lib/tasks/feature_flagger.rake
 homepage: http://github.com/ResultadosDigitais/feature_flagger
 licenses:
 - MIT
@@ -135,8 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Partial release your features.

data/lib/tasks/cleanup.rake

@@ -1,10 +0,0 @@
-namespace :feature_flagger do
-  desc "cleaning up keys from storage that are no longer in the rollout.yml file"
-  task :cleanup_removed_rollouts => :environment do
-    keys = FeatureFlagger::Manager.detached_feature_keys
-    puts "Found keys to remove: #{keys}"
-    keys.each do |key|
-      FeatureFlagger::Manager.cleanup_detached key
-    end
-  end
-end