Maruku Katello warning

lzap · April 30, 2021, 2:58pm

Hey, this is bugging me for months:

 ___________________________________________________________________________
| Maruku tells you:
+---------------------------------------------------------------------------
| Could not find ref_id = "Actions::Katello::Repository::Synchronize" for md_link([
|       md_entity("ldquo"),
|       "Actions::Katello::Repository::Synchronize",
|       md_entity("rdquo")
| ], nil)
| Available refs are []
+---------------------------------------------------------------------------
!/home/lzap/.rbenv/versions/2.7.2/lib/ruby/gems/2.7.0/gems/maruku-0.7.3/lib/maruku/output/to_html.rb:656:in `to_html_link'
!/home/lzap/.rbenv/versions/2.7.2/lib/ruby/gems/2.7.0/gems/maruku-0.7.3/lib/maruku/output/to_html.rb:891:in `block in array_to_html'
!/home/lzap/.rbenv/versions/2.7.2/lib/ruby/gems/2.7.0/gems/maruku-0.7.3/lib/maruku/output/to_html.rb:879:in `each'
!/home/lzap/.rbenv/versions/2.7.2/lib/ruby/gems/2.7.0/gems/maruku-0.7.3/lib/maruku/output/to_html.rb:879:in `array_to_html'
\___________________________________________________________________________

Not creating a link for ref_id = "Actions::Katello::Repository::Synchronize".

Any idea where this comes from? Let’s fix this, it is Friday!

cintrix84 · April 30, 2021, 7:41pm

If we can get rid of this, it would be amazing, it is so annoying and clogs up the output when trying to debug.

Justin_Sherrill · April 30, 2021, 8:34pm

i’ve not seen this. Do you see it on every request?

tbrisker · May 2, 2021, 7:46am

Looks like the source is here:

github.com

theforeman/foreman-tasks/blob/49d86fb388cef3945b299c3769f266b6a9b1f5b1/app/controllers/foreman_tasks/api/tasks_controller.rb#L54


  param :user_id, String, :desc => <<-DESC
    In case :type = 'user', find tasks for the user
  DESC
  param :resource_type, String, :desc => <<-DESC
    In case :type = 'resource', what resource type we're searching the tasks for
  DESC
  param :resource_type, String, :desc => <<-DESC
    In case :type = 'resource', what resource id we're searching the tasks for
  DESC
  param :action_types, [String], :desc => <<-DESC
    Return just tasks of given action type, e.g. ["Actions::Katello::Repository::Synchronize"]
  DESC
  param :active_only, :bool
  param :page, String
  param :per_page, String
end
desc <<-DESC
  For every search it returns the list of tasks that satisfty the condition.
  The reason for supporting multiple searches is the UI that might be ending
  needing periodic updates on task status for various searches at the same time.
  This way, it is possible to get all the task statuses with one request.

For some reason, when booting up apipie passes this string to maruku which tries to convert it to a link but fails. @ofedoren any idea what’s going on here?

lzap · May 3, 2021, 10:47am

Yes, I do see pretty often.

So all we need to do is remove the braces I guess as it is trying to interpret this as MD. I did the patch and it indeed does help! Nice.

https://github.com/theforeman/foreman-tasks/pull/631

ofedoren · May 3, 2021, 2:12pm

@tbrisker, unfortunatelly I’m not so familiar with Maruku, but your suggestion makes sense. And as far as I know there are a lot of such warnings, so it will require to go through all apipie[_dsl] usage and check the places that can be wrongly interpreted by Maruku.