flipper 1.2.2 → 1.3.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ff734c4221d1ea2694fdf4e9e463085f60242e698b8702389c53ccc6a17e87b
-  data.tar.gz: 5666852d9f7416d30919a188c5e3c46cb202d66d332c482aba56c3d496437282
+  metadata.gz: b71c902902ad6e2d1b19483496c257b82a67b0bdf37784c986ac24b41068000e
+  data.tar.gz: df8f571c809de456976c5b8f2adae3e1c2dc443589211a4c83a89130620d8219
 SHA512:
-  metadata.gz: c48de5bfe83ff53d969d496f96a3df9335af8f1fe8d41559158930c9ae3dd94b91f245f7b4cfbceea1c85ab453a4dd94057e4a46e3f928d9b27ddc417f04c718
-  data.tar.gz: 2ed4dd3a74bbf07fe289d57b9545e073527971e5ab7f393ee96ea8f31904a9a550db4cda0ba492f080a14b1eb8b4982eb680e88b1c2bcfeea2e74e032207b1f4
+  metadata.gz: d38bf2b382419e985d9a8bd4f6f650b27d880952f1cecfe2943e3cc2ce72e09843a8bf45b4cd833af40865b5438a3486d7dba72d6c02d197c7a98423d33dd12e
+  data.tar.gz: c67f1b896463545dd60582652d6eaffb7cf4b7e544a7d231bb83a2cc91e2c674c9de13f8a8a4a2e7966fa889792b6a34338782718c49c84a38ace66d7bde9deb

data/.github/workflows/ci.yml

@@ -26,6 +26,7 @@ jobs:
           --health-timeout 5s
           --health-retries 5
     strategy:
+      fail-fast: false
       matrix:
         ruby: ['2.6', '2.7', '3.0', '3.1', '3.2', '3.3']
         rails: ['5.2', '6.0.0', '6.1.0', '7.0.0', '7.1.0']
@@ -75,7 +76,7 @@ jobs:
       - name: Check out repository code
         uses: actions/checkout@v4
       - name: Do some action caching
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: vendor/bundle
           key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-${{ hashFiles('**/Gemfile.lock') }}

data/.github/workflows/examples.yml

@@ -58,7 +58,7 @@ jobs:
       - name: Check out repository code
         uses: actions/checkout@v4
       - name: Do some action caching
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: vendor/bundle
           key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-${{ hashFiles('**/Gemfile.lock') }}

data/README.md

@@ -111,3 +111,4 @@ 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     |

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/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,22 +10,19 @@ module Flipper
         end
       end
 
-      def_delegators :@adapter, :features, :get_all, :add, :remove, :clear, :enable, :disable
-
       def initialize(adapter, handler = nil, &block)
-        @name = :strict
-        @adapter = adapter
+        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

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

data/lib/flipper/cli.rb

@@ -9,7 +9,9 @@ module Flipper
     # Path to the local Rails application's environment configuration.
     DEFAULT_REQUIRE = "./config/environment"
 
-    def initialize
+    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
@@ -17,6 +19,10 @@ module 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>"
@@ -40,10 +46,12 @@ module Flipper
             begin
               values << Flipper::Expression.build(JSON.parse(expression))
             rescue JSON::ParserError => e
-              warn "JSON parse error: #{e.message}"
+              ui.error "JSON parse error #{e.message}"
+              ui.trace(e)
               exit 1
             rescue ArgumentError => e
-              warn "Invalid expression: #{e.message}"
+              ui.error "Invalid expression: #{e.message}"
+              ui.trace(e)
               exit 1
             end
           end
@@ -57,7 +65,7 @@ module Flipper
               values.each { |value| f.send(action, value) }
             end
 
-            puts feature_details(f)
+            ui.info feature_details(f)
           end
         end
       end
@@ -65,21 +73,21 @@ module Flipper
       command 'list' do |c|
         c.description = "List defined features"
         c.action do
-          puts feature_summary(Flipper.features)
+          ui.info 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))
+          ui.info 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
+          ui.info command ? @commands[command].help : help
         end
       end
 
@@ -89,7 +97,7 @@ module Flipper
 
       # Options available on all commands
       on_tail('-h', '--help', 'Print help message') do
-        puts help
+        ui.info help
         exit
       end
 
@@ -114,15 +122,15 @@ module Flipper
         load_environment! if @commands[command].load_environment
         @commands[command].run(args)
       else
-        puts help
+        ui.info help
 
         if command
-          warn "Unknown command: #{command}"
+          ui.error "Unknown command: #{command}"
           exit 1
         end
       end
     rescue OptionParser::InvalidOption => e
-      warn e.message
+      ui.error e.message
       exit 1
     end
 
@@ -138,7 +146,7 @@ module Flipper
       # Ensure all of flipper gets loaded if it hasn't already.
       require 'flipper'
     rescue LoadError => e
-      warn e.message
+      ui.error e.message
       exit 1
     end
 
@@ -170,7 +178,7 @@ module Flipper
         end
 
         colorize("%-#{padding}s" % feature.key, [:BOLD, :WHITE]) + " is #{summary}"
-      end
+      end.join("\n")
     end
 
     def feature_details(feature)
@@ -210,10 +218,12 @@ module Flipper
     end
 
     def colorize(text, colors)
-      if defined?(Bundler)
-        Bundler.ui.add_color(text, *colors)
-      else
-        text
+      ui.add_color(text, *colors)
+    end
+
+    def ui
+      @ui ||= Bundler::UI::Shell.new.tap do |ui|
+        ui.shell = shell
       end
     end
 
@@ -221,6 +231,15 @@ module Flipper
       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
 

data/lib/flipper/cloud/configuration.rb

@@ -174,7 +174,7 @@ module Flipper
       end
 
       def setup_log(options)
-        set_option :logging_enabled, options, default: true, typecast: :boolean
+        set_option :logging_enabled, options, default: false, typecast: :boolean
         set_option :logger, options, from_env: false, default: -> {
           if logging_enabled
             Logger.new(STDOUT)
@@ -214,8 +214,7 @@ module Flipper
           Telemetry.instance_for(self)
         }
 
-        # This is alpha. Don't use this unless you are me. And you are not me.
-        set_option :telemetry_enabled, options, default: false, typecast: :boolean
+        set_option :telemetry_enabled, options, default: true, typecast: :boolean
         instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
         @instrumenter = if telemetry_enabled
           Telemetry::Instrumenter.new(self, instrumenter)

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

@@ -3,9 +3,11 @@ require "delegate"
 module Flipper
   module Cloud
     class Telemetry
-      class Instrumenter < SimpleDelegator
+      class Instrumenter
+        attr_reader :instrumenter
+
         def initialize(cloud_configuration, instrumenter)
-          super instrumenter
+          @instrumenter = instrumenter
           @cloud_configuration = cloud_configuration
         end
 
@@ -14,12 +16,6 @@ module Flipper
           @cloud_configuration.telemetry.record(name, payload)
           return_value
         end
-
-        private
-
-        def instrumenter
-          __getobj__
-        end
       end
     end
   end

data/lib/flipper/cloud/telemetry.rb

@@ -160,8 +160,16 @@ module Flipper
         # thus may have a telemetry-interval header for us to respect.
         response ||= error.response if error && error.respond_to?(:response)
 
-        if response && interval = response["telemetry-interval"]
-          self.interval = interval.to_f
+        if response
+          if Flipper::Typecast.to_boolean(response["telemetry-shutdown"])
+            debug "action=telemetry_shutdown message=The server has requested that telemetry be shut down."
+            stop
+            return
+          end
+
+          if interval = response["telemetry-interval"]
+            self.interval = interval.to_f
+          end
         end
       rescue => error
         error "action=post_to_cloud error=#{error.inspect}"