GRN2-243: Added a report issue button to the 500 error page (#796)

* Added a report issue button to the 500 error page

* Removed unused code

* Removed unused quotes

app/controllers/errors_controller.rb

@@ -27,7 +27,8 @@ class ErrorsController < ApplicationController
         status_code: 500,
         message: I18n.t("errors.internal.message"),
         help: I18n.t("errors.internal.help"),
-        display_back: true
+        display_back: true,
+        report_issue: true
       }
   end
 

app/views/errors/greenlight_error.html.erb

@@ -16,24 +16,29 @@
 <div class="container text-center pt-9">
   <div class="display-1 text-primary mb-5">
     <% if defined?(status_code) %>
-        <%= status_code %>
+      <%= status_code %>
     <% else %>
-        404
+      404
     <% end %>
   </div>
-    <% if defined?(message) && defined?(help) %>
+  <% if defined?(message) && defined?(help) %>
-        <h1 class="h2 mb-3"><%= message %></h1>
+    <h1 class="h2 mb-3"><%= message %></h1>
-        <p class="h4 text-muted font-weight-normal mb-7"><%= help %></p>
+    <p class="h4 text-muted font-weight-normal mb-7"><%= help %></p>
-        <% if defined?(display_back) && display_back %>
+    <% if defined?(display_back) && display_back %>
-            <a class="btn btn-primary" href="javascript:history.back()">
+      <a class="btn btn-primary" href="javascript:history.back()">
-                <i class="fas fa-arrow-left mr-2"></i><%= t("go_back") %>
+        <i class="fas fa-arrow-left mr-2"></i><%= t("go_back") %>
-            </a>
+      </a>
-        <% end %>
-    <% else %>
-        <h1 class="h2 mb-3"><%= t("errors.not_found.message") %></h1>
-        <p class="h4 text-muted font-weight-normal mb-7"><%= t("errors.not_found.help") %></p>
-        <a class="btn btn-primary" href="javascript:history.back()">
-            <i class="fas fa-arrow-left mr-2"></i><%= t("go_back") %>
-        </a>
     <% end %>
+    <% if defined?(report_issue) && report_issue && Rails.configuration.report_issue_url.present? %>
+      <a class="btn btn-primary ml-4" href="<%= Rails.configuration.report_issue_url %>" target="_blank" rel="noopener">
+        <i class="fas fa-exclamation mr-2"></i><%= t("errors.internal.report") %>
+      </a>
+    <% end %>
+  <% else %>
+    <h1 class="h2 mb-3"><%= t("errors.not_found.message") %></h1>
+    <p class="h4 text-muted font-weight-normal mb-7"><%= t("errors.not_found.help") %></p>
+    <a class="btn btn-primary" href="javascript:history.back()">
+      <i class="fas fa-arrow-left mr-2"></i><%= t("go_back") %>
+    </a>
+  <% end %>
 </div>

app/views/shared/_header.html.erb

@@ -76,6 +76,11 @@
               <a class="dropdown-item" href="http://docs.bigbluebutton.org/install/greenlight-v2.html" target="_blank" rel="noopener">
                 <i class="dropdown-icon far fa-question-circle"></i> <%= t("header.dropdown.help") %>
               </a>
+              <% if Rails.configuration.report_issue_url.present? %>
+                <a class="dropdown-item" href="<%= Rails.configuration.report_issue_url %>" target="_blank" rel="noopener">
+                  <i class="dropdown-icon fas fa-exclamation mr-3"></i><%= t("errors.internal.report") %>
+                </a>
+              <% end %>
               <%= link_to logout_path, class: "dropdown-item" do %>
                 <i class="dropdown-icon fas fa-sign-out-alt"></i> <%= t("header.dropdown.signout") %>
               <% end %>

config/application.rb

@@ -125,6 +125,8 @@ module Greenlight
     config.maintenance_window = ENV["MAINTENANCE_WINDOW"]
     config.maintenance_mode = ENV["MAINTENANCE_MODE"] == "true"
 
+    config.report_issue_url = ENV["REPORT_ISSUE_URL"]
+
     # DEFAULTS
 
     # Default branding image if the user does not specify one

config/locales/en.yml

@@ -153,6 +153,7 @@ en:
     internal:
       message: Looks like something went wrong on our end.
       help: The error has been logged, we'll take a look!
+      report: Report Issue
     maintenance:
       message: Sorry, we're down for maintenance.
       help: We'll be back soon!

sample.env

@@ -162,6 +162,12 @@ MAINTENANCE_MODE=false
 # Ex: MAINTENANCE_WINDOW=Friday August 18 6pm-10pm EST
 MAINTENANCE_WINDOW=
 
+# The link to the Report an Issue button that appears on the 500 page and in the Account Dropdown
+#
+# Defaults to the Github Issues Page for Greenlight
+# Button can be disabled by setting the value to blank
+REPORT_ISSUE_URL=https://github.com/bigbluebutton/greenlight/issues/new
+
 # Comment this out to send logs to STDOUT in production instead of log/production.log .
 #
 # RAILS_LOG_TO_STDOUT=true