flipper 0.28.0 → 1.3.6

data/spec/flipper_spec.rb

@@ -64,7 +64,12 @@ RSpec.describe Flipper do
 
   describe "delegation to instance" do
     let(:group) { Flipper::Types::Group.new(:admins) }
-    let(:actor) { Flipper::Actor.new("1") }
+    let(:actor) {
+      Flipper::Actor.new("1", {
+        "plan" => "basic",
+      })
+    }
+    let(:expression) { Flipper.property(:plan).eq("basic") }
 
     before do
       described_class.configure do |config|
@@ -88,12 +93,35 @@ RSpec.describe Flipper do
       expect(described_class.instance.enabled?(:search)).to be(false)
     end
 
-    it 'delegates bool to instance' do
-      expect(described_class.bool).to eq(described_class.instance.bool)
+    it 'delegates expression to instance' do
+      expect(described_class.expression(:search)).to be(nil)
+
+      expression = Flipper.property(:plan).eq("basic")
+      Flipper.instance.enable_expression :search, expression
+
+      expect(described_class.expression(:search)).to eq(expression)
+    end
+
+    it 'delegates enable_expression to instance' do
+      described_class.enable_expression(:search, expression)
+      expect(described_class.instance.enabled?(:search, actor)).to be(true)
+    end
+
+    it 'delegates disable_expression to instance' do
+      described_class.disable_expression(:search)
+      expect(described_class.instance.enabled?(:search, actor)).to be(false)
+    end
+
+    it 'delegates add_expression to instance' do
+      described_class.add_expression(:search, expression)
+      expect(described_class.instance.enabled?(:search, actor)).to be(true)
     end
 
-    it 'delegates boolean to instance' do
-      expect(described_class.boolean).to eq(described_class.instance.boolean)
+    it 'delegates remove_expression to instance' do
+      described_class.enable_expression(:search, Flipper.any(expression))
+      expect(described_class.instance.enabled?(:search, actor)).to be(true)
+      described_class.remove_expression(:search, expression)
+      expect(described_class.instance.enabled?(:search, actor)).to be(false)
     end
 
     it 'delegates enable_actor to instance' do
@@ -106,10 +134,6 @@ RSpec.describe Flipper do
       expect(described_class.instance.enabled?(:search, actor)).to be(false)
     end
 
-    it 'delegates actor to instance' do
-      expect(described_class.actor(actor)).to eq(described_class.instance.actor(actor))
-    end
-
     it 'delegates enable_group to instance' do
       described_class.enable_group(:search, group)
       expect(described_class.instance[:search].enabled_groups).to include(group)
@@ -130,15 +154,6 @@ RSpec.describe Flipper do
       expect(described_class.instance[:search].percentage_of_actors_value).to be(0)
     end
 
-    it 'delegates actors to instance' do
-      expect(described_class.actors(5)).to eq(described_class.instance.actors(5))
-    end
-
-    it 'delegates percentage_of_actors to instance' do
-      expected = described_class.instance.percentage_of_actors(5)
-      expect(described_class.percentage_of_actors(5)).to eq(expected)
-    end
-
     it 'delegates enable_percentage_of_time to instance' do
       described_class.enable_percentage_of_time(:search, 5)
       expect(described_class.instance[:search].percentage_of_time_value).to be(5)
@@ -149,15 +164,6 @@ RSpec.describe Flipper do
       expect(described_class.instance[:search].percentage_of_time_value).to be(0)
     end
 
-    it 'delegates time to instance' do
-      expect(described_class.time(56)).to eq(described_class.instance.time(56))
-    end
-
-    it 'delegates percentage_of_time to instance' do
-      expected = described_class.instance.percentage_of_time(56)
-      expect(described_class.percentage_of_time(56)).to eq(expected)
-    end
-
     it 'delegates features to instance' do
       described_class.instance.add(:search)
       expect(described_class.features).to eq(described_class.instance.features)
@@ -222,6 +228,10 @@ RSpec.describe Flipper do
       expect(described_class.memoizing?).to eq(described_class.adapter.memoizing?)
     end
 
+    it 'delegates read_only? to instance' do
+      expect(described_class.read_only?).to eq(described_class.adapter.read_only?)
+    end
+
     it 'delegates sync stuff to instance and does nothing' do
       expect(described_class.sync).to be(nil)
       expect(described_class.sync_secret).to be(nil)
@@ -231,7 +241,7 @@ RSpec.describe Flipper do
       stub = stub_request(:get, "https://www.flippercloud.io/adapter/features?exclude_gate_names=true").
         with({
           headers: {
-            'Flipper-Cloud-Token'=>'asdf',
+            'flipper-cloud-token'=>'asdf',
           },
         }).to_return(status: 200, body: '{"features": {}}', headers: {})
       cloud_configuration = Flipper::Cloud::Configuration.new({
@@ -303,7 +313,7 @@ RSpec.describe Flipper do
 
   describe '.group_exists' do
     it 'returns true if the group is already created' do
-      group = described_class.register('admins', &:admin?)
+      described_class.register('admins', &:admin?)
       expect(described_class.group_exists?(:admins)).to eq(true)
     end
 
@@ -356,4 +366,52 @@ RSpec.describe Flipper do
       expect(described_class.instance_variable_get('@groups_registry')).to eq(registry)
     end
   end
+
+  describe ".constant" do
+    it "returns Flipper::Expression::Constant instance" do
+      expect(described_class.constant(false)).to eq(Flipper::Expression::Constant.new(false))
+      expect(described_class.constant("string")).to eq(Flipper::Expression::Constant.new("string"))
+    end
+  end
+
+  describe ".property" do
+    it "returns Flipper::Expressions::Property expression" do
+      expect(Flipper.property("name")).to eq(Flipper::Expression.build(Property: "name"))
+    end
+  end
+
+  describe ".boolean" do
+    it "returns Flipper::Expressions::Boolean expression" do
+      expect(described_class.boolean(true)).to eq(Flipper::Expression.build(Boolean: true))
+      expect(described_class.boolean(false)).to eq(Flipper::Expression.build(Boolean: false))
+    end
+  end
+
+  describe ".random" do
+    it "returns Flipper::Expressions::Random expression" do
+      expect(Flipper.random(100)).to eq(Flipper::Expression.build(Random: 100))
+    end
+  end
+
+  describe ".any" do
+    let(:age_expression) { Flipper.property(:age).gte(21) }
+    let(:plan_expression) { Flipper.property(:plan).eq("basic") }
+
+    it "returns Flipper::Expressions::Any instance" do
+      expect(Flipper.any(age_expression, plan_expression)).to eq(
+        Flipper::Expression.build({Any: [age_expression, plan_expression]})
+      )
+    end
+  end
+
+  describe ".all" do
+    let(:age_expression) { Flipper.property(:age).gte(21) }
+    let(:plan_expression) { Flipper.property(:plan).eq("basic") }
+
+    it "returns Flipper::Expressions::All instance" do
+      expect(Flipper.all(age_expression, plan_expression)).to eq(
+        Flipper::Expression.build({All: [age_expression, plan_expression]})
+      )
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -2,14 +2,17 @@ $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 
 require 'pp'
 require 'pathname'
-FlipperRoot = Pathname(__FILE__).dirname.join('..').expand_path
-
-require 'rubygems'
-require 'bundler'
+require 'bundler/setup'
 
-Bundler.setup(:default)
+require 'warning'
+Warning.ignore(/lib\/statsd/)
+Warning.ignore(/lib\/debug\//)
+Warning.ignore(/lib\/ice_age\//)
+Warning.ignore(/lib\/moneta\//)
+Warning.ignore(/lib\/mongo\//)
 
 require 'debug'
+require 'statsd'
 require 'webmock/rspec'
 WebMock.disable_net_connect!(allow_localhost: true)
 
@@ -17,11 +20,20 @@ require 'flipper'
 require 'flipper/api'
 require 'flipper/spec/shared_adapter_specs'
 require 'flipper/ui'
+require 'flipper/test_help'
 
+FlipperRoot = Pathname(__FILE__).dirname.join('..').expand_path
 Dir[FlipperRoot.join('spec/support/**/*.rb')].sort.each { |f| require f }
 
+# Disable telemetry logging in specs.
+ENV["FLIPPER_CLOUD_LOGGING_ENABLED"] = "false"
+
 RSpec.configure do |config|
   config.before(:example) do
+    # default stub for telemetry
+    stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
+      to_return(status: 200, body: "", headers: {})
+    Flipper::Cloud::Telemetry.reset if defined?(Flipper::Cloud::Telemetry) && Flipper::Cloud::Telemetry.respond_to?(:reset)
     Flipper::Poller.reset if defined?(Flipper::Poller)
     Flipper.unregister_groups
     Flipper.configuration = nil
@@ -91,15 +103,3 @@ RSpec.shared_examples_for 'a DSL feature' do
     end.to raise_error(ArgumentError, /must be a String or Symbol/)
   end
 end
-
-RSpec.shared_examples_for 'a DSL boolean method' do
-  it 'returns boolean with value set' do
-    result = subject.send(method_name, true)
-    expect(result).to be_instance_of(Flipper::Types::Boolean)
-    expect(result.value).to be(true)
-
-    result = subject.send(method_name, false)
-    expect(result).to be_instance_of(Flipper::Types::Boolean)
-    expect(result.value).to be(false)
-  end
-end

data/spec/support/actor_names.yml

@@ -0,0 +1 @@
+actor_name_1: 'Actor #1'

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 = capture_output { example.run }
+      fail "Use `silence { }` to avoid printing to STDOUT/STDERR\n#{output}" unless output.empty?
+    end
+  end
+end

data/spec/support/fake_backoff_policy.rb

@@ -0,0 +1,15 @@
+class FakeBackoffPolicy
+  def initialize
+    @retries = 0
+  end
+
+  attr_reader :retries
+
+  def next_interval
+    @retries += 1
+    0
+  end
+
+  def reset
+  end
+end

data/spec/support/spec_helpers.rb

@@ -1,8 +1,11 @@
 require 'ice_age'
 require 'json'
 require 'rack/test'
+require 'rack/session'
 
 module SpecHelpers
+  extend self
+
   def self.included(base)
     base.let(:flipper) { build_flipper }
     base.let(:app) { build_app(flipper) }
@@ -10,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
 
@@ -27,7 +30,11 @@ module SpecHelpers
   end
 
   def json_response
-    JSON.parse(last_response.body)
+    body = last_response.body
+    if last_response["content-encoding"] == 'gzip'
+      body = Flipper::Typecast.from_gzip(body)
+    end
+    JSON.parse(body)
   end
 
   def api_error_code_reference_url
@@ -42,6 +49,14 @@ module SpecHelpers
     }
   end
 
+  def api_positive_percentage_error_response
+    {
+      'code' => 3,
+      'message' => 'Percentage must be a positive number less than or equal to 100.',
+      'more_info' => api_error_code_reference_url,
+    }
+  end
+
   def api_flipper_id_is_missing_response
     {
       'code' => 4,
@@ -50,10 +65,10 @@ module SpecHelpers
     }
   end
 
-  def api_positive_percentage_error_response
+  def api_expression_invalid_response
     {
-      'code' => 3,
-      'message' => 'Percentage must be a positive number less than or equal to 100.',
+      'code' => 7,
+      'message' => 'The provided expression was not valid.',
       'more_info' => api_error_code_reference_url,
     }
   end
@@ -64,15 +79,26 @@ module SpecHelpers
     original_stdout = $stdout
 
     # Redirect stderr and stdout
-    output = $stderr = $stdout = StringIO.new
+    $stderr = $stdout = StringIO.new
 
     yield
-
+  ensure
     $stderr = original_stderr
     $stdout = original_stdout
+  end
+
+  def capture_output
+    original_stderr = $stderr
+    original_stdout = $stdout
+
+    output = $stdout = $stderr = StringIO.new
+
+    yield
 
-    # Return output
     output.string
+  ensure
+    $stderr = original_stderr
+    $stdout = original_stdout
   end
 end
 

data/test/adapters/actor_limit_test.rb

@@ -0,0 +1,20 @@
+require "test_helper"
+require "flipper/test/shared_adapter_test"
+require "flipper/adapters/actor_limit"
+
+class Flipper::Adapters::ActorLimitTest < MiniTest::Test
+  prepend Flipper::Test::SharedAdapterTests
+
+  def setup
+    @memory = Flipper::Adapters::Memory.new
+    @adapter = Flipper::Adapters::ActorLimit.new(@memory, 5)
+  end
+
+  def test_enable_fails_when_limit_exceeded
+    5.times { |i| @feature.enable Flipper::Actor.new("User;#{i}") }
+
+    assert_raises Flipper::Adapters::ActorLimit::LimitExceeded do
+      @feature.enable Flipper::Actor.new("User;6")
+    end
+  end
+end

data/test_rails/generators/flipper/setup_generator_test.rb

@@ -0,0 +1,69 @@
+require "helper"
+require "generators/flipper/setup_generator"
+
+class SetupGeneratorTest < Rails::Generators::TestCase
+  tests Flipper::Generators::SetupGenerator
+  ROOT = File.expand_path("../../../tmp/generators", __dir__)
+  destination ROOT
+  setup :prepare_destination
+
+  test "invokes flipper:active_record generator if ActiveRecord adapter defined" do
+    begin
+      load 'flipper/adapters/active_record.rb'
+      run_generator
+      assert_migration "db/migrate/create_flipper_tables.rb"
+    ensure
+      Flipper::Adapters.send(:remove_const, :ActiveRecord)
+    end
+  end
+
+  test "generates an initializer" do
+    run_generator
+    assert_file 'config/initializers/flipper.rb', /Flipper\.configure/
+  end
+
+  test "does not invoke flipper:active_record generator if ActiveRecord adapter not defined" do
+    # Ensure adapter not defined
+    Flipper::Adapters.send(:remove_const, :ActiveRecord) rescue nil
+
+    run_generator
+    assert_no_migration "db/migrate/create_flipper_tables.rb"
+  end
+
+  %w(.env.development .env.local .env).each do |file|
+    test "configures Flipper Cloud token in #{file} if it exists" do
+      File.write("#{ROOT}/#{file}", "")
+      run_generator %w(--token abc123)
+      assert_file file, /^FLIPPER_CLOUD_TOKEN=abc123$/m
+    end
+  end
+
+  test "configures Flipper Cloud token in .env.development before .env" do
+    File.write("#{ROOT}/.env.development", "")
+    File.write("#{ROOT}/.env", "")
+
+    run_generator %w(--token abc123)
+    assert_file ".env.development", /^FLIPPER_CLOUD_TOKEN=abc123$/m
+    assert_file ".env", ""
+  end
+
+  test "does not write to .env if no token provided" do
+    File.write("#{ROOT}/.env", "")
+    run_generator
+    assert_file ".env", ""
+  end
+
+  test "configures Flipper Cloud token in config/credentials.yml.enc if credentials.yml.enc exist" do
+    Dir.chdir(ROOT) do
+      FileUtils.mkdir_p("config")
+      ENV["RAILS_MASTER_KEY"] = "a" * 32
+      Rails.application = Class.new(Rails::Application)
+      Rails.application.credentials.write("")
+
+      run_generator %w(--token abc123)
+      assert_file "config/credentials.yml.enc"
+      expected_config = { flipper: { cloud_token: "abc123" } }
+      assert_equal expected_config, Rails.application.credentials.config
+    end
+  end
+end

data/test_rails/generators/flipper/update_generator_test.rb

@@ -0,0 +1,96 @@
+require "helper"
+require "generators/flipper/update_generator"
+
+class UpdateGeneratorTest < Rails::Generators::TestCase
+  tests Flipper::Generators::UpdateGenerator
+  ROOT = File.expand_path("../../../../tmp/generators", __FILE__)
+  destination ROOT
+  setup :prepare_destination
+
+  setup do
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+  end
+
+  teardown do
+    ActiveRecord::Base.connection.close
+  end
+
+  test "generates migrations" do
+    run_generator
+
+    assert_migration "db/migrate/create_flipper_tables.rb" do |migration|
+      assert_method :up, migration do |up|
+        assert_match(/create_table :flipper_features/, up)
+        assert_match(/create_table :flipper_gates/, up)
+      end
+
+      assert_method :down, migration do |down|
+        assert_match(/drop_table :flipper_features/, down)
+        assert_match(/drop_table :flipper_gates/, down)
+      end
+    end
+
+    assert_migration "db/migrate/change_flipper_gates_value_to_text.rb" do |migration|
+      [:up, :down].each do |dir|
+        assert_method :up, migration do |method|
+          assert_match(/change_column/, method)
+        end
+      end
+    end
+
+    require_migrations
+
+    silence { CreateFlipperTables.migrate(:up) }
+    assert ActiveRecord::Base.connection.table_exists?(:flipper_features)
+    assert ActiveRecord::Base.connection.table_exists?(:flipper_gates)
+
+    assert ActiveRecord::Base.connection.column_exists?(:flipper_gates, :value, :string)
+    silence { ChangeFlipperGatesValueToText.migrate(:up) }
+    assert ActiveRecord::Base.connection.column_exists?(:flipper_gates, :value, :text)
+
+    silence { ChangeFlipperGatesValueToText.migrate(:down) }
+    assert ActiveRecord::Base.connection.column_exists?(:flipper_gates, :value, :string)
+
+    silence { CreateFlipperTables.migrate(:down) }
+    refute ActiveRecord::Base.connection.table_exists?(:flipper_features)
+    refute ActiveRecord::Base.connection.table_exists?(:flipper_gates)
+  end
+
+  test "ChangeFlipperGatesValueToText is a noop if value is already text" do
+    self.class.generator_class = Flipper::Generators::ActiveRecordGenerator
+    run_generator
+
+    self.class.generator_class = Flipper::Generators::UpdateGenerator
+    run_generator
+
+    assert_migration "db/migrate/create_flipper_tables.rb" do |migration|
+      assert_method :up, migration do |up|
+        assert_match(/text :value/, up)
+      end
+    end
+
+    assert_migration "db/migrate/change_flipper_gates_value_to_text.rb"
+
+    require_migrations
+
+    silence { CreateFlipperTables.migrate(:up) }
+    assert ActiveRecord::Base.connection.column_exists?(:flipper_gates, :value, :text)
+
+    assert_nothing_raised do
+      silence { ChangeFlipperGatesValueToText.migrate(:up) }
+    end
+    assert ActiveRecord::Base.connection.column_exists?(:flipper_gates, :value, :text)
+  end
+
+  def require_migrations
+    # If these are not reloaded, then test order can cause failures
+    Object.send(:remove_const, :CreateFlipperTables) if defined?(::CreateFlipperTables)
+    Object.send(:remove_const, :ChangeFlipperGatesValueToText) if defined?(::ChangeFlipperGatesValueToText)
+
+    Dir.glob("#{ROOT}/db/migrate/*.rb").each do |file|
+      assert_nothing_raised do
+        load file
+      end
+    end
+  end
+end

data/test_rails/helper.rb

@@ -1,11 +1,31 @@
 require 'rubygems'
-require 'bundler'
-Bundler.setup(:default)
+require 'bundler/setup'
+require 'minitest/autorun'
 require 'rails'
 require 'rails/test_help'
 
+require 'warning'
+Warning.ignore(/lib\/capybara\//)
+
 begin
   ActiveSupport::TestCase.test_order = :random
 rescue NoMethodError
   # no biggie, means we are on older version of AS that doesn't have this option
 end
+
+def silence
+  # Store the original stderr and stdout in order to restore them later
+  original_stderr = $stderr
+  original_stdout = $stdout
+
+  # Redirect stderr and stdout
+  output = $stderr = $stdout = StringIO.new
+
+  yield
+
+  $stderr = original_stderr
+  $stdout = original_stdout
+
+  # Return output
+  output.string
+end

data/test_rails/system/test_help_test.rb

@@ -0,0 +1,52 @@
+require_relative "../helper"
+
+# Not worth trying to test on old Rails versions
+return unless Rails::VERSION::MAJOR >= 7
+
+require "capybara/cuprite"
+require "flipper"
+require "flipper/test_help"
+require "action_controller/railtie"
+
+require 'action_dispatch/system_testing/server'
+ActionDispatch::SystemTesting::Server.silence_puma = true
+
+class TestApp < Rails::Application
+  config.load_defaults "#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}"
+  config.eager_load = false
+  config.logger = ActiveSupport::Logger.new(StringIO.new)
+  routes.append do
+    root to: "features#index"
+  end
+end
+
+TestApp.initialize!
+
+class FeaturesController < ActionController::Base
+  def index
+    render json: Flipper.enabled?(:test) ? "Enabled" : "Disabled"
+  end
+end
+
+class TestHelpTest < ActionDispatch::SystemTestCase
+  # Any driver that runs the app in a separate thread will test what we want here.
+  driven_by :cuprite, options: { process_timeout: 60 }
+
+  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)
+    visit "/"
+    assert_selector "*", text: "Disabled"
+
+    Flipper.enable(:test)
+    visit "/"
+    assert_selector "*", text: "Enabled"
+  end
+end