From 7982e4e89099e01449a4207d029090ab76b2e7aa Mon Sep 17 00:00:00 2001
From: Tom Benner <tombenner@gmail.com>
Date: Sun, 21 Jun 2015 11:33:32 -0700
Subject: [PATCH] Prevent redundant polling in the web UI

---
 test/test_web.rb                        | 6 ++++++
 web/views/_nav.erb                      | 4 ++--
 web/views/_poll_js.erb                  | 5 +++++
 web/views/{_poll.erb => _poll_link.erb} | 3 ---
 web/views/layout.erb                    | 1 +
 5 files changed, 14 insertions(+), 5 deletions(-)
 create mode 100644 web/views/_poll_js.erb
 rename web/views/{_poll.erb => _poll_link.erb} (81%)

diff --git a/test/test_web.rb b/test/test_web.rb
index 45045944..1eb14548 100644
--- a/test/test_web.rb
+++ b/test/test_web.rb
@@ -295,6 +295,12 @@ class TestWeb < Sidekiq::Test
       assert_match /#{msg['args'][2]}/, last_response.body
     end
 
+    it 'calls updatePage() once when polling' do
+      get '/busy?poll=true'
+      assert_equal 200, last_response.status
+      assert_equal 1, last_response.body.scan('updatePage(').count
+    end
+
     it 'escape job args and error messages' do
       # on /retries page
       params = add_xss_retry
diff --git a/web/views/_nav.erb b/web/views/_nav.erb
index 8ddcd5fb..e7c3da1c 100644
--- a/web/views/_nav.erb
+++ b/web/views/_nav.erb
@@ -7,7 +7,7 @@
         <span class="icon-bar"></span>
       </button>
       <div class="navbar-toggle collapsed navbar-livereload">
-        <%= erb :_poll %>
+        <%= erb :_poll_link %>
         <% if Sidekiq::Web.app_url %>
           <a class="btn btn-inverse" href="<%= Sidekiq::Web.app_url %>">Back to App</a>
         <% end %>
@@ -54,7 +54,7 @@
       <ul class="nav navbar-nav navbar-right navbar-livereload" data-navbar="static">
         <li>
           <div class="poll-wrapper pull-right">
-            <%= erb :_poll %>
+            <%= erb :_poll_link %>
             <% if Sidekiq::Web.app_url %>
               <a class="btn btn-inverse" href="<%= Sidekiq::Web.app_url %>">Back to App</a>
             <% end %>
diff --git a/web/views/_poll_js.erb b/web/views/_poll_js.erb
new file mode 100644
index 00000000..9018cfc9
--- /dev/null
+++ b/web/views/_poll_js.erb
@@ -0,0 +1,5 @@
+<% if current_path != '' && params[:poll] %>
+  <script>
+    updatePage('<%= root_path + current_path %>')
+  </script>
+<% end %>
diff --git a/web/views/_poll.erb b/web/views/_poll_link.erb
similarity index 81%
rename from web/views/_poll.erb
rename to web/views/_poll_link.erb
index f6e88a82..d6aba179 100644
--- a/web/views/_poll.erb
+++ b/web/views/_poll_link.erb
@@ -1,8 +1,5 @@
 <% if current_path != '' %>
   <% if params[:poll] %>
-    <script>
-      updatePage('<%= root_path + current_path %>')
-    </script>
     <a id="live-poll" class="btn btn-primary active" href="<%= root_path + current_path %>"><%= t('StopPolling') %></a>
   <% else %>
     <a id="live-poll" class="btn btn-primary" href="<%= root_path + current_path %>?<%= qparams(poll: true) %>"><%= t('LivePoll') %></a>
diff --git a/web/views/layout.erb b/web/views/layout.erb
index 80d73374..86447612 100644
--- a/web/views/layout.erb
+++ b/web/views/layout.erb
@@ -26,5 +26,6 @@
       </div>
     </div>
     <%=  erb :_footer %>
+    <%= erb :_poll_js %>
   </body>
 </html>