flipper-cloud 0.20.0.beta3 → 0.20.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6117cc953e569df240b187815f80b55a4c91014916e98fd9b0e2c0fa9ad45cf1
-  data.tar.gz: 9bcdb028730c3f5376316b3f3536df24463e6aa8c1e09b515ad472015147a1ec
+  metadata.gz: 4a7975de45022ee964e72588441cebfcbb2381feb4657342c7423064a709d239
+  data.tar.gz: 0d707e5f5ecda9181a6673df0537696d9c8046fe3a01956bee5091e72c39e58f
 SHA512:
-  metadata.gz: 3bc8e410bc84697b17ddaa0d5afc6fb4e9fd7ae2e775375e3b7b03a31c4fee2628d2fe964aeba93e00ae512d6df1d9338037b667f71907ed1453e0bedb8d0fa0
-  data.tar.gz: 711c266fbc227fa51bc37bff2b3d2cca8ae6c5fc595d7ae1121fce9876cae05974dcae56a259d2f380f2712908f6fe02bcafba8b8b3a1754fb72fd1aa10de288
+  metadata.gz: 1833dab42fd2c96295317d99061a90b1e38b592bea66b4c7b672f013cd915cb09f476984545a244741cac62f37054a66e09e00eb1a0a287fd4b689153098baaa
+  data.tar.gz: 00a7ade548bf735d0cd9ca2fbca6a74e1beb6b15c4719a34b06923db6ff9a56b8a43387a6810ec5ee204fd32dab0a916cd5d3f245176473b658dad75a31eb4f9

data/examples/cloud/app.ru

@@ -1,8 +1,7 @@
 # Usage (from the repo root):
-#   env FLIPPER_CLOUD_TOKEN=<token> FLIPPER_CLOUD_SYNC_SECRET=<secret> FLIPPER_CLOUD_SYNC_METHOD=webhook bundle exec rackup examples/ui/basic.ru -p 9999
-#   env FLIPPER_CLOUD_TOKEN=<token> FLIPPER_CLOUD_SYNC_SECRET=<secret> FLIPPER_CLOUD_SYNC_METHOD=webhook bundle exec shotgun examples/ui/basic.ru -p 9999
+#   env FLIPPER_CLOUD_TOKEN=<token> FLIPPER_CLOUD_SYNC_SECRET=<secret> FLIPPER_CLOUD_SYNC_METHOD=webhook bundle exec rackup examples/cloud/app.ru -p 9999
+#   env FLIPPER_CLOUD_TOKEN=<token> FLIPPER_CLOUD_SYNC_SECRET=<secret> FLIPPER_CLOUD_SYNC_METHOD=webhook bundle exec shotgun examples/cloud/app.ru -p 9999
 #   http://localhost:9999/
-#   http://localhost:9999/webhooks
 
 require 'pathname'
 root_path = Pathname(__FILE__).dirname.join('..').expand_path

data/examples/cloud/basic.rb

@@ -1,5 +1,5 @@
 # Usage (from the repo root):
-#   env TOKEN=<token> bundle exec ruby examples/cloud/basic.rb
+# env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/basic.rb
 require 'pathname'
 require 'logger'
 root_path = Pathname(__FILE__).dirname.join('..').expand_path
@@ -7,7 +7,7 @@ lib_path  = root_path.join('lib')
 $:.unshift(lib_path)
 
 require 'flipper/cloud'
-flipper = Flipper::Cloud.new(ENV.fetch('TOKEN'))
+flipper = Flipper::Cloud.new
 
 flipper[:stats].enable
 

data/examples/cloud/cached_in_memory.rb

@@ -1,3 +1,4 @@
+# env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/cached_in_memory.rb
 require File.expand_path('../../example_setup', __FILE__)
 
 require 'flipper/cloud'
@@ -5,12 +6,11 @@ require 'flipper/adapters/active_support_cache_store'
 require 'active_support/cache'
 require 'active_support/cache/memory_store'
 
-token = ENV.fetch("TOKEN") { abort "TOKEN environment variable not set." }
 feature_name = ENV.fetch("FEATURE") { "testing" }.to_sym
 
 Flipper.configure do |config|
   config.default do
-    Flipper::Cloud.new(token) do |cloud|
+    Flipper::Cloud.new do |cloud|
       cloud.debug_output = STDOUT
       cloud.adapter do |adapter|
         Flipper::Adapters::ActiveSupportCacheStore.new(adapter,

data/examples/cloud/import.rb

@@ -1,5 +1,5 @@
 # Usage (from the repo root):
-#   env TOKEN=<token> bundle exec ruby examples/cloud/basic.rb
+#   env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/import.rb
 require 'pathname'
 require 'logger'
 root_path = Pathname(__FILE__).dirname.join('..').expand_path
@@ -10,14 +10,14 @@ require 'flipper'
 require 'flipper/cloud'
 
 memory_adapter = Flipper::Adapters::Memory.new
-memory_flipper = Flipper.new(memory_adapter)
+flipper = Flipper.new(memory_adapter)
 
-memory_flipper.enable(:test)
-memory_flipper.enable(:search)
-memory_flipper.enable_actor(:stats, Flipper::Actor.new("jnunemaker"))
-memory_flipper.enable_percentage_of_time(:logging, 5)
+flipper.enable(:test)
+flipper.enable(:search)
+flipper.enable_actor(:stats, Flipper::Actor.new("jnunemaker"))
+flipper.enable_percentage_of_time(:logging, 5)
 
-flipper = Flipper::Cloud.new(ENV.fetch('TOKEN'))
+cloud = Flipper::Cloud.new
 
-# wipes cloud clean and makes it identical to memory flipper
-flipper.import(memory_flipper)
+# makes cloud identical to memory flipper
+cloud.import(flipper)

data/examples/cloud/local_adapter.rb

@@ -5,13 +5,13 @@
 # never raise. You could get a slow request every now and then if cloud is
 # unavailable, but we are hoping to fix that soon by doing the cloud update in a
 # background thread.
+# env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/local_adapter.rb
 require File.expand_path('../../example_setup', __FILE__)
 
 require 'logger'
 require 'flipper/cloud'
 require 'flipper/adapters/redis'
 
-token = ENV.fetch("TOKEN") { abort "TOKEN environment variable not set." }
 feature_name = ENV.fetch("FEATURE") { "testing" }.to_sym
 
 redis = Redis.new(logger: Logger.new(STDOUT))
@@ -19,7 +19,7 @@ redis.flushdb
 
 Flipper.configure do |config|
   config.default do
-    Flipper::Cloud.new(token) do |cloud|
+    Flipper::Cloud.new do |cloud|
       cloud.debug_output = STDOUT
       cloud.local_adapter = Flipper::Adapters::Redis.new(redis)
       cloud.sync_interval = 10

data/lib/flipper/cloud/configuration.rb

@@ -1,3 +1,4 @@
+require "socket"
 require "flipper/adapters/http"
 require "flipper/adapters/memory"
 require "flipper/adapters/dual_write"
@@ -68,7 +69,7 @@ module Flipper
         @token = options.fetch(:token) { ENV["FLIPPER_CLOUD_TOKEN"] }
 
         if @token.nil?
-          raise ArgumentError, "Flipper::Cloud token is missing. Please set FLIPPER_CLOUD_TOKEN or provide the token used to validate webhooks (e.g. Flipper::Cloud.new('token'))."
+          raise ArgumentError, "Flipper::Cloud token is missing. Please set FLIPPER_CLOUD_TOKEN or provide the token (e.g. Flipper::Cloud.new('token'))."
         end
 
         @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
@@ -153,6 +154,11 @@ module Flipper
           headers: {
             "Flipper-Cloud-Token" => @token,
             "Feature-Flipper-Token" => @token,
+            "Client-Lang" => "ruby",
+            "Client-Lang-Version" => "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
+            "Client-Platform" => RUBY_PLATFORM,
+            "Client-Engine" => defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
+            "Client-Hostname" => Socket.gethostname,
           },
         })
       end

data/lib/flipper/cloud/middleware.rb

@@ -7,6 +7,8 @@ module Flipper
     class Middleware
       # Internal: The path to match for webhook requests.
       WEBHOOK_PATH = %r{\A/webhooks\/?\Z}
+      # Internal: The root path to match for requests.
+      ROOT_PATH = %r{\A/\Z}
 
       def initialize(app, options = {})
         @app = app
@@ -19,7 +21,7 @@ module Flipper
 
       def call!(env)
         request = Rack::Request.new(env)
-        if request.post? && request.path_info.match(WEBHOOK_PATH)
+        if request.post? && (request.path_info.match(ROOT_PATH) || request.path_info.match(WEBHOOK_PATH))
           status = 200
           headers = {
             "Content-Type" => "application/json",
@@ -32,10 +34,20 @@ module Flipper
           begin
             message_verifier = MessageVerifier.new(secret: flipper.sync_secret)
             if message_verifier.verify(payload, signature)
-              flipper.sync
-              body = JSON.generate({
-                groups: Flipper.group_names.map { |name| {name: name}}
-              })
+              begin
+                flipper.sync
+                body = JSON.generate({
+                  groups: Flipper.group_names.map { |name| {name: name}}
+                })
+              rescue Flipper::Adapters::Http::Error => error
+                status = error.response.code.to_i == 402 ? 402 : 500
+                headers["Flipper-Cloud-Response-Error-Class"] = error.class.name
+                headers["Flipper-Cloud-Response-Error-Message"] = error.message
+              rescue => error
+                status = 500
+                headers["Flipper-Cloud-Response-Error-Class"] = error.class.name
+                headers["Flipper-Cloud-Response-Error-Message"] = error.message
+              end
             end
           rescue MessageVerifier::InvalidSignature
             status = 400

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.20.0.beta3'.freeze
+  VERSION = '0.20.4'.freeze
 end

data/spec/flipper/cloud/middleware_spec.rb

@@ -53,7 +53,7 @@ RSpec.describe Flipper::Cloud::Middleware do
       env = {
         "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
       }
-      post '/webhooks', request_body, env
+      post '/', request_body, env
 
       expect(last_response.status).to eq(200)
       expect(JSON.parse(last_response.body)).to eq({
@@ -80,13 +80,82 @@ RSpec.describe Flipper::Cloud::Middleware do
       env = {
         "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
       }
-      post '/webhooks', request_body, env
+      post '/', request_body, env
 
       expect(last_response.status).to eq(400)
       expect(stub).not_to have_been_requested
     end
   end
 
+  context "when flipper cloud responds with 402" do
+    let(:app) { Flipper::Cloud.app(flipper) }
+
+    it "results in 402" do
+      Flipper.register(:admins) { |*args| false }
+      Flipper.register(:staff) { |*args| false }
+      Flipper.register(:basic) { |*args| false }
+      Flipper.register(:plus) { |*args| false }
+      Flipper.register(:premium) { |*args| false }
+
+      stub = stub_request_for_token('regular', status: 402)
+      env = {
+        "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
+      }
+      post '/', request_body, env
+
+      expect(last_response.status).to eq(402)
+      expect(last_response.headers["Flipper-Cloud-Response-Error-Class"]).to eq("Flipper::Adapters::Http::Error")
+      expect(last_response.headers["Flipper-Cloud-Response-Error-Message"]).to eq("Failed with status: 402")
+      expect(stub).to have_been_requested
+    end
+  end
+
+  context "when flipper cloud responds with non-402 and non-2xx code" do
+    let(:app) { Flipper::Cloud.app(flipper) }
+
+    it "results in 500" do
+      Flipper.register(:admins) { |*args| false }
+      Flipper.register(:staff) { |*args| false }
+      Flipper.register(:basic) { |*args| false }
+      Flipper.register(:plus) { |*args| false }
+      Flipper.register(:premium) { |*args| false }
+
+      stub = stub_request_for_token('regular', status: 503)
+      env = {
+        "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
+      }
+      post '/', request_body, env
+
+      expect(last_response.status).to eq(500)
+      expect(last_response.headers["Flipper-Cloud-Response-Error-Class"]).to eq("Flipper::Adapters::Http::Error")
+      expect(last_response.headers["Flipper-Cloud-Response-Error-Message"]).to eq("Failed with status: 503")
+      expect(stub).to have_been_requested
+    end
+  end
+
+  context "when flipper cloud responds with timeout" do
+    let(:app) { Flipper::Cloud.app(flipper) }
+
+    it "results in 500" do
+      Flipper.register(:admins) { |*args| false }
+      Flipper.register(:staff) { |*args| false }
+      Flipper.register(:basic) { |*args| false }
+      Flipper.register(:plus) { |*args| false }
+      Flipper.register(:premium) { |*args| false }
+
+      stub = stub_request_for_token('regular', status: :timeout)
+      env = {
+        "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
+      }
+      post '/', request_body, env
+
+      expect(last_response.status).to eq(500)
+      expect(last_response.headers["Flipper-Cloud-Response-Error-Class"]).to eq("Net::OpenTimeout")
+      expect(last_response.headers["Flipper-Cloud-Response-Error-Message"]).to eq("execution expired")
+      expect(stub).to have_been_requested
+    end
+  end
+
   context 'when initialized with flipper instance and flipper instance in env' do
     let(:app) { Flipper::Cloud.app(flipper) }
     let(:signature) {
@@ -99,7 +168,7 @@ RSpec.describe Flipper::Cloud::Middleware do
         "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
         'flipper' => env_flipper,
       }
-      post '/webhooks', request_body, env
+      post '/', request_body, env
 
       expect(last_response.status).to eq(200)
       expect(stub).to have_been_requested
@@ -118,7 +187,7 @@ RSpec.describe Flipper::Cloud::Middleware do
         "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
         'flipper' => env_flipper,
       }
-      post '/webhooks', request_body, env
+      post '/', request_body, env
 
       expect(last_response.status).to eq(200)
       expect(stub).to have_been_requested
@@ -138,7 +207,7 @@ RSpec.describe Flipper::Cloud::Middleware do
         'flipper' => flipper,
         'flipper_cloud' => env_flipper,
       }
-      post '/webhooks', request_body, env
+      post '/', request_body, env
 
       expect(last_response.status).to eq(200)
       expect(stub).to have_been_requested
@@ -149,6 +218,27 @@ RSpec.describe Flipper::Cloud::Middleware do
     let(:app) { Flipper::Cloud.app(-> { flipper }) }
 
     it 'works' do
+      stub = stub_request_for_token('regular')
+      env = {
+        "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
+      }
+      post '/', request_body, env
+
+      expect(last_response.status).to eq(200)
+      expect(stub).to have_been_requested
+    end
+  end
+
+  context 'when using older /webhooks path' do
+    let(:app) { Flipper::Cloud.app(flipper) }
+
+    it 'uses instance to sync' do
+      Flipper.register(:admins) { |*args| false }
+      Flipper.register(:staff) { |*args| false }
+      Flipper.register(:basic) { |*args| false }
+      Flipper.register(:plus) { |*args| false }
+      Flipper.register(:premium) { |*args| false }
+
       stub = stub_request_for_token('regular')
       env = {
         "HTTP_FLIPPER_CLOUD_SIGNATURE" => signature_header_value,
@@ -156,13 +246,22 @@ RSpec.describe Flipper::Cloud::Middleware do
       post '/webhooks', request_body, env
 
       expect(last_response.status).to eq(200)
+      expect(JSON.parse(last_response.body)).to eq({
+        "groups" => [
+          {"name" => "admins"},
+          {"name" => "staff"},
+          {"name" => "basic"},
+          {"name" => "plus"},
+          {"name" => "premium"},
+        ],
+      })
       expect(stub).to have_been_requested
     end
   end
 
   describe 'Request method unsupported' do
     it 'skips middleware' do
-      get '/webhooks'
+      get '/'
       expect(last_response.status).to eq(404)
       expect(last_response.content_type).to eq("application/json")
       expect(last_response.body).to eq("{}")
@@ -177,12 +276,17 @@ RSpec.describe Flipper::Cloud::Middleware do
 
   private
 
-  def stub_request_for_token(token)
-    stub_request(:get, "https://www.flippercloud.io/adapter/features").
+  def stub_request_for_token(token, status: 200)
+    stub = stub_request(:get, "https://www.flippercloud.io/adapter/features").
       with({
         headers: {
           'Flipper-Cloud-Token' => token,
         },
-      }).to_return(status: 200, body: response_body, headers: {})
+      })
+    if status == :timeout
+      stub.to_timeout
+    else
+      stub.to_return(status: status, body: response_body, headers: {})
+    end
   end
 end

data/spec/flipper/cloud_spec.rb

@@ -114,4 +114,89 @@ RSpec.describe Flipper::Cloud do
       described_class.new('asdf', open_timeout: 1)
     end
   end
+
+  it 'can import' do
+    stub_request(:post, /www\.flippercloud\.io\/adapter\/features.*/).
+      with(headers: {
+          'Feature-Flipper-Token'=>'asdf',
+          'Flipper-Cloud-Token'=>'asdf',
+      }).to_return(status: 200, body: "{}", headers: {})
+
+    flipper = Flipper.new(Flipper::Adapters::Memory.new)
+
+    flipper.enable(:test)
+    flipper.enable(:search)
+    flipper.enable_actor(:stats, Flipper::Actor.new("jnunemaker"))
+    flipper.enable_percentage_of_time(:logging, 5)
+
+    cloud_flipper = Flipper::Cloud.new("asdf")
+
+    get_all = {
+      "logging" => {actors: Set.new, boolean: nil, groups: Set.new, percentage_of_actors: nil, percentage_of_time: "5"},
+      "search" => {actors: Set.new, boolean: "true", groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+      "stats" => {actors: Set["jnunemaker"], boolean: nil, groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+      "test" => {actors: Set.new, boolean: "true", groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+    }
+
+    expect(flipper.adapter.get_all).to eq(get_all)
+    cloud_flipper.import(flipper)
+    expect(flipper.adapter.get_all).to eq(get_all)
+    expect(cloud_flipper.adapter.get_all).to eq(get_all)
+  end
+
+  it 'raises error for failure while importing' do
+    stub_request(:post, /www\.flippercloud\.io\/adapter\/features.*/).
+      with(headers: {
+          'Feature-Flipper-Token'=>'asdf',
+          'Flipper-Cloud-Token'=>'asdf',
+      }).to_return(status: 500, body: "{}")
+
+    flipper = Flipper.new(Flipper::Adapters::Memory.new)
+
+    flipper.enable(:test)
+    flipper.enable(:search)
+    flipper.enable_actor(:stats, Flipper::Actor.new("jnunemaker"))
+    flipper.enable_percentage_of_time(:logging, 5)
+
+    cloud_flipper = Flipper::Cloud.new("asdf")
+
+    get_all = {
+      "logging" => {actors: Set.new, boolean: nil, groups: Set.new, percentage_of_actors: nil, percentage_of_time: "5"},
+      "search" => {actors: Set.new, boolean: "true", groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+      "stats" => {actors: Set["jnunemaker"], boolean: nil, groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+      "test" => {actors: Set.new, boolean: "true", groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+    }
+
+    expect(flipper.adapter.get_all).to eq(get_all)
+    expect { cloud_flipper.import(flipper) }.to raise_error(Flipper::Adapters::Http::Error)
+    expect(flipper.adapter.get_all).to eq(get_all)
+  end
+
+  it 'raises error for timeout while importing' do
+    stub_request(:post, /www\.flippercloud\.io\/adapter\/features.*/).
+      with(headers: {
+          'Feature-Flipper-Token'=>'asdf',
+          'Flipper-Cloud-Token'=>'asdf',
+      }).to_timeout
+
+    flipper = Flipper.new(Flipper::Adapters::Memory.new)
+
+    flipper.enable(:test)
+    flipper.enable(:search)
+    flipper.enable_actor(:stats, Flipper::Actor.new("jnunemaker"))
+    flipper.enable_percentage_of_time(:logging, 5)
+
+    cloud_flipper = Flipper::Cloud.new("asdf")
+
+    get_all = {
+      "logging" => {actors: Set.new, boolean: nil, groups: Set.new, percentage_of_actors: nil, percentage_of_time: "5"},
+      "search" => {actors: Set.new, boolean: "true", groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+      "stats" => {actors: Set["jnunemaker"], boolean: nil, groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+      "test" => {actors: Set.new, boolean: "true", groups: Set.new, percentage_of_actors: nil, percentage_of_time: nil},
+    }
+
+    expect(flipper.adapter.get_all).to eq(get_all)
+    expect { cloud_flipper.import(flipper) }.to raise_error(Net::OpenTimeout)
+    expect(flipper.adapter.get_all).to eq(get_all)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-cloud
 version: !ruby/object:Gem::Version
-  version: 0.20.0.beta3
+  version: 0.20.4
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-17 00:00:00.000000000 Z
+date: 2021-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0.beta3
+        version: 0.20.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0.beta3
+        version: 0.20.4
 description: 
 email:
 - nunemaker@gmail.com
@@ -31,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- docs/images/flipper_cloud.png
 - examples/cloud/app.ru
 - examples/cloud/basic.rb
 - examples/cloud/cached_in_memory.rb
@@ -65,9 +66,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: