flipper 1.1.2 → 1.3.0

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'
@@ -24,9 +24,10 @@ gem 'stackprof'
 gem 'benchmark-ips'
 gem 'stackprof-webnav'
 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
 
@@ -111,3 +111,5 @@ We also have a [free plan](https://www.flippercloud.io?utm_source=oss&utm_medium
 | ![@alexwheeler](https://avatars3.githubusercontent.com/u/3260042?s=64) | [@alexwheeler](https://github.com/alexwheeler) | api         |
 | ![@thetimbanks](https://avatars1.githubusercontent.com/u/471801?s=64)  | [@thetimbanks](https://github.com/thetimbanks) | ui          |
 | ![@lazebny](https://avatars1.githubusercontent.com/u/6276766?s=64)     | [@lazebny](https://github.com/lazebny)         | docker      |
+| ![@pagertree](https://avatars.githubusercontent.com/u/24941240?s=64)   | [@pagertree](https://github.com/pagertree)   | sponsor     |
+| ![@kdaigle](https://avatars.githubusercontent.com/u/2501?s=64)   | [@kdaigle](https://github.com/kdaigle)   | sponsor     |

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

@@ -0,0 +1,28 @@
+module Flipper
+  module Adapters
+    class ActorLimit < Wrapper
+      LimitExceeded = Class.new(Flipper::Error)
+
+      attr_reader :limit
+
+      def initialize(adapter, limit = 100)
+        super(adapter)
+        @limit = limit
+      end
+
+      def enable(feature, gate, resource)
+        if gate.is_a?(Flipper::Gates::Actor) && over_limit?(feature)
+          raise LimitExceeded, "Actor limit of #{@limit} exceeded for feature #{feature.key}. See https://www.flippercloud.io/docs/features/actors#limitations"
+        else
+          super
+        end
+      end
+
+      private
+
+      def over_limit?(feature)
+        feature.actors_value.size >= @limit
+      end
+    end
+  end
+end

data/lib/flipper/adapters/cache_base.rb

@@ -0,0 +1,143 @@
+module Flipper
+  module Adapters
+    # Base class for caching adapters. Inherit from this and then override
+    # cache_fetch, cache_read_multi, cache_write, and cache_delete.
+    class CacheBase
+      include ::Flipper::Adapter
+
+      # Public: The adapter being cached.
+      attr_reader :adapter
+
+      # Public: The ActiveSupport::Cache::Store to cache with.
+      attr_reader :cache
+
+      # Public: The ttl for all cached data.
+      attr_reader :ttl
+
+      # Public: The cache key where the set of known features is cached.
+      attr_reader :features_cache_key
+
+      # Public: Alias expires_in to ttl for compatibility.
+      alias_method :expires_in, :ttl
+
+      def initialize(adapter, cache, ttl = 300, prefix: nil)
+        @adapter = adapter
+        @cache = cache
+        @ttl = ttl
+
+        @cache_version = 'v1'.freeze
+        @namespace = "flipper/#{@cache_version}"
+        @namespace = @namespace.prepend(prefix) if prefix
+        @features_cache_key = "#{@namespace}/features"
+      end
+
+      # Public: Expire the cache for the set of known feature names.
+      def expire_features_cache
+        cache_delete @features_cache_key
+      end
+
+      # Public: Expire the cache for a given feature.
+      def expire_feature_cache(key)
+        cache_delete feature_cache_key(key)
+      end
+
+      # Public
+      def features
+        read_feature_keys
+      end
+
+      # Public
+      def add(feature)
+        result = @adapter.add(feature)
+        expire_features_cache
+        result
+      end
+
+      # Public
+      def remove(feature)
+        result = @adapter.remove(feature)
+        expire_features_cache
+        expire_feature_cache(feature.key)
+        result
+      end
+
+      # Public
+      def clear(feature)
+        result = @adapter.clear(feature)
+        expire_feature_cache(feature.key)
+        result
+      end
+
+      # Public
+      def get(feature)
+        read_feature(feature)
+      end
+
+      # Public
+      def get_multi(features)
+        read_many_features(features)
+      end
+
+      # Public
+      def get_all
+        features = read_feature_keys.map { |key| Flipper::Feature.new(key, self) }
+        read_many_features(features)
+      end
+
+      # Public
+      def enable(feature, gate, thing)
+        result = @adapter.enable(feature, gate, thing)
+        expire_feature_cache(feature.key)
+        result
+      end
+
+      # Public
+      def disable(feature, gate, thing)
+        result = @adapter.disable(feature, gate, thing)
+        expire_feature_cache(feature.key)
+        result
+      end
+
+      # Public: Generate the cache key for a given feature.
+      #
+      # key - The String or Symbol feature key.
+      def feature_cache_key(key)
+        "#{@namespace}/feature/#{key}"
+      end
+
+      private
+
+      # Private: Returns the Set of known feature keys.
+      def read_feature_keys
+        cache_fetch(@features_cache_key) { @adapter.features }
+      end
+
+      # Private: Read through caching for a single feature.
+      def read_feature(feature)
+        cache_fetch(feature_cache_key(feature.key)) { @adapter.get(feature) }
+      end
+
+      # Private: Given an array of features, attempts to read through cache in
+      # as few network calls as possible.
+      def read_many_features(features)
+        keys = features.map { |feature| feature_cache_key(feature.key) }
+        cache_result = cache_read_multi(keys)
+        uncached_features = features.reject { |feature| cache_result[feature_cache_key(feature)] }
+
+        if uncached_features.any?
+          response = @adapter.get_multi(uncached_features)
+          response.each do |key, value|
+            cache_write feature_cache_key(key), value
+            cache_result[feature_cache_key(key)] = value
+          end
+        end
+
+        result = {}
+        features.each do |feature|
+          result[feature.key] = cache_result[feature_cache_key(feature.key)]
+        end
+        result
+      end
+    end
+  end
+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/operation_logger.rb

@@ -5,111 +5,34 @@ module Flipper
     # Public: Adapter that wraps another adapter and stores the operations.
     #
     # Useful in tests to verify calls and such. Never use outside of testing.
-    class OperationLogger
-      include Flipper::Adapter
+    class OperationLogger < Wrapper
 
       class Operation
-        attr_reader :type, :args
+        attr_reader :type, :args, :kwargs
 
-        def initialize(type, args)
+        def initialize(type, args, kwargs = {})
           @type = type
           @args = args
+          @kwargs = kwargs
         end
       end
 
-      OperationTypes = [
-        :import,
-        :export,
-        :features,
-        :add,
-        :remove,
-        :clear,
-        :get,
-        :get_multi,
-        :get_all,
-        :enable,
-        :disable,
-      ].freeze
-
       # Internal: An array of the operations that have happened.
       attr_reader :operations
 
       # Public
       def initialize(adapter, operations = nil)
-        @adapter = adapter
+        super(adapter)
         @operations = operations || []
       end
 
-      # Public: The set of known features.
-      def features
-        @operations << Operation.new(:features, [])
-        @adapter.features
-      end
-
-      # Public: Adds a feature to the set of known features.
-      def add(feature)
-        @operations << Operation.new(:add, [feature])
-        @adapter.add(feature)
-      end
-
-      # Public: Removes a feature from the set of known features and clears
-      # all the values for the feature.
-      def remove(feature)
-        @operations << Operation.new(:remove, [feature])
-        @adapter.remove(feature)
-      end
-
-      # Public: Clears all the gate values for a feature.
-      def clear(feature)
-        @operations << Operation.new(:clear, [feature])
-        @adapter.clear(feature)
-      end
-
-      # Public
-      def get(feature)
-        @operations << Operation.new(:get, [feature])
-        @adapter.get(feature)
-      end
-
-      # Public
-      def get_multi(features)
-        @operations << Operation.new(:get_multi, [features])
-        @adapter.get_multi(features)
-      end
-
-      # Public
-      def get_all
-        @operations << Operation.new(:get_all, [])
-        @adapter.get_all
-      end
-
-      # Public
-      def enable(feature, gate, thing)
-        @operations << Operation.new(:enable, [feature, gate, thing])
-        @adapter.enable(feature, gate, thing)
-      end
-
-      # Public
-      def disable(feature, gate, thing)
-        @operations << Operation.new(:disable, [feature, gate, thing])
-        @adapter.disable(feature, gate, thing)
-      end
-
-      # Public
-      def import(source)
-        @operations << Operation.new(:import, [source])
-        @adapter.import(source)
-      end
-
-      # Public
-      def export(format: :json, version: 1)
-        @operations << Operation.new(:export, [format, version])
-        @adapter.export(format: format, version: version)
-      end
-
       # Public: Count the number of times a certain operation happened.
-      def count(type)
-        type(type).size
+      def count(type = nil)
+        if type
+          type(type).size
+        else
+          @operations.size
+        end
       end
 
       # Public: Get all operations of a certain type.
@@ -131,6 +54,13 @@ module Flipper
         inspect_id = ::Kernel::format "%x", (object_id * 2)
         %(#<#{self.class}:0x#{inspect_id} @name=#{name.inspect}, @operations=#{@operations.inspect}, @adapter=#{@adapter.inspect}>)
       end
+
+      private
+
+      def wrap(method, *args, **kwargs, &block)
+        @operations << Operation.new(method, args, kwargs)
+        block.call
+      end
     end
   end
 end

data/lib/flipper/adapters/read_only.rb

@@ -3,8 +3,8 @@ require 'flipper'
 module Flipper
   module Adapters
     # Public: Adapter that wraps another adapter and raises for any writes.
-    class ReadOnly
-      include ::Flipper::Adapter
+    class ReadOnly < Wrapper
+      WRITE_METHODS = %i[add remove clear enable disable]
 
       class WriteAttempted < Error
         def initialize(message = nil)
@@ -12,49 +12,16 @@ module Flipper
         end
       end
 
-      # Public
-      def initialize(adapter)
-        @adapter = adapter
-      end
-
-      def features
-        @adapter.features
-      end
-
       def read_only?
         true
       end
 
-      def get(feature)
-        @adapter.get(feature)
-      end
-
-      def get_multi(features)
-        @adapter.get_multi(features)
-      end
-
-      def get_all
-        @adapter.get_all
-      end
-
-      def add(_feature)
-        raise WriteAttempted
-      end
-
-      def remove(_feature)
-        raise WriteAttempted
-      end
-
-      def clear(_feature)
-        raise WriteAttempted
-      end
+      private
 
-      def enable(_feature, _gate, _thing)
-        raise WriteAttempted
-      end
+      def wrap(method, *args, **kwargs)
+        raise WriteAttempted if WRITE_METHODS.include?(method)
 
-      def disable(_feature, _gate, _thing)
-        raise WriteAttempted
+        yield
       end
     end
   end

data/lib/flipper/adapters/strict.rb

@@ -1,10 +1,8 @@
 module Flipper
   module Adapters
     # An adapter that ensures a feature exists before checking it.
-    class Strict
-      extend Forwardable
-      include ::Flipper::Adapter
-      attr_reader :name, :adapter, :handler
+    class Strict < Wrapper
+      attr_reader :handler
 
       class NotFound < ::Flipper::Error
         def initialize(name)
@@ -12,34 +10,34 @@ 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)
+        super(adapter)
+        @handler = block || handler
       end
 
       def get(feature)
         assert_feature_exists(feature)
-        @adapter.get(feature)
+        super
       end
 
       def get_multi(features)
         features.each { |feature| assert_feature_exists(feature) }
-        @adapter.get_multi(features)
+        super
       end
 
       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/adapters/wrapper.rb

@@ -0,0 +1,54 @@
+module Flipper
+  module Adapters
+    # A base class for any adapter that wraps another adapter. By default, all methods
+    # delegate to the wrapped adapter. Implement `#wrap` to customize the behavior of
+    # all delegated methods, or override individual methods as needed.
+    class Wrapper
+      include Flipper::Adapter
+
+      METHODS = [
+        :import,
+        :export,
+        :features,
+        :add,
+        :remove,
+        :clear,
+        :get,
+        :get_multi,
+        :get_all,
+        :enable,
+        :disable,
+      ].freeze
+
+      attr_reader :adapter
+
+      def initialize(adapter)
+        @adapter = adapter
+      end
+
+      METHODS.each do |method|
+        if RUBY_VERSION >= '3.0'
+          define_method(method) do |*args, **kwargs|
+            wrap(method, *args, **kwargs) { @adapter.public_send(method, *args, **kwargs) }
+          end
+        else
+          define_method(method) do |*args|
+            wrap(method, *args) { @adapter.public_send(method, *args) }
+          end
+        end
+      end
+
+      # Override this method to customize the behavior of all delegated methods, and just yield to
+      # the block to call the wrapped adapter.
+      if RUBY_VERSION >= '3.0'
+        def wrap(method, *args, **kwargs, &block)
+          block.call
+        end
+      else
+        def wrap(method, *args, &block)
+          block.call
+        end
+      end
+    end
+  end
+end