flipper 1.1.1 → 1.2.0

data/lib/flipper/instrumentation/log_subscriber.rb

@@ -1,4 +1,5 @@
 require 'securerandom'
+require 'active_support/gem_version'
 require 'active_support/notifications'
 require 'active_support/log_subscriber'
 
@@ -71,11 +72,19 @@ module Flipper
         self.class.logger
       end
 
+      def self.attach
+        attach_to InstrumentationNamespace
+      end
+
+      def self.detach
+        # Rails 5.2 doesn't support this, that's fine
+        detach_from InstrumentationNamespace if respond_to?(:detach_from)
+      end
+
       private
 
       # Rails 7.1 changed the signature of this function.
-      # Checking if > 7.0.99 rather than >= 7.1 so that 7.1 pre-release versions are included.
-      COLOR_OPTIONS = if Rails.gem_version > Gem::Version.new('7.0.99')
+      COLOR_OPTIONS = if Gem::Requirement.new(">=7.1").satisfied_by?(ActiveSupport.gem_version)
         { bold: true }.freeze
       else
         true
@@ -88,5 +97,5 @@ module Flipper
     end
   end
 
-  Instrumentation::LogSubscriber.attach_to InstrumentationNamespace
+  Instrumentation::LogSubscriber.attach
 end

data/lib/flipper/metadata.rb

@@ -1,9 +1,11 @@
+require_relative './version'
+
 module Flipper
   METADATA = {
     "documentation_uri" => "https://www.flippercloud.io/docs",
     "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/blob/main/Changelog.md",
+    "changelog_uri"     => "https://github.com/flippercloud/flipper/releases/tag/v#{Flipper::VERSION}",
   }.freeze
 end

data/lib/flipper/test_help.rb

@@ -0,0 +1,36 @@
+module Flipper
+  module TestHelp
+    def flipper_configure
+      # Create a single shared memory adapter instance for each test
+      @flipper_adapter = Flipper::Adapters::Memory.new
+
+      Flipper.configure do |config|
+        config.adapter { @flipper_adapter }
+        config.default { Flipper.new(config.adapter) }
+      end
+    end
+
+    def flipper_reset
+      Flipper.instance = nil # Reset previous flipper instance
+    end
+  end
+end
+
+if defined?(RSpec)
+  RSpec.configure do |config|
+    config.include Flipper::TestHelp
+    config.before(:all) { flipper_configure }
+    config.before(:each) { flipper_reset }
+  end
+end
+
+if defined?(ActiveSupport)
+  ActiveSupport.on_load(:active_support_test_case) do
+    ActiveSupport::TestCase.class_eval do
+      include Flipper::TestHelp
+
+      setup :flipper_configure
+      setup :flipper_reset
+    end
+  end
+end

data/lib/flipper/version.rb

@@ -1,3 +1,13 @@
 module Flipper
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.2.0'.freeze
+
+  REQUIRED_RUBY_VERSION = '2.6'.freeze
+  NEXT_REQUIRED_RUBY_VERSION = '3.0'.freeze
+
+  REQUIRED_RAILS_VERSION = '5.2'.freeze
+  NEXT_REQUIRED_RAILS_VERSION = '6.1.0'.freeze
+
+  def self.deprecated_ruby_version?
+    Gem::Version.new(RUBY_VERSION) < Gem::Version.new(NEXT_REQUIRED_RUBY_VERSION)
+  end
 end

data/lib/generators/flipper/setup_generator.rb

@@ -0,0 +1,63 @@
+require 'rails/generators/active_record'
+
+module Flipper
+  module Generators
+    class SetupGenerator < ::Rails::Generators::Base
+      desc 'Peform any necessary steps to install Flipper'
+
+      class_option :token, type: :string, default: nil, aliases: '-t',
+        desc: "Your personal environment token for Flipper Cloud"
+
+      def generate_active_record
+        invoke 'flipper:active_record' if defined?(Flipper::Adapters::ActiveRecord)
+      end
+
+      def configure_cloud_token
+        return unless options[:token]
+
+        configure_with_dotenv || configure_with_credentials
+      end
+
+      private
+
+      def configure_with_dotenv
+        ['.env.development', '.env.local', '.env'].detect do |file|
+          next unless exists?(file)
+          append_to_file file, "\nFLIPPER_CLOUD_TOKEN=#{options[:token]}\n"
+        end
+      end
+
+      def configure_with_credentials
+        return unless exists?("config/credentials.yml.enc") && (ENV["RAILS_MASTER_KEY"] || exists?("config/master.key"))
+
+        content = "flipper:\n  cloud_token: #{options[:token]}\n"
+        action InjectIntoEncryptedFile.new(self, Rails.application.credentials, content, after: /\z/)
+      end
+
+      # Check if a file exists in the destination root
+      def exists?(path)
+        File.exist?(File.expand_path(path, destination_root))
+      end
+
+      # Action to inject content into ActiveSupport::EncryptedFile
+      class InjectIntoEncryptedFile < Thor::Actions::InjectIntoFile
+        def initialize(base, encrypted_file, data, config)
+          @encrypted_file = encrypted_file
+          super(base, encrypted_file.content_path, data, config)
+        end
+
+        def content
+          @content ||= @encrypted_file.read
+        end
+
+        def replace!(regexp, string, force)
+          if force || !replacement_present?
+            success = content.gsub!(regexp, string)
+            @encrypted_file.write content unless pretend?
+            success
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/flipper/templates/update/migrations/01_create_flipper_tables.rb.erb

@@ -0,0 +1,22 @@
+class CreateFlipperTables < ActiveRecord::Migration<%= migration_version %>
+  def up
+    create_table :flipper_features do |t|
+      t.string :key, null: false
+      t.timestamps null: false
+    end
+    add_index :flipper_features, :key, unique: true
+
+    create_table :flipper_gates do |t|
+      t.string :feature_key, null: false
+      t.string :key, null: false
+      t.string :value
+      t.timestamps null: false
+    end
+    add_index :flipper_gates, [:feature_key, :key, :value], unique: true
+  end
+
+  def down
+    drop_table :flipper_gates
+    drop_table :flipper_features
+  end
+end

data/lib/generators/flipper/templates/update/migrations/02_change_flipper_gates_value_to_text.rb.erb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class ChangeFlipperGatesValueToText < ActiveRecord::Migration<%= migration_version %>
+  def up
+    # Ensure this incremental update migration is idempotent
+    return unless connection.column_exists? :flipper_gates, :value, :string
+
+    if index_exists? :flipper_gates, [:feature_key, :key, :value]
+      remove_index :flipper_gates, [:feature_key, :key, :value]
+    end
+    change_column :flipper_gates, :value, :text
+    add_index :flipper_gates, [:feature_key, :key, :value], unique: true, length: { value: 255 }
+  end
+
+  def down
+    change_column :flipper_gates, :value, :string
+  end
+end

data/lib/generators/flipper/update_generator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Flipper
+  module Generators
+    #
+    # Rails generator used for updating Flipper in a Rails application.
+    # Run it with +bin/rails g flipper:update+ in your console.
+    #
+    class UpdateGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      TEMPLATES = File.join(File.dirname(__FILE__), 'templates/update')
+      source_paths << TEMPLATES
+
+      # Generates incremental migration files unless they already exist.
+      # All migrations should be idempotent e.g. +add_index+ is guarded with +if_index_exists?+
+      def update_migration_files
+        migration_templates = Dir.children(File.join(TEMPLATES, 'migrations')).sort
+        migration_templates.each do |template_file|
+          destination_file = template_file.match(/^\d*_(.*\.rb)/)[1] # 01_create_flipper_tables.rb.erb => create_flipper_tables.rb
+          migration_template "migrations/#{template_file}", File.join(db_migrate_path, destination_file), skip: true
+        end
+      end
+
+      private
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::STRING.to_f}]"
+      end
+    end
+  end
+end

data/spec/fixtures/environment.rb

@@ -0,0 +1 @@
+# Placeholder for config/environment.rb

data/spec/flipper/adapter_builder_spec.rb

@@ -38,10 +38,9 @@ RSpec.describe Flipper::AdapterBuilder do
       strict_adapter = memoizable_adapter.adapter
       memory_adapter = strict_adapter.adapter
 
-
       expect(memoizable_adapter).to be_instance_of(Flipper::Adapters::Memoizable)
       expect(strict_adapter).to be_instance_of(Flipper::Adapters::Strict)
-      expect(strict_adapter.handler).to be(Flipper::Adapters::Strict::HANDLERS.fetch(:warn))
+      expect(strict_adapter.handler).to be(:warn)
       expect(memory_adapter).to be_instance_of(Flipper::Adapters::Memory)
     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

@@ -5,82 +5,91 @@ require 'rack/handler/webrick'
 FLIPPER_SPEC_API_PORT = ENV.fetch('FLIPPER_SPEC_API_PORT', 9001).to_i
 
 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
-
-      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)
+  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
+        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
+
+        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
 
   it "sends default headers" do
     headers = {
-      'Accept' => 'application/json',
-      'Content-Type' => 'application/json',
-      'User-Agent' => "Flipper HTTP Adapter v#{Flipper::VERSION}",
+      '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)
@@ -94,9 +103,17 @@ RSpec.describe Flipper::Adapters::Http 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")
 
     headers = {
-      "Client-Framework" => ["rails=7.1.0", "sinatra=3.1.0", "hanami=0.7.2"]
+      "client-framework" => [
+        "rails=7.1.0",
+        "sinatra=3.1.0",
+        "hanami=0.7.2",
+        "good_job=3.21.5",
+        "sidekiq=7.2.0",
+      ]
     }
 
     stub_request(:get, "http://app.com/flipper/features/feature_panel")
@@ -112,7 +129,7 @@ RSpec.describe Flipper::Adapters::Http do
     stub_const("Sinatra::VERSION", "3.1.0")
 
     headers = {
-      "Client-Framework" => ["rails=7.1.0", "sinatra=3.1.0"]
+      "client-framework" => ["rails=7.1.0", "sinatra=3.1.0"]
     }
 
     stub_request(:get, "http://app.com/flipper/features/feature_panel")
@@ -280,7 +297,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,
@@ -301,7 +318,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/strict_spec.rb

@@ -6,18 +6,20 @@ RSpec.describe Flipper::Adapters::Strict do
     subject { described_class.new(Flipper::Adapters::Memory.new, :noop) }
   end
 
-  context "handler = :raise" do
-    subject { described_class.new(Flipper::Adapters::Memory.new, :raise) }
+  [true, :raise].each do |handler|
+    context "handler = #{handler}" do
+      subject { described_class.new(Flipper::Adapters::Memory.new, handler) }
 
-    context "#get" do
-      it "raises an error for unknown feature" do
-        expect { subject.get(feature) }.to raise_error(Flipper::Adapters::Strict::NotFound)
+      context "#get" do
+        it "raises an error for unknown feature" do
+          expect { subject.get(feature) }.to raise_error(Flipper::Adapters::Strict::NotFound)
+        end
       end
-    end
 
-    context "#get_multi" do
-      it "raises an error for unknown feature" do
-        expect { subject.get_multi([feature]) }.to raise_error(Flipper::Adapters::Strict::NotFound)
+      context "#get_multi" do
+        it "raises an error for unknown feature" do
+          expect { subject.get_multi([feature]) }.to raise_error(Flipper::Adapters::Strict::NotFound)
+        end
       end
     end
   end