prefab-cloud-ruby 0.6.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fa80ee91d95324b503253f95a12deb9b0db91291
-  data.tar.gz: 0315d992eb2a87073998e1d7db4864a8c3da289c
+SHA256:
+  metadata.gz: 80a03ec9a75bc4c5d827c746354ff1353fe135a5ab6e31e9beaaf1ca1c27c931
+  data.tar.gz: d4c9f02e6bbb54d8d4884cc2d94179f39e859aafe3966188b1a00f7b7e5ccc48
 SHA512:
-  metadata.gz: e43a7a8dafbfd3a9e6c12cd93b57bed2ee8fd738406fdba166c5eddad03154de66d9150285961f8c08da58d0754fde385b8b68e0bb22f9a27de8441f231a429a
-  data.tar.gz: c3586f0e6b689e0ee5b1fd86e621d79ffab5a2263cf977c004fd7a4618cea403059f075f719a86d5a0b4533a16e398e3acb35dff9ca0930082fb81266ef1e545
+  metadata.gz: 67f8b5ed6f61f01943736f9abbb685c9d7f7fd4c029ff3e051356f6e65936595f18899160fd842c415d86c371b0f9d915d795c6b9adafbdebeadd5b6fc6cc75b
+  data.tar.gz: c56dd76208ad8bbfd9d7add1bbc317a951671c2590cecf93389fbb5170aa9da13898bb3501e396450df2eaa93a67d7041b24fbdc2ca77f2a414056d0cbf471f9

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.3

data/CODEOWNERS

@@ -0,0 +1 @@
+*    @prefab-cloud/prefabdevs @prefab-cloud/prefabmaintainers @prefab-cloud/prefabadmins

data/Gemfile

@@ -2,13 +2,17 @@ source "https://rubygems.org"
 
 gem 'concurrent-ruby', '~> 1.0', '>= 1.0.5'
 gem 'faraday'
-gem 'grpc'
+gem 'ld-eventsource'
+gem 'grpc', :platforms => :ruby
+gem 'google-protobuf', :platforms => :ruby
+gem 'googleapis-common-protos-types', :platforms => :ruby
 
 group :development do
-  gem 'grpc-tools', '~> 1.17.1'
+  gem 'grpc-tools', :platforms => :ruby
   gem "shoulda", ">= 0"
   gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0"
+  gem "bundler"
   gem "juwelier", "~> 2.4.9"
   gem "simplecov", ">= 0"
+  gem 'thin'
 end

data/Gemfile.lock

@@ -10,14 +10,22 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     builder (3.2.4)
     concurrent-ruby (1.1.8)
+    daemons (1.4.1)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     docile (1.3.5)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    eventmachine (1.2.7)
     faraday (1.3.0)
       faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
     faraday-net_http (1.0.1)
+    ffi (1.15.5)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
     git (1.8.1)
       rchardet (~> 1.8)
     github_api (0.19.0)
@@ -26,15 +34,23 @@ GEM
       faraday (>= 0.8, < 2)
       hashie (~> 3.5, >= 3.5.2)
       oauth2 (~> 1.0)
-    google-protobuf (3.15.6)
-    googleapis-common-protos-types (1.0.6)
-      google-protobuf (~> 3.14)
-    grpc (1.36.0)
+    google-protobuf (3.19.3)
+    googleapis-common-protos-types (1.3.0)
       google-protobuf (~> 3.14)
+    grpc (1.43.1)
+      google-protobuf (~> 3.18)
       googleapis-common-protos-types (~> 1.0)
-    grpc-tools (1.17.1)
+    grpc-tools (1.43.1)
     hashie (3.6.0)
     highline (2.0.3)
+    http (5.0.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.3.0)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
     i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     json (1.8.6)
@@ -53,13 +69,20 @@ GEM
     jwt (2.2.2)
     kamelcase (0.0.2)
       semver2 (~> 3)
-    mini_portile2 (2.4.0)
+    ld-eventsource (2.2.0)
+      concurrent-ruby (~> 1.0)
+      http (>= 4.4.1, < 6.0.0)
+    llhttp-ffi (0.3.1)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    mini_portile2 (2.7.1)
     minitest (5.14.4)
     multi_json (1.15.0)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.13.1)
+      mini_portile2 (~> 2.7.0)
+      racc (~> 1.4)
     oauth2 (1.4.7)
       faraday (>= 0.8, < 2.0)
       jwt (>= 1.0, < 3.0)
@@ -68,6 +91,7 @@ GEM
       rack (>= 1.2, < 3)
     psych (3.3.1)
     public_suffix (4.0.6)
+    racc (1.6.0)
     rack (2.2.3)
     rake (13.0.3)
     rchardet (1.8.0)
@@ -85,23 +109,34 @@ GEM
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.3)
+    thin (1.8.1)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
     thread_safe (0.3.6)
     tzinfo (1.2.9)
       thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0)
+  bundler
   concurrent-ruby (~> 1.0, >= 1.0.5)
   faraday
+  google-protobuf
+  googleapis-common-protos-types
   grpc
-  grpc-tools (~> 1.17.1)
+  grpc-tools
   juwelier (~> 2.4.9)
+  ld-eventsource
   rdoc (~> 3.12)
   shoulda
   simplecov
+  thin
 
 BUNDLED WITH
-   1.16.0
+   2.3.5

data/README.md

@@ -53,7 +53,16 @@ end
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
+## Release
+
+```shell
+update VERSION
+bundle exec rake gemspec:generate
+git commit & push
+REMOTE_BRANCH=main LOCAL_BRANCH=main bundle exec rake release
+```
+
 ## Copyright
 
-Copyright (c) 2018 Jeff Dwyer. See LICENSE.txt for
+Copyright (c) 2022 Jeff Dwyer. See LICENSE.txt for
 further details.

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.9.0

data/compile_protos.sh

@@ -1,2 +1,5 @@
 #!/usr/bin/env bash
 grpc_tools_ruby_protoc -I ../prefab-cloud/ --ruby_out=lib --grpc_out=lib prefab.proto
+# on M1 you need to
+# 1. run in rosetta
+# 2. mv gems/2.6.0/gems/grpc-tools-1.43.1/bin/x86_64-macos x86-macos

data/lib/prefab/client.rb

@@ -8,7 +8,7 @@ module Prefab
     }
 
 
-    attr_reader :account_id, :shared_cache, :stats, :namespace, :interceptor, :api_key
+    attr_reader :project_id, :shared_cache, :stats, :namespace, :interceptor, :api_key, :environment, :prefab_api_url
 
     def initialize(api_key: ENV['PREFAB_API_KEY'],
                    logdev: nil,
@@ -19,26 +19,31 @@ module Prefab
                    log_formatter: DEFAULT_LOG_FORMATTER
     )
       raise "No API key. Set PREFAB_API_KEY env var" if api_key.nil? || api_key.empty?
+      raise "PREFAB_API_KEY format invalid. Expecting 123-development-yourapikey-SDK" unless api_key.count("-") == 3
       @logdev = (logdev || $stdout)
       @log_formatter = log_formatter
       @local = local
       @stats = (stats || NoopStats.new)
       @shared_cache = (shared_cache || NoopCache.new)
       @api_key = api_key
-      @account_id = api_key.split("|")[0].to_i
+      @project_id = api_key.split("-")[0].to_i
+      @environment = api_key.split("-")[1]
       @namespace = namespace
       @interceptor = Prefab::AuthInterceptor.new(api_key)
       @stubs = {}
-
+      @prefab_api_url = ENV["PREFAB_API_URL"] || 'https://api.prefab.cloud'
+      @prefab_grpc_url = ENV["PREFAB_GRPC_URL"] || 'grpc.prefab.cloud:443'
+      log_internal Logger::INFO, "Prefab Initializing in environment: '#{@environment}' and namespace: '#{@namespace}'"
+      log_internal Logger::INFO, "Prefab Connecting to: #{@prefab_api_url} and #{@prefab_grpc_url} Secure: #{http_secure?}"
       at_exit do
         channel.destroy
       end
     end
 
     def channel
-      credentials = ENV["PREFAB_CLOUD_HTTP"] == "true" ? :this_channel_is_insecure : creds
-      url = ENV["PREFAB_API_URL"] || 'api.prefab.cloud:443'
-      @_channel ||= GRPC::Core::Channel.new(url, nil, credentials)
+      credentials = http_secure? ? creds : :this_channel_is_insecure
+      log_internal Logger::DEBUG, "GRPC Channel #{@prefab_grpc_url} #{credentials}"
+      @_channel ||= GRPC::Core::Channel.new(@prefab_grpc_url, nil, credentials)
     end
 
     def config_client(timeout: 5.0)
@@ -88,7 +93,7 @@ module Prefab
     end
 
     def cache_key(post_fix)
-      "prefab:#{account_id}:#{post_fix}"
+      "prefab:#{project_id}:#{post_fix}"
     end
 
     def reset!
@@ -98,6 +103,10 @@ module Prefab
 
     private
 
+    def http_secure?
+      ENV["PREFAB_CLOUD_HTTP"] != "true"
+    end
+
     def stub_for(service, timeout)
       @stubs["#{service}_#{timeout}"] ||= service::Stub.new(nil,
                                                             nil,

data/lib/prefab/config_client.rb

@@ -6,6 +6,7 @@ module Prefab
 
     def initialize(base_client, timeout)
       @base_client = base_client
+      @base_client.log_internal Logger::DEBUG, "Initialize ConfigClient"
       @timeout = timeout
       @initialization_lock = Concurrent::ReadWriteLock.new
 
@@ -14,23 +15,27 @@ module Prefab
       @config_loader = Prefab::ConfigLoader.new(@base_client)
       @config_resolver = Prefab::ConfigResolver.new(@base_client, @config_loader)
 
+      @base_client.log_internal Logger::DEBUG, "Initialize ConfigClient: AcquireWriteLock"
       @initialization_lock.acquire_write_lock
+      @base_client.log_internal Logger::DEBUG, "Initialize ConfigClient: AcquiredWriteLock"
 
       @cancellable_interceptor = Prefab::CancellableInterceptor.new(@base_client)
 
       @s3_cloud_front = ENV["PREFAB_S3CF_BUCKET"] || DEFAULT_S3CF_BUCKET
+
       load_checkpoint
       start_checkpointing_thread
     end
 
     def start_streaming
       @streaming = true
-      start_api_connection_thread(@config_loader.highwater_mark)
+      # start_grpc_streaming_connection_thread(@config_loader.highwater_mark)
+      start_sse_streaming_connection_thread(@config_loader.highwater_mark)
     end
 
-    def get(prop)
+    def get(key)
       @initialization_lock.with_read_lock do
-        @config_resolver.get(prop)
+        @config_resolver.get(key)
       end
     end
 
@@ -58,8 +63,14 @@ module Prefab
     end
 
     def self.value_to_delta(key, config_value, namespace = nil)
-      Prefab::ConfigDelta.new(key: [namespace, key].compact.join(":"),
-                              value: config_value)
+      Prefab::Config.new(key: [namespace, key].compact.join(":"),
+                         rows: [Prefab::ConfigRow.new(value: config_value)])
+    end
+
+    def get_config_obj(key)
+      @initialization_lock.with_read_lock do
+        @config_resolver.get_config(key)
+      end
     end
 
     private
@@ -86,11 +97,14 @@ module Prefab
     end
 
     def load_checkpoint_from_config
-      config_req = Prefab::ConfigServicePointer.new(account_id: @base_client.account_id,
-                                                    start_at_id: @config_loader.highwater_mark)
+      @base_client.log_internal Logger::DEBUG, "Load Checkpoint From Config"
+
+      config_req = Prefab::ConfigServicePointer.new(start_at_id: @config_loader.highwater_mark)
+
       resp = stub.get_all_config(config_req)
-      load_deltas(resp, :api)
-      resp.deltas.each do |delta|
+      @base_client.log_internal Logger::DEBUG, "Got Response #{resp}"
+      load_configs(resp, :api)
+      resp.configs.each do |delta|
         @config_loader.set(delta)
       end
       @config_resolver.update
@@ -105,17 +119,16 @@ module Prefab
       url = "#{@s3_cloud_front}/#{@base_client.api_key.gsub("|", "/")}"
       resp = Faraday.get url
       if resp.status == 200
-        deltas = Prefab::ConfigDeltas.decode(resp.body)
-        load_deltas(deltas, :s3)
+        configs = Prefab::Configs.decode(resp.body)
+        load_configs(configs, :s3)
       else
         @base_client.log_internal Logger::INFO, "No S3 checkpoint. Response #{resp.status} Plan may not support this."
       end
     end
 
-
-    def load_deltas(deltas, source)
-      deltas.deltas.each do |delta|
-        @config_loader.set(delta)
+    def load_configs(configs, source)
+      configs.configs.each do |config|
+        @config_loader.set(config)
       end
       @base_client.log_internal Logger::INFO, "Found checkpoint with highwater id #{@config_loader.highwater_mark} from #{source}"
       @base_client.stats.increment("prefab.config.checkpoint.load")
@@ -150,11 +163,35 @@ module Prefab
       end
     end
 
+
+    def start_sse_streaming_connection_thread(start_at_id)
+      auth = "#{@base_client.project_id}:#{@base_client.api_key}"
+
+      auth_string = Base64.strict_encode64(auth)
+      headers = {
+        "x-prefab-start-at-id": start_at_id,
+        "Authorization": "Basic #{auth_string}",
+      }
+      url = "#{@base_client.prefab_api_url}/api/v1/sse/config"
+      @base_client.log_internal Logger::INFO, "SSE Streaming Connect to #{url}"
+      SSE::Client.new(url, headers: headers) do |client|
+        client.on_event do |event|
+          configs = Prefab::Configs.decode(Base64.decode64(event.data))
+          @base_client.log_internal Logger::INFO, "SSE received configs."
+          @base_client.log_internal Logger::DEBUG, "SSE received configs: #{configs}"
+          configs.configs.each do |config|
+            @config_loader.set(config)
+          end
+          @config_resolver.update
+          finish_init!(:streaming)
+        end
+      end
+    end
+
     # Setup a streaming connection to the API
     # Save new config values into the loader
-    def start_api_connection_thread(start_at_id)
-      config_req = Prefab::ConfigServicePointer.new(account_id: @base_client.account_id,
-                                                    start_at_id: start_at_id)
+    def start_grpc_streaming_connection_thread(start_at_id)
+      config_req = Prefab::ConfigServicePointer.new(start_at_id: start_at_id)
       @base_client.log_internal Logger::DEBUG, "start api connection thread #{start_at_id}"
       @base_client.stats.increment("prefab.config.api.start")
 
@@ -168,8 +205,8 @@ module Prefab
           begin
             resp = stub.get_config(config_req)
             resp.each do |r|
-              r.deltas.each do |delta|
-                @config_loader.set(delta)
+              r.configs.each do |config|
+                @config_loader.set(config)
               end
               @config_resolver.update
               finish_init!(:streaming)

data/lib/prefab/config_helper.rb

@@ -0,0 +1,20 @@
+module Prefab
+  module ConfigHelper
+    def value_of(config_value)
+      case config_value.type
+      when :string
+        config_value.string
+      when :int
+        config_value.int
+      when :double
+        config_value.double
+      when :bool
+        config_value.bool
+      when :feature_flag
+        config_value.feature_flag
+      when :segment
+        config_value.segment
+      end
+    end
+  end
+end

data/lib/prefab/config_loader.rb

@@ -14,24 +14,24 @@ module Prefab
     def calc_config
       rtn = @classpath_config.clone
       @api_config.each_key do |k|
-        rtn[k] = @api_config[k].value
+        rtn[k] = @api_config[k]
       end
       rtn = rtn.merge(@local_overrides)
       rtn
     end
 
-    def set(delta)
+    def set(config)
       # don't overwrite newer values
-      if @api_config[delta.key] && @api_config[delta.key].id > delta.id
+      if @api_config[config.key] && @api_config[config.key].id > config.id
         return
       end
 
-      if delta.value.nil?
-        @api_config.delete(delta.key)
+      if config.rows.empty?
+        @api_config.delete(config.key)
       else
-        @api_config[delta.key] = delta
+        @api_config[config.key] = config
       end
-      @highwater_mark = [delta.id, @highwater_mark].max
+      @highwater_mark = [config.id, @highwater_mark].max
     end
 
     def rm(key)
@@ -39,11 +39,11 @@ module Prefab
     end
 
     def get_api_deltas
-      deltas = Prefab::ConfigDeltas.new
+      configs = Prefab::Configs.new
       @api_config.each_value do |config_value|
-        deltas.deltas << config_value
+        configs.configs << config_value
       end
-      deltas
+      configs
     end
 
     private
@@ -63,7 +63,9 @@ module Prefab
       Dir.glob(glob).each do |file|
         yaml = load(file)
         yaml.each do |k, v|
-          rtn[k] = Prefab::ConfigValue.new(value_from(v))
+          rtn[k] = Prefab::Config.new(key: k, rows: [
+            Prefab::ConfigRow.new(value: Prefab::ConfigValue.new(value_from(v)))
+          ])
         end
       end
       rtn

data/lib/prefab/config_resolver.rb

@@ -1,11 +1,12 @@
 module Prefab
   class ConfigResolver
+    include Prefab::ConfigHelper
     NAMESPACE_DELIMITER = ".".freeze
-    NAME_KEY_DELIMITER = ":".freeze
 
     def initialize(base_client, config_loader)
       @lock = Concurrent::ReadWriteLock.new
       @local_store = {}
+      @environment = base_client.environment
       @namespace = base_client.namespace
       @config_loader = config_loader
       make_local
@@ -16,19 +17,22 @@ module Prefab
       @lock.with_read_lock do
         @local_store.each do |k, v|
           value = v[:value]
-          str << "|#{k}| in #{v[:namespace]} |#{value_of(value)}|#{value_of(value).class}\n"
+          str << "|#{k}| from #{v[:match]} |#{value_of(value)}|#{value_of(value).class}\n"
         end
       end
       str
     end
 
     def get(property)
-      config = @lock.with_read_lock do
-        @local_store[property]
-      end
+      config = _get(property)
       config ? value_of(config[:value]) : nil
     end
 
+    def get_config(property)
+      config = _get(property)
+      config ? config[:config] : nil
+    end
+
     def update
       make_local
     end
@@ -39,21 +43,6 @@ module Prefab
 
     private
 
-    def value_of(config_value)
-      case config_value.type
-      when :string
-        config_value.string
-      when :int
-        config_value.int
-      when :double
-        config_value.double
-      when :bool
-        config_value.bool
-      when :feature_flag
-        config_value.feature_flag
-      end
-    end
-
     # Should client a.b.c see key in namespace a.b? yes
     # Should client a.b.c see key in namespace a.b.c? yes
     # Should client a.b.c see key in namespace a.b.d? no
@@ -61,36 +50,43 @@ module Prefab
     #
     def starts_with_ns?(key_namespace, client_namespace)
       zipped = key_namespace.split(NAMESPACE_DELIMITER).zip(client_namespace.split(NAMESPACE_DELIMITER))
-      zipped.map do |k, c|
-        (k.nil? || k.empty?) || c == k
-      end.all?
+      mapped = zipped.map do |k, c|
+        (k.nil? || k.empty?) || k == c
+      end
+      [mapped.all?, mapped.size]
     end
 
     def make_local
       store = {}
-      @config_loader.calc_config.each do |prop, value|
-        property = prop
-        key_namespace = ""
-
-        split = prop.split(NAME_KEY_DELIMITER)
-
-        if split.size > 1
-          property = split[1..-1].join(NAME_KEY_DELIMITER)
-          key_namespace = split[0]
-        end
-
-        if starts_with_ns?(key_namespace, @namespace)
-          existing = store[property]
-          if existing.nil?
-            store[property] = { namespace: key_namespace, value: value }
-          elsif existing[:namespace].split(NAMESPACE_DELIMITER).size < key_namespace.split(NAMESPACE_DELIMITER).size
-            store[property] = { namespace: key_namespace, value: value }
+      @config_loader.calc_config.each do |key, config|
+        sortable = config.rows.map do |row|
+          if !row.env_key.empty?
+            if row.env_key == @environment
+              if !row.namespace.empty?
+                (starts_with, count) = starts_with_ns?(row.namespace, @namespace)
+                # rubocop:disable BlockNesting
+                { sortable: 2 + count, match: row.namespace, value: row.value, config: config} if starts_with
+              else
+                { sortable: 1, match: row.env_key, value: row.value, config: config}
+              end
+            end
+          else
+            { sortable: 0, match: "default", value: row.value, config: config}
           end
-        end
+        end.compact
+        to_store = sortable.sort_by { |h| h[:sortable] }.last
+        store[key] = to_store
       end
+
       @lock.with_write_lock do
         @local_store = store
       end
     end
+
+    def _get(property)
+      @lock.with_read_lock do
+        @local_store[property]
+      end
+    end
   end
 end