flipper 1.0.0 → 1.3.6

data/lib/flipper/cli.rb

@@ -0,0 +1,263 @@
+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"
+
+    attr_accessor :shell
+
+    def initialize(stdout: $stdout, stderr: $stderr, shell: Bundler::Thor::Base.shell.new)
+      super
+
+      # Program is always flipper, no matter how it's invoked
+      @program_name = 'flipper'
+      @require = ENV.fetch("FLIPPER_REQUIRE", DEFAULT_REQUIRE)
+      @commands = {}
+
+      # Extend whatever shell to support output redirection
+      @shell = shell.extend(ShellOutput)
+      shell.redirect(stdout: stdout, stderr: stderr)
+
+      %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
+              ui.error "JSON parse error #{e.message}"
+              ui.trace(e)
+              exit 1
+            rescue ArgumentError => e
+              ui.error "Invalid expression: #{e.message}"
+              ui.trace(e)
+              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
+
+            ui.info feature_details(f)
+          end
+        end
+      end
+
+      command 'list' do |c|
+        c.description = "List defined features"
+        c.action do
+          ui.info feature_summary(Flipper.features)
+        end
+      end
+
+      command 'show' do |c|
+        c.description = "Show a defined feature"
+        c.action do |feature|
+          ui.info feature_details(Flipper.feature(feature))
+        end
+      end
+
+      command 'help' do |c|
+        c.load_environment = false
+        c.action do |command = nil|
+          ui.info 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
+        ui.info 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
+        ui.info help
+
+        if command
+          ui.error "Unknown command: #{command}"
+          exit 1
+        end
+      end
+    rescue OptionParser::InvalidOption => e
+      ui.error 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
+      ui.error 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.join("\n")
+    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, colors)
+      ui.add_color(text, *colors)
+    end
+
+    def ui
+      @ui ||= Bundler::UI::Shell.new.tap do |ui|
+        ui.shell = shell
+      end
+    end
+
+    def indent(text, spaces)
+      text.gsub(/^/, " " * spaces)
+    end
+
+    # Redirect the shell's output to the given stdout and stderr streams
+    module ShellOutput
+      attr_reader :stdout, :stderr
+
+      def redirect(stdout: $stdout, stderr: $stderr)
+        @stdout, @stderr = stdout, stderr
+      end
+    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

@@ -1,12 +1,13 @@
+require "logger"
 require "socket"
 require "flipper/adapters/http"
 require "flipper/adapters/poll"
 require "flipper/poller"
-require "flipper/adapters/memory"
 require "flipper/adapters/dual_write"
 require "flipper/adapters/sync/synchronizer"
-require "flipper/cloud/instrumenter"
-require "brow"
+require "flipper/cloud/telemetry"
+require "flipper/cloud/telemetry/instrumenter"
+require "flipper/cloud/telemetry/submitter"
 
 module Flipper
   module Cloud
@@ -19,18 +20,13 @@ module Flipper
 
       DEFAULT_URL = "https://www.flippercloud.io/adapter".freeze
 
-      # Private: Keeps track of brow instances so they can be shared across
-      # threads.
-      def self.brow_instances
-        @brow_instances ||= Concurrent::Map.new
-      end
-
       # Public: The token corresponding to an environment on flippercloud.io.
       attr_accessor :token
 
       # Public: The url for http adapter. Really should only be customized for
-       #        development work. Feel free to forget you ever saw this.
-      attr_reader :url
+      #         development work if you are me and you are not me. Feel free to
+      #         forget you ever saw this.
+      attr_accessor :url
 
       # Public: net/http read timeout for all http requests (default: 5).
       attr_accessor :read_timeout
@@ -73,32 +69,25 @@ module Flipper
       # occur or not.
       attr_accessor :sync_secret
 
-      def initialize(options = {})
-        @token = options.fetch(:token) { ENV["FLIPPER_CLOUD_TOKEN"] }
+      # Public: The logger to use for debugging inner workings.
+      attr_accessor :logger
 
-        if @token.nil?
-          raise ArgumentError, "Flipper::Cloud token is missing. Please set FLIPPER_CLOUD_TOKEN or provide the token (e.g. Flipper::Cloud.new(token: 'token'))."
-        end
+      # Public: Should the logger log or not (default: true).
+      attr_accessor :logging_enabled
 
-        @read_timeout = options.fetch(:read_timeout) { ENV.fetch("FLIPPER_CLOUD_READ_TIMEOUT", 5).to_f }
-        @open_timeout = options.fetch(:open_timeout) { ENV.fetch("FLIPPER_CLOUD_OPEN_TIMEOUT", 5).to_f }
-        @write_timeout = options.fetch(:write_timeout) { ENV.fetch("FLIPPER_CLOUD_WRITE_TIMEOUT", 5).to_f }
-        @sync_interval = options.fetch(:sync_interval) { ENV.fetch("FLIPPER_CLOUD_SYNC_INTERVAL", 10).to_f }
-        @sync_secret = options.fetch(:sync_secret) { ENV["FLIPPER_CLOUD_SYNC_SECRET"] }
-        @local_adapter = options.fetch(:local_adapter) { Adapters::Memory.new }
-        @debug_output = options[:debug_output]
-        @adapter_block = ->(adapter) { adapter }
-        self.url = options.fetch(:url) { ENV.fetch("FLIPPER_CLOUD_URL", DEFAULT_URL) }
+      # Public: The telemetry instance to use for tracking feature usage.
+      attr_accessor :telemetry
 
-        instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
+      # Public: Should telemetry be enabled or not (default: false).
+      attr_accessor :telemetry_enabled
 
-        # This is alpha. Don't use this unless you are me. And you are not me.
-        cloud_instrument = options.fetch(:cloud_instrument) { ENV["FLIPPER_CLOUD_INSTRUMENT"] == "1" }
-        @instrumenter = if cloud_instrument
-          Instrumenter.new(brow: brow, instrumenter: instrumenter)
-        else
-          instrumenter
-        end
+      def initialize(options = {})
+        setup_auth options
+        setup_log options
+        setup_http options
+        setup_sync options
+        setup_adapter options
+        setup_telemetry options
       end
 
       # Public: Read or customize the http adapter. Calling without a block will
@@ -120,38 +109,35 @@ module Flipper
         end
       end
 
-      # Public: Set url for the http adapter.
-      attr_writer :url
-
+      # Public: Force a sync.
       def sync
         Flipper::Adapters::Sync::Synchronizer.new(local_adapter, http_adapter, {
           instrumenter: instrumenter,
         }).call
       end
 
-      def brow
-        self.class.brow_instances.compute_if_absent(url + token) do
-          uri = URI.parse(url)
-          uri.path = "#{uri.path}/events".squeeze("/")
-
-          Brow::Client.new({
-            url: uri.to_s,
-            headers: {
-              "Accept" => "application/json",
-              "Content-Type" => "application/json",
-              "User-Agent" => "Flipper v#{VERSION} via Brow v#{Brow::VERSION}",
-              "Flipper-Cloud-Token" => @token,
-            }
-          })
-        end
-      end
-
       # Public: The method that will be used to synchronize local adapter with
       # cloud. (default: :poll, will be :webhook if sync_secret is set).
       def sync_method
         sync_secret ? :webhook : :poll
       end
 
+      # Internal: The http client used by the http adapter. Exposed so we can
+      # use the same client for posting telemetry.
+      def http_client
+        http_adapter.client
+      end
+
+      # Internal: Logs message if logging is enabled.
+      def log(message, level: :debug)
+        return unless logging_enabled
+        logger.send(level, "name=flipper_cloud #{message}")
+      end
+
+      def instrument(name, payload = {}, &block)
+        instrumenter.instrument(name, payload, &block)
+      end
+
       private
 
       def app_adapter
@@ -180,10 +166,101 @@ 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
+
+      def setup_auth(options)
+        set_option :token, options, required: true
+      end
+
+      def setup_log(options)
+        set_option :logging_enabled, options, default: false, typecast: :boolean
+        set_option :logger, options, from_env: false, default: -> {
+          if logging_enabled
+            Logger.new(STDOUT)
+          else
+            Logger.new("/dev/null")
+          end
+        }
+      end
+
+      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
+      end
+
+      def setup_sync(options)
+        set_option :sync_interval, options, default: 10, typecast: :float, minimum: 10
+        set_option :sync_secret, options
+      end
+
+      def setup_adapter(options)
+        set_option :local_adapter, options, default: -> { Adapters::Memory.new }, from_env: false
+        @adapter_block = ->(adapter) { adapter }
+      end
+
+      def setup_telemetry(options)
+        # Needs to be after url and token assignments because they are used for
+        # uniqueness in Telemetry.instance_for.
+        set_option :telemetry, options, from_env: false, default: -> {
+          Telemetry.instance_for(self)
+        }
+
+        set_option :telemetry_enabled, options, default: true, typecast: :boolean
+        instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
+        @instrumenter = if telemetry_enabled
+          Telemetry::Instrumenter.new(self, instrumenter)
+        else
+          instrumenter
+        end
+      end
+
+      # Internal: Super helper for defining an option that can be set via
+      # options hash or ENV with defaults, typecasting and minimums.
+      def set_option(name, options, default: nil, typecast: nil, minimum: nil, from_env: true, required: false)
+        env_var = "FLIPPER_CLOUD_#{name.to_s.upcase}"
+        value = options.fetch(name) {
+          default_value = default.respond_to?(:call) ? default.call : default
+          if from_env
+            ENV.fetch(env_var, default_value)
+          else
+            default_value
+          end
+        }
+        value = Flipper::Typecast.send("to_#{typecast}", value) if typecast
+        send("#{name}=", value)
+        enforce_minimum(name, minimum) if minimum
+
+        if required
+          option_value = send(name)
+          if option_value.nil? || option_value.empty?
+            message = String.new("Flipper::Cloud #{name} is missing. Please ")
+            message << "set #{env_var} or " if from_env
+            message << "provide #{name} (e.g. Flipper::Cloud.new(#{name}: value))."
+            raise ArgumentError, message
+          end
+        end
+      end
+
+      # Enforce minimum interval for tasks that run on a timer.
+      def enforce_minimum(name, minimum)
+        provided = send(name)
+        if provided && provided < minimum
+          warn "Flipper::Cloud##{name} must be at least #{minimum} seconds but was #{provided}. Using #{minimum} seconds."
+          send(:instance_variable_set, "@#{name}", minimum)
+        end
+      end
     end
   end
 end

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/backoff_policy.rb

@@ -0,0 +1,96 @@
+module Flipper
+  module Cloud
+    class Telemetry
+      class BackoffPolicy
+        # Private: The default minimum timeout between intervals in milliseconds.
+        MIN_TIMEOUT_MS = 30_000
+
+        # Private: The default maximum timeout between intervals in milliseconds.
+        MAX_TIMEOUT_MS = 120_000
+
+        # Private: The value to multiply the current interval with for each
+        # retry attempt.
+        MULTIPLIER = 1.5
+
+        # Private: The randomization factor to use to create a range around the
+        # retry interval.
+        RANDOMIZATION_FACTOR = 0.5
+
+        # Private
+        attr_reader :min_timeout_ms, :max_timeout_ms, :multiplier, :randomization_factor
+
+        # Private
+        attr_reader :attempts
+
+        # Public: Create new instance of backoff policy.
+        #
+        # options - The Hash of options.
+        #   :min_timeout_ms - The minimum backoff timeout.
+        #   :max_timeout_ms - The maximum backoff timeout.
+        #   :multiplier - The value to multiply the current interval with for each
+        #                 retry attempt.
+        #   :randomization_factor - The randomization factor to use to create a range
+        #                           around the retry interval.
+        def initialize(options = {})
+          @min_timeout_ms = options.fetch(:min_timeout_ms) {
+            ENV.fetch("FLIPPER_BACKOFF_MIN_TIMEOUT_MS", MIN_TIMEOUT_MS).to_i
+          }
+          @max_timeout_ms = options.fetch(:max_timeout_ms) {
+            ENV.fetch("FLIPPER_BACKOFF_MAX_TIMEOUT_MS", MAX_TIMEOUT_MS).to_i
+          }
+          @multiplier = options.fetch(:multiplier) {
+            ENV.fetch("FLIPPER_BACKOFF_MULTIPLIER", MULTIPLIER).to_f
+          }
+          @randomization_factor = options.fetch(:randomization_factor) {
+            ENV.fetch("FLIPPER_BACKOFF_RANDOMIZATION_FACTOR", RANDOMIZATION_FACTOR).to_f
+          }
+
+          unless @min_timeout_ms >= 0
+            raise ArgumentError, ":min_timeout_ms must be >= 0 but was #{@min_timeout_ms.inspect}"
+          end
+
+          unless @max_timeout_ms >= 0
+            raise ArgumentError, ":max_timeout_ms must be >= 0 but was #{@max_timeout_ms.inspect}"
+          end
+
+          unless @min_timeout_ms <= max_timeout_ms
+            raise ArgumentError, ":min_timeout_ms (#{@min_timeout_ms.inspect}) must be <= :max_timeout_ms (#{@max_timeout_ms.inspect})"
+          end
+
+          @attempts = 0
+        end
+
+        # Public: Returns the next backoff interval in milliseconds.
+        def next_interval
+          interval = @min_timeout_ms * (@multiplier**@attempts)
+          interval = add_jitter(interval, @randomization_factor)
+
+          @attempts += 1
+
+          # cap the interval to the max timeout
+          result = [interval, @max_timeout_ms].min
+          # jitter even when maxed out
+          result == @max_timeout_ms ? add_jitter(result, 0.05) : result
+        end
+
+        def reset
+          @attempts = 0
+        end
+
+        private
+
+        def add_jitter(base, randomization_factor)
+          random_number = rand
+          max_deviation = base * randomization_factor
+          deviation = random_number * max_deviation
+
+          if random_number < 0.5
+            base - deviation
+          else
+            base + deviation
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require "delegate"
+
+module Flipper
+  module Cloud
+    class Telemetry
+      class Instrumenter
+        attr_reader :instrumenter
+
+        def initialize(cloud_configuration, instrumenter)
+          @instrumenter = instrumenter
+          @cloud_configuration = cloud_configuration
+        end
+
+        def instrument(name, payload = {}, &block)
+          return_value = instrumenter.instrument(name, payload, &block)
+          @cloud_configuration.telemetry.record(name, payload)
+          return_value
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Flipper
+  module Cloud
+    class Telemetry
+      class Metric
+        attr_reader :key, :time, :result
+
+        def initialize(key, result, time = Time.now)
+          @key = key
+          @result = result
+          @time = time.to_i / 60 * 60
+        end
+
+        def as_json(options = {})
+          data = {
+            "key" => key.to_s,
+            "time" => time,
+            "result" => result,
+          }
+
+          if options[:with]
+            data.merge!(options[:with])
+          end
+
+          data
+        end
+
+        def eql?(other)
+          self.class.eql?(other.class) &&
+            @key == other.key && @time == other.time && @result == other.result
+        end
+        alias :== :eql?
+
+        def hash
+          [self.class, @key, @time, @result].hash
+        end
+      end
+    end
+  end
+end