prefab-cloud-ruby 0.13.3 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc875095444727947594dfa96e7a4e59fbab20a14ec486fdd4b804b936aad374
-  data.tar.gz: 7af3f2155fdb85063c674b4f4bf3365b089e507789adf9eaa0ca5b4e206b9e19
+  metadata.gz: 2fef66a6ac50710f11854f9168c30573ef3fea74acd9089308d1a70ac754f584
+  data.tar.gz: 7b424813748667165d263f0869cf0a93c56d9f0fdafe60f22799b358f3f5688a
 SHA512:
-  metadata.gz: aff23956f0c34934a5702bd51517ac14111a7888ba99948537fb76fbcdf162abf6a032ae8caba5c902e06894b0f3bf5ffcf5a95efce9cf00210b4f333059e233
-  data.tar.gz: 21717c0f85eecd1972baf9fc1d8fa8b57d225da60eb6cba006b3ac4f288f4fab77c18f5d6a34e49ca8beb8835e22a520b3bc92b058658309d41db5eba9a05c86
+  metadata.gz: 03d9230267363cc51962c3a244f39cc9b6e6bda7da3c6e9b460ed195330d3035840f69fc2837f66b86a4c05d6b830a14db56aee4578fa5e13e580c7be89fa6c8
+  data.tar.gz: 1b084b6f4b8180069a214a6edcaeb5d23c1afb234f5161870a6b11d5d2841a1d05683f65eeb94c9cd6b92cd02d70296e2abb9d430d2f1c6143ee2d0224ae3b85

data/VERSION

@@ -1 +1 @@
-0.13.3
+0.14.0

data/lib/prefab/config_client.rb

@@ -5,7 +5,6 @@ module Prefab
 
     RECONNECT_WAIT = 5
     DEFAULT_CHECKPOINT_FREQ_SEC = 60
-    DEFAULT_S3CF_BUCKET = 'http://d2j4ed6ti5snnd.cloudfront.net'
     SSE_READ_TIMEOUT = 300
 
     def initialize(base_client, timeout)
@@ -29,8 +28,6 @@ module Prefab
 
       @cancellable_interceptor = Prefab::CancellableInterceptor.new(@base_client)
 
-      @s3_cloud_front = ENV["PREFAB_S3CF_BUCKET"] || DEFAULT_S3CF_BUCKET
-
       if @options.local_only?
         finish_init!(:local_only)
       else
@@ -119,7 +116,6 @@ module Prefab
                                                interceptors: [@base_client.interceptor, @cancellable_interceptor])
     end
 
-    # try API first, if not, fallback to s3
     def load_checkpoint
       success = load_checkpoint_api_cdn
 
@@ -134,12 +130,6 @@ module Prefab
       if success
         return
       else
-        @base_client.log_internal Logger::INFO, "LoadCheckpoint: Fallback to S3"
-      end
-
-      success = load_checkpoint_from_s3
-
-      if !success
         @base_client.log_internal Logger::WARN, "No success loading checkpoints"
       end
     end
@@ -172,11 +162,6 @@ module Prefab
       load_url(conn, :remote_cdn_api)
     end
 
-    def load_checkpoint_from_s3
-      url = "#{@s3_cloud_front}/#{@base_client.api_key.gsub("|", "/")}"
-      load_url(Faraday.new(url), :remote_s3)
-    end
-
     def load_url(conn, source)
       resp = conn.get('')
       if resp.status == 200

data/lib/prefab/config_loader.rb

@@ -56,57 +56,59 @@ module Prefab
 
     def load_classpath_config
       classpath_dir = @prefab_options.prefab_config_classpath_dir
-      load_glob(File.join(classpath_dir, ".prefab*config.yaml"))
+      rtn = load_glob(File.join(classpath_dir, ".prefab.default.config.yaml"))
+      @prefab_options.prefab_envs.each do |env|
+        rtn = rtn.merge load_glob(File.join(classpath_dir, ".prefab.#{env}.config.yaml"))
+      end
+      rtn
     end
 
     def load_local_overrides
       override_dir = @prefab_options.prefab_config_override_dir
-      load_glob(File.join(override_dir, ".prefab*config.yaml"))
+      rtn = load_glob(File.join(override_dir, ".prefab.overrides.config.yaml"))
+      @prefab_options.prefab_envs.each do |env|
+        rtn = rtn.merge load_glob(File.join(override_dir, ".prefab.#{env}.config.yaml"))
+      end
+      rtn
     end
 
     def load_glob(glob)
       rtn = {}
       Dir.glob(glob).each do |file|
+        @base_client.log_internal Logger::INFO, "Load #{file}"
         yaml = load(file)
         yaml.each do |k, v|
-          if v.class == Hash
-            v.each do |env_k, env_v|
-              if k == @prefab_options.defaults_env
-                if env_v.class == Hash && env_v['feature_flag']
-                  rtn[env_k] = feature_flag_config(file, k, env_k, env_v)
-                else
-                  rtn[env_k] = {
-                    source: file,
-                    match: k,
-                    config: Prefab::Config.new(
-                      key: env_k,
-                      rows: [
-                        Prefab::ConfigRow.new(value: Prefab::ConfigValue.new(value_from(env_v)))
-                      ]
-                    )
-                  }
-                end
-              else
-                next
-              end
-            end
-          else
-            rtn[k] = {
-              source: file,
-              match: "default",
-              config: Prefab::Config.new(
-                key: k,
-                rows: [
-                  Prefab::ConfigRow.new(value: Prefab::ConfigValue.new(value_from(v)))
-                ]
-              )
-            }
-          end
+          load_kv(k, v, rtn, file)
         end
       end
       rtn
     end
 
+    def load_kv(k, v, rtn, file)
+      if v.class == Hash
+        if v['feature_flag']
+          rtn[k] = feature_flag_config(file, k, v)
+        else
+          v.each do |nest_k, nest_v|
+            nested_key = "#{k}.#{nest_k}"
+            nested_key = k if nest_k == "_"
+            load_kv(nested_key, nest_v, rtn, file)
+          end
+        end
+      else
+        rtn[k] = {
+          source: file,
+          match: "default",
+          config: Prefab::Config.new(
+            key: k,
+            rows: [
+              Prefab::ConfigRow.new(value: Prefab::ConfigValue.new(value_from(v)))
+            ]
+          )
+        }
+      end
+    end
+
     def load(filename)
       if File.exist? filename
         @base_client.log_internal Logger::INFO, "Load #{filename}"
@@ -130,11 +132,11 @@ module Prefab
       end
     end
 
-    def feature_flag_config(file, k, env_k, env_v)
+    def feature_flag_config(file, key, value)
       criteria = Prefab::Criteria.new(operator: 'ALWAYS_TRUE')
 
-      if env_v['criteria']
-        criteria = Prefab::Criteria.new(criteria_values(env_v['criteria']))
+      if value['criteria']
+        criteria = Prefab::Criteria.new(criteria_values(value['criteria']))
       end
 
       row = Prefab::ConfigRow.new(
@@ -154,16 +156,16 @@ module Prefab
         )
       )
 
-      unless env_v.has_key?('value')
-        raise Prefab::Error, "Feature flag config `#{env_k}` #{file} must have a `value`"
+      unless value.has_key?('value')
+        raise Prefab::Error, "Feature flag config `#{key}` #{file} must have a `value`"
       end
 
       {
         source: file,
-        match: k,
+        match: key,
         config: Prefab::Config.new(
-          key: env_k,
-          variants: [Prefab::FeatureFlagVariant.new(value_from(env_v['value']))],
+          key: key,
+          variants: [Prefab::FeatureFlagVariant.new(value_from(value['value']))],
           rows: [row]
         )
       }

data/lib/prefab/options.rb

@@ -14,7 +14,7 @@ module Prefab
     attr_reader :on_init_failure
     attr_reader :prefab_config_override_dir
     attr_reader :prefab_config_classpath_dir
-    attr_reader :defaults_env
+    attr_reader :prefab_envs
 
     DEFAULT_LOG_FORMATTER = proc { |severity, datetime, progname, msg|
       "#{severity.ljust(5)} #{datetime}: #{progname} #{msg}\n"
@@ -50,7 +50,7 @@ module Prefab
       prefab_datasources: ENV['PREFAB_DATASOURCES'] == "LOCAL_ONLY" ? DATASOURCES::LOCAL_ONLY : DATASOURCES::ALL,
       prefab_config_override_dir: Dir.home,
       prefab_config_classpath_dir: ".",
-      defaults_env: ""
+      prefab_envs:  ENV['PREFAB_ENVS'].nil? ? [] : ENV['PREFAB_ENVS'].split(",")
     )
       # debugger
       @api_key = api_key
@@ -67,7 +67,7 @@ module Prefab
       @prefab_datasources = prefab_datasources
       @prefab_config_classpath_dir = prefab_config_classpath_dir
       @prefab_config_override_dir = prefab_config_override_dir
-      @defaults_env = defaults_env
+      @prefab_envs = Array(prefab_envs)
     end
 
     def local_only?

data/prefab-cloud-ruby.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: prefab-cloud-ruby 0.13.3 ruby lib
+# stub: prefab-cloud-ruby 0.14.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "prefab-cloud-ruby".freeze
-  s.version = "0.13.3"
+  s.version = "0.14.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Jeff Dwyer".freeze]
-  s.date = "2022-08-12"
+  s.date = "2022-08-15"
   s.description = "RateLimits & Config as a service".freeze
   s.email = "jdwyer@prefab.cloud".freeze
   s.extra_rdoc_files = [
@@ -54,7 +54,8 @@ Gem::Specification.new do |s|
     "lib/prefab_services_pb.rb",
     "prefab-cloud-ruby.gemspec",
     "run_test_harness_server.sh",
-    "test/.prefab.test.config.yaml",
+    "test/.prefab.default.config.yaml",
+    "test/.prefab.unit_tests.config.yaml",
     "test/harness_server.rb",
     "test/test_client.rb",
     "test/test_config_client.rb",

data/test/.prefab.default.config.yaml

@@ -0,0 +1,2 @@
+sample: default sample value
+sample_bool: true

data/test/.prefab.unit_tests.config.yaml

@@ -0,0 +1,25 @@
+sample_int: 123
+sample_double: 12.12
+sample_bool: true
+false_value: false
+zero_value: 0
+sample_to_override: Foo
+prefab.log_level: debug
+sample: test sample value
+enabled_flag: true
+disabled_flag: false
+flag_with_a_value: { "feature_flag": "true", value: "all-features" }
+in_lookup_key: { "feature_flag": "true", value: true, criteria: { operator: LOOKUP_KEY_IN, values: [ "abc123", "xyz987" ] } }
+just_my_domain: { "feature_flag": "true", value: "new-version", criteria: { operator: PROP_IS_ONE_OF, property: "domain", values: [ "prefab.cloud", "example.com" ] } }
+nested:
+  values:
+    _: top level
+    string: nested value
+
+logging:
+  app:
+    _: error
+    controller:
+      hello:
+        _: warn
+        index: info

data/test/test_client.rb

@@ -89,7 +89,7 @@ class TestClient < Minitest::Test
     options = Prefab::Options.new(**{
       prefab_config_override_dir: "none",
       prefab_config_classpath_dir: "test",
-      defaults_env: "unit_tests",
+      prefab_envs: ["unit_tests"],
       prefab_datasources: Prefab::Options::DATASOURCES::LOCAL_ONLY
     }.merge(overrides))
 

data/test/test_config_client.rb

@@ -6,7 +6,7 @@ class TestConfigClient < Minitest::Test
     options = Prefab::Options.new(
       prefab_config_override_dir: "none",
       prefab_config_classpath_dir: "test",
-      defaults_env: "unit_tests",
+      prefab_envs: "unit_tests",
       prefab_datasources: Prefab::Options::DATASOURCES::LOCAL_ONLY
     )
 
@@ -32,6 +32,21 @@ class TestConfigClient < Minitest::Test
     assert_match(/couldn't initialize in 0.01 second timeout/, err.message)
   end
 
+  def test_prefab_envs_is_forgiving
+    assert_equal ["my_env"], Prefab::Options.new(
+      prefab_envs: "my_env",
+    ).prefab_envs
+
+    assert_equal ["my_env", "a_second_env"], Prefab::Options.new(
+      prefab_envs: ["my_env", "a_second_env"],
+    ).prefab_envs
+  end
+
+  def test_prefab_envs_env_var
+    ENV["PREFAB_ENVS"] = "one,two"
+    assert_equal ["one", "two"], Prefab::Options.new().prefab_envs
+  end
+
   def test_invalid_api_key_error
     options = Prefab::Options.new(
       api_key: "",

data/test/test_config_loader.rb

@@ -6,7 +6,7 @@ class TestConfigLoader < Minitest::Test
     options = Prefab::Options.new(
       prefab_config_override_dir: "none",
       prefab_config_classpath_dir: "test",
-      defaults_env: "unit_tests"
+      prefab_envs: "unit_tests"
     )
     @loader = Prefab::ConfigLoader.new(MockBaseClient.new(options))
   end
@@ -18,11 +18,19 @@ class TestConfigLoader < Minitest::Test
     should_be :double, 12.12, "sample_double"
   end
 
-  def test_load_in_no_default_env
+  def test_nested
+    should_be :string, "nested value", "nested.values.string"
+    should_be :string, "top level", "nested.values"
+    should_be :string, "error", "logging.app"
+    should_be :string, "warn", "logging.app.controller.hello"
+    should_be :string, "info", "logging.app.controller.hello.index"
+  end
+
+  def test_load_without_unit_test_env
     options = Prefab::Options.new(
       prefab_config_override_dir: "none",
       prefab_config_classpath_dir: "test",
-    # no defaults_env
+      # no prefab_envs
     )
     @loader = Prefab::ConfigLoader.new(MockBaseClient.new(options))
     should_be :string, "default sample value", "sample"

data/test/test_helper.rb

@@ -81,7 +81,7 @@ def new_client(overrides = {})
   options = Prefab::Options.new(**{
     prefab_config_override_dir: "none",
     prefab_config_classpath_dir: "test",
-    defaults_env: "unit_tests",
+    prefab_envs: ["unit_tests"],
     prefab_datasources: Prefab::Options::DATASOURCES::LOCAL_ONLY
   }.merge(overrides))
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefab-cloud-ruby
 version: !ruby/object:Gem::Version
-  version: 0.13.3
+  version: 0.14.0
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2022-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -227,7 +227,8 @@ files:
 - lib/prefab_services_pb.rb
 - prefab-cloud-ruby.gemspec
 - run_test_harness_server.sh
-- test/.prefab.test.config.yaml
+- test/.prefab.default.config.yaml
+- test/.prefab.unit_tests.config.yaml
 - test/harness_server.rb
 - test/test_client.rb
 - test/test_config_client.rb

data/test/.prefab.test.config.yaml

@@ -1,32 +0,0 @@
-sample: default sample value
-sample_int: 123
-sample_double: 12.12
-sample_bool: true
-false_value: false
-zero_value: 0
-sample_to_override: Foo
-prefab.log_level: debug
-unit_tests:
-  sample: test sample value
-  enabled_flag: true
-  disabled_flag: false
-  flag_with_a_value:
-    feature_flag: true
-    value: "all-features"
-  in_lookup_key:
-    feature_flag: true
-    value: true
-    criteria:
-      operator: LOOKUP_KEY_IN
-      values:
-        - abc123
-        - xyz987
-  just_my_domain:
-    feature_flag: true
-    value: new-version
-    criteria:
-      operator: PROP_IS_ONE_OF
-      property: domain
-      values: ["prefab.cloud", "example.com"]
-ignored_env:
-  sample: ignored value