Comments API: Render markdown on explicit request only

os-autoinst · Nov 16, 2023 · 05a9f12 · 05a9f12
1 parent c0373be
commit 05a9f12
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 6 deletions.
diff --git a/lib/OpenQA/Schema/Result/Comments.pm b/lib/OpenQA/Schema/Result/Comments.pm
@@ -169,11 +169,11 @@ sub event_data ($self) {
     return $data;
 }
 
-sub extended_hash ($self) {
+sub extended_hash ($self, $render_markdown = 1) {
     return {
         id => $self->id,
         text => $self->text,
-        renderedMarkdown => $self->rendered_markdown->to_string,
+        renderedMarkdown => ($render_markdown) ? $self->rendered_markdown->to_string : undef,
         bugrefs => $self->bugrefs,
         created => $self->t_created->strftime("%Y-%m-%d %H:%M:%S %z"),
         updated => $self->t_updated->strftime("%Y-%m-%d %H:%M:%S %z"),

diff --git a/lib/OpenQA/WebAPI/Controller/API/V1/Comment.pm b/lib/OpenQA/WebAPI/Controller/API/V1/Comment.pm
@@ -72,17 +72,21 @@ sub _comments ($self) {
 =item list()
 
 Returns a list of comments for a job or a job group given its id. For each comment the
-list includes its bug references, date of creation, comment id, rendered markdown text,
+list includes its bug references, date of creation, comment id,
 text, date of update and the user name that created the comment.
 
+Add the optional "render_markdown=1" parameter to include the rendered markdown text
+for each comment.
+
 =back
 
 =cut
 
 sub list ($self) {
     my $comments = $self->_comments();
     return unless $comments;
-    $self->render(json => [map { $_->extended_hash } $comments->all]);
+    my $render_markdown = $self->param('render_markdown') // 0;
+    $self->render(json => [map { $_->extended_hash($render_markdown) } $comments->all]);
 }
 
 

diff --git a/t/16-markdown.t b/t/16-markdown.t
@@ -165,7 +165,8 @@ subtest 'bugrefs to markdown' => sub {
       '<a href="https://bugs.freedesktop.org/show_bug.cgi?id=9876" title="Bug referenced: fdo#9876">fdo#9876</a>',
       'right markdown for fdo';
     is bugref_to_html('jsc#9876'),
-      '<a href="https://jira.suse.de/browse/9876" title="Bug referenced: jsc#9876">jsc#9876</a>', 'right markdown for jsc';
+      '<a href="https://jira.suse.de/browse/9876" title="Bug referenced: jsc#9876">jsc#9876</a>',
+      'right markdown for jsc';
     is bugref_to_html('pio#foo#1234'),
       '<a href="https://pagure.io/foo/issue/1234" title="Bug referenced: pio#foo#1234">pio#foo#1234</a>',
       'right markdown for pio';

diff --git a/t/api/09-comments.t b/t/api/09-comments.t
@@ -120,7 +120,7 @@ sub test_comments ($in, $id) {
     };
 
     subtest 'list multiple comments' => sub {
-        $t->get_ok("/api/v1/$in/$id/comments")->status_is(200)
+        $t->get_ok("/api/v1/$in/$id/comments?render_markdown=1")->status_is(200)
           ->json_is('/0/text' => $edited_test_message, 'text correct')->json_is(
             '/0/renderedMarkdown' =>
 "<p>This is a cool test \x{2620} - <a href=\"http://open.qa\">http://open.qa</a> - this message will be\\nappended if editing works \x{2620}</p>\n",