fix(atomic, quantic): broken HTML because of formatting in CRGA markdown heading #4553
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
@coveo/[email protected] @coveo/[email protected] @coveo/[email protected] @coveo/[email protected] @coveo/[email protected] @coveo/[email protected] @coveo/[email protected] **/CHANGELOG.md **/package.json CHANGELOG.md package.json package-lock.json
lbergeron
requested review from
erocheleau,
SimonMilord,
mmitiche,
olamothe,
fpbrault,
louis-bompart and
alexprudhomme
Pull Request ReportPR Title✅ Title follows the conventional commit spec. Live demo linksBundle Size
SSR Progress
Detailed logssearch : buildInteractiveResultsearch : buildInteractiveInstantResult search : buildInteractiveRecentResult search : buildInteractiveCitation search : buildGeneratedAnswer recommendation : missing SSR support product-recommendation : missing SSR support product-listing : missing SSR support case-assist : missing SSR support insight : missing SSR support commerce : missing SSR support |
lbergeron
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
fbeaudoincoveo
approved these changes
Oct 17, 2024
lbergeron
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
SimonMilord
reviewed
Oct 18, 2024
| ); | ||
| }); | ||
|
|
||
| it('should transform heading with nested formatting', () => { |
There was a problem hiding this comment.
should we also have this test for nested formatting in the quantic tests?
There was a problem hiding this comment.
Considering the test suite was simplified for Quantic, I went with a single test to cover the change. I don't think adding another test for nested formatting is necessary.
SimonMilord
approved these changes
Oct 18, 2024
alexprudhomme
requested changes
Oct 21, 2024
lbergeron
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
|
Creating a clean PR with the TIP of |
lbergeron
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SVCC-4245
A CRGA model generally generates markdown headings like this:
However, in some cases, it can generate headings this way:
When it does, the HTML returned by the
generated-answercomponent is broken and the heading reads like this:The core of the issue is in the custom Marked renderer. When the heading has formatting, the
textparameter contains the HTML rendering of the heading content. Inserting non-escaped HTML into thearia-labelattribute then breaks thedivelement.This PR fixes the issue by affecting only the heading text content to the
aria-labelattribute. To do so, the HTML elements are removed from the heading content when settingaria-label. The heading content HTML is kept intact when setting the heading inner HTML though in order to keep the heading formatting.For example:
Would generate this HTML