consul_application_settings 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e6c1820af05af3bcc9adca21879296cbcfc8898e69ffa7136bac1d785ae1bb1
-  data.tar.gz: 0e8b5c29bf2992a6d36e7a064b8887922b69ec5f820073157b53a21dc5905089
+  metadata.gz: fa6d5fd8ad5cf3b9df7fcbc3622a6efac55fc1bc3fcc81327ea061eab9a1ae77
+  data.tar.gz: 93434d8c607adf270f4acb503cc93bed92850b0fb366fb2d4513f679f39154e3
 SHA512:
-  metadata.gz: 976fec73196a99d0a642d9f4d9243beb0a0925f44f140ff6e77091dac1919f36472b1467344e190da01b071803412d6ec612ccb31f8751a9d06d3f471a49fd1f
-  data.tar.gz: e0d2e02025e94d2d5fc6ac4dd24a4073f9ac228969e67afbd9afb5cafa297c6a347dd68a53fac9a4ad6b4c2ce875b036372894b175e1bd36e6db138c1b31e9d9
+  metadata.gz: e86cddbca8a53cf608b72abb8dbe8c1aefdee558636f21cad45b6b3111ced6159f758175e4a377c55fbe2eba0ffab729b7fe427cf84ae43e77e25818a06593d1
+  data.tar.gz: 1ad1589204db6e0fa56ca42300f68c32a796a8c181b03c2aebde4104b66568c9100c2cec032b76ade78b811106228611717f92900f96fa451721be4fafebd240

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 ## [Unreleased]
 
+## [3.0.0]
+### Breaking Changes
+- Use Preloaded Consul Settings Provider by default
+### New features
+- Configurable setting providers
+- Preloaded Consul Settings Provider to prioritize performance over consistency
+- Performance tests in spec
+- Benchmarking script
+### Fixes
+- Return nil instead of empty hash when reading missing setting from file
+- Return nil instead of empty string when reading missing value from Consul
+- Add missing load method on Settings Reader to create object with narrow scope
+
+## [2.1.1]
+### Changes
+- Update Diplomat to latest version 
+
+## [2.1.0]
+### Fixes
+- Return nil for unknown keys 
+
+## [2.0.0]
+### Breaking Changes
+- Change default naming for setting files 
+
+## [1.0.0]
+### Features
+- Add support for second settings file (local settings for development) 
+
+## [0.1.4]
+### Fixes
+- Clone values before returning
+
 ## [0.1.3]
 ### Fixes
 - Add `Diplomat::PathNotFound` to the list of caught exceptions
@@ -22,7 +55,13 @@
 - Support deep settings search
 - Support nested configs
 
-[Unreleased]: https://github.com/matic-insurance/consul_application_settings/compare/0.1.3...HEAD
+[Unreleased]: https://github.com/matic-insurance/consul_application_settings/compare/3.0.0...HEAD
+[3.0.0]: https://github.com/matic-insurance/consul_application_settings/compare/2.0.0...3.0.0
+[2.1.1]: https://github.com/matic-insurance/consul_application_settings/compare/2.1.0...2.1.1
+[2.1.0]: https://github.com/matic-insurance/consul_application_settings/compare/2.0.0...2.1.0
+[2.0.0]: https://github.com/matic-insurance/consul_application_settings/compare/1.0.0...2.0.0
+[1.0.0]: https://github.com/matic-insurance/consul_application_settings/compare/0.1.4...1.0.0
+[0.1.4]: https://github.com/matic-insurance/consul_application_settings/compare/0.1.3...0.1.4
 [0.1.3]: https://github.com/matic-insurance/consul_application_settings/compare/0.1.2...0.1.3
 [0.1.2]: https://github.com/matic-insurance/consul_application_settings/compare/0.1.1...0.1.2
 [0.1.1]: https://github.com/matic-insurance/consul_application_settings/compare/0.1.0...0.1.1

data/README.md

@@ -45,6 +45,11 @@ ConsulApplicationSettings.configure do |config|
   config.local_file_path = Rails.root.join('config/my_settings.local.yml')
   # Specify whether exceprion should be thrown on Consul connection errors. Default: false
   config.disable_consul_connection_errors = true
+  # Specify setting providers. Default: [ConsulApplicationSettings::Providers::ConsulPreloaded, ConsulApplicationSettings::Providers::LocalStorage]
+  config.settings_providers = [
+    ConsulApplicationSettings::Providers::Consul,          
+    ConsulApplicationSettings::Providers::LocalStorage          
+  ]
 end
 
 APP_SETTINGS = ConsulApplicationSettings.load
@@ -139,6 +144,10 @@ All Gem configurations
 | base_file_path                   | no       | 'config/application_settings.yml'       | String  | Path to the file with base settings                                          |
 | local_file_path                  | no       | 'config/application_settings.local.yml' | String  | Path to the file with local settings overriding the base settings            |
 | disable_consul_connection_errors | no       | true                                    | Boolean | Do not raise exception when consul is not available (useful for development) |
+| settings_providers               | no       | Array(Provider)                         | Array   | Specify custom setting provider lists                                        |
+
+### Performance vs Consistency
+To be defined in future iterations on Consul Providers
 
 ## Development
 

data/bin/benchmark

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'consul_application_settings'
+require 'benchmark'
+
+ITERATIONS = 1000
+
+def kill_consul
+  `pgrep consul | xargs kill`
+end
+
+def start_consul
+  spawn('consul agent -dev -node machine > /dev/null 2>&1')
+end
+
+def application_settings(providers)
+  file = 'spec/fixtures/base_application_settings.yml'
+  ConsulApplicationSettings.configure do |config|
+    config.settings_providers = providers
+  end
+  ConsulApplicationSettings.load(file)
+end
+
+def benchmark_gem
+  Benchmark.bm(20) do |x|
+    x.report('Real Time Consul') do
+      ca = application_settings([
+                                  ConsulApplicationSettings::Providers::Consul,
+                                  ConsulApplicationSettings::Providers::LocalStorage
+                                ])
+      ITERATIONS.times { ca.get('application/name') }
+    end
+
+    x.report('Preloaded Consul') do
+      ca = application_settings([
+                                  ConsulApplicationSettings::Providers::ConsulPreloaded,
+                                  ConsulApplicationSettings::Providers::LocalStorage
+                                ])
+      ITERATIONS.times { ca.get('application/name') }
+    end
+
+    x.report('File Only') do
+      ca = application_settings([
+                                  ConsulApplicationSettings::Providers::ConsulPreloaded
+                                ])
+      ITERATIONS.times { ca.get('application/name') }
+    end
+  end
+end
+
+puts '-' * 80
+puts 'Benchmark without consul agent'
+kill_consul
+benchmark_gem
+
+
+puts '-' * 80
+puts 'Benchmark with consul agent running'
+start_consul
+benchmark_gem
+
+kill_consul

data/lib/consul_application_settings.rb

@@ -1,8 +1,10 @@
 require 'consul_application_settings/version'
+require 'consul_application_settings/providers/abstract'
+require 'consul_application_settings/providers/consul'
+require 'consul_application_settings/providers/consul_preloaded'
+require 'consul_application_settings/providers/local_storage'
 require 'consul_application_settings/configuration'
-require 'consul_application_settings/consul_provider'
-require 'consul_application_settings/file_provider'
-require 'consul_application_settings/settings_provider'
+require 'consul_application_settings/reader'
 require 'consul_application_settings/utils'
 
 # The gem provides possibility to load settings from Consul and automatically fall back to data stored in file system
@@ -21,6 +23,6 @@ module ConsulApplicationSettings
   end
 
   def self.load(path = '')
-    SettingsProvider.new(path, config)
+    Reader.new(path, config)
   end
 end

data/lib/consul_application_settings/configuration.rb

@@ -3,12 +3,17 @@ module ConsulApplicationSettings
   class Configuration
     DEFAULT_BASE_FILE_PATH = 'config/app_settings.yml'.freeze
     DEFAULT_LOCAL_FILE_PATH = 'config/app_settings.local.yml'.freeze
-    attr_accessor :base_file_path, :local_file_path, :disable_consul_connection_errors
+    DEFAULT_PROVIDERS = [
+      ConsulApplicationSettings::Providers::ConsulPreloaded,
+      ConsulApplicationSettings::Providers::LocalStorage
+    ]
+    attr_accessor :base_file_path, :local_file_path, :disable_consul_connection_errors, :settings_providers
 
     def initialize
       @base_file_path = DEFAULT_BASE_FILE_PATH
       @local_file_path = DEFAULT_LOCAL_FILE_PATH
       @disable_consul_connection_errors = true
+      @settings_providers = DEFAULT_PROVIDERS
     end
   end
 end

data/lib/consul_application_settings/providers/abstract.rb

@@ -0,0 +1,25 @@
+module ConsulApplicationSettings
+  module Providers
+    # Abstract class with basic functionality
+    class Abstract
+      def initialize(base_path, config)
+        @base_path, @config = base_path, config
+      end
+
+      def get(path)
+        raise NotImplementedError
+      end
+
+      protected
+
+      def absolute_key_path(path)
+        ConsulApplicationSettings::Utils.generate_path(@base_path, path)
+      end
+
+      def get_value_from_hash(path, data)
+        parts = ConsulApplicationSettings::Utils.decompose_path(path)
+        data.dig(*parts).clone
+      end
+    end
+  end
+end

data/lib/consul_application_settings/providers/consul.rb

@@ -0,0 +1,24 @@
+require 'diplomat'
+
+module ConsulApplicationSettings
+  module Providers
+    # Provides access to settings stored in Consul
+    class Consul < Abstract
+      def get(path)
+        full_path = absolute_key_path(path)
+        value = get_from_consul(full_path)
+        ConsulApplicationSettings::Utils.cast_consul_value(value)
+      end
+
+      private
+
+      def get_from_consul(path)
+        Diplomat::Kv.get(path, {})
+      rescue Diplomat::KeyNotFound
+        return nil
+      rescue SystemCallError, Faraday::ConnectionFailed, Diplomat::PathNotFound => e
+        raise e unless @config.disable_consul_connection_errors
+      end
+    end
+  end
+end

data/lib/consul_application_settings/providers/consul_preloaded.rb

@@ -0,0 +1,26 @@
+module ConsulApplicationSettings
+  module Providers
+    # Provides access to settings stored in Consul. Loads them once
+    class ConsulPreloaded < Abstract
+      def initialize(base_path, config)
+        super
+        @data = get_all_from_consul
+      end
+
+      def get(path)
+        value = get_value_from_hash(absolute_key_path(path), @data)
+        ConsulApplicationSettings::Utils.cast_consul_value(value)
+      end
+
+      protected
+
+      def get_all_from_consul
+        Diplomat::Kv.get_all(@base_path, { convert_to_hash: true })
+      rescue Diplomat::KeyNotFound
+        {}
+      rescue SystemCallError, Faraday::ConnectionFailed, Diplomat::PathNotFound => e
+        raise e unless @config.disable_consul_connection_errors
+      end
+    end
+  end
+end

data/lib/consul_application_settings/providers/local_storage.rb

@@ -0,0 +1,42 @@
+require 'yaml'
+
+module ConsulApplicationSettings
+  module Providers
+    # Provides access to settings stored in file system with support of base and local files
+    class LocalStorage < Abstract
+      def initialize(base_path, config)
+        super
+        @data = load
+      end
+
+      def get(path)
+        get_value_from_hash(absolute_key_path(path), @data)
+      end
+
+      private
+
+      def load
+        base_yml = read_yml(base_file_path)
+        local_yml = read_yml(local_file_path)
+        DeepMerge.deep_merge!(local_yml, base_yml, preserve_unmergeables: false, overwrite_arrays: true,
+                              merge_nil_values: true)
+      end
+
+      def base_file_path
+        @config.base_file_path
+      end
+
+      def local_file_path
+        @config.local_file_path
+      end
+
+      def read_yml(path)
+        return {} unless File.exist?(path)
+
+        YAML.safe_load(IO.read(path))
+      rescue Psych::SyntaxError, Errno::ENOENT => e
+        raise ConsulApplicationSettings::Error, "Cannot read settings file at #{path}: #{e.message}"
+      end
+    end
+  end
+end

data/lib/consul_application_settings/reader.rb

@@ -0,0 +1,25 @@
+module ConsulApplicationSettings
+  # Provides access to settings stored in Consul or in file system
+  class Reader
+    def initialize(base_path, config)
+      @base_path = base_path
+      @config = config
+      @providers = config.settings_providers.map { |provider| provider.new(base_path, config) }
+    end
+
+    def get(path)
+      @providers.each do |provider|
+        value = provider.get(path)
+        return value unless value.nil?
+      end
+      nil
+    end
+
+    alias [] get
+
+    def load(sub_path)
+      new_path = ConsulApplicationSettings::Utils.generate_path(@base_path, sub_path)
+      self.class.new(new_path, @config)
+    end
+  end
+end

data/lib/consul_application_settings/utils.rb

@@ -6,6 +6,7 @@ module ConsulApplicationSettings
 
     class << self
       def cast_consul_value(value)
+        return nil if value.nil?
         return false if value == 'false'
         return true if value == 'true'
 

data/lib/consul_application_settings/version.rb

@@ -1,3 +1,3 @@
 module ConsulApplicationSettings
-  VERSION = '2.1.1'.freeze
+  VERSION = '3.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul_application_settings
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Volodymyr Mykhailyk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-22 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diplomat
@@ -143,15 +143,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/benchmark
 - bin/console
 - bin/rspec
 - bin/setup
 - consul_application_settings.gemspec
 - lib/consul_application_settings.rb
 - lib/consul_application_settings/configuration.rb
-- lib/consul_application_settings/consul_provider.rb
-- lib/consul_application_settings/file_provider.rb
-- lib/consul_application_settings/settings_provider.rb
+- lib/consul_application_settings/providers/abstract.rb
+- lib/consul_application_settings/providers/consul.rb
+- lib/consul_application_settings/providers/consul_preloaded.rb
+- lib/consul_application_settings/providers/local_storage.rb
+- lib/consul_application_settings/reader.rb
 - lib/consul_application_settings/utils.rb
 - lib/consul_application_settings/version.rb
 homepage: https://github.com/matic-insurance/consul_application_settings
@@ -176,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Application settings via Consul with yaml defaults

data/lib/consul_application_settings/consul_provider.rb

@@ -1,33 +0,0 @@
-require 'diplomat'
-
-module ConsulApplicationSettings
-  # Provides access to settings stored in Consul
-  class ConsulProvider
-    def initialize(base_path, config)
-      @base_path = base_path
-      @config = config
-    end
-
-    def get(path)
-      value = fetch_value(path)
-      ConsulApplicationSettings::Utils.cast_consul_value(value)
-    end
-
-    private
-
-    def fetch_value(path)
-      full_path = generate_full_path(path)
-      Diplomat::Kv.get(full_path, {}, :return)
-    rescue SystemCallError, Faraday::ConnectionFailed, Diplomat::PathNotFound => e
-      raise e unless disable_consul_connection_errors?
-    end
-
-    def generate_full_path(path)
-      ConsulApplicationSettings::Utils.generate_path(@base_path, path)
-    end
-
-    def disable_consul_connection_errors?
-      @config.disable_consul_connection_errors
-    end
-  end
-end

data/lib/consul_application_settings/file_provider.rb

@@ -1,54 +0,0 @@
-require 'yaml'
-
-module ConsulApplicationSettings
-  # Provides access to settings stored in file system with support of base and local files
-  class FileProvider
-    def initialize(base_path, config)
-      @base_path = base_path
-      @config = config
-      load
-    end
-
-    def get(path)
-      read_path(path).clone
-    end
-
-    private
-
-    def load
-      base_yml = read_yml(base_file_path)
-      local_yml = read_yml(local_file_path)
-      @data = DeepMerge.deep_merge!(local_yml, base_yml, preserve_unmergeables: false, overwrite_arrays: true,
-                                                         merge_nil_values: true)
-    end
-
-    def base_file_path
-      @config.base_file_path
-    end
-
-    def local_file_path
-      @config.local_file_path
-    end
-
-    def read_yml(path)
-      return {} unless File.exist?(path)
-
-      YAML.safe_load(IO.read(path))
-    rescue Psych::SyntaxError, Errno::ENOENT => e
-      raise ConsulApplicationSettings::Error, "Cannot read settings file at #{path}: #{e.message}"
-    end
-
-    def read_path(path)
-      full_path = ConsulApplicationSettings::Utils.generate_path(@base_path, path)
-      parts = ConsulApplicationSettings::Utils.decompose_path(full_path)
-      parts.reduce(@data, &method(:read_value))
-    end
-
-    def read_value(hash, key)
-      raise ConsulApplicationSettings::Error, 'reading arrays not implemented' if hash.is_a? Array
-      return {} if hash.nil?
-
-      hash.fetch(key.to_s, nil)
-    end
-  end
-end

data/lib/consul_application_settings/settings_provider.rb

@@ -1,16 +0,0 @@
-module ConsulApplicationSettings
-  # Provides access to settings stored in Consul or in file system
-  class SettingsProvider
-    def initialize(base_path, config)
-      @consul_provider = ConsulProvider.new(base_path, config)
-      @file_provider = FileProvider.new(base_path, config)
-    end
-
-    def get(path)
-      consul_value = @consul_provider.get(path)
-      !consul_value.nil? && consul_value != '' ? consul_value : @file_provider.get(path)
-    end
-
-    alias [] get
-  end
-end