Queue reporting work for any zone #18041

jrafanie · 2018-10-01T14:54:44Z

Because reporting is a regional role, meaning, it's possible to do the same reporting work from different zones in the same region, we need to queue reporting work for the nil ("any") zone. By allowing queue put to choose the current server's zone, it was possible for UI appliances without the reporting role to create reporting queue messages that would never get processed.

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

Notifier is a regional role, so there's no need to set the zone for it here. It's done lower in the stack, when 'put' calls 'determine_queue_zone'. https://bugzilla.redhat.com/show_bug.cgi?id=1629945

jrafanie · 2018-10-01T14:56:02Z

This seems like a good candidate to backport to g and h branches since it's not that risky.

@miq-bot add_label gaprindashvili/yes
@miq-bot add_label hammer/yes

jrafanie · 2018-10-01T14:58:30Z

app/models/miq_report/generator.rb

@@ -164,8 +164,8 @@ def queue_generate_table(options = {})
    if sync
      _async_generate_table(task.id, options)
    else
-      MiqQueue.put(
-        :queue_name  => "reporting",


This was most likely the cause of the reporting bug where reporting work would be enqueued for a zone without a reporting role. The absence of the :role => "reporting" and :zone => nil causes this message to be queued for :zone => Zone.my_zone (the current server's zone)

jrafanie · 2018-10-01T14:59:37Z

app/models/miq_report/generator.rb

@@ -792,9 +792,8 @@ def queue_report_result(options, res_opts)
    _log.info("Adding generate report task to the message queue...")
    task = MiqTask.create(:name => "Generate Report: '#{name}'", :userid => options[:userid])

-    MiqQueue.put(
-      :queue_name  => "reporting",
-      :role        => "reporting",


Note, this was probably not causing the issue seen above because it specified the role as reporting, which should set the zone to nil. To simplify things, I moved this code to use the submit_job method to be more consistent.

jrafanie · 2018-10-01T15:00:26Z

app/models/miq_widget.rb

@@ -108,6 +108,7 @@ def queue_generate_content_for_users_or_group(*args)
    MiqQueue.create_with(callback).put_unless_exists(
      :queue_name  => "reporting",
      :role        => "reporting",
+      :zone        => nil, # any zone


Note, I didn't change this to use submit_job because that method doesn't support put_unless_exists. Therefore, I have to set the zone to nil.

bdunne · 2018-10-01T15:04:47Z

spec/models/miq_report/generator_spec.rb

+    it "#queue_generate_table" do
+      report.queue_generate_table(:userid => "admin")
+      task = MiqTask.first
+      expect(task.name).to eq("Generate Report: '#{report.name}'")


expect(task).to have_attributes(:name => ...)

bdunne · 2018-10-01T15:05:15Z

spec/models/miq_report/generator_spec.rb

+    it "#queue_report_result" do
+      task_id = report.queue_report_result({:userid => "admin"}, {})
+      task = MiqTask.find(task_id)
+      expect(task.name).to eq("Generate Report: '#{report.name}'")


jrafanie · 2018-10-01T15:50:51Z

app/models/miq_report/generator.rb

-      MiqQueue.put(
-        :queue_name  => "reporting",
+      MiqQueue.submit_job(
+        :service     => "reporting",


To be clear, submit_job will set the role as reporting and because of this, determine_queue_zone, from put, will set the zone to nil for "any" zone.

bdunne · 2018-10-01T16:06:57Z

spec/models/miq_report/generator_spec.rb

+      )
+
+      message = MiqQueue.where(:method_name => "_async_generate_table")
+      message = message.first


bdunne · 2018-10-01T16:07:19Z

spec/models/miq_report/generator_spec.rb

+      )
+
+      message = MiqQueue.where(:method_name => "build_report_result")
+      message = message.first


https://bugzilla.redhat.com/show_bug.cgi?id=1629945 Because the queue put was specifying a queue_name without a role OR zone, the zone was being set to MiqServer.my_zone. By leveraging the higher level method, submit_job, specifying the service of "reporting" sets the role and because reporting is a regional role, there's no need to specify the zone, it will default to the "nil" (any) zone.

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

jrafanie · 2018-10-01T18:15:32Z

Ok, I think I got all the things cleaned up

miq-bot · 2018-10-01T18:23:11Z

Checked commits jrafanie/manageiq@68dad68~...c5c004c with ruby 2.3.3, rubocop 0.52.1, haml-lint 0.20.0, and yamllint 1.10.0
7 files checked, 0 offenses detected
Everything looks fine. 🍪

…zone Queue reporting work for any zone (cherry picked from commit 65ef49c) https://bugzilla.redhat.com/show_bug.cgi?id=1629945

simaishi · 2018-10-02T13:19:58Z

Hammer backport details:

$ git log -1
commit 9d680ed61217a82f61fe964357ad65aac7ea8d25
Author: Brandon Dunne <[email protected]>
Date:   Mon Oct 1 14:34:36 2018 -0400

    Merge pull request #18041 from jrafanie/queue_reporting_work_for_any_zone
    
    Queue reporting work for any zone
    
    (cherry picked from commit 65ef49c7d2bc27a56406d18bf9e40d1696871e94)
    
    https://bugzilla.redhat.com/show_bug.cgi?id=1629945

…zone Queue reporting work for any zone (cherry picked from commit 65ef49c) https://bugzilla.redhat.com/show_bug.cgi?id=1635255

simaishi · 2018-11-05T15:45:09Z

Gaprindashvili backport details:

$ git log -1
commit 652732ba513d7c6810f610e50292119eb959133a
Author: Brandon Dunne <[email protected]>
Date:   Mon Oct 1 14:34:36 2018 -0400

    Merge pull request #18041 from jrafanie/queue_reporting_work_for_any_zone
    
    Queue reporting work for any zone
    
    (cherry picked from commit 65ef49c7d2bc27a56406d18bf9e40d1696871e94)
    
    https://bugzilla.redhat.com/show_bug.cgi?id=1635255

Required after changes from PR ManageIQ/manageiq#18041

…for_any_zone Queue reporting work for any zone (cherry picked from commit 65ef49c) https://bugzilla.redhat.com/show_bug.cgi?id=1635255

Queue zone is handled in 'put' for regional roles

68dad68

Notifier is a regional role, so there's no need to set the zone for it here. It's done lower in the stack, when 'put' calls 'determine_queue_zone'. https://bugzilla.redhat.com/show_bug.cgi?id=1629945

jrafanie added bug core/queue labels Oct 1, 2018

jrafanie requested a review from bdunne October 1, 2018 14:54

miq-bot added gaprindashvili/yes labels Oct 1, 2018

jrafanie commented Oct 1, 2018

View reviewed changes

jrafanie requested a review from kbrock October 1, 2018 15:02

bdunne reviewed Oct 1, 2018

View reviewed changes

jrafanie force-pushed the queue_reporting_work_for_any_zone branch from 9547007 to 01f6f3f Compare October 1, 2018 15:49

jrafanie commented Oct 1, 2018

View reviewed changes

bdunne reviewed Oct 1, 2018

View reviewed changes

jrafanie added 2 commits October 1, 2018 14:13

Specify "any" zone via a nil zone

c5c004c

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

jrafanie force-pushed the queue_reporting_work_for_any_zone branch from 01f6f3f to c5c004c Compare October 1, 2018 18:13

bdunne approved these changes Oct 1, 2018

View reviewed changes

bdunne merged commit 65ef49c into ManageIQ:master Oct 1, 2018

bdunne added this to the Sprint 96 Ending Oct 8, 2018 milestone Oct 1, 2018

bdunne self-assigned this Oct 1, 2018

jrafanie deleted the queue_reporting_work_for_any_zone branch October 1, 2018 18:49

simaishi pushed a commit that referenced this pull request Oct 2, 2018

Merge pull request #18041 from jrafanie/queue_reporting_work_for_any_…

9d680ed

…zone Queue reporting work for any zone (cherry picked from commit 65ef49c) https://bugzilla.redhat.com/show_bug.cgi?id=1629945

simaishi added hammer/backported and removed hammer/yes labels Oct 2, 2018

gmcculloug mentioned this pull request Oct 2, 2018

Remove check for nil zone during MiqQueue.put of GenericMailer ManageIQ/manageiq-automation_engine#241

Merged

simaishi added the blocker label Nov 5, 2018

simaishi pushed a commit that referenced this pull request Nov 5, 2018

Merge pull request #18041 from jrafanie/queue_reporting_work_for_any_…

652732b

…zone Queue reporting work for any zone (cherry picked from commit 65ef49c) https://bugzilla.redhat.com/show_bug.cgi?id=1635255

simaishi added gaprindashvili/backported and removed gaprindashvili/yes labels Nov 5, 2018

lfu added a commit to lfu/manageiq-automation_engine that referenced this pull request Nov 5, 2018

Update the zone check during MiqQueue.put.

4358e7f

Required after changes from PR ManageIQ/manageiq#18041

lfu mentioned this pull request Nov 5, 2018

[GAPRINDASHVILI] Update the zone check during MiqQueue.put. ManageIQ/manageiq-automation_engine#267

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Queue reporting work for any zone #18041

Queue reporting work for any zone #18041

jrafanie commented Oct 1, 2018

jrafanie commented Oct 1, 2018

jrafanie Oct 1, 2018

jrafanie Oct 1, 2018

jrafanie Oct 1, 2018

bdunne Oct 1, 2018

bdunne Oct 1, 2018

jrafanie Oct 1, 2018

bdunne Oct 1, 2018

bdunne Oct 1, 2018

jrafanie commented Oct 1, 2018

miq-bot commented Oct 1, 2018

simaishi commented Oct 2, 2018

simaishi commented Nov 5, 2018

Queue reporting work for any zone #18041

Queue reporting work for any zone #18041

Conversation

jrafanie commented Oct 1, 2018

jrafanie commented Oct 1, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jrafanie commented Oct 1, 2018

miq-bot commented Oct 1, 2018

simaishi commented Oct 2, 2018

simaishi commented Nov 5, 2018