flipper 1.1.2 → 1.2.1

data/Gemfile

@@ -13,7 +13,7 @@ gem 'rspec', '~> 3.0'
 gem 'rack-test'
 gem 'rackup'
 gem 'sqlite3', "~> #{ENV['SQLITE3_VERSION'] || '1.4.1'}"
-gem 'rails', "~> #{ENV['RAILS_VERSION'] || '7.0.4'}"
+gem 'rails', "~> #{ENV['RAILS_VERSION'] || '7.1'}"
 gem 'minitest', '~> 5.18'
 gem 'minitest-documentation'
 gem 'webmock'
@@ -27,6 +27,8 @@ gem 'flamegraph'
 gem 'climate_control'
 gem 'mysql2'
 gem 'pg'
+gem 'cuprite'
+gem 'puma'
 
 group(:guard) do
   gem 'guard'

data/README.md

@@ -99,7 +99,7 @@ We also have a [free plan](https://www.flippercloud.io?utm_source=oss&utm_medium
 
 1. Update the version to be whatever it should be and commit.
 2. `script/release`
-3. Profit.
+3. Create a new [GitHub Release](https://github.com/flippercloud/flipper/releases/new)
 
 ## Brought To You By
 

data/Rakefile

@@ -27,7 +27,8 @@ end
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = %w(--color --format documentation)
+  t.rspec_opts = %w(--color)
+  t.verbose = false
 end
 
 namespace :spec do
@@ -41,7 +42,6 @@ end
 Rake::TestTask.new do |t|
   t.libs = %w(lib test)
   t.pattern = 'test/**/*_test.rb'
-  t.options = '--documentation'
   t.warning = false
 end
 

data/exe/flipper

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "flipper/cli"
+
+Flipper::CLI.run(ARGV)

data/flipper.gemspec

@@ -6,7 +6,7 @@ plugin_files = []
 plugin_test_files = []
 
 Dir['flipper-*.gemspec'].map do |gemspec|
-  spec = eval(File.read(gemspec))
+  spec = Gem::Specification.load(gemspec)
   plugin_files << spec.files
   plugin_test_files << spec.files
 end
@@ -27,6 +27,8 @@ Gem::Specification.new do |gem|
   gem.homepage      = 'https://www.flippercloud.io/docs'
   gem.license       = 'MIT'
 
+  gem.bindir = "exe"
+  gem.executables   = `git ls-files -- exe/*`.split("\n").map { |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n") - ignored_files + ['lib/flipper/version.rb']
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n") - ignored_test_files
   gem.name          = 'flipper'
@@ -35,4 +37,6 @@ Gem::Specification.new do |gem|
   gem.metadata      = Flipper::METADATA
 
   gem.add_dependency 'concurrent-ruby', '< 2'
+
+  gem.required_ruby_version = ">= #{Flipper::REQUIRED_RUBY_VERSION}"
 end

data/lib/flipper/adapters/http/client.rb

@@ -7,26 +7,28 @@ module Flipper
     class Http
       class Client
         DEFAULT_HEADERS = {
-          'Content-Type' => 'application/json',
-          'Accept' => 'application/json',
-          'User-Agent' => "Flipper HTTP Adapter v#{VERSION}",
+          'content-type' => 'application/json',
+          'accept' => 'application/json',
+          'user-agent' => "Flipper HTTP Adapter v#{VERSION}",
         }.freeze
 
         HTTPS_SCHEME = "https".freeze
 
         CLIENT_FRAMEWORKS = {
-          rails: -> { Rails.version if defined?(Rails) },
-          sinatra: -> { Sinatra::VERSION if defined?(Sinatra) },
-          hanami: -> { Hanami::VERSION if defined?(Hanami) },
+          rails:    -> { Rails.version if defined?(Rails) },
+          sinatra:  -> { Sinatra::VERSION if defined?(Sinatra) },
+          hanami:   -> { Hanami::VERSION if defined?(Hanami) },
+          sidekiq:  -> { Sidekiq::VERSION if defined?(Sidekiq) },
+          good_job: -> { GoodJob::VERSION if defined?(GoodJob) },
         }
 
         attr_reader :uri, :headers
         attr_reader :basic_auth_username, :basic_auth_password
-        attr_reader :read_timeout, :open_timeout, :write_timeout, :max_retries, :debug_output
+        attr_reader :read_timeout, :open_timeout, :write_timeout
+        attr_reader :max_retries, :debug_output
 
         def initialize(options = {})
           @uri = URI(options.fetch(:url))
-          @headers = DEFAULT_HEADERS.merge(options[:headers] || {})
           @basic_auth_username = options[:basic_auth_username]
           @basic_auth_password = options[:basic_auth_password]
           @read_timeout = options[:read_timeout]
@@ -34,9 +36,16 @@ module Flipper
           @write_timeout = options[:write_timeout]
           @max_retries = options.key?(:max_retries) ? options[:max_retries] : 0
           @debug_output = options[:debug_output]
+
+          @headers = {}
+          DEFAULT_HEADERS.each { |key, value| add_header key, value }
+          if options[:headers]
+            options[:headers].each { |key, value| add_header key, value }
+          end
         end
 
         def add_header(key, value)
+          key = key.to_s.downcase.gsub('_'.freeze, '-'.freeze).freeze
           @headers[key] = value
         end
 
@@ -87,13 +96,13 @@ module Flipper
 
         def build_request(http_method, uri, headers, options)
           request_headers = {
-            client_language: "ruby",
-            client_language_version: "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
-            client_platform: RUBY_PLATFORM,
-            client_engine: defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
-            client_pid: Process.pid.to_s,
-            client_thread: Thread.current.object_id.to_s,
-            client_hostname: Socket.gethostname,
+            'client-language' => "ruby",
+            'client-language-version' => "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
+            'client-platform' => RUBY_PLATFORM,
+            'client-engine' => defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
+            'client-pid' => Process.pid.to_s,
+            'client-thread' => Thread.current.object_id.to_s,
+            'client-hostname' => Socket.gethostname,
           }.merge(headers)
 
           body = options[:body]
@@ -101,7 +110,7 @@ module Flipper
           request.initialize_http_header(request_headers)
 
           client_frameworks.each do |framework, version|
-            request.add_field("Client-Framework", [framework, version].join("="))
+            request.add_field("client-framework", [framework, version].join("="))
           end
 
           request.body = body if body

data/lib/flipper/adapters/strict.rb

@@ -12,18 +12,12 @@ module Flipper
         end
       end
 
-      HANDLERS = {
-        raise: ->(feature) { raise NotFound.new(feature.key) },
-        warn: ->(feature) { warn NotFound.new(feature.key).message },
-        noop: ->(_) { },
-      }
-
       def_delegators :@adapter, :features, :get_all, :add, :remove, :clear, :enable, :disable
 
       def initialize(adapter, handler = nil, &block)
         @name = :strict
         @adapter = adapter
-        @handler = block || HANDLERS.fetch(handler)
+        @handler = block || handler
       end
 
       def get(feature)
@@ -39,7 +33,16 @@ module Flipper
       private
 
       def assert_feature_exists(feature)
-        @handler.call(feature) unless @adapter.features.include?(feature.key)
+        return if @adapter.features.include?(feature.key)
+
+        case handler
+        when Proc then handler.call(feature)
+        when :warn then warn NotFound.new(feature.key).message
+        when :noop, false, nil
+         # noop
+        else # truthy or :raise
+         raise NotFound.new(feature.key)
+        end
       end
 
     end

data/lib/flipper/cli.rb

@@ -0,0 +1,240 @@
+require 'optparse'
+
+module Flipper
+  class CLI < OptionParser
+    def self.run(argv = ARGV)
+      new.run(argv)
+    end
+
+    # Path to the local Rails application's environment configuration.
+    DEFAULT_REQUIRE = "./config/environment"
+
+    def initialize
+      super
+
+      # Program is always flipper, no matter how it's invoked
+      @program_name = 'flipper'
+      @require = ENV.fetch("FLIPPER_REQUIRE", DEFAULT_REQUIRE)
+      @commands = {}
+
+      %w[enable disable].each do |action|
+        command action do |c|
+          c.banner = "Usage: #{c.program_name} [options] <feature>"
+          c.description = "#{action.to_s.capitalize} a feature"
+
+          values = []
+
+          c.on('-a id', '--actor=id', "#{action} for an actor") do |id|
+            values << Actor.new(id)
+          end
+          c.on('-g name', '--group=name', "#{action} for a group") do |name|
+            values << Types::Group.new(name)
+          end
+          c.on('-p NUM', '--percentage-of-actors=NUM', Numeric, "#{action} for a percentage of actors") do |num|
+            values << Types::PercentageOfActors.new(num)
+          end
+          c.on('-t NUM', '--percentage-of-time=NUM', Numeric, "#{action} for a percentage of time") do |num|
+            values << Types::PercentageOfTime.new(num)
+          end
+          c.on('-x expressions', '--expression=NUM', "#{action} for the given expression") do |expression|
+            begin
+              values << Flipper::Expression.build(JSON.parse(expression))
+            rescue JSON::ParserError => e
+              warn "JSON parse error: #{e.message}"
+              exit 1
+            rescue ArgumentError => e
+              warn "Invalid expression: #{e.message}"
+              exit 1
+            end
+          end
+
+          c.action do |feature|
+            f = Flipper.feature(feature)
+
+            if values.empty?
+              f.send(action)
+            else
+              values.each { |value| f.send(action, value) }
+            end
+
+            puts feature_details(f)
+          end
+        end
+      end
+
+      command 'list' do |c|
+        c.description = "List defined features"
+        c.action do
+          puts feature_summary(Flipper.features)
+        end
+      end
+
+      command 'show' do |c|
+        c.description = "Show a defined feature"
+        c.action do |feature|
+          puts feature_details(Flipper.feature(feature))
+        end
+      end
+
+      command 'help' do |c|
+        c.load_environment = false
+        c.action do |command = nil|
+          puts command ? @commands[command].help : help
+        end
+      end
+
+      on_tail('-r path', "The path to load your application. Default: #{@require}") do |path|
+        @require = path
+      end
+
+      # Options available on all commands
+      on_tail('-h', '--help', 'Print help message') do
+        puts help
+        exit
+      end
+
+      # Set help documentation
+      self.banner = "Usage: #{program_name} [options] <command>"
+      separator ""
+      separator "Commands:"
+
+      pad = @commands.keys.map(&:length).max + 2
+      @commands.each do |name, command|
+        separator "  #{name.to_s.ljust(pad, " ")} #{command.description}" if command.description
+      end
+
+      separator ""
+      separator "Options:"
+    end
+
+    def run(argv)
+      command, *args = order(argv)
+
+      if @commands[command]
+        load_environment! if @commands[command].load_environment
+        @commands[command].run(args)
+      else
+        puts help
+
+        if command
+          warn "Unknown command: #{command}"
+          exit 1
+        end
+      end
+    rescue OptionParser::InvalidOption => e
+      warn e.message
+      exit 1
+    end
+
+    # Helper method to define a new command
+    def command(name, &block)
+      @commands[name] = Command.new(program_name: "#{program_name} #{name}")
+      block.call(@commands[name])
+    end
+
+    def load_environment!
+      ENV["FLIPPER_CLOUD_LOGGING_ENABLED"] ||= "false"
+      require File.expand_path(@require)
+      # Ensure all of flipper gets loaded if it hasn't already.
+      require 'flipper'
+    rescue LoadError => e
+      warn e.message
+      exit 1
+    end
+
+    def feature_summary(features)
+      features = Array(features)
+      padding = features.map { |f| f.key.to_s.length }.max
+
+      features.map do |feature|
+        summary = case feature.state
+        when :on
+          colorize("⏺ enabled", [:GREEN])
+        when :off
+          "⦸ disabled"
+        else
+            "#{colorize("◯ enabled", [:YELLOW])} for " + feature.enabled_gates.map do |gate|
+            case gate.name
+            when :actor
+              pluralize feature.actors_value.size, 'actor', 'actors'
+            when :group
+              pluralize feature.groups_value.size, 'group', 'groups'
+            when :percentage_of_actors
+              "#{feature.percentage_of_actors_value}% of actors"
+            when :percentage_of_time
+              "#{feature.percentage_of_time_value}% of time"
+            when :expression
+              "an expression"
+            end
+          end.join(', ')
+        end
+
+        colorize("%-#{padding}s" % feature.key, [:BOLD, :WHITE]) + " is #{summary}"
+      end
+    end
+
+    def feature_details(feature)
+      summary = case feature.state
+      when :on
+        colorize("⏺ enabled", [:GREEN])
+      when :off
+        "⦸ disabled"
+      else
+        lines = feature.enabled_gates.map do |gate|
+          case gate.name
+          when :actor
+            [ pluralize(feature.actors_value.size, 'actor', 'actors') ] +
+            feature.actors_value.map { |actor| "- #{actor}" }
+          when :group
+            [ pluralize(feature.groups_value.size, 'group', 'groups') ] +
+            feature.groups_value.map { |group| "  - #{group}" }
+          when :percentage_of_actors
+            "#{feature.percentage_of_actors_value}% of actors"
+          when :percentage_of_time
+            "#{feature.percentage_of_time_value}% of time"
+          when :expression
+            json = indent(JSON.pretty_generate(feature.expression_value), 2)
+            "the expression: \n#{colorize(json, [:MAGENTA])}"
+          end
+        end
+
+        "#{colorize("◯ conditionally enabled", [:YELLOW])} for:\n" +
+        indent(lines.flatten.join("\n"), 2)
+      end
+
+      "#{colorize(feature.key, [:BOLD, :WHITE])} is #{summary}"
+    end
+
+    def pluralize(count, singular, plural)
+      "#{count} #{count == 1 ? singular : plural}"
+    end
+
+    def colorize(text, options)
+      IRB::Color.colorize(text, options)
+    end
+
+    def indent(text, spaces)
+      text.gsub(/^/, " " * spaces)
+    end
+
+    class Command < OptionParser
+      attr_accessor :description, :load_environment
+
+      def initialize(program_name: nil)
+        super()
+        @program_name = program_name
+        @load_environment = true
+        @action = lambda { }
+      end
+
+      def run(argv)
+        # Parse argv and call action with arguments
+        @action.call(*permute(argv))
+      end
+
+      def action(&block)
+        @action = block
+      end
+    end
+  end
+end

data/lib/flipper/cloud/configuration.rb

@@ -163,7 +163,8 @@ module Flipper
           max_retries: 0, # we'll handle retries ourselves
           debug_output: @debug_output,
           headers: {
-            "Flipper-Cloud-Token" => @token,
+            "flipper-cloud-token" => @token,
+            "accept-encoding" => "gzip",
           },
         })
       end
@@ -186,6 +187,11 @@ module Flipper
       def setup_http(options)
         set_option :url, options, default: DEFAULT_URL
         set_option :debug_output, options, from_env: false
+
+        if @debug_output.nil? && Flipper::Typecast.to_boolean(ENV["FLIPPER_CLOUD_DEBUG_OUTPUT_STDOUT"])
+          @debug_output = STDOUT
+        end
+
         set_option :read_timeout, options, default: 5, typecast: :float, minimum: 0.1
         set_option :open_timeout, options, default: 2, typecast: :float, minimum: 0.1
         set_option :write_timeout, options, default: 5, typecast: :float, minimum: 0.1

data/lib/flipper/cloud/middleware.rb

@@ -24,7 +24,7 @@ module Flipper
         if request.post? && (request.path_info.match(ROOT_PATH) || request.path_info.match(WEBHOOK_PATH))
           status = 200
           headers = {
-            "content-type" => "application/json",
+            Rack::CONTENT_TYPE => "application/json",
           }
           body = "{}"
           payload = request.body.read
@@ -41,12 +41,12 @@ module Flipper
                 })
               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
+                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
+                headers["flipper-cloud-response-error-class"] = error.class.name
+                headers["flipper-cloud-response-error-message"] = error.message
               end
             end
           rescue MessageVerifier::InvalidSignature

data/lib/flipper/cloud/telemetry/submitter.rb

@@ -78,8 +78,8 @@ module Flipper
 
         def submit(body)
           client = @cloud_configuration.http_client
-          client.add_header :schema_version, SCHEMA_VERSION
-          client.add_header :content_encoding, GZIP_ENCODING
+          client.add_header "schema-version", SCHEMA_VERSION
+          client.add_header "content-encoding", GZIP_ENCODING
 
           response = client.post PATH, body
           code = response.code.to_i

data/lib/flipper/cloud.rb

@@ -24,7 +24,7 @@ module Flipper
       env_key = options.fetch(:env_key, 'flipper')
       memoizer_options = options.fetch(:memoizer_options, {})
 
-      app = ->(_) { [404, { 'content-type'.freeze => 'application/json'.freeze }, ['{}'.freeze]] }
+      app = ->(_) { [404, { Rack::CONTENT_TYPE => 'application/json'.freeze }, ['{}'.freeze]] }
       builder = Rack::Builder.new
       yield builder if block_given?
       builder.use Flipper::Middleware::SetupEnv, flipper, env_key: env_key

data/lib/flipper/engine.rb

@@ -1,5 +1,19 @@
 module Flipper
   class Engine < Rails::Engine
+    def self.default_strict_value
+      value = ENV["FLIPPER_STRICT"]
+      if value.in?(["warn", "raise", "noop"])
+        value.to_sym
+      elsif value
+        Typecast.to_boolean(value) ? :raise : false
+      elsif Rails.env.production?
+        false
+      else
+        # Warn in development for now. Future versions may default to :raise in development and test
+        Rails.env.development? && :warn
+      end
+    end
+
     paths["config/routes.rb"] = ["lib/flipper/cloud/routes.rb"]
 
     config.before_configuration do
@@ -10,7 +24,8 @@ module Flipper
         instrumenter: ENV.fetch('FLIPPER_INSTRUMENTER', 'ActiveSupport::Notifications').constantize,
         log: ENV.fetch('FLIPPER_LOG', 'true').casecmp('true').zero?,
         cloud_path: "_flipper",
-        strict: default_strict_value
+        strict: default_strict_value,
+        test_help: Flipper::Typecast.to_boolean(ENV["FLIPPER_TEST_HELP"] || Rails.env.test?),
       )
     end
 
@@ -29,10 +44,6 @@ module Flipper
       require 'flipper/cloud' if cloud?
 
       Flipper.configure do |config|
-        if app.config.flipper.strict
-          config.use Flipper::Adapters::Strict, app.config.flipper.strict
-        end
-
         config.default do
           if cloud?
             Flipper::Cloud.new(
@@ -54,6 +65,16 @@ module Flipper
       end
     end
 
+    initializer "flipper.strict", after: :load_config_initializers do |app|
+      flipper = app.config.flipper
+
+      if flipper.strict
+        Flipper.configure do |config|
+          config.use Flipper::Adapters::Strict, flipper.strict
+        end
+      end
+    end
+
     initializer "flipper.memoizer", after: :load_config_initializers do |app|
       flipper = app.config.flipper
 
@@ -66,22 +87,16 @@ module Flipper
       end
     end
 
+    initializer "flipper.test" do |app|
+      require "flipper/test_help" if app.config.flipper.test_help
+    end
+
     def cloud?
       !!ENV["FLIPPER_CLOUD_TOKEN"]
     end
 
-    def self.default_strict_value
-      value = ENV["FLIPPER_STRICT"]
-      if value.in?(["warn", "raise", "noop"])
-        value.to_sym
-      elsif value
-        Typecast.to_boolean(value) ? :raise : false
-      elsif Rails.env.production?
-        false
-      else
-        # Warn for now. Future versions will default to :raise in development and test
-        :warn
-      end
+    def self.deprecated_rails_version?
+      Gem::Version.new(Rails.version) < Gem::Version.new(Flipper::NEXT_REQUIRED_RAILS_VERSION)
     end
   end
 end

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