flipper 0.26.0 → 1.1.0

data/Gemfile

@@ -7,23 +7,28 @@ Dir['flipper-*.gemspec'].each do |gemspec|
 end
 
 gem 'debug'
-gem 'rake', '~> 12.3.3'
-gem 'shotgun', '~> 0.9'
+gem 'rake'
 gem 'statsd-ruby', '~> 1.2.1'
 gem 'rspec', '~> 3.0'
-gem 'rack-test', '~> 0.6.3'
+gem 'rack-test'
+gem 'rackup'
 gem 'sqlite3', "~> #{ENV['SQLITE3_VERSION'] || '1.4.1'}"
-gem 'rails', "~> #{ENV['RAILS_VERSION'] || '7.0.0'}"
-gem 'minitest', '~> 5.8'
+gem 'rails', "~> #{ENV['RAILS_VERSION'] || '7.0.4'}"
+gem 'minitest', '~> 5.18'
 gem 'minitest-documentation'
-gem 'webmock', '~> 3.0'
+gem 'webmock'
 gem 'ice_age'
 gem 'redis-namespace'
 gem 'webrick'
+gem 'stackprof'
+gem 'benchmark-ips'
+gem 'stackprof-webnav'
+gem 'flamegraph'
+gem 'climate_control'
 
 group(:guard) do
-  gem 'guard', '~> 2.15'
-  gem 'guard-rspec', '~> 4.5'
-  gem 'guard-bundler', '~> 2.2'
-  gem 'rb-fsevent', '~> 0.9'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'rb-fsevent'
 end

data/README.md

@@ -1,6 +1,6 @@
 [![Flipper Mark](docs/images/banner.jpg)](https://www.flippercloud.io)
 
-[Website](https://flippercloud.io) | [Documentation](https://flippercloud.io/docs) | [Examples](examples) | [Twitter](https://twitter.com/flipper_cloud)
+[Website](https://flippercloud.io?utm_source=oss&utm_medium=readme&utm_campaign=website_link) | [Documentation](https://flippercloud.io/docs?utm_source=oss&utm_medium=readme&utm_campaign=docs_link) | [Examples](examples) | [Twitter](https://twitter.com/flipper_cloud) | [Ruby.social](https://ruby.social/@flipper)
 
 # Flipper
 
@@ -35,7 +35,7 @@ Or install it yourself with:
 
 ## Subscribe & Ship
 
-[💌  Subscribe](https://buttondown.email/flipper) - I'll send you short and sweet emails when we release new versions.
+[💌  Subscribe](https://blog.flippercloud.io/#/portal/signup) - we'll send you short and sweet emails when we release new versions ([examples](https://blog.flippercloud.io/tag/releases/)).
 
 ## Getting Started
 
@@ -43,7 +43,7 @@ Use `Flipper#enabled?` in your app to check if a feature is enabled.
 
 ```ruby
 # check if search is enabled
-if Flipper.enabled? :search, current_user
+if Flipper.enabled?(:search, current_user)
   puts 'Search away!'
 else
   puts 'No search for you!'
@@ -66,24 +66,26 @@ Flipper.enable_group :search, :admin
 Flipper.enable_percentage_of_actors :search, 2
 ```
 
-Read more about [getting started with Flipper](https://flippercloud.io/docs) and [enabling features](https://flippercloud.io/docs/features).
+Read more about [getting started with Flipper](https://flippercloud.io/docs?utm_source=oss&utm_medium=readme&utm_campaign=getting_started) and [enabling features](https://flippercloud.io/docs/features?utm_source=oss&utm_medium=readme&utm_campaign=enabling_features).
 
 ## Flipper Cloud
 
-Like Flipper and want more? Check out [Flipper Cloud](https://www.flippercloud.io), which comes with:
+Like Flipper and want more? Check out [Flipper Cloud](https://www.flippercloud.io?utm_source=oss&utm_medium=readme&utm_campaign=check_out), which comes with:
 
-* **everything in one place** — no need to bounce around from different application UIs or IRB consoles.
-* **permissions** — grant access to everyone in your organization or lockdown each project to particular people.
-* **multiple environments** — production, staging, enterprise, by continent, whatever you need.
-* **personal environments** — no more rake scripts or manual enable/disable to get your laptop to look like production. Every developer gets a personal environment that inherits from production that they can override as they please ([read more](https://www.johnnunemaker.com/flipper-cloud-environments/)).
-* **no maintenance** — we'll keep the lights on for you. We also have handy webhooks for keeping your app in sync with Cloud, so **our availability won't affect yours**. All your feature flag reads are local to your app.
+* **multiple environments** — production, staging, per continent, whatever you need. Every environment inherits from production by default and every project comes with a [project overview page](https://blog.flippercloud.io/project-overview/) that shows each feature and its status in each environment.
+* **personal environments** — everyone on your team gets a personal environment (that inherits from production) which they can modify however they want without stepping on anyone else's toes.
+* **permissions** — grant access to everyone in your organization or lockdown each project to particular people. You can even limit access to a particular environment (like production) to specific people.
 * **audit history** — every feature change and who made it.
 * **rollbacks** — enable or disable a feature accidentally? No problem. You can roll back to any point in the audit history with a single click.
+* **maintenance** — we'll keep the lights on for you. We also have handy webhooks and background polling for keeping your app in sync with Cloud, so **our availability won't affect yours**. All your feature flag reads are local to your app.
+* **everything in one place** — no need to bounce around from different application UIs or IRB consoles.
 
-[![Flipper Cloud Screenshot](docs/images/flipper_cloud.png)](https://www.flippercloud.io)
+[![Flipper Cloud Screenshot](docs/images/flipper_cloud.png)](https://www.flippercloud.io?utm_source=oss&utm_medium=readme&utm_campaign=screenshot)
 
 Cloud is super simple to integrate with Rails ([demo app](https://github.com/fewerandfaster/flipper-rails-demo)), Sinatra or any other framework.
 
+We also have a [free plan](https://www.flippercloud.io?utm_source=oss&utm_medium=readme&utm_campaign=free_plan) that you can use forever.
+
 ## Contributing
 
 1. Fork it

data/benchmark/enabled_ips.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+require 'flipper'
+require 'benchmark/ips'
+
+actor = Flipper::Actor.new("User;1")
+
+Benchmark.ips do |x|
+  x.report("with actor") { Flipper.enabled?(:foo, actor) }
+  x.report("without actor") { Flipper.enabled?(:foo) }
+end

data/benchmark/enabled_multiple_actors_ips.rb

@@ -0,0 +1,20 @@
+require 'bundler/setup'
+require 'flipper'
+require 'benchmark/ips'
+
+actor1 = Flipper::Actor.new("User;1")
+actor2 = Flipper::Actor.new("User;2")
+actor3 = Flipper::Actor.new("User;3")
+actor4 = Flipper::Actor.new("User;4")
+actor5 = Flipper::Actor.new("User;5")
+actor6 = Flipper::Actor.new("User;6")
+actor7 = Flipper::Actor.new("User;7")
+actor8 = Flipper::Actor.new("User;8")
+
+actors = [actor1, actor2, actor3, actor4, actor5, actor6, actor7, actor8]
+
+Benchmark.ips do |x|
+  x.report("with array of actors") { Flipper.enabled?(:foo, actors) }
+  x.report("with multiple enabled? checks") { actors.each { |actor| Flipper.enabled?(:foo, actor) } }
+  x.compare!
+end

data/benchmark/enabled_profile.rb

@@ -0,0 +1,20 @@
+require 'bundler/setup'
+require 'flipper'
+require 'stackprof'
+require 'benchmark/ips'
+
+flipper = Flipper.new(Flipper::Adapters::Memory.new)
+feature = flipper.feature(:foo)
+actor = Flipper::Actor.new("User;1")
+
+profile = StackProf.run(mode: :wall, interval: 1_000) do
+  2_000_000.times do
+    feature.enabled?(actor)
+  end
+end
+
+result = StackProf::Report.new(profile)
+puts
+result.print_text
+puts "\n\n\n"
+result.print_method(/Flipper::Feature#enabled?/)

data/benchmark/instrumentation_ips.rb

@@ -0,0 +1,21 @@
+require 'bundler/setup'
+require 'flipper'
+require 'active_support/notifications'
+require 'active_support/isolated_execution_state'
+require 'benchmark/ips'
+
+class FlipperSubscriber
+  def call(name, start, finish, id, payload)
+  end
+
+  ActiveSupport::Notifications.subscribe(/flipper/, new)
+end
+
+actor = Flipper::Actor.new("User;1")
+bare = Flipper.new(Flipper::Adapters::Memory.new)
+instrumented = Flipper.new(Flipper::Adapters::Memory.new, instrumenter: ActiveSupport::Notifications)
+
+Benchmark.ips do |x|
+  x.report("with instrumentation") { instrumented.enabled?(:foo, actor) }
+  x.report("without instrumentation") { bare.enabled?(:foo, actor) }
+end

data/benchmark/typecast_ips.rb

@@ -0,0 +1,27 @@
+require 'bundler/setup'
+require 'flipper'
+require 'benchmark/ips'
+
+Benchmark.ips do |x|
+  x.report("Typecast.to_boolean true") { Flipper::Typecast.to_boolean(true) }
+  x.report("Typecast.to_boolean 1") { Flipper::Typecast.to_boolean(1) }
+  x.report("Typecast.to_boolean 'true'") { Flipper::Typecast.to_boolean('true'.freeze) }
+  x.report("Typecast.to_boolean '1'") { Flipper::Typecast.to_boolean('1'.freeze) }
+  x.report("Typecast.to_boolean false") { Flipper::Typecast.to_boolean(false) }
+
+  x.report("Typecast.to_integer 1") { Flipper::Typecast.to_integer(1) }
+  x.report("Typecast.to_integer '1'") { Flipper::Typecast.to_integer('1') }
+
+  x.report("Typecast.to_float 1") { Flipper::Typecast.to_float(1) }
+  x.report("Typecast.to_float '1'") { Flipper::Typecast.to_float('1'.freeze) }
+  x.report("Typecast.to_float 1.01") { Flipper::Typecast.to_float(1) }
+  x.report("Typecast.to_float '1.01'") { Flipper::Typecast.to_float('1'.freeze) }
+
+  x.report("Typecast.to_number 1") { Flipper::Typecast.to_number(1) }
+  x.report("Typecast.to_number 1.1") { Flipper::Typecast.to_number(1.1) }
+  x.report("Typecast.to_number '1'") { Flipper::Typecast.to_number('1'.freeze) }
+  x.report("Typecast.to_number '1.1'") { Flipper::Typecast.to_number('1.1'.freeze) }
+  x.report("Typecast.to_number nil") { Flipper::Typecast.to_number(nil) }
+  time = Time.now
+  x.report("Typecast.to_number Time.now") { Flipper::Typecast.to_number(time) }
+end

data/examples/api/basic.ru

@@ -1,19 +1,18 @@
 #
 # Usage:
-#   # if you want it to not reload and be really fast
 #   bin/rackup examples/api/basic.ru -p 9999
 #
-#   # if you want reloading
-#   bin/shotgun examples/api/basic.ru -p 9999
-#
 #   http://localhost:9999/
 #
 
 require 'bundler/setup'
+require 'rack/reloader'
 require "flipper/api"
 require "flipper/adapters/pstore"
 
 # You can uncomment this to get some default data:
 # Flipper.enable :logging
 
+use Rack::Reloader
+
 run Flipper::Api.app

data/examples/api/custom_memoized.ru

@@ -1,15 +1,12 @@
 #
 # Usage:
-#   # if you want it to not reload and be really fast
 #   bin/rackup examples/api/custom_memoized.ru -p 9999
 #
-#   # if you want reloading
-#   bin/shotgun examples/api/custom_memoized.ru -p 9999
-#
 #   http://localhost:9999/
 #
 
 require 'bundler/setup'
+require 'rack/reloader'
 require "active_support/notifications"
 require "flipper/api"
 require "flipper/adapters/pstore"
@@ -31,6 +28,8 @@ ActiveSupport::Notifications.subscribe(/.*/, ->(*args) {
 # You can uncomment this to get some default data:
 # flipper[:logging].enable_percentage_of_time 5
 
+use Rack::Reloader
+
 run Flipper::Api.app(flipper) { |builder|
   builder.use Flipper::Middleware::SetupEnv, flipper
   builder.use Flipper::Middleware::Memoizer, preload: true

data/examples/api/memoized.ru

@@ -1,15 +1,12 @@
 #
 # Usage:
-#   # if you want it to not reload and be really fast
 #   bin/rackup examples/api/memoized.ru -p 9999
 #
-#   # if you want reloading
-#   bin/shotgun examples/api/memoized.ru -p 9999
-#
 #   http://localhost:9999/
 #
 
 require 'bundler/setup'
+require 'rack/reloader'
 require "active_support/notifications"
 require "flipper/api"
 require "flipper/adapters/pstore"
@@ -38,6 +35,8 @@ Flipper.register(:admins) { |actor|
 # You can uncomment this to get some default data:
 # Flipper.enable :logging
 
+use Rack::Reloader
+
 run Flipper::Api.app { |builder|
   builder.use Flipper::Middleware::Memoizer, preload: true
 }

data/examples/cloud/app.ru

@@ -0,0 +1,12 @@
+# Usage (from the repo root):
+#   env FLIPPER_CLOUD_TOKEN=<token> FLIPPER_CLOUD_SYNC_SECRET=<secret> bundle exec rackup examples/cloud/app.ru -p 9999
+#   http://localhost:9999/
+
+require 'bundler/setup'
+require 'flipper/cloud'
+
+Flipper.configure do |config|
+  config.default { Flipper::Cloud.new }
+end
+
+run Flipper::Cloud.app

data/examples/cloud/backoff_policy.rb

@@ -0,0 +1,13 @@
+# Just a simple example that shows how the backoff policy works.
+require 'bundler/setup'
+require 'flipper/cloud/telemetry/backoff_policy'
+
+intervals = []
+policy = Flipper::Cloud::Telemetry::BackoffPolicy.new
+
+10.times do |n|
+  intervals << policy.next_interval
+end
+
+pp intervals.map { |i| i.round(2) }
+puts "Total: #{intervals.sum.round(2)}ms (#{(intervals.sum/1_000.0).round(2)} sec)"

data/examples/cloud/basic.rb

@@ -0,0 +1,22 @@
+# Usage (from the repo root):
+# env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/basic.rb
+
+require_relative "./cloud_setup"
+require 'bundler/setup'
+require 'flipper/cloud'
+
+Flipper[:stats].enable
+
+if Flipper[:stats].enabled?
+  puts 'Enabled!'
+else
+  puts 'Disabled!'
+end
+
+Flipper[:stats].disable
+
+if Flipper[:stats].enabled?
+  puts 'Enabled!'
+else
+  puts 'Disabled!'
+end

data/examples/cloud/cloud_setup.rb

@@ -0,0 +1,20 @@
+if ENV["FLIPPER_CLOUD_TOKEN"].nil? || ENV["FLIPPER_CLOUD_TOKEN"].empty?
+  warn "FLIPPER_CLOUD_TOKEN missing so skipping cloud example."
+  exit
+end
+
+matrix_key = if ENV["CI"]
+  suffix_rails = ENV["RAILS_VERSION"].split(".").take(2).join
+  suffix_ruby = RUBY_VERSION.split(".").take(2).join
+  "FLIPPER_CLOUD_TOKEN_#{suffix_ruby}_#{suffix_rails}"
+else
+  "FLIPPER_CLOUD_TOKEN"
+end
+
+if matrix_token = ENV[matrix_key]
+  puts "Using #{matrix_key} for FLIPPER_CLOUD_TOKEN"
+  ENV["FLIPPER_CLOUD_TOKEN"] = matrix_token
+else
+  warn "Missing #{matrix_key}. Go create an environment in flipper cloud and set #{matrix_key} to the adapter token for that environment in github actions secrets."
+  exit 1
+end

data/examples/cloud/forked.rb

@@ -0,0 +1,36 @@
+# Usage (from the repo root):
+# env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/threaded.rb
+
+require_relative "./cloud_setup"
+require 'bundler/setup'
+require 'flipper/cloud'
+
+puts Process.pid
+
+# Make a call in the parent process so we can detect forking.
+Flipper.enabled?(:stats)
+
+pids = 2.times.map do |n|
+  fork {
+    # Check every second to see if the feature is enabled
+    threads = []
+    2.times do
+      threads << Thread.new do
+        loop do
+          sleep rand
+
+          if Flipper[:stats].enabled?
+            puts "#{Process.pid} #{Time.now.to_i} Enabled!"
+          else
+            puts "#{Process.pid} #{Time.now.to_i} Disabled!"
+          end
+        end
+      end
+    end
+    threads.map(&:join)
+  }
+end
+
+pids.each do |pid|
+  Process.waitpid pid, 0
+end

data/examples/cloud/import.rb

@@ -0,0 +1,17 @@
+# Usage (from the repo root):
+#   env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/import.rb
+
+require_relative "./cloud_setup"
+require 'bundler/setup'
+require 'flipper'
+require 'flipper/cloud'
+
+Flipper.enable(:test)
+Flipper.enable(:search)
+Flipper.enable_actor(:stats, Flipper::Actor.new("jnunemaker"))
+Flipper.enable_percentage_of_time(:logging, 5)
+
+cloud = Flipper::Cloud.new
+
+# makes cloud identical to memory flipper
+cloud.import(Flipper)

data/examples/cloud/threaded.rb

@@ -0,0 +1,33 @@
+# Usage (from the repo root):
+# env FLIPPER_CLOUD_TOKEN=<token> bundle exec ruby examples/cloud/threaded.rb
+
+require_relative "./cloud_setup"
+require 'bundler/setup'
+require 'flipper/cloud'
+
+puts Process.pid
+
+Flipper.configure do |config|
+  config.default {
+    Flipper::Cloud.new(
+      local_adapter: config.adapter,
+      debug_output: STDOUT,
+    )
+  }
+end
+
+# You might want to do this at some point to see different results:
+# Flipper.enable(:search)
+# Flipper.disable(:stats)
+
+# Check every second to see if the feature is enabled
+5.times.map { |i|
+  Thread.new {
+    loop do
+      sleep rand
+
+      Flipper.enabled?(:stats)
+      Flipper.enabled?(:search)
+    end
+  }
+}.each(&:join)

data/examples/dsl.rb

@@ -1,7 +1,7 @@
 require 'bundler/setup'
 require 'flipper'
 
-# create a thing with an identifier
+# create an actor with an identifier
 class Person < Struct.new(:id)
   include Flipper::Identifier
 end
@@ -47,20 +47,6 @@ puts "stats.enabled?: #{stats.enabled?}"
 puts "stats.enabled? person: #{stats.enabled? person}"
 puts
 
-# get an instance of the percentage of time type set to 5
-puts Flipper.time(5).inspect
-
-# get an instance of the percentage of actors type set to 15
-puts Flipper.actors(15).inspect
-
-# get an instance of an actor using an object that responds to flipper_id
-responds_to_flipper_id = Struct.new(:flipper_id).new(10)
-puts Flipper.actor(responds_to_flipper_id).inspect
-
-# get an instance of an actor using an object
-thing = Struct.new(:flipper_id).new(22)
-puts Flipper.actor(thing).inspect
-
 # register a top level group
 admins = Flipper.register(:admins) { |actor|
   actor.respond_to?(:admin?) && actor.admin?

data/examples/enabled_for_actor.rb

@@ -31,5 +31,7 @@ Flipper.enable_percentage_of_actors :pro_stats, 50
 Flipper.enable_group :tweets, :admins
 Flipper.enable_actor :posts, user2
 
-pp Flipper.features.select { |feature| feature.enabled?(user1) }.map(&:name)
-pp Flipper.features.select { |feature| feature.enabled?(user2) }.map(&:name)
+pp Flipper.features.select { |feature| feature.enabled?(user1) }.map(&:name).sort
+pp Flipper.features.select { |feature| feature.enabled?(user2) }.map(&:name).sort
+pp Flipper.features.select { |feature| feature.enabled?(user1, user2) }.map(&:name).sort
+pp Flipper.features.select { |feature| feature.enabled?([user2, user1]) }.map(&:name).sort