Merge pull request #986 from pkrisko/feat/add-version-check-enabled-config

Add version_check_enabled config to skip version.js in UI

Author: jnunemaker

lib/flipper/ui/configuration.rb

@@ -45,6 +45,11 @@ class Configuration
       # false and it will go away. Defaults to true.
       attr_accessor :cloud_recommendation
 
+      # Public: Set to false to disable the version check that fetches the
+      # latest release from flippercloud.io. Useful when a strict Content
+      # Security Policy is in place. Defaults to true.
+      attr_accessor :version_check_enabled
+
       # Public: What should show up in the form to add actors. This can be
       # different per application since flipper_id's can be whatever an
       # application needs. Defaults to "a flipper id".
@@ -114,6 +119,7 @@ def initialize
         @feature_removal_enabled = true
         @fun = true
         @cloud_recommendation = true
+        @version_check_enabled = true
         @add_actor_placeholder = "a flipper id"
         @descriptions_source = DEFAULT_DESCRIPTIONS_SOURCE
         @actor_names_source = DEFAULT_ACTOR_NAMES_SOURCE

lib/flipper/ui/views/layout.erb

@@ -18,8 +18,10 @@
       <%- end -%>
 
       <div class="text-muted small text-end">
-        <a href="#" class="badge text-bg-warning ms-2 d-none" style="font-size:100%" id="new-version-badge" data-version="<%= Flipper::VERSION %>">
-        </a>
+        <% if Flipper::UI.configuration.version_check_enabled %>
+          <a href="#" class="badge text-bg-warning ms-2 d-none" style="font-size:100%" id="new-version-badge" data-version="<%= Flipper::VERSION %>">
+          </a>
+        <% end %>
 
         <% if Flipper.deprecated_ruby_version? %>
           <a href="https://github.com/flippercloud/flipper/pull/776" class="badge text-bg-danger ms-2" style="font-size:100%">
@@ -83,6 +85,8 @@
     <script src="<%= script_name + popper_js[:src] %>" integrity="<%= popper_js[:hash] %>" crossorigin="anonymous"></script>
     <script src="<%= script_name + bootstrap_js[:src] %>" integrity="<%= bootstrap_js[:hash] %>" crossorigin="anonymous"></script>
     <script src="<%= script_name %>/js/application.js?v=<%= Flipper::VERSION %>"></script>
-    <script src="<%= script_name %>/js/version.js?v=<%= Flipper::VERSION %>"></script>
+    <% if Flipper::UI.configuration.version_check_enabled %>
+      <script src="<%= script_name %>/js/version.js?v=<%= Flipper::VERSION %>"></script>
+    <% end %>
   </body>
 </html>

spec/flipper/ui/configuration_spec.rb

@@ -73,6 +73,17 @@
     end
   end
 
+  describe "#version_check_enabled" do
+    it "has default value" do
+      expect(configuration.version_check_enabled).to eq(true)
+    end
+
+    it "can be updated" do
+      configuration.version_check_enabled = false
+      expect(configuration.version_check_enabled).to eq(false)
+    end
+  end
+
   describe "#feature_removal_enabled" do
     it "has default value" do
       expect(configuration.feature_removal_enabled).to eq(true)