abstract_feature_branch 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52ff8ed098aa83bdd70eda839fa74b291c95993fb9859e2cc5ed8c0752bfa213
-  data.tar.gz: 9b5e6915905904be0b87690a73b1dfe14ec8893b2659383545bac23b0fe76978
+  metadata.gz: 47e99ade543da399fb1529db07bbecd871e23a1eb7cff9239a578067453dc312
+  data.tar.gz: b54ab8066e04ee68d6d40940a84dd69f237354d40523e5003be4f34ef6d4e03b
 SHA512:
-  metadata.gz: 2f948fd18d057bed300d4cb9eb89e36b784ec2e8a445edaeaf2d742866884828795e8873de02ea9d1794604757dee8d6af2b63934a4f7fcd5b7c0d65aa1171ec
-  data.tar.gz: c4a1ddc94547f390e2960ddc97a20034cf7bd3dbaa378e17060ae38509b019897d0364913573856254269217c22731de15e7e1e8c8825b1d30c0615521ee6610
+  metadata.gz: a2d9b1f7a36c405bbb7406bd22b4ec29f0f9d4d55a1ecf7d83ee8adb6f77cba28159f20a32be8b1fa36f97422ccdf74a7f93c6c06d8cb617b0f5405d0d833052
+  data.tar.gz: d851c77683233aa129261171769b8e693949bf178af7c958995daf8f237fed1d7364db8b805e635e5346acdb26c3944af24aab15aab8c5c1f686efa29aba5bcc

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 1.3.2
+
+- Ensure better performance, fetch Redis Overrides at app/server startup time only by default while providing option to fetch live by setting `AbstractFeatureBranch.feature_store_live_fetching` to `true`
+- Do not automatically pre-init `AbstractFeatureBranch.feature_store` with `Redis.new` if it was `nil` as that is a bad default.
+- Fix issue with crashing when not including the `connection_pool` gem manually if needed with a version of `redis` older than 5
+
 ## 1.3.1
 
 - Support Redis `ConnectionPool` `AbstractFeatureBranch::Configuration#feature_store`

data/README.md

@@ -1,4 +1,4 @@
-# Abstract Feature Branch 1.3.1
+# Abstract Feature Branch 1.3.2
 [![Gem Version](https://badge.fury.io/rb/abstract_feature_branch.png)](http://badge.fury.io/rb/abstract_feature_branch)
 [![Build Status](https://api.travis-ci.org/AndyObtiva/abstract_feature_branch.png?branch=master)](https://travis-ci.org/AndyObtiva/abstract_feature_branch)
 [![Coverage Status](https://coveralls.io/repos/AndyObtiva/abstract_feature_branch/badge.png?branch=master)](https://coveralls.io/r/AndyObtiva/abstract_feature_branch?branch=master)
@@ -37,8 +37,8 @@ Setup
 ### Rails Application Use
 
 1. Configure Rubygem
-   - With `rails` between `~> 7.0` and `~> 2.0`: Add the following to Gemfile <pre>gem 'abstract_feature_branch', '~> 1.3.1'</pre>
-   - With `rails` `~> 2.0` only: Add the following to config/environment.rb <pre>config.gem 'abstract_feature_branch', :version => '1.3.1'</pre>
+   - With `rails` between `~> 7.0` and `~> 2.0`: Add the following to Gemfile <pre>gem 'abstract_feature_branch', '~> 1.3.2'</pre>
+   - With `rails` `~> 2.0` only: Add the following to config/environment.rb <pre>config.gem 'abstract_feature_branch', :version => '1.3.2'</pre>
 2. Generate <code>config/initializers/abstract_feature_branch.rb</code>, <code>lib/tasks/abstract_feature_branch.rake</code>, <code>config/features.yml</code> and <code>config/features.local.yml</code> in your Rails app directory by running <pre>rails g abstract_feature_branch:install</pre>
 3. [Optional] Generate <code>config/features/[context_path].yml</code> in your Rails app directory by running <pre>rails g abstract_feature_branch:context context_path</pre> (more details under [**instructions**](#instructions))
 4. [Optional] Customize configuration in <code>config/initializers/abstract_feature_branch.rb</code> (can be useful for changing location of feature files in Rails application, configuring Redis with a Redis or ConnectionPool instance to use for overrides, and per-user feature enablement, or troubleshooting a specific Rails environment feature configuration)
@@ -47,7 +47,7 @@ Setup
 
 ### Ruby Application General Use
 
-1. <pre>gem install abstract_feature_branch -v 1.3.1</pre>
+1. <pre>gem install abstract_feature_branch -v 1.3.2</pre>
 2. Add code <code>require 'abstract_feature_branch'</code>
 3. Create <code>config/features.yml</code> under <code>AbstractFeatureBranch.application_root</code> and fill it with content similar to that of the sample <code>config/features.yml</code> mentioned under [**instructions**](#instructions).
 4. [Optional] Create <code>config/features.local.yml</code> under <code>AbstractFeatureBranch.application_root</code>  (more details under [**instructions**](#instructions))
@@ -57,7 +57,8 @@ Setup
 8. [Optional] Add code <code>AbstractFeatureBranch.logger = "[your_application_logger]"</code> (it defaults to a new instance of Ruby <code>Logger</code>. Must use a logger with <code>info</code> and <code>warn</code> methods).
 9. [Optional] Add code <code>AbstractFeatureBranch.cacheable = {[environment] => [true/false]}</code> to indicate cacheability of loaded feature files for enhanced performance (it defaults to true for every environment other than development).
 10. [Optional] Add code <code>AbstractFeatureBranch.load_application_features</code> to pre-load application features for improved first-use performance
-11. [Optional] Add code <code>AbstractFeatureBranch.feature_store = Redis.new(options)</code> to configure Redis for overrides or per-user feature enablement
+11. [Optional] Add code <code>AbstractFeatureBranch.feature_store = Redis.new(options)</code> to configure Redis for overrides and/or per-user feature enablement
+12. [Optional] Set <code>AbstractFeatureBranch.feature_store_live_fetching = true</code> to enable live fetching of features from store (e.g. Redis) to avoid need for app/server restart upon feature changes, with the trade-off of slightly more latency due to making calls to feature store over the network
 
 Instructions
 ------------
@@ -262,12 +263,16 @@ application more easily.
 Redis Overrides
 ---------------
 
-Prerequisites: Redis server and client (`redis` gem) and optional Redis configuration of `AbstractFeatureBranch.feature_store` in `config/initializers/abstract_feature_branch.rb` (`Redis` `ConnectionPool` instance is recommended for Production environments)
+Prerequisites: Redis server and client (`redis` gem) and Redis configuration of `AbstractFeatureBranch.feature_store` in `config/initializers/abstract_feature_branch.rb` (`Redis` `ConnectionPool` instance is recommended for Production environments)
 
 To be able to override feature configuration in a production environment, you can utilize Redis Overrides.
 
 Alternatively, you may use Redis Overrides as your main source of feature configuration if you prefer that instead of relying on YAML files.
 
+Keep in mind that by default, Redis Overrides are fetched on app/server start to pre-cache for better performance.
+
+To enable live fetching of Redis Overrides, set `AbstractFeatureBranch#feature_store_live_fetching` to `true` (e.g. in `config/initializers/abstract_feature_branch.rb`), but keep in mind the trade-off with more latency due to making calls to Redis Server over the network.
+
 You can override feature configuration with Redis hash values by calling `AbstractFeatureBranch#set_store_feature` in `rails console` (or `irb` after requiring `redis` and `abstract_feature_branch`):
 
 ```ruby
@@ -358,6 +363,10 @@ Here is the content of the generated initializer [with `redis` client gem added]
 >     # The following example line works with Heroku Redis To Go while still operating on local Redis for local development
 >     # AbstractFeatureBranch.feature_store = Redis.new(:url => ENV['REDISTOGO_URL'])
 >
+>     # Enable live fetching of feature configuration from storage system, to update features without app/server restart.
+>     # false by default to only load features on app/server start for faster performance (requires restart on change)
+>     AbstractFeatureBranch.feature_store_live_fetching = false
+>
 >     # Application root where config/features.yml or config/features/ is found
 >     AbstractFeatureBranch.application_root = Rails.root
 >

data/VERSION

@@ -1 +1 @@
-1.3.1
+1.3.2

data/abstract_feature_branch.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: abstract_feature_branch 1.3.1 ruby lib
+# stub: abstract_feature_branch 1.3.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "abstract_feature_branch".freeze
-  s.version = "1.3.1"
+  s.version = "1.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -40,7 +40,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/AndyObtiva/abstract_feature_branch".freeze
   s.licenses = ["MIT".freeze]
   s.post_install_message = "\nRails-only post-install instructions:\n\n1) Run the following command to generate the Rails initializer and basic feature files:\n\nrails g abstract_feature_branch:install\n\n2) Optionally, you may run this command to generate feature files per context:\n\nrails g abstract_feature_branch:context context_path\n   \n3) Optionally, install Redis server with [Homebrew](https://brew.sh/) by running:\n\nbrew install redis\n\n4) Optionally, install redis client gem (required with Redis server) by adding the following line to Gemfile above abstract_feature_branch:\n\ngem 'redis', '~> 5.0.5'\n\nAfterwards, run:\n\nbundle\n\n5) Optionally, customize configuration in config/initializers/abstract_feature_branch.rb\n\n(can be useful for changing location of feature files in Rails application,\nconfiguring Redis with a Redis or ConnectionPool instance to use for overrides and per-user feature enablement,\nand/or troubleshooting specific Rails environment feature configurations)\n\n".freeze
-  s.rubygems_version = "3.3.6".freeze
+  s.rubygems_version = "3.1.4".freeze
   s.summary = "abstract_feature_branch is a Rails gem that enables developers to easily branch by abstraction as per this pattern: http://paulhammant.com/blog/branch_by_abstraction.html".freeze
 
   if s.respond_to? :specification_version then

data/lib/abstract_feature_branch/configuration.rb

@@ -45,7 +45,7 @@ module AbstractFeatureBranch
     end
     
     def feature_store
-      @feature_store ||= initialize_feature_store
+      @feature_store
     end
     alias user_features_storage feature_store
     
@@ -53,18 +53,28 @@ module AbstractFeatureBranch
       if feature_store.nil?
         @feature_store = nil
       else
-        @feature_store = feature_store.is_a?(::ConnectionPool) ? AbstractFeatureBranch::Redis::ConnectionPoolToRedisAdapter.new(feature_store) : feature_store
+        begin
+          @feature_store = feature_store.is_a?(::ConnectionPool) ? AbstractFeatureBranch::Redis::ConnectionPoolToRedisAdapter.new(feature_store) : feature_store
+        rescue NameError => e
+          logger.debug { "connection_pool gem is not available" }
+          @feature_store = feature_store
+        end
       end
     end
     alias user_features_storage= feature_store=
     
-    def initialize_feature_store
-      self.feature_store = ::Redis.new
-    rescue => e
-      logger.debug { "Redis is not enabled!" }
-      logger.debug { e.full_message }
-      nil
-    end
-    alias initialize_user_features_storage initialize_feature_store
+    def feature_store_live_fetching
+      initialize_feature_store_live_fetching if @feature_store_live_fetching.nil?
+      @feature_store_live_fetching
+    end
+    alias feature_store_live_fetching? feature_store_live_fetching
+    
+    def feature_store_live_fetching=(value)
+      @feature_store_live_fetching = value
+    end
+    
+    def initialize_feature_store_live_fetching
+      @feature_store_live_fetching = false
+    end
   end
 end

data/lib/abstract_feature_branch.rb

@@ -23,14 +23,16 @@ module AbstractFeatureBranch
 
   class << self
     extend Forwardable
-    def_delegators :configuration, :application_root, :application_root=, :initialize_application_root, :application_environment, :application_environment=, :initialize_application_environment, :logger, :logger=, :initialize_logger, :cacheable, :cacheable=, :initialize_cacheable, :feature_store, :feature_store=, :initialize_feature_store, :user_features_storage, :user_features_storage=, :initialize_user_features_storage
+    def_delegators :configuration, :application_root, :application_root=, :initialize_application_root, :application_environment, :application_environment=, :initialize_application_environment,
+                   :logger, :logger=, :initialize_logger, :cacheable, :cacheable=, :initialize_cacheable, :feature_store, :feature_store=, :user_features_storage, :user_features_storage=,
+                   :feature_store_live_fetching, :feature_store_live_fetching=
 
     def configuration
       @configuration ||= Configuration.new
     end
 
     def redis_overrides
-      load_redis_overrides
+      @redis_overrides ||= load_redis_overrides
     end
     def load_redis_overrides
       return {} if feature_store.nil?
@@ -39,7 +41,7 @@ module AbstractFeatureBranch
         output.merge(feature => get_store_feature(feature))
       end
       
-      downcase_keys(redis_feature_hash)
+      @redis_overrides = downcase_keys(redis_feature_hash)
     end
 
     def environment_variable_overrides
@@ -76,19 +78,22 @@ module AbstractFeatureBranch
       local_features[environment] ||= {}
       @environment_features[environment] = features[environment].
         merge(local_features[environment]).
-        merge(environment_variable_overrides)
+        merge(environment_variable_overrides).
+        merge(redis_overrides)
     end
     def application_features
       unload_application_features unless cacheable?
       environment_features(application_environment)
     end
     def load_application_features
+      AbstractFeatureBranch.load_redis_overrides
       AbstractFeatureBranch.load_environment_variable_overrides
       AbstractFeatureBranch.load_features
       AbstractFeatureBranch.load_local_features
       AbstractFeatureBranch.load_environment_features(application_environment)
     end
     def unload_application_features
+      @redis_overrides = nil
       @environment_variable_overrides = nil
       @features = nil
       @local_features = nil

data/lib/ext/feature_branch.rb

@@ -10,7 +10,7 @@ class Object
   def self.feature_enabled?(feature_name, user_id = nil)
     normalized_feature_name = feature_name.to_s.downcase
 
-    redis_override_value = AbstractFeatureBranch.get_store_feature(normalized_feature_name) rescue nil
+    redis_override_value = (AbstractFeatureBranch.get_store_feature(normalized_feature_name) rescue nil) if AbstractFeatureBranch.configuration.feature_store_live_fetching?
     value = !redis_override_value.nil? ? redis_override_value : AbstractFeatureBranch.application_features[normalized_feature_name]
     if value == 'per_user'
       value = !user_id.nil? && AbstractFeatureBranch.user_features_storage.sismember("#{AbstractFeatureBranch::ENV_FEATURE_PREFIX}#{normalized_feature_name}", user_id)

data/lib/generators/templates/config/initializers/abstract_feature_branch.rb

@@ -7,6 +7,10 @@
 # The following example line works with Heroku Redis To Go while still operating on local Redis for local development
 # AbstractFeatureBranch.feature_store = Redis.new(:url => ENV['REDISTOGO_URL'])
 
+# Enable live fetching of feature configuration from storage system, to update features without app/server restart.
+# false by default to only load features on app/server start for faster performance (requires restart on change)
+AbstractFeatureBranch.feature_store_live_fetching = false
+
 # Application root where config/features.yml or config/features/ is found
 AbstractFeatureBranch.application_root = Rails.root
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: abstract_feature_branch
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Annas "Andy" Maleh
@@ -168,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.6
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: 'abstract_feature_branch is a Rails gem that enables developers to easily