rollout-redis 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09b02bf812a6d2bf771a7d9b3d299113d6600c43d88516e40ff43d724c6681b9'
-  data.tar.gz: d18a8829c7ded0e56c2c9f43da26a73e2011d28a7aee15a9011d6246bcc5a166
+  metadata.gz: 8e4931c09772c7b9e3b1c3042d9912b49cbe8e3d07e6062d1238c6ac9842dd3c
+  data.tar.gz: fbc9b0e1f80851d1960038169ddce0e93b813097979a8b12c2c82f8fec916ce2
 SHA512:
-  metadata.gz: 8da06a204a6133487f43c52c013485476391b1ff8d2d5680eda8ef9f419aa6b516a63a27fbae3627f0b747b7515fff2347b0594802252ab8b05f78a8b9988154
-  data.tar.gz: 2850a4238642e603504ea4034bd036d09649d319127d99eae4afbe2903f099c7af6d6cc49e50248bfff4b01354982ce93b4b8e58468fdbf7c37dae6801bd0f10
+  metadata.gz: 8d543d5e22d3519838ae6b9c15fbd6a982db066ef7ffe8792945d98bf636a4a34c23294fe02618b4484c6f3d3ee5625fb600a8e3942fc843fb393fdcc701e299
+  data.tar.gz: 8a79720ea90eed5001b67e6394e0ae26e19893e70478166aef179da9e5848c266f736fd1a69c962fa162a309fb510df5265cf14a134a15fb43081c6dd5b87af7

data/CHANGELOG.md

@@ -5,6 +5,17 @@ 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.0.0] - 2023-10-25
+
+### Added
+- `#with_notifications` method for allowing to send notifications when some different event occurs.
+
+### Changed
+- When the threshold of errors is reached when using the `with_degrade` feature, instead of deleting the feature flag from the redis, we are marking it now as degraded, moving the activation percentage to 0% and adding some useful information to the feature flag stored data.
+
+## [0.3.1] - 2023-10-24
+- Same as 0.3.0. When testing GitHub actions for moving to first release `1.0.0` it deployed a new version of the gem by error.
+
 ## [0.3.0] - 2023-10-24
 
 ### Added

data/README.md

@@ -14,6 +14,7 @@ Topics covered in this README:
   - [Gradual activation based on percentages](#gradual-activation-based-on-percentages)
   - [Caching Feature Flags](#caching-feature-flags)
   - [Auto-deactivating flags](#auto-deactivating-flags)
+  - [Sending Notifications](#sending-notifications)
 - [Rake tasks](#rake-tasks)
 - [Migrating from rollout gem](#migrating-from-rollout-gem-)
 - [Changelog](#changelog)
@@ -142,7 +143,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 erros is reached, you can enable the degrade feature using the `with_degrade` method.
+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.
 
 ```ruby
 @rollout ||= Rollout.new(redis)
@@ -158,7 +159,66 @@ So now, instead of using the `active?` method, you need to wrap your new code un
 end
 ```
 
-When any unexpected error appears during the wrapped code execution, the Rollout gem will take it into account for automatically deactivating the feature flag if the threshold of errors is reached. All the managed or captured errors inside the wrapped code will not be taken into consideration.
+When any unexpected error appears during the wrapped code execution, the Rollout gem will take it into account for automatically degrading the feature flag if the threshold of errors is reached. The feature flag will not be removed from the redis, but it will change its percentage to 0 and it will be marked as degraded.
+
+_NOTE_: All the managed or captured errors inside the wrapped code will not be taken into consideration for degrading the feature flag.
+
+### Sending notifications
+
+`rollout-redis` gem can send different notifications to your development team. For enabling this feature, you just need to use the `with_notifications` instance method providing the channels where you want to publish each of the different events that can occur:
+
+- **status_change**: This notification is triggered when a feature flag is activated or deactivated using the `rollout-redis` gem.
+- **degrade**: This notification is triggered when a feature flag is automatically degraded because the threshold of errors is reached
+  - The instance must be configured for automatically degrading using the `with_degrade` instance method.
+
+You must provide at least one [channel](#defining-the-channels) as a parameter if you want to enable the notifications for that specific event. If no channels provided, the notifications will not be sent. 
+
+```ruby
+@rollout ||= Rollout.new(redis)
+              .with_cache
+              .with_degrade(min: 100, threshold: 0.1)
+              .with_notifications(
+                status_change: [slack_channel],
+                degrade: [slack_channel, email_channel]
+              )
+```
+
+#### Defining the channels
+
+When enabling a notification, you can provide the different channels where the notification should be published. `rollout-redis` gem offers different channels that can be configured.
+
+##### Slack Channel
+
+Allows you to send notifications using a slack webhook.
+
+The first thing to do is to setup an incoming webhook service integration. You can do this from your services page.
+
+After that, you can provide the obtained webhook url when instantiating the Slack channel.
+
+```ruby
+require 'rollout'
+
+slack_channel = Rollout::Notifications::Channels::Slack.new(
+  webhook_url: ENV.fetch('SLACK_COMPANY_WEBHOOK_URL'),
+  channel: '#feature-flags-notifications',
+  username: 'rollout-redis'
+)
+```
+
+##### Email Channel
+
+Allows you to send notifications via email.
+
+```ruby
+require 'rollout'
+
+email_channel = Rollout::Notifications::Channels::Email.new(
+  smtp_host: ENV.fetch('SMTP_HOST'),
+  smtp_port: ENV.fetch('SMTP_PORT'),
+  from: 'no-reply@rollout-redis.com',
+  to: 'developers@yourcompany.com'
+)
+```
 
 ## Rake tasks
 
@@ -226,7 +286,9 @@ We welcome and appreciate contributions from the open-source community. Before y
 
 ### Development
 
-This project is dockerized. Once you clone the repository, you can use the `Make` commands to build the project.
+This project is dockerized, so be sure you have docker installed in your machine. 
+
+Once you clone the repository, you can use the `Make` commands to build the project.
 
 ```shell
 make build

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

@@ -0,0 +1,31 @@
+require 'mail'
+
+class Rollout
+  module Notifications
+    module Channels
+      class Email
+        def initialize(smtp_host:, smtp_port:, from:'no-reply@rollout-redis.com', to:)
+          @smtp_host = smtp_host
+          @smtp_port = smtp_port
+          @from = from
+          @to = to
+        end
+
+        def publish(subject, body)
+          mail = Mail.new do
+            subject  subject
+            body     body
+          end
+          mail.smtp_envelope_from = @from
+          mail.smtp_envelope_to = @to
+          mail.delivery_method :smtp, address: @smtp_host, port: @smtp_port
+          mail.deliver
+        end
+
+        def type
+          :email
+        end
+      end
+    end
+  end
+end 

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

@@ -0,0 +1,45 @@
+require 'slack-notifier'
+
+class Rollout
+  module Notifications
+    module Channels
+      class Slack
+        def initialize(webhook_url:, channel:, username:'rollout-redis')
+          @webhook_url = webhook_url
+          @channel = channel
+          @username = username
+        end
+
+        def publish(text)
+          begin
+            blocks = [
+              {
+                "type": "section",
+                "text": {
+                  "type": "mrkdwn",
+                  "text": text
+                }
+              }
+            ]
+            slack_notifier.post(blocks: blocks)
+          rescue => e
+            puts "[ERROR] Error sending notification to slack webhook. Error => #{e}"
+          end
+        end
+
+        def type
+          :slack
+        end
+
+        private
+
+        def slack_notifier
+          @notifier ||= ::Slack::Notifier.new @webhook_url do
+            defaults channel: @channel,
+                     username: @username
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+class Rollout
+  module Notifications
+    module Notifiers
+      class Base
+        def initialize(channels)
+          if channels.respond_to?(:first)
+            @channels = channels
+          else
+            @channels = [channels]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require_relative 'base'
+
+class Rollout
+  module Notifications
+    module Notifiers
+      class Degrade < Base
+        def initialize(channels)
+          super(channels)
+        end
+
+        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
+          end
+        end
+
+        private
+
+        def publish_for_slack_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)
+          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)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+require_relative 'base'
+
+class Rollout
+  module Notifications
+    module Notifiers
+      class StatusChange < Base
+        def initialize(channels)
+          super(channels)
+        end
+
+        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
+          end
+        end
+
+        private
+
+        def publish_for_slack_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
+            text = "Feature flag '#{feature_name}' has been deactivated and deleted!"
+          end
+          c.publish(text)
+        end
+
+        def publish_for_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}!"
+          elsif new_status == :deactivated
+            subject = 'Feature flag has been deactivated!'
+            content = "Feature flag '#{feature_name}' has been deactivated and deleted!"
+          end
+          c.publish(subject, content)
+        end
+      end
+    end
+  end
+end

data/lib/rollout/version.rb

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

data/lib/rollout.rb

@@ -1,10 +1,16 @@
 # frozen_string_literal: true
 
-require 'rollout/feature'
-require 'rollout/version'
 require 'redis'
 require 'json'
 
+require 'rollout/feature'
+require 'rollout/notifications/channels/email'
+require 'rollout/notifications/channels/slack'
+require 'rollout/notifications/notifiers/degrade'
+require 'rollout/notifications/notifiers/status_change'
+require 'rollout/version'
+
+
 class Rollout
 
   class Error < StandardError; end
@@ -33,14 +39,36 @@ class Rollout
     self
   end
 
+  def with_notifications(status_change:[], degrade:[])
+    status_change_channels = status_change
+    degrade_channels = degrade
+
+    if !status_change_channels.empty?
+      @status_change_notifier = Notifications::Notifiers::StatusChange.new(status_change_channels)
+    end
+
+    if !degrade_channels.empty?
+      @degrade_notifier = Notifications::Notifiers::Degrade.new(degrade_channels)
+    end
+
+    self
+  end
+
   def activate(feature_name, percentage=100)
     data = { percentage: percentage }
     feature = Feature.new(feature_name, data)
-    @cache[feature_name] = {
-      feature: feature,
-      timestamp: Time.now.to_i
-    } if @cache_enabled
-    save(feature) == "OK"
+    result = save(feature) == "OK"
+
+    if result
+      @cache[feature_name] = {
+        feature: feature,
+        timestamp: Time.now.to_i
+      } if @cache_enabled
+
+      @status_change_notifier&.notify(feature_name, :activated, percentage)
+    end
+
+    result
   end
 
   def activate_percentage(feature_name, percentage)
@@ -48,7 +76,11 @@ class Rollout
   end
 
   def deactivate(feature_name)
-    del(feature_name)
+    result = del(feature_name)
+
+    @status_change_notifier&.notify(feature_name, :deactivated)
+
+    result
   end
 
   def active?(feature_name, determinator = nil)
@@ -73,7 +105,7 @@ class Rollout
       feature.add_error
       save(feature)
 
-      deactivate(feature_name) if degraded?(feature)
+      degrade(feature_name) if degraded?(feature)
     end
     raise e
   end
@@ -115,7 +147,11 @@ class Rollout
 
         @storage.set(new_key, new_data)
 
-        puts "Migrated key: #{old_key} to #{new_key} with data #{new_data}"
+        puts "Migrated key: #{old_key.gsub('feature:', '')} to #{new_key.gsub('feature-rollout-redis:', '')} with data #{new_data}"
+
+        if percentage > 0
+          @status_change_notifier&.notify(new_key.gsub('feature-rollout-redis:', ''), :activated, percentage)
+        end
       end
     end
   end
@@ -147,6 +183,22 @@ class Rollout
     @storage.del(key(feature_name)) == 1
   end
 
+  def degrade(feature_name)
+    feature = get(feature_name)
+    data_with_degrade = feature.data.merge({
+      percentage: 0,
+      degraded: true,
+      degraded_at: Time.now
+    })
+    result = @storage.set(key(feature.name), data_with_degrade.to_json) == "OK"
+
+    if result
+      @degrade_notifier.notify(feature_name, feature.requests, feature.errors)
+    end
+
+    result
+  end
+
   def from_cache(feature_name)
     return nil unless @cache_enabled
 

data/rollout-redis.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.3'
 
   spec.add_runtime_dependency 'redis', '>= 4.0', '<= 5'
+  spec.add_runtime_dependency 'slack-notifier', '~> 2.4'
+  spec.add_runtime_dependency 'mail', '~> 2.8'
 
   spec.add_development_dependency 'bundler', '>= 2.4'
   spec.add_development_dependency 'rspec', '~> 3.12'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollout-redis
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Juan Carlos García
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-24 00:00:00.000000000 Z
+date: 2023-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -30,6 +30,34 @@ dependencies:
     - - "<="
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +126,11 @@ files:
 - Rakefile
 - lib/rollout.rb
 - lib/rollout/feature.rb
+- lib/rollout/notifications/channels/email.rb
+- lib/rollout/notifications/channels/slack.rb
+- lib/rollout/notifications/notifiers/base.rb
+- lib/rollout/notifications/notifiers/degrade.rb
+- lib/rollout/notifications/notifiers/status_change.rb
 - lib/rollout/tasks/rollout.rake
 - lib/rollout/version.rb
 - rollout-redis.gemspec