Queue operations for pglogical replication set-up

[yrudman]

Queue operations for pglogical replication set-up

Fixes https://bugzilla.redhat.com/show_bug.cgi?id=1562956

depends on ManageIQ/manageiq#17956

BEFORE: Page was locked (and ui worker occupied) for the duration of save operation

AFTER: Request to save queued and page unlocked

[yrudman]

@miq-bot add-label enhancement

\cc @gtanzillo

[mzazrivec]

The CI failure

1) OpsController OpsController::Settings::Common #update_exclude_tables_for_remote_region updates the exclude tables for the remote region
Failure/Error:super(options).to_str
ActionController::UrlGenerationError:
  No route matches {:action=>"wait_for_task", :escape=>false, :task_id=>32000000000011}
# ./app/helpers/application_helper.rb:1352:in `remote_function'
# ./app/controllers/application_controller/wait_for_task.rb:31:in `block in browser_refresh_task'
# ./app/controllers/application_controller/wait_for_task.rb:29:in `browser_refresh_task'
# ./app/controllers/application_controller/wait_for_task.rb:61:in `initiate_wait_for_task'
# ./app/controllers/ops_controller/settings/common.rb:209:in `pglogical_save_subscriptions'
# ./spec/controllers/ops_controller/settings/common_spec.rb:215:in `block (4 levels) in <top (required)>'

might be related.

[miq-bot]

Checked commits yrudman/manageiq-ui-classic@2e9833f~...4538215 with ruby 2.3.3, rubocop 0.52.1, haml-lint 0.20.0, and yamllint 1.10.0
2 files checked, 0 offenses detected
Everything looks fine. 👍

[yrudman]

@mzazrivec thank you, failing test fixed

[yrudman]

thank you for merging!
@mzazrivec @himdel there is some small UX changes/degradation in this PR and I am not sure how to fix it: there is no confirmation sent to user after task queued using initiate_wait_for_task,
I was getting Error caught: [AbstractController::DoubleRenderError] Render and/or redirect were called multiple times in this action.... error if add_flash + javascript_flash used together with initiate_wait_for_task.
Do you know how/if there is some work around it?

[himdel]

@yrudman That's because initiate_wait_for_task is doing its own render (see browser_refresh_task in ApplicationController::WaitForTask).

So.. you would probably have to extend browser_refresh_task to support outputting flash messages.

[yrudman]

@himdel thank you for looking at it.
So, they way to fix it is to add extra parameter for confirmation message to initiate_wait_for_task and pass it down to browser_refresh_task with rewriting implementation of browser_refresh_task.

[himdel]

@yrudman yes, sounds about right .. except maybe it'd be better to just make that extra parameter enable pushing the flash messages, instead of just hardcoding one

(as in, use add_flash as now, and then call initiate_wait_for_task with something like :render_flash => true added)

[yrudman]

@himdel I do not think i can implement it (combine two render), it is out of my very limited UI skills, - different league...

[himdel]

Ok, not sure this is still needed, but should it become so:

diff --git a/app/controllers/application_controller/wait_for_task.rb b/app/controllers/application_controller/wait_for_task.rb
index f0c37121c..67456c4d6 100644
--- a/app/controllers/application_controller/wait_for_task.rb
+++ b/app/controllers/application_controller/wait_for_task.rb
@@ -24,12 +24,13 @@ module ApplicationController::WaitForTask
     end
   end
 
-  def browser_refresh_task(task_id)
+  def browser_refresh_task(task_id, should_flash = false)
     session[:async][:interval] += 250 if session[:async][:interval] < 5000 # Slowly move up to 5 second retries
     render :update do |page|
       page << javascript_prologue
       ajax_call = remote_function(:url => {:action => 'wait_for_task', :task_id => task_id})
       page << "setTimeout(\"#{ajax_call}\", #{session[:async][:interval]});"
+      page.replace("flash_msg_div", :partial => "layouts/flash_msg") if should_flash
     end
   end
   private :browser_refresh_task
@@ -38,6 +39,7 @@ module ApplicationController::WaitForTask
   # :task_id => id of task to wait for
   # :action  => 'action_to_call' -- action to be called when the task finishes
   # :rx_action => 'method_to_call' -- a method to create a RxJs message
+  # :flash => true|false -- output queued flash messages *while waiting*
   #
   def initiate_wait_for_task(options = {})
     task_id = options[:task_id]
@@ -58,7 +60,7 @@ module ApplicationController::WaitForTask
       session[:async][:params][:rx_action] = options[:rx_action]
     end
 
-    browser_refresh_task(task_id)
+    browser_refresh_task(task_id, !!options[:flash])
   end
   private :initiate_wait_for_task
 

Is all you'd need to be able to call something like...

add_flash(_("Queued"))
initiate_wait_for_task(:task_id => task_id, :action => "pglogical_save_finished", :flash => true)

and have that flash appear while the spinner is spinning.
(If the message needs to be shown after the action, it needs to come from pglogical_save_finished.)