Skip to content

feat(DuoChat): Add default markdown renderer for streaming messages

What does this MR do?

feat(DuoChat): Add default markdown renderer for streaming messages

While we consume streaming messages, we render markdown on the fly in the frontend. Once the message is finally rendered by the backend, we will consume some rendered HTML.

One of the problems we are facing now, that if a streamed message contains code blocks for example, the code blocks might note be closed yet and comments might be rendered as headings:

```yaml
# this is not a headline

will be rendered as:

<p>```yaml</p>
<h1>this is not a headline</h1>

Luckily the CommonMark spec, which marked follows, considers the end of a markdown document as closing the open code block. So we do not need to worry about: gitlab#433338 (closed)

In order to achieve consistent behavior between our current usages of Duo Chat, we add a default markdown renderer to Duo Chat. This will help us solve gitlab-vscode-extension#1227 (closed) more easily while also ensuring that we can quickly fix rendering issues like the aforementioned codeblock issue in a single place.

In order to ensure that the markdown render doesn't "pollute" other components, we lint against imports and add a message that it is only supposed to be used in Duo Chat.

Screenshots or screen recordings

Screen_Recording_2024-02-06_at_13.20.45

Integration merge requests

Does this MR meet the acceptance criteria?

This checklist encourages the authors, reviewers, and maintainers of merge requests (MRs) to confirm changes were analyzed for conformity with the project's guidelines, security and accessibility.

Toggle the acceptance checklist

Conformity

  • Code review guidelines.
  • GitLab UI's contributing guidelines.
  • If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer.
  • If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer.
  • If the MR changes a component's API, integration MR(s) have been opened (see integration merge requests above).
  • Added the ~"component:*" label(s) if applicable.

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • Security reports checked/validated by a reviewer from the AppSec team

Accessibility

If this MR adds or modifies a component, take a few moments to review the following:

  • All actions and functionality can be done with a keyboard.
  • Links, buttons, and controls have a visible focus state.
  • All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label for icons that have meaning or perform actions.
  • Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false" to aria-expanded="true" when an accordion is expanded.
  • Color combinations have sufficient contrast.
Edited by Lukas 'ai-pi' Eipert

Merge request reports