flipper 1.2.1 → 1.3.0.pre

data/spec/flipper/cloud/telemetry_spec.rb

@@ -2,6 +2,12 @@ require 'flipper/cloud/telemetry'
 require 'flipper/cloud/configuration'
 
 RSpec.describe Flipper::Cloud::Telemetry do
+  before do
+    # Stub polling for features.
+    stub_request(:get, "https://www.flippercloud.io/adapter/features?exclude_gate_names=true").
+      to_return(status: 200, body: "{}")
+  end
+
   it "phones home and does not update telemetry interval if missing" do
     stub = stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
       to_return(status: 200, body: "{}")
@@ -42,6 +48,52 @@ RSpec.describe Flipper::Cloud::Telemetry do
     expect(stub).to have_been_requested
   end
 
+  it "phones home and requests shutdown if telemetry-shutdown header is true" do
+    stub = stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
+      to_return(status: 404, body: "{}", headers: {"telemetry-shutdown" => "true"})
+
+    output = StringIO.new
+    cloud_configuration = Flipper::Cloud::Configuration.new(
+      token: "test",
+      logger: Logger.new(output),
+      logging_enabled: true,
+    )
+
+    # Record some telemetry and stop the threads so we submit a response.
+    telemetry = described_class.new(cloud_configuration)
+    telemetry.record(Flipper::Feature::InstrumentationName, {
+      operation: :enabled?,
+      feature_name: :foo,
+      result: true,
+    })
+    telemetry.stop
+    expect(stub).to have_been_requested
+    expect(output.string).to match(/action=telemetry_shutdown message=The server has requested that telemetry be shut down./)
+  end
+
+  it "phones home and does not shutdown if telemetry shutdown header is missing" do
+    stub = stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
+      to_return(status: 404, body: "{}", headers: {})
+
+    output = StringIO.new
+    cloud_configuration = Flipper::Cloud::Configuration.new(
+      token: "test",
+      logger: Logger.new(output),
+      logging_enabled: true,
+    )
+
+    # Record some telemetry and stop the threads so we submit a response.
+    telemetry = described_class.new(cloud_configuration)
+    telemetry.record(Flipper::Feature::InstrumentationName, {
+      operation: :enabled?,
+      feature_name: :foo,
+      result: true,
+    })
+    telemetry.stop
+    expect(stub).to have_been_requested
+    expect(output.string).not_to match(/action=telemetry_shutdown message=The server has requested that telemetry be shut down./)
+  end
+
   it "can update telemetry interval from error" do
     stub = stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
       to_return(status: 500, body: "{}", headers: {"telemetry-interval" => "120"})

data/spec/flipper/cloud_spec.rb

@@ -36,7 +36,8 @@ RSpec.describe Flipper::Cloud do
       expect(client.uri.host).to eq('www.flippercloud.io')
       expect(client.uri.path).to eq('/adapter')
       expect(client.headers["flipper-cloud-token"]).to eq(token)
-      expect(@instance.instrumenter).to be(Flipper::Instrumenters::Noop)
+      expect(@instance.instrumenter).to be_a(Flipper::Cloud::Telemetry::Instrumenter)
+      expect(@instance.instrumenter.instrumenter).to be(Flipper::Instrumenters::Noop)
     end
   end
 
@@ -55,15 +56,15 @@ RSpec.describe Flipper::Cloud do
   end
 
   it 'can initialize with no token explicitly provided' do
-    with_env 'FLIPPER_CLOUD_TOKEN' => 'asdf' do
-      expect(described_class.new).to be_instance_of(Flipper::Cloud::DSL)
-    end
+    ENV['FLIPPER_CLOUD_TOKEN'] = 'asdf'
+    expect(described_class.new).to be_instance_of(Flipper::Cloud::DSL)
   end
 
   it 'can set instrumenter' do
     instrumenter = Flipper::Instrumenters::Memory.new
     instance = described_class.new(token: 'asdf', instrumenter: instrumenter)
-    expect(instance.instrumenter).to be(instrumenter)
+    expect(instance.instrumenter).to be_a(Flipper::Cloud::Telemetry::Instrumenter)
+    expect(instance.instrumenter.instrumenter).to be(instrumenter)
   end
 
   it 'allows wrapping adapter with another adapter like the instrumenter' do

data/spec/flipper/engine_spec.rb

@@ -4,8 +4,10 @@ require 'flipper/engine'
 RSpec.describe Flipper::Engine do
   let(:application) do
     Class.new(Rails::Application) do
+      config.load_defaults Rails::VERSION::STRING.to_f
       config.eager_load = false
       config.logger = ActiveSupport::Logger.new($stdout)
+      config.active_support.remove_deprecated_time_with_zone_name = false
     end.instance
   end
 
@@ -33,28 +35,25 @@ RSpec.describe Flipper::Engine do
     let(:adapter) { Flipper.adapter.adapter }
 
     it 'can set strict=true from ENV' do
-      with_env 'FLIPPER_STRICT' => 'true' do
-        subject
-        expect(config.strict).to eq(:raise)
-        expect(adapter).to be_instance_of(Flipper::Adapters::Strict)
-      end
+      ENV['FLIPPER_STRICT'] = 'true'
+      subject
+      expect(config.strict).to eq(:raise)
+      expect(adapter).to be_instance_of(Flipper::Adapters::Strict)
     end
 
     it 'can set strict=warn from ENV' do
-      with_env 'FLIPPER_STRICT' => 'warn' do
-        subject
-        expect(config.strict).to eq(:warn)
-        expect(adapter).to be_instance_of(Flipper::Adapters::Strict)
-        expect(adapter.handler).to be(:warn)
-      end
+      ENV['FLIPPER_STRICT'] = 'warn'
+      subject
+      expect(config.strict).to eq(:warn)
+      expect(adapter).to be_instance_of(Flipper::Adapters::Strict)
+      expect(adapter.handler).to be(:warn)
     end
 
     it 'can set strict=false from ENV' do
-      with_env 'FLIPPER_STRICT' => 'false' do
-        subject
-        expect(config.strict).to eq(false)
-        expect(adapter).to be_instance_of(Flipper::Adapters::Memory)
-      end
+      ENV['FLIPPER_STRICT'] = 'false'
+      subject
+      expect(config.strict).to eq(false)
+      expect(adapter).to be_instance_of(Flipper::Adapters::Memory)
     end
 
     [true, :raise, :warn].each do |value|
@@ -104,39 +103,34 @@ RSpec.describe Flipper::Engine do
     it_behaves_like 'config.strict'
 
     it 'can set env_key from ENV' do
-      with_env 'FLIPPER_ENV_KEY' => 'flopper' do
-        subject
-        expect(config.env_key).to eq('flopper')
-      end
+      ENV['FLIPPER_ENV_KEY'] = 'flopper'
+      subject
+      expect(config.env_key).to eq('flopper')
     end
 
     it 'can set memoize from ENV' do
-      with_env 'FLIPPER_MEMOIZE' => 'false' do
-        subject
-        expect(config.memoize).to eq(false)
-      end
+      ENV['FLIPPER_MEMOIZE'] = 'false'
+      subject
+      expect(config.memoize).to eq(false)
     end
 
     it 'can set preload from ENV' do
-      with_env 'FLIPPER_PRELOAD' => 'false' do
-        subject
-        expect(config.preload).to eq(false)
-      end
+      ENV['FLIPPER_PRELOAD'] = 'false'
+      subject
+      expect(config.preload).to eq(false)
     end
 
     it 'can set instrumenter from ENV' do
       stub_const('My::Cool::Instrumenter', Class.new)
-      with_env 'FLIPPER_INSTRUMENTER' => 'My::Cool::Instrumenter' do
-        subject
-        expect(config.instrumenter).to eq(My::Cool::Instrumenter)
-      end
+      ENV['FLIPPER_INSTRUMENTER'] = 'My::Cool::Instrumenter'
+      subject
+      expect(config.instrumenter).to eq(My::Cool::Instrumenter)
     end
 
     it 'can set log from ENV' do
-      with_env 'FLIPPER_LOG' => 'false' do
-        subject
-        expect(config.log).to eq(false)
-      end
+      ENV['FLIPPER_LOG'] = 'false'
+      subject
+      expect(config.log).to eq(false)
     end
 
     it 'sets defaults' do
@@ -220,10 +214,8 @@ RSpec.describe Flipper::Engine do
   end
 
   context 'with cloud' do
-    around do |example|
-      with_env "FLIPPER_CLOUD_TOKEN" => "test-token" do
-        example.run
-      end
+    before do
+      ENV["FLIPPER_CLOUD_TOKEN"] = "test-token"
     end
 
     # App for Rack::Test
@@ -244,14 +236,13 @@ RSpec.describe Flipper::Engine do
       application.initialize!
 
       expect(Flipper.instance).to be_a(Flipper::Cloud::DSL)
-      expect(Flipper.instance.instrumenter).to be(ActiveSupport::Notifications)
+      expect(Flipper.instance.instrumenter).to be_a(Flipper::Cloud::Telemetry::Instrumenter)
+      expect(Flipper.instance.instrumenter.instrumenter).to be(ActiveSupport::Notifications)
     end
 
     context "with CLOUD_SYNC_SECRET" do
-      around do |example|
-        with_env "FLIPPER_CLOUD_SYNC_SECRET" => "test-secret" do
-          example.run
-        end
+      before do
+        ENV["FLIPPER_CLOUD_SYNC_SECRET"] = "test-secret"
       end
 
       let(:request_body) do
@@ -296,10 +287,9 @@ RSpec.describe Flipper::Engine do
 
     context "without FLIPPER_CLOUD_TOKEN" do
       it "gracefully skips configuring webhook app" do
-        with_env "FLIPPER_CLOUD_TOKEN" => nil do
-          application.initialize!
-          expect(Flipper.instance).to be_a(Flipper::DSL)
-        end
+        ENV["FLIPPER_CLOUD_TOKEN"] = nil
+        application.initialize!
+        expect(Flipper.instance).to be_a(Flipper::DSL)
 
         post "/_flipper"
         expect(last_response.status).to eq(404)

data/spec/flipper/middleware/memoizer_spec.rb

@@ -458,7 +458,7 @@ RSpec.describe Flipper::Middleware::Memoizer do
       logged_memory = Flipper::Adapters::OperationLogger.new(memory)
       cache = ActiveSupport::Cache::MemoryStore.new
       cache.clear
-      cached = Flipper::Adapters::ActiveSupportCacheStore.new(logged_memory, cache, expires_in: 10)
+      cached = Flipper::Adapters::ActiveSupportCacheStore.new(logged_memory, cache)
       logged_cached = Flipper::Adapters::OperationLogger.new(cached)
       memo = {}
       flipper = Flipper.new(logged_cached)
@@ -471,15 +471,18 @@ RSpec.describe Flipper::Middleware::Memoizer do
 
       get '/', {}, 'flipper' => flipper
       expect(logged_cached.count(:get_all)).to be(1)
-      expect(logged_memory.count(:get_all)).to be(1)
+      expect(logged_memory.count(:features)).to be(1)
+      expect(logged_memory.count(:get_multi)).to be(1)
 
       get '/', {}, 'flipper' => flipper
       expect(logged_cached.count(:get_all)).to be(2)
-      expect(logged_memory.count(:get_all)).to be(1)
+      expect(logged_memory.count(:features)).to be(1)
+      expect(logged_memory.count(:get_multi)).to be(1)
 
       get '/', {}, 'flipper' => flipper
       expect(logged_cached.count(:get_all)).to be(3)
-      expect(logged_memory.count(:get_all)).to be(1)
+      expect(logged_memory.count(:features)).to be(1)
+      expect(logged_memory.count(:get_multi)).to be(1)
     end
   end
 end

data/spec/support/fail_on_output.rb

@@ -0,0 +1,8 @@
+if ENV["CI"] || ENV["FAIL_ON_OUTPUT"]
+  RSpec.configure do |config|
+    config.around do |example|
+      output = silence { example.run }
+      fail "Use `silence { }` to avoid printing to STDOUT/STDERR\n#{output}" unless output.empty?
+    end
+  end
+end

data/spec/support/spec_helpers.rb

@@ -1,6 +1,7 @@
 require 'ice_age'
 require 'json'
 require 'rack/test'
+require 'rack/session'
 
 module SpecHelpers
   extend self
@@ -12,7 +13,7 @@ module SpecHelpers
 
   def build_app(flipper, options = {})
     Flipper::UI.app(flipper, options) do |builder|
-      builder.use Rack::Session::Cookie, secret: 'test'
+      builder.use Rack::Session::Cookie, secret: 'test' * 16 # Rack 3+ wants a 64-character secret
     end
   end
 

data/test_rails/system/test_help_test.rb

@@ -29,10 +29,15 @@ end
 
 class TestHelpTest < ActionDispatch::SystemTestCase
   # Any driver that runs the app in a separate thread will test what we want here.
-  driven_by :cuprite
+  driven_by :cuprite, options: { process_timeout: 60 }
 
-  # Ensure this test uses this app instance
-  setup { Rails.application = TestApp.instance }
+  setup do
+    # Reconfigure Flipper since other tests change the adapter.
+    flipper_configure
+
+    # Ensure this test uses this app instance
+    Rails.application = TestApp.instance
+  end
 
   test "configures a shared adapter between tests and app" do
     Flipper.disable(:test)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0.pre
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-15 00:00:00.000000000 Z
+date: 2024-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -90,6 +90,7 @@ files:
 - lib/flipper/actor.rb
 - lib/flipper/adapter.rb
 - lib/flipper/adapter_builder.rb
+- lib/flipper/adapters/cache_base.rb
 - lib/flipper/adapters/dual_write.rb
 - lib/flipper/adapters/failover.rb
 - lib/flipper/adapters/failsafe.rb
@@ -109,6 +110,7 @@ files:
 - lib/flipper/adapters/sync/feature_synchronizer.rb
 - lib/flipper/adapters/sync/interval_synchronizer.rb
 - lib/flipper/adapters/sync/synchronizer.rb
+- lib/flipper/adapters/wrapper.rb
 - lib/flipper/cli.rb
 - lib/flipper/cloud.rb
 - lib/flipper/cloud/configuration.rb
@@ -193,6 +195,8 @@ files:
 - lib/generators/flipper/templates/update/migrations/01_create_flipper_tables.rb.erb
 - lib/generators/flipper/templates/update/migrations/02_change_flipper_gates_value_to_text.rb.erb
 - lib/generators/flipper/update_generator.rb
+- package-lock.json
+- package.json
 - spec/fixtures/environment.rb
 - spec/fixtures/feature.json
 - spec/fixtures/flipper_pstore_1679087600.json
@@ -286,8 +290,8 @@ files:
 - spec/flipper_spec.rb
 - spec/spec_helper.rb
 - spec/support/actor_names.yml
-- spec/support/climate_control.rb
 - spec/support/descriptions.yml
+- spec/support/fail_on_output.rb
 - spec/support/fake_backoff_policy.rb
 - spec/support/fake_udp_socket.rb
 - spec/support/skippable.rb
@@ -307,7 +311,7 @@ metadata:
   homepage_uri: https://www.flippercloud.io
   source_code_uri: https://github.com/flippercloud/flipper
   bug_tracker_uri: https://github.com/flippercloud/flipper/issues
-  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.2.1
+  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.3.0.pre
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -421,8 +425,8 @@ test_files:
 - spec/flipper_spec.rb
 - spec/spec_helper.rb
 - spec/support/actor_names.yml
-- spec/support/climate_control.rb
 - spec/support/descriptions.yml
+- spec/support/fail_on_output.rb
 - spec/support/fake_backoff_policy.rb
 - spec/support/fake_udp_socket.rb
 - spec/support/skippable.rb

data/spec/support/climate_control.rb

@@ -1,7 +0,0 @@
-require 'climate_control'
-
-RSpec.configure do |config|
-  def with_env(options = {}, &block)
-    ClimateControl.modify(options, &block)
-  end
-end