flipper-cloud 0.23.0 → 0.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 808e7998e34d07ad62c7e9ccf32b38bda9ba013037d8a650ab92137881a1ffd8
-  data.tar.gz: 198d9f67b76e46a6902a67d641bb403b140ed90d4da38d8d5db9a2e50f7ac895
+  metadata.gz: da84cb1704e31fac9f950282867da74412c73f1cc7a0a2fdebe1cab70b1caffa
+  data.tar.gz: e356bef8598889a5d8905737d8201da58b1f4d8d607dd48d26a8695ce0558adc
 SHA512:
-  metadata.gz: ca987e0d72af2621f9f9e50986e40621d06ed169cc533337f73797e51920ada87405b01d5ca74060ff04a590440ed592c4545cff54c0fd73252d443697936bfb
-  data.tar.gz: 046f0b0d7937ba32429057b30be25ef52fd557942f6afcac7f83875129b2ccaf86cfe2f2f99c2f13876a0aa719e0c483a1644e661a548bcbd2f6f3e189e44114
+  metadata.gz: fa9efb9eca7fb3e058ad85cb19ddc405ac445ee2f49f1bcd368976cee7758dda4b3446baaeac4a1f1a110240d625126708fb5e85afe5706fb92a276780662151
+  data.tar.gz: 330335221574998e0c76452cb728881e360828fc61ff38057ba6c6d3f20a9e3e1b958452746c1104c1b4f3f40b79ea590073935cc7de918758fb0aef5b26e538

data/examples/cloud/basic.rb

@@ -1,5 +1,7 @@
 # Usage (from the repo root):
 # env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/basic.rb
+
+require_relative "./cloud_setup"
 require 'bundler/setup'
 require 'flipper/cloud'
 

data/examples/cloud/cloud_setup.rb

@@ -0,0 +1,4 @@
+if ENV["FLIPPER_CLOUD_TOKEN"].nil? || ENV["FLIPPER_CLOUD_TOKEN"].empty?
+  warn "FLIPPER_CLOUD_TOKEN missing so skipping cloud example."
+  exit
+end

data/examples/cloud/import.rb

@@ -1,5 +1,7 @@
 # Usage (from the repo root):
 #   env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/import.rb
+
+require_relative "./cloud_setup"
 require 'bundler/setup'
 require 'flipper'
 require 'flipper/cloud'

data/flipper-cloud.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |gem|
   gem.metadata      = Flipper::METADATA
 
   gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
+  gem.add_dependency "brow", "~> 0.4.1"
 end

data/lib/flipper/cloud/configuration.rb

@@ -3,6 +3,9 @@ require "flipper/adapters/http"
 require "flipper/adapters/memory"
 require "flipper/adapters/dual_write"
 require "flipper/adapters/sync"
+require "flipper/cloud/instrumenter"
+require "flipper/cloud/registry"
+require "brow"
 
 module Flipper
   module Cloud
@@ -75,7 +78,6 @@ module Flipper
         end
         self.sync_method = options[:sync_method] if options[:sync_method]
 
-        @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
         @read_timeout = options.fetch(:read_timeout) { ENV.fetch("FLIPPER_CLOUD_READ_TIMEOUT", 5).to_f }
         @open_timeout = options.fetch(:open_timeout) { ENV.fetch("FLIPPER_CLOUD_OPEN_TIMEOUT", 5).to_f }
         @write_timeout = options.fetch(:write_timeout) { ENV.fetch("FLIPPER_CLOUD_WRITE_TIMEOUT", 5).to_f }
@@ -85,6 +87,16 @@ module Flipper
         @debug_output = options[:debug_output]
         @adapter_block = ->(adapter) { adapter }
         self.url = options.fetch(:url) { ENV.fetch("FLIPPER_CLOUD_URL", DEFAULT_URL) }
+
+        instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
+
+        # This is alpha. Don't use this unless you are me. And you are not me.
+        cloud_instrument = options.fetch(:cloud_instrument) { ENV["FLIPPER_CLOUD_INSTRUMENT"] == "1" }
+        @instrumenter = if cloud_instrument
+          Instrumenter.new(brow: brow, instrumenter: instrumenter)
+        else
+          instrumenter
+        end
       end
 
       # Public: Read or customize the http adapter. Calling without a block will
@@ -116,6 +128,24 @@ module Flipper
         }).call
       end
 
+      def brow
+        uri = URI.parse(url)
+        uri.path = "#{uri.path}/events".squeeze("/")
+        events_url = uri.to_s
+
+        Registry.default.fetch(events_url) {
+          Brow::Client.new({
+            url: events_url,
+            headers: {
+              "Accept" => "application/json",
+              "Content-Type" => "application/json",
+              "User-Agent" => "Flipper v#{VERSION} via Brow v#{Brow::VERSION}",
+              "Flipper-Cloud-Token" => @token,
+            }
+          })
+        }
+      end
+
       # Public: The method that will be used to synchronize local adapter with
       # cloud. (default: :poll, will be :webhook if sync_secret is set).
       def sync_method
@@ -157,5 +187,3 @@ module Flipper
     end
   end
 end
-
-# "FLIPPER_TIMESTAMP".freeze => Flipper::Timestamp.generate.to_s,

data/lib/flipper/cloud/instrumenter.rb

@@ -0,0 +1,43 @@
+require "delegate"
+require "flipper/instrumenters/noop"
+
+module Flipper
+  module Cloud
+    class Instrumenter < SimpleDelegator
+      def initialize(options = {})
+        @brow = options.fetch(:brow)
+        @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
+        super @instrumenter
+      end
+
+      def instrument(name, payload = {}, &block)
+        result = @instrumenter.instrument(name, payload, &block)
+        push name, payload
+        result
+      end
+
+      private
+
+      def push(name, payload)
+        return unless name == Flipper::Feature::InstrumentationName
+        return unless :enabled? == payload[:operation]
+
+        dimensions = {
+          "feature" => payload[:feature_name].to_s,
+          "result" => payload[:result].to_s,
+        }
+        if (thing = payload[:thing])
+          dimensions["flipper_id"] = thing.value.to_s
+        end
+
+        event = {
+          type: "enabled",
+          dimensions: dimensions,
+          measures: {},
+          ts: Time.now.utc,
+        }
+        @brow.push event
+      end
+    end
+  end
+end

data/lib/flipper/cloud/registry.rb

@@ -0,0 +1,46 @@
+require "thread"
+
+module Flipper
+  module Cloud
+    class Registry
+      def self.default
+        @default ||= new
+      end
+
+      def initialize
+        @mutex = Mutex.new
+        @data = {}
+      end
+
+      def fetch(key, &block)
+        @mutex.synchronize do
+          if data = @data[key]
+            data
+          else
+            @data[key] = yield
+          end
+        end
+      end
+
+      def keys
+        @mutex.synchronize do
+          @data.keys
+        end
+      end
+
+      def each(&block)
+        data = @mutex.synchronize do
+          @data.dup
+        end
+
+        data.each(&block)
+      end
+
+      def clear
+        @mutex.synchronize do
+          @data = {}
+        end
+      end
+    end
+  end
+end

data/lib/flipper/cloud.rb

@@ -40,8 +40,9 @@ module Flipper
       builder.use Flipper::Cloud::Middleware, env_key: env_key
       builder.run app
       klass = self
-      builder.define_singleton_method(:inspect) { klass.inspect } # pretty rake routes output
-      builder
+      app = builder.to_app
+      app.define_singleton_method(:inspect) { klass.inspect } # pretty rake routes output
+      app
     end
 
     # Private: Configure Flipper to use Cloud by default

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.23.0'.freeze
+  VERSION = '0.24.1'.freeze
 end

data/spec/flipper/cloud/configuration_spec.rb

@@ -240,4 +240,21 @@ RSpec.describe Flipper::Cloud::Configuration do
     expect(all["search"][:boolean]).to eq("true")
     expect(all["history"][:boolean]).to eq(nil)
   end
+
+  it "can setup brow to report events to cloud" do
+    # skip logging brow
+    Brow.logger = Logger.new(File::NULL)
+    brow = described_class.new(required_options).brow
+
+    stub = stub_request(:post, "https://www.flippercloud.io/adapter/events")
+      .with { |request|
+        data = JSON.parse(request.body)
+        data.keys == ["uuid", "messages"] && data["messages"] == [{"n" => 1}]
+      }
+      .to_return(status: 201, body: "{}", headers: {})
+
+    brow.push({"n" => 1})
+    brow.worker.stop
+    expect(stub).to have_been_requested.times(1)
+  end
 end

data/spec/flipper/cloud/middleware_spec.rb

@@ -267,7 +267,7 @@ RSpec.describe Flipper::Cloud::Middleware do
 
   describe 'Inspecting the built Rack app' do
     it 'returns a String' do
-      expect(Flipper::Cloud.app(flipper).inspect).to be_a(String)
+      expect(Flipper::Cloud.app(flipper).inspect).to eq("Flipper::Cloud")
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-cloud
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-24 00:00:00.000000000 Z
+date: 2022-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.24.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.24.1
+- !ruby/object:Gem::Dependency
+  name: brow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 description: 
 email:
 - nunemaker@gmail.com
@@ -34,6 +48,7 @@ files:
 - docs/images/flipper_cloud.png
 - examples/cloud/app.ru
 - examples/cloud/basic.rb
+- examples/cloud/cloud_setup.rb
 - examples/cloud/import.rb
 - flipper-cloud.gemspec
 - lib/flipper-cloud.rb
@@ -41,8 +56,10 @@ files:
 - lib/flipper/cloud/configuration.rb
 - lib/flipper/cloud/dsl.rb
 - lib/flipper/cloud/engine.rb
+- lib/flipper/cloud/instrumenter.rb
 - lib/flipper/cloud/message_verifier.rb
 - lib/flipper/cloud/middleware.rb
+- lib/flipper/cloud/registry.rb
 - lib/flipper/cloud/routes.rb
 - lib/flipper/version.rb
 - spec/flipper/cloud/configuration_spec.rb