Job composer template notes not formatting html

simonleary-umass-edu · January 17, 2023, 9:44pm

See the paragraph on the right, there’s <p> and <code> where there shouldn’t be.

template manifest:

name: Matlab
notes: |
  Running at MATLAB script using using just one node
  (note that `-b` takes a command, not a file; also some toolboxes may require the jvm,
  so you may not want the `-nojvm` option, but try it first).
script: main_job.sh

Is this a known bug? Did I do something wrong?

travert · January 17, 2023, 10:39pm

This may be a bug. It is using the class below to ingest the manifest.yml:

github.com

OSC/ondemand/blob/master/apps/myjobs/app/models/manifest.rb#L33


      
          # @oprion opts [String] "script" The relative path of the submit script in the templated workflow
          def initialize(path, opts)
            raise InvalidContentError.new("Invalid Content in manifest.yml") unless(opts && opts.is_a?(Hash))
          
          
  @path = Pathname.new(path)
          
          
  @name = opts.fetch("name", default_name)
            @host = opts.fetch("host", default_host)
            @notes = opts.fetch("notes", default_notes)
          
          
  if Configuration.render_template_notes_as_markdown?
              begin
                @notes = OodAppkit.markdown.render(@notes)
              rescue StandardError => e
                Rails.logger.warn "Markdown rendering failed for manifest #{@path.to_s}"
              end
            end
          
          
  @script = opts.fetch("script", default_script)
          end

Notice it is checking to see if by default we want to store that input as rendered markdown.

That environment variable is by default set to true here:

github.com

OSC/ondemand/blob/81973d092fd61a4a750de998198debf7fdfd47dc/apps/myjobs/config/configuration_singleton.rb#L122


      
          
          
def locale
            (ENV['OOD_LOCALE'] || I18n.default_locale).to_sym
          end
          
          
def locales_root
            Pathname.new(ENV['OOD_LOCALES_ROOT'] || "/etc/ood/config/locales")
          end
          
          
# Permit sites to disable Markdown rendering of Template notes
          def render_template_notes_as_markdown?
            preference = ENV['RENDER_TEMPLATE_NOTES_AS_MARKDOWN']
          
          
  if preference.nil?
              true
            else
              to_bool(preference)
            end
          end
          
          
def brand_bg_color

So, this seems to always result in that type of output where you see the rendering having already happened.

I’m currently trying to see in the view what happens and if there is any way to get that markdown to render there correctly.

I’ll circle back and post the issue explain the behavior fully when I see what’s going on.

Thanks for pointing this out!

system · July 16, 2023, 10:40pm

This topic was automatically closed 180 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
Job templates: unparsed html p-tags wrap description ("notes") text Get Help	2	129	September 15, 2024
Job Composer Thoughts/Suggestions Feature Requests and Roadmap Discussion feature-request	9	1443	May 26, 2022
Job templates: allow for symlink'd script resource Feature Requests and Roadmap Discussion	1	192	June 25, 2024
Location of template file for job composer Get Help	12	1311	May 26, 2022
Error message for Job Composer Get Help question	18	533	October 8, 2022

Job composer template notes not formatting html

Related topics