feat: Improvements to the restart link user feedback (#511)

abujeda · web-flow · commit 04fdfc175e43 · 2025-09-29T10:50:28.000+01:00
diff --git a/application/app/services/nav/nav_defaults.rb b/application/app/services/nav/nav_defaults.rb
@@ -92,7 +92,7 @@ def self.navigation_items
             {
               id: 'nav-restart',
               label: I18n.t('layouts.nav.navigation.link_restart_text'),
-              url: "/nginx/stop?redir=#{routes.root_path}",
+              url: routes.widgets_path('restart'),
               icon: 'bs://bi-bootstrap-reboot',
               position: 3
             },
diff --git a/application/app/views/widgets/_reset.html.erb b/application/app/views/widgets/_reset.html.erb
@@ -8,9 +8,6 @@
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <%= stylesheet_link_tag "application" %>
   <%= javascript_include_tag "application", defer: true %>
-
-  <!-- Meta refresh fallback -->
-  <meta http-equiv="refresh" content="3;url=<%= root_path %>">
 </head>
 <body class="bg-light d-flex justify-content-center align-items-center vh-100">
 <div class="container">
@@ -25,9 +22,11 @@
         </div>
         <!-- Success redirect -->
         <script>
+            <!-- FIRE AND FORGET -->
+            fetch("<%= restart_url %>").catch(() => { })
             setTimeout(function() {
-                window.location.href = "<%= restart_url %>";
-            }, 3000);
+                window.location.href = "<%= root_path %>";
+            }, <%= ::Configuration.restart_delay %>);
         </script>
       <% else %>
         <div class="alert alert-danger border-2 rounded-3 shadow-sm text-center" role="alert">
@@ -39,7 +38,7 @@
         <script>
             setTimeout(function() {
                 window.location.href = "<%= root_path %>";
-            }, 3000);
+            }, <%= ::Configuration.restart_delay %>);
         </script>
       <% end %>
     </div>
diff --git a/application/app/views/widgets/_restart.html.erb b/application/app/views/widgets/_restart.html.erb
@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= t('.page_title') %></title>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <%= stylesheet_link_tag "application" %>
+  <%= javascript_include_tag "application", defer: true %>
+</head>
+<body class="bg-light d-flex justify-content-center align-items-center vh-100">
+<div class="container">
+  <div class="row justify-content-center">
+    <div class="col-md-8 col-lg-6">
+      <div class="alert alert-success border-2 rounded-3 shadow-sm text-center" role="alert">
+        <i class="bi bi-arrow-repeat fs-3 text-success mb-2"></i>
+        <h4 class="alert-heading"><%= t('.content_title') %></h4>
+        <%= t('.content_html', url: root_path) %>
+      </div>
+      <script>
+          // Fire and forget restart trigger
+          fetch("<%= restart_url %>").catch(() => { })
+          setTimeout(function() {
+              window.location.href = "<%= root_path %>";
+          }, <%= ::Configuration.restart_delay %>);
+      </script>
+    </div>
+  </div>
+</div>
+</body>
+</html>
diff --git a/application/config/configuration_singleton.rb b/application/config/configuration_singleton.rb
@@ -21,6 +21,7 @@ def property_configs
       ::ConfigurationProperty.integer(:download_files_retention_period, default: 24 * 60 * 60),
       ::ConfigurationProperty.integer(:upload_files_retention_period, default: 24 * 60 * 60),
       ::ConfigurationProperty.integer(:ui_feedback_delay, default: 1500),
+      ::ConfigurationProperty.integer(:restart_delay, default: 3000),
       ::ConfigurationProperty.integer(:detached_controller_interval, default: 10),
       ::ConfigurationProperty.integer(:detached_process_status_interval, default: 10 * 1000), # 10s in MILLISECONDS
       ::ConfigurationProperty.integer(:max_download_file_size, default: 10 * 1024 * 1024 * 1024), # 10 GIGABYTE
diff --git a/application/config/locales/views/en.yml b/application/config/locales/views/en.yml
@@ -324,12 +324,22 @@ en:
       tab_project_label: "This Project Downloads"
       tab_global_label: "All Projects"
       empty_recent_text: "No recently used datasets found."
+    restart:
+      page_title: "Application Restarting"
+      content_title: "Restart in Progress"
+      content_html: >
+        <p>Your personal <em>OnDemand Loop</em> instance is restarting.</p>
+        <p>You will be redirected to the application <strong>shortly</strong>.</p>
+        <hr>
+        <p class="mb-0">
+          If the page does not refresh automatically, <a href="%{url}">click here to continue</a>.
+        </p>
     reset:
       success_page_title: "Reset Completed"
       success_content_title: "Reset Completed"
       success_content_html: >
         <p>Your personal <em>OnDemand Loop</em> instance has been successfully reset.</p>
-        <p>The application will automatically restart in <strong>3 seconds</strong>.</p>
+        <p>The application will automatically restart <strong>shortly</strong>.</p>
         <hr>
         <p class="mb-0">
         If the page does not refresh, <a href="%{url}">click here to continue</a>.
diff --git a/application/test/services/nav/nav_defaults_test.rb b/application/test/services/nav/nav_defaults_test.rb
@@ -157,7 +157,6 @@ class Nav::NavDefaultsTest < ActiveSupport::TestCase
     assert_equal 'bs://bi-bootstrap-reboot', restart_item.icon
     assert_equal 3, restart_item.position
     assert restart_item.link?
-    assert_includes restart_item.url, '/nginx/stop?redir='
 
     separator_item = menu_items_by_id['help-reset-separator']
     assert_equal '---', separator_item.label
diff --git a/application/test/views/widgets/reset_partial_test.rb b/application/test/views/widgets/reset_partial_test.rb
@@ -19,8 +19,9 @@ def render_with(method: :post)
 
     assert_includes html, 'Reset Completed'
     assert_includes html, 'successfully reset'
-    assert_includes html, 'window.location.href = "/restart"'
+    assert_includes html, 'window.location.href = "/"'
     assert_includes html, 'bi-check-circle-fill'
+    assert_includes html, 'fetch("/restart")'
   end
 
   test 'renders error when request is GET' do
diff --git a/application/test/views/widgets/restart_partial_test.rb b/application/test/views/widgets/restart_partial_test.rb
@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class RestartPartialTest < ActionView::TestCase
+
+  def render_restart_partial
+    view.stubs(:restart_url).returns('/restart')
+    view.stubs(:root_path).returns('/')
+
+    render partial: 'widgets/restart'
+  end
+
+  test 'renders restart content with correct elements' do
+    html = render_restart_partial
+
+    assert_includes html, 'Application Restarting'
+    assert_includes html, 'Restart in Progress'
+    assert_includes html, 'restarting'
+    assert_includes html, 'bi-arrow-repeat'
+    assert_includes html, 'alert-success'
+  end
+
+  test 'includes restart fetch call and redirect script' do
+    html = render_restart_partial
+
+    assert_includes html, 'fetch("/restart")'
+    assert_includes html, 'window.location.href = "/"'
+  end
+
+  test 'uses Configuration.restart_delay for timeout' do
+    html = render_restart_partial
+
+    # Should include the configuration value in the setTimeout
+    assert_match /setTimeout\(function\(\)\s*\{.*\},\s*\d+\);/m, html
+  end
+end
diff --git a/docs/guide/content/admin/configuration.md b/docs/guide/content/admin/configuration.md
@@ -64,6 +64,7 @@ The following properties control various aspects of OnDemand Loop's behavior. Ea
 - [download_files_retention_period](#download_files_retention_period)
 - [upload_files_retention_period](#upload_files_retention_period)
 - [ui_feedback_delay](#ui_feedback_delay)
+- [restart_delay](#restart_delay)
 - [detached_controller_interval](#detached_controller_interval)
 - [detached_process_status_interval](#detached_process_status_interval)
 - [max_download_file_size](#max_download_file_size)
@@ -191,6 +192,15 @@ Defines the delay in milliseconds for feedback messages in the UI, such as tempo
 
 ---
 
+<a id="restart_delay"></a>
+**`restart_delay`**  
+Sets the delay in milliseconds before redirecting users after application restart or reset operations. This gives users time to read completion messages.
+
+- **Default**: `3_000`
+- **Environment Variable**: `OOD_LOOP_RESTART_DELAY`
+
+---
+
 <a id="detached_controller_interval"></a>
 **`detached_controller_interval`**  
 Controls how often (in seconds) the detached background process controller checks for updates or process state changes.
@@ -385,6 +395,7 @@ locale: ":es"
 download_files_retention_period: 172_800
 upload_files_retention_period: 172_800
 ui_feedback_delay: 2_000
+restart_delay: 3_000
 detached_controller_interval: 5
 detached_process_status_interval: 2_000
 max_download_file_size: 15_000_000_000
@@ -413,6 +424,7 @@ OOD_LOOP_LOCALE=:es
 OOD_LOOP_DOWNLOAD_FILES_RETENTION_PERIOD=172_800
 OOD_LOOP_UPLOAD_FILES_RETENTION_PERIOD=172_800
 OOD_LOOP_UI_FEEDBACK_DELAY=2_000
+OOD_LOOP_RESTART_DELAY=3_000
 OOD_LOOP_DETACHED_CONTROLLER_INTERVAL=5
 OOD_LOOP_DETACHED_PROCESS_STATUS_INTERVAL=2_000
 OOD_LOOP_MAX_DOWNLOAD_FILE_SIZE=15_000_000_000

Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ def self.navigation_items`
`92`	`92`	`{`
`93`	`93`	`id: 'nav-restart',`
`94`	`94`	`label: I18n.t('layouts.nav.navigation.link_restart_text'),`
`95`		`- url: "/nginx/stop?redir=#{routes.root_path}",`
	`95`	`+ url: routes.widgets_path('restart'),`
`96`	`96`	`icon: 'bs://bi-bootstrap-reboot',`
`97`	`97`	`position: 3`
`98`	`98`	`},`