feature_toggle_service 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce47d232400183cfb243ae96d1ac819ec989ac45
-  data.tar.gz: a6adfd7d17bbea3294a189484a5e438e1f89bf08
+  metadata.gz: 871f7203a1058c29fdb1b77f335f06621677ae72
+  data.tar.gz: 273df5f6daf47a89d2dfb24f7f777cf89b3b9882
 SHA512:
-  metadata.gz: 09172b065adead592fed6e46e4f8fdf5c0d132d2e2a78215e757f18ca8dbc39700d81bb59be59992182d044d09aaf78e0d0fbb243d5ddef6340d22b62f1dcf75
-  data.tar.gz: 7e23602767d12c7781bb9e5a036076be30a000bc5016dd462fb9cd5cfec5d0ca10ecfd57200888694a621ce1ff058aa0261b41882786cbbcc37233d3bd84a072
+  metadata.gz: 4641d20335d2e8947c5b7fb253c4a14854487b49b2782544bcc1e8496b8f3e63a40d8530d3144e6a942910eaad087fc109d9354eaa16f99dacf4d61af6306c58
+  data.tar.gz: 101b517a76ee5e41c7f60ba5cd0bfb49eccdb40dc9d85397f9ee1bd740acbf1c3f90201bb999f5bdd58f9c29f913e57d39d551bd67481da86d311886e5fcd0ad

data/README.md

@@ -46,16 +46,23 @@ We can remove a default with `FeatureToggleService.unset_default(key)`, or all o
 
 The default value will be returned if the key is not found in hobknob, or if etcd does not respond.
 
+## Cached Toggles
+
+If enabled in the config params (see "Config parameters" section bellow), a given toggle will be loaded only once, and its value will be stored in the FeatureToggleService in a hash.
+
+The caching takes place around the actual call to `etcd` so it's the only part that is cached. It's only cached if it is successful (true or false), so if etcd is off or if the key is not found it will keep checking etcd every time. 
+
 ## Config parameters
 
 We can set parameters for config.
 
 * `app_name`: required. It's the App name in hobknob.
+* `cache_toggles`: if true, the toggles will be looked up only once (see "Cached Toggles" section). It's a boolean. Defaults to `false`
 * `logger`: logger to be used in the client. Defaults to `nil`
 * `logger_level`: if no `logger` is passed, then a new `Logger` will be created to `STDOUT` and this level will be used. Defaults to `nil` 
 * `key_suffix`: a suffix on the key, used as the discriminator in hobknob. Can be the environment, or the domain...  Defaults to `nil`
 * `enabled`: if false, then etcd calls are skipped, and only overrides and defaults are used. Defaults to `true`
-* `etcd_client`: parameters for the etcd client. It's a hash. Defaults to `{ port: 4001 }`
+* `etcd_client`: parameters for the etcd client. It's a hash. Defaults to `{ port: 4001, host: 'localhost' }`
 
 *important: The config has to be set before using the service*
 

data/lib/feature_toggle_service/config.rb

@@ -1,20 +1,25 @@
 module FeatureToggleService
   class Config
 
-    attr_reader :enabled, :app_name, :etcd_client, :logger, :key_suffix
+    attr_reader :enabled, :app_name, :etcd_client, :logger, :key_suffix, :cache_toggles
 
-    def initialize(logger: nil, logger_level: nil, key_suffix: 'suffix', enabled: true, app_name:, etcd_client: { port: 4001 })
-      @enabled     = enabled
-      @app_name    = app_name
-      @etcd_client = etcd_client
-      @key_suffix  = key_suffix
-      @logger      = logger || build_logger(logger_level)
+    def initialize(logger: nil, logger_level: nil, key_suffix: 'suffix', enabled: true, app_name:, etcd_client: { port: 4001 }, cache_toggles: false)
+      @enabled       = enabled
+      @app_name      = app_name
+      @etcd_client   = etcd_client
+      @key_suffix    = key_suffix
+      @logger        = logger || build_logger(logger_level)
+      @cache_toggles = cache_toggles
     end
 
     def enabled?
       !!enabled
     end
 
+    def cache_toggles?
+      !!cache_toggles
+    end
+
     private
     def build_logger(logger_level)
       Logger.new(STDOUT).tap do |log|

data/lib/feature_toggle_service/repository.rb

@@ -7,6 +7,7 @@ module FeatureToggleService
     def initialize(config)
       @config    = config
       @overrides = {}
+      @cached    = {}
       @defaults  = {}
     end
 
@@ -45,7 +46,7 @@ module FeatureToggleService
     delegate :key_suffix, :enabled?, :app_name, to: :config
 
     private
-    delegate :logger, to: :config
+    delegate :logger, :cache_toggles?, to: :config
 
     def load_value(key)
       enabled? ? retrieve_value(key) : default_value_for(key)
@@ -53,7 +54,7 @@ module FeatureToggleService
 
     def retrieve_value(key)
       fk = final_key(key)
-      etcd_client.get(fk).value
+      etcd_get_toggle(fk)
     rescue Etcd::KeyNotFound => e
       logger.error { "Feature Toggle without key #{key.inspect}, final key #{fk.inspect}." }
       default_value_for(key)
@@ -63,6 +64,18 @@ module FeatureToggleService
       default_value_for(key)
     end
 
+    def etcd_get_toggle(fk)
+      etcd_load_toggle(fk) unless cache_toggles?
+
+      @cached.fetch(fk) do
+        @cached[fk] = etcd_load_toggle(fk)
+      end
+    end
+
+    def etcd_load_toggle(fk)
+      etcd_client.get(fk).value
+    end
+
     def final_key(key)
       "/v1/toggles/#{app_name}/#{key}/#{key_suffix}"
     end

data/lib/feature_toggle_service/service.rb

@@ -6,7 +6,7 @@ module FeatureToggleService
 
     # Instance
     def config_params
-      @config_params ||= { key_suffix: 'suffix', enabled: true, app_name: 'Default App', etcd_client: { port: 4001 } }
+      @config_params ||= { key_suffix: 'suffix', enabled: true, cache_toggles: false, app_name: 'Default App', etcd_client: { port: 4001 } }
     end
 
     def off?(key)

data/lib/feature_toggle_service/version.rb

@@ -1,3 +1,3 @@
 module FeatureToggleService
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feature_toggle_service
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Eduardo Turiño
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2015-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: etcd