rollout-redis 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e4931c09772c7b9e3b1c3042d9912b49cbe8e3d07e6062d1238c6ac9842dd3c
-  data.tar.gz: fbc9b0e1f80851d1960038169ddce0e93b813097979a8b12c2c82f8fec916ce2
+  metadata.gz: d3d7a7f17af2164aaeaefcea4ebd6def9fa5a9d29af982e5ed0ad05f2ee4a3a8
+  data.tar.gz: f9b9ff1cd3a1d45fa46695150d705dfff5489937baeaff082718fca7221e90f0
 SHA512:
-  metadata.gz: 8d543d5e22d3519838ae6b9c15fbd6a982db066ef7ffe8792945d98bf636a4a34c23294fe02618b4484c6f3d3ee5625fb600a8e3942fc843fb393fdcc701e299
-  data.tar.gz: 8a79720ea90eed5001b67e6394e0ae26e19893e70478166aef179da9e5848c266f736fd1a69c962fa162a309fb510df5265cf14a134a15fb43081c6dd5b87af7
+  metadata.gz: 016c6a7f22c74586628b600bada44d95a3c5934b40c973811e539de286136282d039e1dedc991d6678275b4b25a67a9b3c8139b8403d607ebc78ec27657545d7
+  data.tar.gz: e959cd3d1d9a3a9bbd727b68fef633a30b6e066ecfa0d708bc9dc27db199a6ab9285e2a9709b2696d02af14565055230c02fb85305917f4854454345a7dab005

data/CHANGELOG.md

@@ -4,6 +4,14 @@ All changes to `rollout-redis` will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2023-10-28
+
+### Added
+- `#with_old_rollout_gem_compatibility` method for allowing working with Feature Flags that were stored by the old `rollout` gem.
+- `rollout:migrate_from_rollout_format` rake task for performing a migration of the feature flags stored by the old `rollout` gem to the new `rollout-redis` format.
+- Add a new parameter when performing `#activate` method for providing a specific degrade configuration for the feature flag that is being activated.
+- Add a new parameter when performing `rollout:on` rake task for providing a specific degrade configuration for the feature flag that is being activated.
+- You can implement now your own `Rollout::Notifications::Channels::Channel` in case the ones offered by the `gem` are not enough.
 
 ## [1.0.0] - 2023-10-25
 

data/README.md

@@ -17,6 +17,7 @@ Topics covered in this README:
   - [Sending Notifications](#sending-notifications)
 - [Rake tasks](#rake-tasks)
 - [Migrating from rollout gem](#migrating-from-rollout-gem-)
+  - [Compatible payloads and keys](#compatible-payloads-and-keys)
 - [Changelog](#changelog)
 - [Contributing](#contributing)
 
@@ -143,7 +144,7 @@ In the case that you need to clear the cache at any point, you can make use of t
 
 ### Auto-deactivating flags
 
-If you want to allow the gem to deactivate your feature flag automatically when a threshold of errors is reached, you can enable the degrade feature using the `with_degrade` method.
+If you want to allow the gem to deactivate all the feature flags automatically when a threshold of errors is reached, you can enable the degrade feature using the `with_degrade` method.
 
 ```ruby
 @rollout ||= Rollout.new(redis)
@@ -151,6 +152,18 @@ If you want to allow the gem to deactivate your feature flag automatically when
               .with_degrade(min: 100, threshold: 0.1)
 ```
 
+However, if you just want to activate the degradation of an specific feature flag, you need to provide the following information when activating the feature flag (note that now the percentage is a mandatory parameter if you want to pass the degrade options):
+
+```ruby
+@rollout.activate('FEATURE_FLAG_NAME', 100, degrade: { min: 500, threshold: 0.2 })
+```
+
+The same configuration 👆 is available when using the rake task for activating the feature flag. Check [Rake tasks](#rake-tasks) section.
+
+```shell
+bundle exec rake rollout:on[FEATURE_FLAG_NAME,100,500,0.2]
+```
+
 So now, instead of using the `active?` method, you need to wrap your new code under the `with_feature` method.
 
 ```ruby
@@ -220,6 +233,39 @@ email_channel = Rollout::Notifications::Channels::Email.new(
 )
 ```
 
+##### Custom channel
+
+If you want to send the notifications using a different channel not offered by this gem, you can implement your own class with a `publish` method.
+
+```ruby
+require 'rollout'
+
+module YourApp
+  class YourCustomChannel
+    def initialize()
+      # provide here whatever you need for configuring your channel
+    end
+
+    def publish(text)
+      # Implement the way you want to publish the notification
+    end
+  end
+end
+```
+
+After implementing it, you can pass it to the list of configured channels
+
+```ruby
+your_channel = YourApp::YourCustomChannel.new(url: 'wadus', param2: 'foo')
+@rollout ||= Rollout.new(redis)
+              .with_cache
+              .with_degrade(min: 100, threshold: 0.1)
+              .with_notifications(
+                status_change: [your_channel],
+                degrade: [your_channel]
+              )
+```
+
 ## Rake tasks
 
 In order to have access to the rollout rakes, you have to load manually the task definitions. For doing so load the rollout rake task:
@@ -260,10 +306,20 @@ For listing all the stored feature flags, do:
 bundle exec rake rollout:list
 ```
 
+For migrating feature flags stored using the old `rollout` gem format (check [migration guide](https://github.com/jcagarcia/rollout-redis/blob/main/MIGRATING_FROM_ROLLOUT_GEM.md)), do:
+
+```shell
+bundle exec rake rollout:migrate_from_rollout_format
+```
+
 ## Migrating from rollout gem 🚨
 
 If you are currently using the unmaintained [rollout](https://github.com/fetlife/rollout) gem, you should consider checking this [migration guide](https://github.com/jcagarcia/rollout-redis/blob/main/MIGRATING_FROM_ROLLOUT_GEM.md) for start using the new `rollout-redis` gem.
 
+### Compatible payloads and keys
+
+You can use the `.with_old_rollout_gem_compatibility` instance method for making the `rollout-redis` gem work as the the discontinued [rollout](https://github.com/fetlife/rollout) gem in terms of redis storage and format storage. Check the [migration guide](https://github.com/jcagarcia/rollout-redis/blob/main/MIGRATING_FROM_ROLLOUT_GEM.md) for more information.
+
 ## Changelog
 
 If you're interested in seeing the changes and bug fixes between each version of `rollout-redis`, read the [Changelog](https://github.com/jcagarcia/rollout-redis/blob/main/CHANGELOG.md).

data/lib/rollout/feature.rb

@@ -4,7 +4,7 @@ require 'zlib'
 
 class Rollout
     class Feature
-      attr_accessor :percentage
+      attr_accessor :percentage, :degrade
       attr_reader :name, :data
 
       RAND_BASE = (2**32 - 1) / 100.0
@@ -13,6 +13,7 @@ class Rollout
         @name = name
         @data = data
         @percentage = @data[:percentage]
+        @degrade = @data[:degrade]
       end
   
       def active?(determinator=nil)
@@ -48,7 +49,7 @@ class Rollout
       end
 
       def to_h
-        {
+        h = {
           name: @name,
           percentage: @percentage,
           data: {
@@ -56,6 +57,12 @@ class Rollout
             errors: errors
           }
         }
+
+        h.merge!({
+          degrade: @degrade
+        }) if @degrade
+
+        h
       end
   
       private

data/lib/rollout/notifications/channels/email.rb

@@ -21,10 +21,6 @@ class Rollout
           mail.delivery_method :smtp, address: @smtp_host, port: @smtp_port
           mail.deliver
         end
-
-        def type
-          :email
-        end
       end
     end
   end

data/lib/rollout/notifications/channels/slack.rb

@@ -27,10 +27,6 @@ class Rollout
           end
         end
 
-        def type
-          :slack
-        end
-
         private
 
         def slack_notifier

data/lib/rollout/notifications/notifiers/degrade.rb

@@ -10,19 +10,22 @@ class Rollout
 
         def notify(feature_name, requests, errors)
           @channels.each do |c|
-            publish_for_slack_channel(c, feature_name, requests, errors) if c.type == :slack
-            publish_for_email_channel(c, feature_name, requests, errors) if c.type == :email
+            if c.class == Rollout::Notifications::Channels::Email
+              publish_to_email_channel(c, feature_name, requests, errors)
+            else
+              publish_to_channel(c, feature_name, requests, errors)
+            end
           end
         end
 
         private
 
-        def publish_for_slack_channel(c, feature_name, requests, errors)
+        def publish_to_channel(c, feature_name, requests, errors)
           text = "Feature flag '#{feature_name}' has been degraded after #{requests} requests and #{errors} errors"
           c.publish(text)
         end
 
-        def publish_for_email_channel(c, feature_name, requests, errors)
+        def publish_to_email_channel(c, feature_name, requests, errors)
           subject = 'Feature flag has been automatically deactivated!'
           content = "Feature flag '#{feature_name}' has been degraded after #{requests} requests and #{errors} errors"
           c.publish(subject, content)

data/lib/rollout/notifications/notifiers/status_change.rb

@@ -10,14 +10,17 @@ class Rollout
 
         def notify(feature_name, new_status, new_percentage=nil)
           @channels.each do |c|
-            publish_for_slack_channel(c, feature_name, new_status, new_percentage) if c.type == :slack
-            publish_for_email_channel(c, feature_name, new_status, new_percentage) if c.type == :email
+            if c.class == Rollout::Notifications::Channels::Email
+              publish_to_email_channel(c, feature_name, new_status, new_percentage)
+            else
+              publish_to_channel(c, feature_name, new_status, new_percentage)
+            end
           end
         end
 
         private
 
-        def publish_for_slack_channel(c, feature_name, new_status, new_percentage)
+        def publish_to_channel(c, feature_name, new_status, new_percentage)
           if new_status == :activated
             text = "Feature flag '#{feature_name}' has been activated with percentage #{new_percentage}!"
           elsif new_status == :deactivated
@@ -26,7 +29,7 @@ class Rollout
           c.publish(text)
         end
 
-        def publish_for_email_channel(c, feature_name, new_status, new_percentage)
+        def publish_to_email_channel(c, feature_name, new_status, new_percentage)
           if new_status == :activated
             subject = 'Feature flag has been activated!'
             content = "Feature flag '#{feature_name}' has been activated with percentage #{new_percentage}!"

data/lib/rollout/tasks/rollout.rake

@@ -1,13 +1,20 @@
 
 namespace :rollout do
   desc "Activate a feature"
-  task :on, [:feature, :percentage] => :environment do |task, args|
+  task :on, [:feature, :percentage, :degrade_min, :degrade_threshold] => :environment do |task, args|
     if args.feature
-      puts "Activating feature #{args.feature}..."
       if args.percentage
-        activated = rollout.activate(args.feature, args.percentage.to_i)
+        percentage = args.percentage.to_i
       else
-        activated = rollout.activate(args.feature)
+        percentage = 100
+      end
+
+      if args.degrade_min && args.degrade_threshold
+        puts "Activating feature #{args.feature} at #{percentage}% (degrade config set to a min of #{args.degrade_min} requests and a threshold of error of #{args.degrade_threshold.to_f*100}%)..."
+        activated = rollout.activate(args.feature, percentage, degrade: { min: args.degrade_min.to_i, threshold: args.degrade_threshold.to_f})
+      else
+        puts "Activating feature #{args.feature} at #{percentage}%..."
+        activated = rollout.activate(args.feature, percentage)
       end
 
       if activated
@@ -43,6 +50,13 @@ namespace :rollout do
     end
   end
 
+  desc "Migrate stored feature flags to the new format without removing the old information"
+  task migrate_from_rollout_format: :environment do
+    puts "Starting the migration..."
+    rollout.migrate_from_rollout_format
+    puts "Migration has finished!"
+  end
+
   private
 
   def rollout

data/lib/rollout/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Rollout
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/rollout.rb

@@ -21,6 +21,8 @@ class Rollout
     @storage = storage
     @cache_enabled = false
     @degrade_enabled = false
+    @old_gem_compatibility_enabled = false
+    @auto_migrate_from_old_format = false
   end
 
   def with_cache(expires_in: 300)
@@ -44,18 +46,38 @@ class Rollout
     degrade_channels = degrade
 
     if !status_change_channels.empty?
+      status_change_channels.each do |c|
+        raise Rollout::Error.new("Channel #{c.class.name} does not implement `publish` method") unless c.respond_to?(:publish)
+      end
       @status_change_notifier = Notifications::Notifiers::StatusChange.new(status_change_channels)
     end
 
     if !degrade_channels.empty?
+      degrade_channels.each do |c|
+        raise Rollout::Error.new("Channel #{c.class.name} does not implement `publish` method") unless c.respond_to?(:publish)
+      end
       @degrade_notifier = Notifications::Notifiers::Degrade.new(degrade_channels)
     end
 
     self
   end
 
-  def activate(feature_name, percentage=100)
+  def with_old_rollout_gem_compatibility(auto_migration: false)
+    @old_gem_compatibility_enabled = true
+    @auto_migrate_from_old_format = auto_migration
+
+    self
+  end
+
+  def activate(feature_name, percentage=100, degrade: nil)
     data = { percentage: percentage }
+    data.merge!({
+      degrade: {
+        min: degrade[:min] || 0,
+        threshold: degrade[:threshold] || 0
+      }
+    }) if degrade
+
     feature = Feature.new(feature_name, data)
     result = save(feature) == "OK"
 
@@ -84,12 +106,19 @@ class Rollout
   end
 
   def active?(feature_name, determinator = nil)
-    feature = get(feature_name, determinator)
+    feature = get(feature_name)
+    if feature.nil? && @old_gem_compatibility_enabled
+      feature = get_with_old_format(feature_name)
+      if feature && @auto_migrate_from_old_format
+        activate(feature_name, feature.percentage)
+      end
+    end
+
     return false unless feature
 
     active = feature.active?(determinator)
 
-    if active && @degrade_enabled
+    if active && degrade_enabled?(feature)
       feature.add_request
       save(feature)
     end
@@ -99,9 +128,11 @@ class Rollout
 
   def with_feature_flag(feature_name, determinator = nil, &block)
     yield if active?(feature_name, determinator)
+  rescue Rollout::Error => e
+    raise
   rescue => e
-    feature = get(feature_name, determinator)
-    if @degrade_enabled && feature
+    feature = get(feature_name)
+    if feature && degrade_enabled?(feature)
       feature.add_error
       save(feature)
 
@@ -147,7 +178,7 @@ class Rollout
 
         @storage.set(new_key, new_data)
 
-        puts "Migrated key: #{old_key.gsub('feature:', '')} to #{new_key.gsub('feature-rollout-redis:', '')} with data #{new_data}"
+        puts "Migrated redis key from #{old_key} to #{new_key}. Migrating data from '#{old_data}' to '#{new_data}'."
 
         if percentage > 0
           @status_change_notifier&.notify(new_key.gsub('feature-rollout-redis:', ''), :activated, percentage)
@@ -158,7 +189,7 @@ class Rollout
 
   private
 
-  def get(feature_name, determinator = nil)
+  def get(feature_name)
     feature = from_redis(feature_name)
     return unless feature
 
@@ -175,6 +206,15 @@ class Rollout
     cached_feature
   end
 
+  def get_with_old_format(feature_name)
+    feature = from_redis_with_old_format(feature_name)
+    return unless feature
+
+    feature
+  rescue ::Redis::BaseError => e
+    raise Rollout::Error.new(e)
+  end
+
   def save(feature)
     @storage.set(key(feature.name), feature.data.to_json)
   end
@@ -218,22 +258,58 @@ class Rollout
     Feature.new(feature_name, JSON.parse(data, symbolize_names: true))
   end
 
+  def from_redis_with_old_format(feature_name)
+    old_data = @storage.get(old_key(feature_name))
+    return unless old_data
+
+    percentage = old_data.split('|')[0].to_i
+
+    new_data = {
+      percentage: percentage,
+      requests: 0,
+      errors: 0
+    }
+
+    Feature.new(feature_name, new_data)
+  end
+
   def expired?(timestamp)
     Time.now.to_i - timestamp > @cache_time
   end
 
   def degraded?(feature)
-    return false if !@degrade_enabled
-    return false if feature.requests < @degrade_min
+    return false if !degrade_enabled?(feature)
+
+    if feature.degrade
+      degrade_min = feature.degrade[:min]
+      degrade_threshold = feature.degrade[:threshold]
+    else
+      degrade_min = @degrade_min
+      degrade_threshold = @degrade_threshold
+    end
 
-    feature.errors > @degrade_threshold * feature.requests
+    return false if feature.requests < degrade_min
+
+    feature.errors > degrade_threshold * feature.requests
+  end
+
+  def degrade_enabled?(feature)
+    @degrade_enabled || !feature.degrade.nil?
   end
 
   def key(name)
     "#{key_prefix}:#{name}"
   end
 
+  def old_key(name)
+    "#{old_key_prefix}:#{name}"
+  end
+
   def key_prefix
     "feature-rollout-redis"
   end
+
+  def old_key_prefix
+    "feature"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollout-redis
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Juan Carlos García
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-25 00:00:00.000000000 Z
+date: 2023-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis