ffe 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4a4f8d7608dddb3df97d2e03b69b815cfd23662ef1f3eb83a934f5336a63b73
-  data.tar.gz: fb39e4b322a411d8e93f29b0cdaefc27b12fc3c418efde0a74198e5301f51806
+  metadata.gz: 8714db1c7883a34c1d3d855f04531060fe1dfe11b568bee0508570f4e4c1942a
+  data.tar.gz: e781c9895aeeb7ccc047b684805216d81ee4e3adc1eece5e7ee3fe9078f4a715
 SHA512:
-  metadata.gz: d3cdfbfc53a7015ceefed64e5c6ac7bfe364beea2f33e874ee946b0245ca7f90bc198c45a17fa77ab7be87b8b0e89395b91f6e73f2c2258077669942ea7758cb
-  data.tar.gz: 6a7060e5583b18bf30e218663ea19bd7cd6f93fba0541c39d2a0015be3847b57d608befd54313482d3f3e54e0184a6181caa40970334fbd40bcb2712bca30fb0
+  metadata.gz: 5ca29b54bfe343aa8dd8fee221a0921bf8ce349b177e759d65efecdabe69d8c824a439d507b687d7bfd42bf72ab0492ed38365cad0febc90ef0c4f7239908002
+  data.tar.gz: 792f322fe595ec922daf165dee955ee7550a02ab6ef0354ef007fdb60ac44248f48b1c878ee0d324161a43b1b5d43c3a6e7dd42eabbefd45322be00734158f9b

data/README.md

@@ -3,6 +3,7 @@
 A minimalistic Feature Flag engine, cause i was bored of unleash and other overloaded ones.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -18,11 +19,23 @@ Copy over the initializer with:
 ```bash
 $ bin/rails g ffe:install
 ```
-and adjust it to your needs.
+and adjust it to your needs. 
+Defaults are:
+```rb
+config.bitlength = 4
+config.milieus = { development: 0, staging: 1, production: 2 }
+config.env_variable = 'RAILS_ENV'
+# actual supported: :solid_queue, :sidekiq
+config.queue_adapter = :solid_queue 
+```
+
+It also adds a loader for `feature_flags.json`, so you can easily load feature flags from a file.
+But to this later under `Scenarios`.
 
 Install the migration with:
 ```bash
 $ bin/rails ffe:install:migrations
+$ bin/rails db:migrate
 ```
 (have an eye on the length of the `milieu` bit mask)
 
@@ -31,12 +44,65 @@ Mount the engine in your application's `config/routes.rb` file:
 mount Ffe::Engine => "/feature_flags"
 ```
 
+### Views
+
+The engine provides base views for operating on FeatureFlags.
+
+But I recommend implement your own ones, as it is usually easier to customize. See: [views/ffe/feature_flags](https://github.com/LeFnord/ffe/tree/master/app/views/ffe/feature_flags).
+
 ## Usage
 
-coming soon
+Run your app and go to [http://localhost:3000/ffe/feature_flags](http://localhost:3000/ffe/feature_flags) to create your first feature flag.
+
+1. general usage, respecting only the environment
+    ```rb
+   Ffe::FeatureFlag.enabled?(:flag)
+   # or
+   Ffe::FeatureFlag.disabled?(:flag)
+   ```
+  
+
+2. check if a user is allowed
+    ```rb
+    Ffe::FeatureFlag.enabled_for?(:flag, user: current_user)
+    ```
+
+## Usage Scenarios
+
+
+**Use Case**: Cleaning-Up -- The functionality is available to everyone.
+
+> Please don't forget to remove feature flags after its use isn't needed anymore.
+
+> Every unused feature flag, makes the code noisy and uncomfortable to read and understand.
+
+1. Clean up the code after the feature flag has been disabled, or doesn't changed over a long time!
+
+**Use Case**: A new functionality is to be developed that is accessible to specific users and/or environments via a feature flag.
+
+1. Create a feature flag in production
+2. Dump the flags, then replace the `config/feature_flags.json` file locally and commit it.
+3. Continue developing against the feature as before.
+
+**Use Case**: Functionality is available to only a small number of users.
+
+1. Create a feature flag in production, and add allowed users.
+2. Dump the flags, then replace the `config/feature_flags.json` file locally and commit it.
+3. Edit the flag locally and specify a corresponding user.
+4. Continue developing against the feature as before.
+
+**Use Case**: Set a feature flag for an announcement, or something similar, for a specific period of time.
+
+> This requires the use of ActiveJob; currently, only `SolidQueue` and `Sidekiq` are supported. But feel free to add more.
+
+1. Create a feature flag in production, but without setting the expires date.
+2. Dump the flags, then replace the `config/feature_flags.json` file locally and commit it.
+3. Continue developing against the feature as before.
+4. After deployment to production, set the expiration date on the flag -- the flag will be automatically disabled after the expiration date.
 
 
 ## Contributing
+
 Contribution directions go here.
 
 ## License

data/app/controllers/ffe/feature_flags_controller.rb

@@ -5,19 +5,19 @@ module Ffe
     before_action :set_ffe, only: %i[show edit update destroy]
 
     def index
-      @feature_flags = ::Ffe::FeatureFlag.order(created_at: :desc)
+      @feature_flags = Ffe::FeatureFlag.order(created_at: :desc)
     end
 
     def show; end
 
     def new
-      @feature_flag = ::Ffe::FeatureFlag.new
+      @feature_flag = Ffe::FeatureFlag.new
     end
 
     def edit; end
 
     def create
-      @feature_flag = ::Ffe::FeatureFlag.new(feature_flag_params.except(:milieus))
+      @feature_flag = Ffe::FeatureFlag.new(feature_flag_params.except(:milieus, :clear_expires_at))
 
       if @feature_flag.save
         redirect_to feature_flag_path(@feature_flag), notice: 'FFE wurde erstellt.'
@@ -27,7 +27,7 @@ module Ffe
     end
 
     def update
-      if @feature_flag.update(feature_flag_params.except(:milieus))
+      if @feature_flag.update(feature_flag_params.except(:milieus, :clear_expires_at))
         redirect_to feature_flag_path(@feature_flag), notice: 'FFE wurde aktualisiert.'
       else
         render :edit, status: :unprocessable_content
@@ -39,15 +39,23 @@ module Ffe
       redirect_to feature_flags_path, notice: 'FFE wurde gelöscht.'
     end
 
+    def dump
+      render json: Ffe::FeatureFlag.order(:name).map { |ff| ff.attributes.slice('name', 'description', 'enabled', 'milieu', 'expires_at', 'percentage') }
+    end
+
     private
 
     def set_ffe
-      @feature_flag = ::Ffe::FeatureFlag.find(params.expect(:id))
+      @feature_flag = Ffe::FeatureFlag.find(params.expect(:id))
     end
 
     def feature_flag_params
-      params.expect(feature_flag: [:name, :description, :enabled, :expires_at, { milieus: {} }]).tap do |params|
+      params.expect(
+        feature_flag: [:name, :description, :enabled, :expires_at, :clear_expires_at, { user_ids: [], milieus: {} }]
+      ).tap do |params|
         params[:milieu] = params[:milieus].values.join.ljust(Ffe.config.bitlength, '0') if params[:milieus].present?
+        params[:expires_at] = nil if params[:clear_expires_at] == '1'
+        params[:user_ids]&.delete_if(&:blank?)
       end
     end
   end

data/app/jobs/ffe/expired_handling_job.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Ffe
+  class ExpiredHandlingJob < ApplicationJob
+    queue_as :ffe
+
+    def perform(flag)
+      feature_flag = FeatureFlag.find_by(name: flag)
+      feature_flag.update!(enabled: false)
+    end
+  end
+end

data/app/models/concerns/sidekiq_adapter.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SidekiqAdapter
+  extend ActiveSupport::Concern
+
+  def adapter_job
+    Sidekiq::ScheduledSet.new.find do |job|
+      job.item.dig('args', 0, 'job_id') == job_id
+    end
+  end
+
+  def adapter_update_job
+    destroy_job
+    create_job
+  end
+
+  def adapter_destroy_job
+    job.presence&.delete
+  end
+end

data/app/models/concerns/solid_queue_adapter.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SolidQueueAdapter
+  extend ActiveSupport::Concern
+
+  def adapter_job
+    SolidQueue::Job.scheduled.find_by(active_job_id: job_id)
+  end
+
+  def adapter_update_job
+    job.update(scheduled_at: expires_at)
+    se = SolidQueue::ScheduledExecution.find_by(job_id: job.id)
+    se.update(scheduled_at: expires_at)
+  end
+
+  def adapter_destroy_job
+    job.presence&.discard
+  end
+end

data/app/models/ffe/feature_flag.rb

@@ -2,10 +2,22 @@
 
 module Ffe
   class FeatureFlag < ApplicationRecord
+    if Ffe.config.queue_adapter == :solid_queue
+      include SolidQueueAdapter
+    elsif Ffe.config.queue_adapter == :sidekiq
+      include SidekiqAdapter
+    end
+
     self.table_name = 'feature_flags'
 
-    validates :name, presence: true, uniqueness: true, format: { with: /\A[a-zA-Z_]+\z/ }
-    validates :expires_at, comparison: { greater_than: Time.current.end_of_day }, if: -> { expires_at.present? }
+    # validations
+    #
+    validates :name, presence: true, uniqueness: true, format: { with: /\A[a-zA-Z_\d]+\z/ }
+    validates :expires_at, comparison: { greater_than: Time.current.end_of_day }, if: -> { expires_at.present? && expires_at_changed? } # rubocop:disable Layout/LineLength
+
+    # callbacks
+    after_save_commit :handle_change_job, unless: -> { Rails.env.test? }
+    before_destroy :destroy_job
 
     # the Flag functionality itself
     #
@@ -39,7 +51,7 @@ module Ffe
       milieu[pos] == '1'
     end
 
-    def readable_milieus # rubocop:disable Metrics/AbcSize
+    def readable_milieus
       relevant = milieu.to_s.ljust(Ffe.config.milieus.length, '0').chars.first(Ffe.config.milieus.length)
       return 'all' if relevant.all? { |m| m == '1' }
       return 'no' if relevant.all? { |m| m == '0' }
@@ -47,5 +59,47 @@ module Ffe
       inverted = Ffe.config.milieus.invert
       relevant.each_with_index.filter_map { |m, i| inverted[i] if m == '1' }.join(', ')
     end
+
+    # ExpiresAt related methods
+    #
+    # handles changes and decide to update or to destroy the job
+    def handle_change_job
+      if expires_at.present? && job_id.blank?
+        create_job
+      elsif expires_at.present? && job_id.present?
+        update_job
+      elsif expires_at.blank? && job_id.present?
+        destroy_job
+      end
+    end
+
+    # 1. create job if expires_at set
+    def create_job
+      return if expires_at.blank?
+
+      job = Ffe::ExpiredHandlingJob.set(wait_until: expires_at).perform_later(name)
+      update_columns(job_id: job.job_id, touch: true) # rubocop:disable Rails/SkipsModelValidations
+    end
+
+    # 2. update job if expires_at changed
+    def update_job
+      return unless job_id.present? && expires_at.present?
+      return create_job unless job
+
+      adapter_update_job if job
+    end
+
+    # 3. delete job if expires_at changed to empty, or FF was destroyed
+    def destroy_job
+      return if job_id.blank?
+
+      adapter_destroy_job if job
+
+      update_columns(job_id: nil, touch: true) unless destroyed? # rubocop:disable Rails/SkipsModelValidations
+    end
+
+    def job
+      adapter_job.presence
+    end
   end
 end

data/app/views/ffe/feature_flags/_form.html.erb

@@ -27,7 +27,9 @@
 
   <div>
     <%= form.label :expires_at %>
-    <%= form.datetime_local_field :expires_at, min: Time.current.tomorrow.beginning_of_day, value: feature_flag.expires_at&.strftime('%Y-%m-%dT%H:%M') %>
+    <%= form.datetime_local_field :expires_at %>
+    <%= check_box_tag 'feature_flag[clear_expires_at]', "1", false %>
+    <%= form.label :clear_expires_at %>
   </div>
 
   <div>
@@ -41,6 +43,11 @@
     <% end %>
   </div>
 
+  <div>
+    <%= form.label :user_ids %>
+    <%= form.collection_select :user_ids, Ffe::User.all, :id, :name, { include_blank: true, multiple: true } %>
+  </div>
+
   <div>
     <%= form.submit %>
   </div>

data/app/views/ffe/feature_flags/index.html.erb

@@ -1,6 +1,7 @@
 <h1>Feature Flags</h1>
 
-<p><%= link_to "Neues Feature Flag anlegen", new_feature_flag_path %></p>
+<div><%= link_to 'Neues Feature Flag anlegen', new_feature_flag_path %></div>
+<div><%= link_to 'dump', dump_feature_flags_path, download: 'feature_flags.json' %></div>
 
 <table>
   <thead>
@@ -22,8 +23,8 @@
         <td><%= feature_flag.expires_at&.strftime('%Y-%m-%dT%H:%M') %></td>
         <td><%= feature_flag.readable_milieus %></td>
         <td>
-          <%= link_to "Bearbeiten", edit_feature_flag_path(feature_flag) %>
-          <%= button_to "Löschen", feature_flag_path(feature_flag), method: :delete %>
+          <%= link_to 'Bearbeiten', edit_feature_flag_path(feature_flag) %>
+          <%= button_to 'Löschen', feature_flag_path(feature_flag), method: :delete %>
         </td>
       </tr>
     <% end %>

data/app/views/ffe/feature_flags/show.html.erb

@@ -17,5 +17,10 @@
   <%= @feature_flag.readable_milieus %>
 </div>
 
+<div>
+  <strong>User IDs:</strong>
+  <%= @feature_flag.user_ids %>
+</div>
+
 <p><%= link_to "Bearbeiten", edit_feature_flag_path(@feature_flag) %></p>
 <p><%= link_to "Zurück", feature_flags_path %></p>

data/config/routes.rb

@@ -1,3 +1,5 @@
 Ffe::Engine.routes.draw do
-  resources :feature_flags
+  resources :feature_flags do
+    get :dump, on: :collection
+  end
 end

data/db/migrate/20260810150000_create_feature_flags.rb

@@ -5,6 +5,7 @@ class CreateFeatureFlags < ActiveRecord::Migration[8.2]
       t.string :description
       t.boolean :enabled, default: false
       t.datetime :expires_at
+      t.string :job_id
       t.column :milieu, "bit(#{Ffe.config.bitlength})", default: ''.ljust(Ffe.config.bitlength, '0') # only for PG
       t.text :user_ids, array: true, default: []
 

data/lib/ffe/configuration.rb

@@ -2,12 +2,13 @@
 
 module Ffe
   class Configuration
-    attr_accessor :bitlength, :env_variable, :milieus
+    attr_accessor :bitlength, :env_variable, :milieus, :queue_adapter
 
     def initialize
       @bitlength = 4
       @env_variable = 'RAILS_ENV'
       @milieus = { development: 0, staging: 1, production: 2 }
+      @queue_adapter = :async
     end
   end
 end

data/lib/ffe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ffe
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/lib/generators/ffe/install/install_generator.rb

@@ -11,6 +11,7 @@ module Ffe
 
       def copy_initializer
         template 'ffe_initializer.rb.tt', 'config/initializers/ffe.rb'
+        template 'feature_flags.json.tt', 'config/feature_flags.json'
       end
     end
   end

data/lib/generators/ffe/templates/feature_flags.json.tt

@@ -0,0 +1,9 @@
+[
+  {
+    "name": "x_dummy_testing",
+    "description": "A general testing FF.",
+    "enabled": true,
+    "milieu": "1000",
+    "expires_at": null,
+  }
+]

data/lib/generators/ffe/templates/ffe_initializer.rb.tt

@@ -23,4 +23,25 @@ Ffe.configure do |config|
 
   # not all rails apps are using RAILS_ENV variable to set it
   config.env_variable = 'RAILS_ENV'
+
+  # set the active job adapter,
+  # needed if you want to use the Ffe::ExpiredHandlingJob
+  # actual supported: :solid_queue, :sidekiq
+  config.queue_adapter = ActiveJob::Base.queue_adapter_name.to_sym
+end
+
+
+Rails.configuration.after_initialize do
+  if ActiveRecord::Base.connection.table_exists?(:feature_flags)
+    path = Rails.root.join('config/feature_flags.json')
+    next unless File.exist?(path)
+
+    data = JSON.load_file(path)
+    data.each do |flag|
+      name = flag.delete('name')
+      next if Ffe::FeatureFlag.exists?(name: name)
+
+      Ffe::FeatureFlag.create_with(flag).find_or_create_by(name: name)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffe
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - LeFnord
@@ -38,7 +38,10 @@ files:
 - app/controllers/ffe/feature_flags_controller.rb
 - app/helpers/ffe/application_helper.rb
 - app/jobs/ffe/application_job.rb
+- app/jobs/ffe/expired_handling_job.rb
 - app/mailers/ffe/application_mailer.rb
+- app/models/concerns/sidekiq_adapter.rb
+- app/models/concerns/solid_queue_adapter.rb
 - app/models/ffe/application_record.rb
 - app/models/ffe/feature_flag.rb
 - app/models/ffe/user.rb
@@ -56,6 +59,7 @@ files:
 - lib/ffe/engine.rb
 - lib/ffe/version.rb
 - lib/generators/ffe/install/install_generator.rb
+- lib/generators/ffe/templates/feature_flags.json.tt
 - lib/generators/ffe/templates/ffe_initializer.rb.tt
 - lib/tasks/ffe_tasks.rake
 homepage: https://github.com/LeFnord/ffe
@@ -80,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.18
+rubygems_version: 4.0.19
 specification_version: 4
 summary: A minimal Feature Flag Engine for Rails
 test_files: []