flipper-ui 1.2.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e7548b068b159bfd58094d749671e3d93ad0e8e7e5159a60e334d5f87a94a52
-  data.tar.gz: 47506fd1ede7edae268409131cdf5fc67398fdde135dde6c61902f7eb401033d
+  metadata.gz: 00b09ef9134ecfe7b076edae579e9ff91827964ada4053fa8d5b5167b2965992
+  data.tar.gz: 22b200ae581fd91ced63c0936bfa03ce9ee306779bf09c7ed40809ec97e9d4c6
 SHA512:
-  metadata.gz: 86e2ffab3abe94252f89748155872551d94755c9c8c202a1d39e8d948b5ed0b062b9f5bfcdfcc4d371fee294ea051cfb7ff6808064c75eb8bc6b076106514c6b
-  data.tar.gz: e507fe429a898098c26a063d3946ac4866e80b00eba146789bedebed50351869f0eeea8ee9019b2ebc49567c4fadd2cec3372dac607f69684176369402c35378
+  metadata.gz: d85919950864694f4156846ffd1cf20c758451821409c6ae7fb566b11759740842368af8393669617c5d8c5764ac5a9d11c7f91207641c51892dec0169cd09ad
+  data.tar.gz: 62b4831c0a38c4321ab627480e79ab5043140d4b57869c80a3792288d9b2d21421133f701ba1a8df72b6d5d707854df65714cce7009cb383aee039c04177718a

data/examples/ui/basic.ru

@@ -25,6 +25,7 @@ Flipper::UI.configure do |config|
   config.feature_removal_enabled = true
   config.cloud_recommendation = true
   config.confirm_fully_enable = false
+  config.confirm_disable = false
   config.read_only = false
   # config.show_feature_description_in_list = true
   config.descriptions_source = lambda do |_keys|
@@ -46,6 +47,8 @@ Flipper::UI.configure do |config|
       '6' => '<a href="https://opensoul.org">Brandon</a>',
     }
   end
+
+  config.application_href = "https://example.com"
 end
 
 # You can uncomment these to get some default data:
@@ -63,5 +66,6 @@ end
 use Rack::Reloader
 
 run Flipper::UI.app { |builder|
+  builder.use Rack::Reloader, 1
   builder.use Rack::Session::Cookie, secret: "_super_secret"
 }

data/flipper-ui.gemspec

@@ -21,8 +21,9 @@ Gem::Specification.new do |gem|
   gem.metadata      = Flipper::METADATA
 
   gem.add_dependency 'rack', '>= 1.4', '< 4'
-  gem.add_dependency 'rack-protection', '>= 1.5.3', '<= 4.0.0'
+  gem.add_dependency 'rack-protection', '>= 1.5.3', '<5.0.0'
+  gem.add_dependency 'rack-session', '>= 1.0.2', '< 3.0.0'
   gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
   gem.add_dependency 'erubi', '>= 1.0.0', '< 2.0.0'
-  gem.add_dependency 'sanitize', '< 7'
+  gem.add_dependency 'sanitize', '< 8'
 end

data/lib/flipper/ui/action.rb

@@ -7,12 +7,20 @@ require 'sanitize'
 
 module Flipper
   module UI
+    # Sanitize config for descriptions in list view. Removes anchor tags to
+    # avoid nested links (the feature row is wrapped in an <a> tag).
+    # See: https://github.com/flippercloud/flipper/issues/939
+    SANITIZE_LIST = Sanitize::Config.merge(
+      Sanitize::Config::BASIC,
+      elements: Sanitize::Config::BASIC[:elements] - ['a']
+    )
+
     class Action
       module FeatureNameFromRoute
         def feature_name
           @feature_name ||= begin
             match = request.path_info.match(self.class.route_regex)
-            match ? Rack::Utils.unescape(match[:feature_name]) : nil
+            match ? Flipper::UI::Util.unescape(match[:feature_name]) : nil
           end
         end
         private :feature_name
@@ -27,24 +35,7 @@ module Flipper
                                              'delete'.freeze,
                                            ]).freeze
 
-      SOURCES = {
-        bootstrap_css: {
-          src: '/css/bootstrap-4.6.0.min.css'.freeze,
-          hash: 'sha384-B0vP5xmATw1+K9KRQjQERJvTumQW0nPEzvF6L/Z6nronJ3oUOFUFpCjEUQouq2+l'.freeze
-        }.freeze,
-        jquery_js: {
-          src: '/js/jquery-3.6.0.slim.js'.freeze,
-          hash: 'sha256-HwWONEZrpuoh951cQD1ov2HUK5zA5DwJ1DNUXaM6FsY='.freeze
-        }.freeze,
-        popper_js: {
-          src: '/js/popper-1.12.9.min.js'.freeze,
-          hash: 'sha384-ApNbgh9B+Y1QKtv3Rn7W3mgPxhU9K/ScQsAP7hUibX39j7fakFPskvXusvfa0b4Q'.freeze
-        }.freeze,
-        bootstrap_js: {
-          src: '/js/bootstrap-4.6.0.min.js'.freeze,
-          hash: 'sha384-+YQ4JLhjyBLPDQt//I+STsc9iw4uQqACwlvpslubQzn4u2UU2UFM80nGisd026JF'.freeze
-        }.freeze
-      }.freeze
+      SOURCES = JSON.parse(File.read(File.expand_path('sources.json', __dir__))).freeze
       CONTENT_SECURITY_POLICY = <<-CSP.delete("\n")
         default-src 'none';
         img-src 'self';
@@ -110,12 +101,6 @@ module Flipper
         @request = request
         @code = 200
         @headers = {Rack::CONTENT_TYPE => 'text/plain'}
-        @breadcrumbs =
-          if Flipper::UI.configuration.application_breadcrumb_href
-            [Breadcrumb.new('App', Flipper::UI.configuration.application_breadcrumb_href)]
-          else
-            []
-          end
       end
 
       # Public: Runs the request method for the provided request.
@@ -187,7 +172,7 @@ module Flipper
       # location - The String location to set the Location header to.
       def redirect_to(location)
         status 302
-        header 'location', "#{script_name}#{Rack::Utils.escape_path(location)}"
+        header 'location', "#{script_name}#{location}"
         halt [@code, @headers, ['']]
       end
 
@@ -219,16 +204,6 @@ module Flipper
         end
       end
 
-      # Public: Add a breadcrumb to the trail.
-      #
-      # text - The String text for the breadcrumb.
-      # href - The String href for the anchor tag (optional). If nil, breadcrumb
-      #        is assumed to be the end of the trail.
-      def breadcrumb(text, href = nil)
-        breadcrumb_href = href.nil? ? href : "#{script_name}#{href}"
-        @breadcrumbs << Breadcrumb.new(text, breadcrumb_href)
-      end
-
       # Private
       def view_with_layout(&block)
         view :layout, &block
@@ -252,6 +227,16 @@ module Flipper
         request.env['SCRIPT_NAME']
       end
 
+      # Internal: Generate urls relative to the app's script name.
+      #
+      #   url_for("feature")             # => "http://localhost:9292/flipper/feature"
+      #   url_for("/thing")              # => "http://localhost:9292/thing"
+      #   url_for("https://example.com") # => "https://example.com"
+      #
+      def url_for(*parts)
+        URI.join(request.base_url, script_name + '/', *parts).to_s
+      end
+
       # Private
       def views_path
         self.class.views_path
@@ -279,11 +264,6 @@ module Flipper
       # to inform people of that fact.
       def render_read_only
         status 403
-
-        breadcrumb 'Home', '/'
-        breadcrumb 'Features', '/features'
-        breadcrumb 'Noooooope'
-
         halt view_response(:read_only)
       end
 
@@ -296,19 +276,23 @@ module Flipper
       end
 
       def bootstrap_css
-        SOURCES[:bootstrap_css]
+        asset_hash "/css/bootstrap.min.css"
       end
 
       def bootstrap_js
-        SOURCES[:bootstrap_js]
+        asset_hash "/js/bootstrap.min.js"
       end
 
       def popper_js
-        SOURCES[:popper_js]
+        asset_hash "/js/popper.min.js"
       end
 
-      def jquery_js
-        SOURCES[:jquery_js]
+      def asset_hash(src)
+        v = ENV["RACK_ENV"] == "development" ? Time.now.to_i : Flipper::VERSION
+        {
+          src: "#{src}?v=#{v}",
+          hash: SOURCES[src]
+        }
       end
     end
   end

data/lib/flipper/ui/actions/actors_gate.rb

@@ -13,12 +13,6 @@ module Flipper
         def get
           feature = flipper[feature_name]
           @feature = Decorators::Feature.new(feature)
-
-          breadcrumb 'Home', '/'
-          breadcrumb 'Features', '/features'
-          breadcrumb @feature.key, "/features/#{@feature.key}"
-          breadcrumb 'Add Actor'
-
           view_response :add_actor
         end
 
@@ -31,7 +25,7 @@ module Flipper
 
           if values.empty?
             error = "#{value.inspect} is not a valid actor value."
-            redirect_to("/features/#{feature.key}/actors?error=#{error}")
+            redirect_to("/features/#{Flipper::UI::Util.escape feature.key}/actors?error=#{Flipper::UI::Util.escape error}")
           end
 
           values.each do |value|
@@ -45,7 +39,7 @@ module Flipper
             end
           end
 
-          redirect_to("/features/#{feature.key}")
+          redirect_to("/features/#{Flipper::UI::Util.escape feature.key}")
         end
       end
     end

data/lib/flipper/ui/actions/add_feature.rb

@@ -12,18 +12,9 @@ module Flipper
 
           unless Flipper::UI.configuration.feature_creation_enabled
             status 403
-
-            breadcrumb 'Home', '/'
-            breadcrumb 'Features', '/features'
-            breadcrumb 'Noooooope'
-
             halt view_response(:feature_creation_disabled)
           end
 
-          breadcrumb 'Home', '/'
-          breadcrumb 'Features', '/features'
-          breadcrumb 'Add'
-
           view_response :add_feature
         end
       end

data/lib/flipper/ui/actions/boolean_gate.rb

@@ -21,7 +21,7 @@ module Flipper
             feature.disable
           end
 
-          redirect_to "/features/#{@feature.key}"
+          redirect_to "/features/#{Flipper::UI::Util.escape @feature.key}"
         end
       end
     end

data/lib/flipper/ui/actions/cloud_migrate.rb

@@ -0,0 +1,26 @@
+require 'flipper/ui/action'
+require 'flipper/ui/util'
+
+module Flipper
+  module UI
+    module Actions
+      class CloudMigrate < UI::Action
+        route %r{\A/settings\/cloud/?\Z}
+
+        def post
+          result = Flipper::Cloud.migrate(flipper)
+
+          if result.url
+            status 302
+            header 'location', result.url
+            halt [@code, @headers, ['']]
+          else
+            message = "Migration failed (HTTP #{result.code})"
+            message << ": #{result.message}" if result.message
+            redirect_to "/settings?error=#{Flipper::UI::Util.escape(message)}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flipper/ui/actions/feature.rb

@@ -18,10 +18,6 @@ module Flipper
           @page_title = "#{@feature.key} // Features"
           @percentages = [0, 1, 5, 10, 25, 50, 100]
 
-          breadcrumb 'Home', '/'
-          breadcrumb 'Features', '/features'
-          breadcrumb @feature.key
-
           view_response :feature
         end
 
@@ -31,9 +27,6 @@ module Flipper
           unless Flipper::UI.configuration.feature_removal_enabled
             status 403
 
-            breadcrumb 'Home', '/'
-            breadcrumb 'Features', '/features'
-
             halt view_response(:feature_removal_disabled)
           end
 

data/lib/flipper/ui/actions/features.rb

@@ -29,9 +29,6 @@ module Flipper
 
           @show_blank_slate = @features.empty?
 
-          breadcrumb 'Home', '/'
-          breadcrumb 'Features'
-
           view_response :features
         end
 
@@ -41,10 +38,6 @@ module Flipper
           unless Flipper::UI.configuration.feature_creation_enabled
             status 403
 
-            breadcrumb 'Home', '/'
-            breadcrumb 'Features', '/features'
-            breadcrumb 'Noooooope'
-
             halt view_response(:feature_creation_disabled)
           end
 
@@ -52,13 +45,13 @@ module Flipper
 
           if Util.blank?(value)
             error = "#{value.inspect} is not a valid feature name."
-            redirect_to("/features/new?error=#{error}")
+            redirect_to("/features/new?error=#{Flipper::UI::Util.escape error}")
           end
 
           feature = flipper[value]
           feature.add
 
-          redirect_to "/features/#{value}"
+          redirect_to "/features/#{Flipper::UI::Util.escape value}"
         end
       end
     end

data/lib/flipper/ui/actions/groups_gate.rb

@@ -13,11 +13,6 @@ module Flipper
           feature = flipper[feature_name]
           @feature = Decorators::Feature.new(feature)
 
-          breadcrumb 'Home', '/'
-          breadcrumb 'Features', '/features'
-          breadcrumb @feature.key, "/features/#{@feature.key}"
-          breadcrumb 'Add Group'
-
           view_response :add_group
         end
 
@@ -35,10 +30,10 @@ module Flipper
               feature.disable_group value
             end
 
-            redirect_to("/features/#{feature.key}")
+            redirect_to("/features/#{Flipper::UI::Util.escape feature.key}")
           else
             error = "The group named #{value.inspect} has not been registered."
-            redirect_to("/features/#{feature.key}/groups?error=#{error}")
+            redirect_to("/features/#{Flipper::UI::Util.escape feature.key}/groups?error=#{Flipper::UI::Util.escape error}")
           end
         end
       end

data/lib/flipper/ui/actions/percentage_of_actors_gate.rb

@@ -19,10 +19,10 @@ module Flipper
             feature.enable_percentage_of_actors params['value']
           rescue ArgumentError => exception
             error = "Invalid percentage of actors value: #{exception.message}"
-            redirect_to("/features/#{@feature.key}?error=#{error}")
+            redirect_to("/features/#{Flipper::UI::Util.escape @feature.key}?error=#{Flipper::UI::Util.escape error}")
           end
 
-          redirect_to "/features/#{@feature.key}"
+          redirect_to "/features/#{Flipper::UI::Util.escape @feature.key}"
         end
       end
     end

data/lib/flipper/ui/actions/percentage_of_time_gate.rb

@@ -19,10 +19,10 @@ module Flipper
             feature.enable_percentage_of_time params['value']
           rescue ArgumentError => exception
             error = "Invalid percentage of time value: #{exception.message}"
-            redirect_to("/features/#{@feature.key}?error=#{error}")
+            redirect_to("/features/#{Flipper::UI::Util.escape @feature.key}?error=#{Flipper::UI::Util.escape error}")
           end
 
-          redirect_to "/features/#{@feature.key}"
+          redirect_to "/features/#{Flipper::UI::Util.escape @feature.key}"
         end
       end
     end

data/lib/flipper/ui/actions/settings.rb

@@ -10,9 +10,6 @@ module Flipper
         def get
           @page_title = 'Settings'
 
-          breadcrumb 'Home', '/'
-          breadcrumb 'Settings'
-
           view_response :settings
         end
       end

data/lib/flipper/ui/configuration.rb

@@ -5,18 +5,28 @@ module Flipper
     class Configuration
       attr_reader :delete
 
-      attr_accessor :banner_text,
-                    :banner_class
+      attr_accessor :banner_text
+      attr_reader :banner_class
 
       # Public: Is the UI in read only mode or not. Default is false. This
       # supersedes all other write-related options such as
       # (feature_creation_enabled and feature_removal_enabled).
       attr_accessor :read_only
 
-      # Public: If you set this, the UI will always have a first breadcrumb that
+      # Public: If you set this, the UI will always have a first nav item that
       # says "App" which points to this href. The href can be a path (ie: "/")
       # or full url ("https://app.example.com/").
-      attr_accessor :application_breadcrumb_href
+      attr_accessor :application_href
+      alias_method :application_breadcrumb_href, :application_href
+      alias_method :application_breadcrumb_href=, :application_href=
+
+      # Public: An array of nav items to show. By default "Features" and
+      # "Settings" are shown, but you can add your own. Each item must have
+      # a `:title` and `:href` key:
+      #
+      #   config.nav_items << { title: "Custom", href: "/custom/page" }
+      #
+      attr_accessor :nav_items
 
       # Public: Is feature creation allowed from the UI? Defaults to true. If
       # set to false, users of the UI cannot create features. All feature
@@ -97,6 +107,10 @@ module Flipper
         @confirm_fully_enable = false
         @confirm_disable = true
         @read_only = false
+        @nav_items = [
+          { title: "Features", href: "features" },
+          { title: "Settings", href: "settings" },
+        ]
       end
 
       def using_descriptions?

data/lib/flipper/ui/middleware.rb

@@ -27,6 +27,7 @@ module Flipper
         @action_collection.add UI::Actions::Features
         @action_collection.add UI::Actions::Export
         @action_collection.add UI::Actions::Import
+        @action_collection.add UI::Actions::CloudMigrate
         @action_collection.add UI::Actions::Settings
 
         # Static Assets/Files