flipper 0.28.3 → 1.4.2

data/spec/flipper/adapters/failover_spec.rb

@@ -126,4 +126,16 @@ RSpec.describe Flipper::Adapters::Failover do
       end
     end
   end
+
+  describe '#adapter_stack' do
+    it 'returns the tree representation' do
+      expect(subject.adapter_stack).to eq("failover(primary: memory, secondary: memory)")
+    end
+
+    it 'shows nested adapters in the tree' do
+      strict_primary = Flipper::Adapters::Strict.new(primary)
+      adapter = described_class.new(strict_primary, secondary)
+      expect(adapter.adapter_stack).to eq("failover(primary: strict -> memory, secondary: memory)")
+    end
+  end
 end

data/spec/flipper/adapters/http/client_spec.rb

@@ -0,0 +1,61 @@
+require "flipper/adapters/http/client"
+
+RSpec.describe Flipper::Adapters::Http::Client do
+  describe "#initialize" do
+    it "requires url" do
+      expect { described_class.new }.to raise_error(KeyError, "key not found: :url")
+    end
+
+    it "sets default headers" do
+      client = described_class.new(url: "http://example.com")
+      expect(client.headers).to eq({
+        'content-type' => 'application/json',
+        'accept' => 'application/json',
+        'user-agent' => "Flipper HTTP Adapter v#{Flipper::VERSION}",
+      })
+    end
+
+    it "adds custom headers" do
+      client = described_class.new(url: "http://example.com", headers: {'custom-header' => 'value'})
+      expect(client.headers).to include('custom-header' => 'value')
+    end
+
+    it "overrides default headers with custom headers" do
+      client = described_class.new(url: "http://example.com", headers: {'content-type' => 'text/plain'})
+      expect(client.headers['content-type']).to eq('text/plain')
+    end
+  end
+
+  describe "#add_header" do
+    it "can add string header" do
+      client = described_class.new(url: "http://example.com")
+      client.add_header("key", "value")
+      expect(client.headers.fetch("key")).to eq("value")
+    end
+
+    it "standardizes key to lowercase" do
+      client = described_class.new(url: "http://example.com")
+      client.add_header("Content-Type", "value")
+      expect(client.headers.fetch("content-type")).to eq("value")
+    end
+
+    it "standardizes key to dashes" do
+      client = described_class.new(url: "http://example.com")
+      client.add_header(:content_type, "value")
+      expect(client.headers.fetch("content-type")).to eq("value")
+    end
+
+    it "can add symbol header" do
+      client = described_class.new(url: "http://example.com")
+      client.add_header(:key, "value")
+      expect(client.headers.fetch("key")).to eq("value")
+    end
+
+    it "overrides existing header" do
+      client = described_class.new(url: "http://example.com")
+      client.add_header("key", "value 1")
+      client.add_header("key", "value 2")
+      expect(client.headers.fetch("key")).to eq("value 2")
+    end
+  end
+end

data/spec/flipper/adapters/http_spec.rb

@@ -1,99 +1,160 @@
 require 'flipper/adapters/http'
 require 'flipper/adapters/pstore'
-require 'rack/handler/webrick'
 
-FLIPPER_SPEC_API_PORT = ENV.fetch('FLIPPER_SPEC_API_PORT', 9001).to_i
+rack_handler = begin
+  # Rack 3+
+  require 'rackup/handler/webrick'
+  Rackup::Handler::WEBrick
+rescue LoadError
+  require 'rack/handler/webrick'
+  Rack::Handler::WEBrick
+end
 
-RSpec.describe Flipper::Adapters::Http do
-  context 'adapter' do
-    subject do
-      described_class.new(url: "http://localhost:#{FLIPPER_SPEC_API_PORT}")
-    end
 
-    before :all do
-      dir = FlipperRoot.join('tmp').tap(&:mkpath)
-      log_path = dir.join('flipper_adapters_http_spec.log')
-      @pstore_file = dir.join('flipper.pstore')
-      @pstore_file.unlink if @pstore_file.exist?
-
-      api_adapter = Flipper::Adapters::PStore.new(@pstore_file)
-      flipper_api = Flipper.new(api_adapter)
-      app = Flipper::Api.app(flipper_api)
-      server_options = {
-        Port: FLIPPER_SPEC_API_PORT,
-        StartCallback: -> { @started = true },
-        Logger: WEBrick::Log.new(log_path.to_s, WEBrick::Log::INFO),
-        AccessLog: [
-          [log_path.open('w'), WEBrick::AccessLog::COMBINED_LOG_FORMAT],
-        ],
-      }
-      @server = WEBrick::HTTPServer.new(server_options)
-      @server.mount '/', Rack::Handler::WEBrick, app
+FLIPPER_SPEC_API_PORT = ENV.fetch('FLIPPER_SPEC_API_PORT', 9001).to_i
 
-      Thread.new { @server.start }
-      Timeout.timeout(1) { :wait until @started }
+RSpec.describe Flipper::Adapters::Http do
+  default_options = {
+    url: "http://localhost:#{FLIPPER_SPEC_API_PORT}",
+  }
+
+  {
+    basic: default_options.dup,
+    gzip: default_options.dup.merge(headers: { 'accept-encoding': 'gzip' }),
+  }.each do |name, options|
+    context "adapter (#{name} #{options.inspect})" do
+      subject do
+        described_class.new(options)
+      end
+
+      before :all do
+        @started = false
+        dir = FlipperRoot.join('tmp').tap(&:mkpath)
+        log_path = dir.join('flipper_adapters_http_spec.log')
+        @pstore_file = dir.join('flipper.pstore')
+        @pstore_file.unlink if @pstore_file.exist?
+
+        api_adapter = Flipper::Adapters::PStore.new(@pstore_file)
+        flipper_api = Flipper.new(api_adapter)
+        app = Flipper::Api.app(flipper_api)
+        server_options = {
+          Port: FLIPPER_SPEC_API_PORT,
+          StartCallback: -> { @started = true },
+          Logger: WEBrick::Log.new(log_path.to_s, WEBrick::Log::INFO),
+          AccessLog: [
+            [log_path.open('w'), WEBrick::AccessLog::COMBINED_LOG_FORMAT],
+          ],
+        }
+        @server = WEBrick::HTTPServer.new(server_options)
+        @server.mount '/', rack_handler, app
+
+        Thread.new { @server.start }
+        Timeout.timeout(1) { :wait until @started }
+      end
+
+      after :all do
+        @server.shutdown if @server
+      end
+
+      before(:each) do
+        @pstore_file.unlink if @pstore_file.exist?
+      end
+
+      it_should_behave_like 'a flipper adapter'
+
+      it "can enable and disable unregistered group" do
+        flipper = Flipper.new(subject)
+        expect(flipper[:search].enable_group(:some_made_up_group)).to be(true)
+        expect(flipper[:search].groups_value).to eq(Set["some_made_up_group"])
+
+        expect(flipper[:search].disable_group(:some_made_up_group)).to be(true)
+        expect(flipper[:search].groups_value).to eq(Set.new)
+      end
+
+      it "can import" do
+        adapter = Flipper::Adapters::Memory.new
+        source_flipper = Flipper.new(adapter)
+        source_flipper.enable_percentage_of_actors :search, 10
+        source_flipper.enable_percentage_of_time :search, 15
+        source_flipper.enable_actor :search, Flipper::Actor.new('User;1')
+        source_flipper.enable_actor :search, Flipper::Actor.new('User;100')
+        source_flipper.enable_group :search, :admins
+        source_flipper.enable_group :search, :employees
+        source_flipper.enable :plausible
+        source_flipper.disable :google_analytics
+
+        flipper = Flipper.new(subject)
+        flipper.import(source_flipper)
+        expect(flipper[:search].percentage_of_actors_value).to be(10)
+        expect(flipper[:search].percentage_of_time_value).to be(15)
+        expect(flipper[:search].actors_value).to eq(Set["User;1", "User;100"])
+        expect(flipper[:search].groups_value).to eq(Set["admins", "employees"])
+        expect(flipper[:plausible].boolean_value).to be(true)
+        expect(flipper[:google_analytics].boolean_value).to be(false)
+      end
     end
+  end
 
-    after :all do
-      @server.shutdown if @server
-    end
+  it "sends default headers" do
+    headers = {
+      'accept' => 'application/json',
+      'content-type' => 'application/json',
+      'user-agent' => "Flipper HTTP Adapter v#{Flipper::VERSION}",
+    }
+    stub_request(:get, "http://app.com/flipper/features/feature_panel")
+      .with(headers: headers)
+      .to_return(status: 404)
 
-    before(:each) do
-      @pstore_file.unlink if @pstore_file.exist?
-    end
+    adapter = described_class.new(url: 'http://app.com/flipper')
+    adapter.get(flipper[:feature_panel])
+  end
 
-    it_should_behave_like 'a flipper adapter'
+  it "sends framework versions" do
+    stub_const("Rails", double(version: "7.1.0"))
+    stub_const("Sinatra::VERSION", "3.1.0")
+    stub_const("Hanami::VERSION", "0.7.2")
+    stub_const("GoodJob::VERSION", "3.21.5")
+    stub_const("Sidekiq::VERSION", "7.2.0")
 
-    it "can enable and disable unregistered group" do
-      flipper = Flipper.new(subject)
-      expect(flipper[:search].enable_group(:some_made_up_group)).to be(true)
-      expect(flipper[:search].groups_value).to eq(Set["some_made_up_group"])
+    headers = {
+      "client-framework" => [
+        "rails=7.1.0",
+        "sinatra=3.1.0",
+        "hanami=0.7.2",
+        "good_job=3.21.5",
+        "sidekiq=7.2.0",
+      ]
+    }
 
-      expect(flipper[:search].disable_group(:some_made_up_group)).to be(true)
-      expect(flipper[:search].groups_value).to eq(Set.new)
-    end
+    stub_request(:get, "http://app.com/flipper/features/feature_panel")
+      .with(headers: headers)
+      .to_return(status: 404)
 
-    it "can import" do
-      adapter = Flipper::Adapters::Memory.new
-      source_flipper = Flipper.new(adapter)
-      source_flipper.enable_percentage_of_actors :search, 10
-      source_flipper.enable_percentage_of_time :search, 15
-      source_flipper.enable_actor :search, Flipper::Actor.new('User;1')
-      source_flipper.enable_actor :search, Flipper::Actor.new('User;100')
-      source_flipper.enable_group :search, :admins
-      source_flipper.enable_group :search, :employees
-      source_flipper.enable :plausible
-      source_flipper.disable :google_analytics
-
-      flipper = Flipper.new(subject)
-      flipper.import(source_flipper)
-      expect(flipper[:search].percentage_of_actors_value).to be(10)
-      expect(flipper[:search].percentage_of_time_value).to be(15)
-      expect(flipper[:search].actors_value).to eq(Set["User;1", "User;100"])
-      expect(flipper[:search].groups_value).to eq(Set["admins", "employees"])
-      expect(flipper[:plausible].boolean_value).to be(true)
-      expect(flipper[:google_analytics].boolean_value).to be(false)
-    end
+    adapter = described_class.new(url: 'http://app.com/flipper')
+    adapter.get(flipper[:feature_panel])
   end
 
-  it "sends default headers" do
+  it "does not send undefined framework versions" do
+    stub_const("Rails", double(version: "7.1.0"))
+    stub_const("Sinatra::VERSION", "3.1.0")
+
     headers = {
-      'Accept' => 'application/json',
-      'Content-Type' => 'application/json',
-      'User-Agent' => "Flipper HTTP Adapter v#{Flipper::VERSION}",
+      "client-framework" => ["rails=7.1.0", "sinatra=3.1.0"]
     }
+
     stub_request(:get, "http://app.com/flipper/features/feature_panel")
       .with(headers: headers)
-      .to_return(status: 404, body: "", headers: {})
+      .to_return(status: 404)
 
     adapter = described_class.new(url: 'http://app.com/flipper')
     adapter.get(flipper[:feature_panel])
   end
 
+
   describe "#get" do
     it "raises error when not successful response" do
       stub_request(:get, "http://app.com/flipper/features/feature_panel")
-        .to_return(status: 503, body: "", headers: {})
+        .to_return(status: 503)
 
       adapter = described_class.new(url: 'http://app.com/flipper')
       expect {
@@ -105,7 +166,7 @@ RSpec.describe Flipper::Adapters::Http do
   describe "#get_multi" do
     it "raises error when not successful response" do
       stub_request(:get, "http://app.com/flipper/features?keys=feature_panel&exclude_gate_names=true")
-        .to_return(status: 503, body: "", headers: {})
+        .to_return(status: 503)
 
       adapter = described_class.new(url: 'http://app.com/flipper')
       expect {
@@ -117,19 +178,259 @@ RSpec.describe Flipper::Adapters::Http do
   describe "#get_all" do
     it "raises error when not successful response" do
       stub_request(:get, "http://app.com/flipper/features?exclude_gate_names=true")
-        .to_return(status: 503, body: "", headers: {})
+        .to_return(status: 503)
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      expect {
+        adapter.get_all
+      }.to raise_error(Flipper::Adapters::Http::Error)
+    end
+
+    it "stores ETag and sends If-None-Match on subsequent requests" do
+      features_response = {
+        "features" => [
+          {
+            "key" => "search",
+            "gates" => [
+              {"key" => "boolean", "value" => true}
+            ]
+          }
+        ]
+      }
+
+      # First request - server returns ETag
+      stub_request(:get, "http://app.com/flipper/features?exclude_gate_names=true")
+        .to_return(
+          status: 200,
+          body: JSON.generate(features_response),
+          headers: { 'ETag' => '"abc123"' }
+        )
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      result = adapter.get_all
+
+      expect(result).to have_key("search")
+
+      # Second request - should send If-None-Match header
+      stub_request(:get, "http://app.com/flipper/features?exclude_gate_names=true")
+        .with(headers: { 'If-None-Match' => '"abc123"' })
+        .to_return(
+          status: 200,
+          body: JSON.generate(features_response),
+          headers: { 'ETag' => '"abc123"' }
+        )
+
+      etag_result = adapter.get_all
+
+      expect(etag_result).to eq(result)
+      expect(etag_result).to have_key("search")
+      expect(
+        a_request(:get, "http://app.com/flipper/features?exclude_gate_names=true")
+        .with(headers: { 'If-None-Match' => '"abc123"' })
+      ).to have_been_made.once
+    end
+
+    it "returns cached result when server returns 304 Not Modified" do
+      features_response = {
+        "features" => [
+          {
+            "key" => "search",
+            "gates" => [
+              {"key" => "boolean", "value" => true}
+            ]
+          }
+        ]
+      }
+
+      # First request - server returns ETag
+      stub_request(:get, "http://app.com/flipper/features?exclude_gate_names=true")
+        .to_return(
+          status: 200,
+          body: JSON.generate(features_response),
+          headers: { 'ETag' => '"abc123"' }
+        )
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      first_result = adapter.get_all
+
+      expect(first_result).to have_key("search")
+
+      # Second request - server returns 304
+      stub_request(:get, "http://app.com/flipper/features?exclude_gate_names=true")
+        .with(headers: { 'If-None-Match' => '"abc123"' })
+        .to_return(status: 304, headers: { 'ETag' => '"abc123"' })
+
+      second_result = adapter.get_all
+
+      # Should return the cached result
+      expect(second_result).to eq(first_result)
+      expect(second_result).to have_key("search")
+    end
+
+    it "raises error when 304 received without cached result" do
+      # Server returns 304 without any prior request
+      stub_request(:get, "http://app.com/flipper/features?exclude_gate_names=true")
+        .to_return(status: 304)
 
       adapter = described_class.new(url: 'http://app.com/flipper')
       expect {
         adapter.get_all
       }.to raise_error(Flipper::Adapters::Http::Error)
     end
+
+    it "skips If-None-Match header when cache_bust is true" do
+      features_response = {
+        "features" => [
+          {
+            "key" => "search",
+            "gates" => [
+              {"key" => "boolean", "value" => true}
+            ]
+          }
+        ]
+      }
+
+      # First request - populate the ETag cache
+      stub_request(:get, "http://app.com/flipper/features?exclude_gate_names=true")
+        .to_return(
+          status: 200,
+          body: JSON.generate(features_response),
+          headers: { 'ETag' => '"abc123"' }
+        )
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      adapter.get_all
+
+      # Second request with cache_bust - should NOT send If-None-Match
+      cache_bust_stub = stub_request(:get, %r{/flipper/features\?_cb=\d+&exclude_gate_names=true})
+        .to_return(
+          status: 200,
+          body: JSON.generate(features_response),
+          headers: { 'ETag' => '"def456"' }
+        )
+
+      adapter.get_all(cache_bust: true)
+
+      expect(cache_bust_stub).to have_been_requested.once
+      expect(
+        a_request(:get, %r{/flipper/features\?_cb=\d+&exclude_gate_names=true})
+        .with { |req| req.headers['If-None-Match'].nil? }
+      ).to have_been_made.once
+    end
+
+    it "returns fresh data on cache_bust even when ETag is cached" do
+      stale_response = {
+        "features" => [
+          {
+            "key" => "search",
+            "gates" => [
+              {"key" => "boolean", "value" => nil}
+            ]
+          }
+        ]
+      }
+
+      fresh_response = {
+        "features" => [
+          {
+            "key" => "search",
+            "gates" => [
+              {"key" => "boolean", "value" => true}
+            ]
+          }
+        ]
+      }
+
+      # First request - populate ETag cache with feature disabled
+      stub_request(:get, "http://app.com/flipper/features?exclude_gate_names=true")
+        .to_return(
+          status: 200,
+          body: JSON.generate(stale_response),
+          headers: { 'ETag' => '"abc123"' }
+        )
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      stale_result = adapter.get_all
+
+      expect(stale_result["search"][:boolean]).to be_nil
+
+      # Cache bust request returns fresh data (feature now enabled)
+      stub_request(:get, %r{/flipper/features\?_cb=\d+&exclude_gate_names=true})
+        .to_return(
+          status: 200,
+          body: JSON.generate(fresh_response),
+          headers: { 'ETag' => '"def456"' }
+        )
+
+      fresh_result = adapter.get_all(cache_bust: true)
+
+      expect(fresh_result["search"][:boolean]).to eq("true")
+    end
+
+    it "does not send If-None-Match for other endpoints" do
+      stub_request(:get, "http://app.com/flipper/features/search")
+        .to_return(status: 404)
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      adapter.get(flipper[:search])
+
+      # Verify no If-None-Match header was sent
+      expect(
+        a_request(:get, "http://app.com/flipper/features/search")
+        .with { |req| req.headers['If-None-Match'].nil? }
+      ).to have_been_made.once
+    end
+
+    it "stores last get_all response for poll-shutdown header checking" do
+      features_response = {
+        "features" => [
+          {
+            "key" => "search",
+            "gates" => [
+              {"key" => "boolean", "value" => true}
+            ]
+          }
+        ]
+      }
+
+      stub_request(:get, "http://app.com/flipper/features?exclude_gate_names=true")
+        .to_return(
+          status: 200,
+          body: JSON.generate(features_response),
+          headers: { 'poll-shutdown' => 'true' }
+        )
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      adapter.get_all
+
+      expect(adapter.last_get_all_response).not_to be_nil
+      expect(adapter.last_get_all_response['poll-shutdown']).to eq('true')
+    end
+
+    it "stores last get_all response even for error responses" do
+      stub_request(:get, "http://app.com/flipper/features?exclude_gate_names=true")
+        .to_return(
+          status: 404,
+          body: JSON.generate({ error: "Not found" }),
+          headers: { 'poll-shutdown' => 'true' }
+        )
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+
+      expect {
+        adapter.get_all
+      }.to raise_error(Flipper::Adapters::Http::Error)
+
+      # Even though it raised an error, response should be stored
+      expect(adapter.last_get_all_response).not_to be_nil
+      expect(adapter.last_get_all_response['poll-shutdown']).to eq('true')
+    end
   end
 
   describe "#features" do
     it "raises error when not successful response" do
       stub_request(:get, "http://app.com/flipper/features?exclude_gate_names=true")
-        .to_return(status: 503, body: "", headers: {})
+        .to_return(status: 503)
 
       adapter = described_class.new(url: 'http://app.com/flipper')
       expect {
@@ -246,7 +547,7 @@ RSpec.describe Flipper::Adapters::Http do
     let(:options) do
       {
         url: 'http://app.com/mount-point',
-        headers: { 'X-Custom-Header' => 'foo' },
+        headers: { 'x-custom-header' => 'foo' },
         basic_auth_username: 'username',
         basic_auth_password: 'password',
         read_timeout: 100,
@@ -267,7 +568,7 @@ RSpec.describe Flipper::Adapters::Http do
       subject.get(feature)
       expect(
         a_request(:get, 'http://app.com/mount-point/features/feature_panel')
-        .with(headers: { 'X-Custom-Header' => 'foo' })
+        .with(headers: { 'x-custom-header' => 'foo' })
       ).to have_been_made.once
     end
 

data/spec/flipper/adapters/instrumented_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe Flipper::Adapters::Instrumented do
 
   let(:feature) { flipper[:stats] }
   let(:gate) { feature.gate(:percentage_of_actors) }
-  let(:thing) { flipper.actors(22) }
+  let(:thing) { Flipper::Types::PercentageOfActors.new(22) }
 
   subject do
     described_class.new(adapter, instrumenter: instrumenter)