Switch description and comments to ADF rendering using guarana

Description

First lets rollout new ADF (rich-text) renderer for

  • description
  • comments
  • custom field (there can be ADF custom fields ❗ - like environment field or other)
  • filter view > rich-text column (images might stop working)

that works only if special query param is available in url ?render=adf

Otherwise we will use current rendered.

Image mapping can be done using HTML from Jira api v2.

Please watch of E2E tests 🔍 , specially those related with Issue formatting
`description-display.spec.ts`, `comment-formatting.spec.ts`

Linked issues

relates to
Issue Type Icon ESFJ-391 [Blocked] Expand is not working on JES pages Priority: Medium
Withdrawn
Issue Type Icon ESFJ-368 [Blocked] Table layout breaks when line break appears in cell between two values Priority: Medium
Withdrawn
Issue Type Icon ESFJ-576 Videos included in comment doesn't work on External Share page Priority: Medium
Withdrawn
Issue Type Icon ESFJ-730 Incorrect conversion of HTML text formatting when using text color change Priority: Medium
Withdrawn
Issue Type Icon ESFJ-629 Text and code snippet overflow in comment section Priority: Medium
Released
Issue Type Icon ESFJ-497 Certain links are not automatically converted to inline (Smart) links and cannot be manually converted to inline or card view either Priority: Medium
Withdrawn
Issue Type Icon ESFJ-1020 Non-formatted images fail to display correctly in shared issue descriptions Priority: Medium
Withdrawn
Issue Type Icon ESFJ-652 Images are not displated on shared page Priority: Medium
Withdrawn
Issue Type Icon ESFJ-1073 Add same linking behaviour to comments as in share description Priority: Lowest
To Do

Activity

Polina Naumenko 20 December 2024, 12:29

Improvement implemented - QA env

Polina Naumenko 20 December 2024, 12:27

Daniel Siara 20 December 2024, 11:15

@Polina Naumenko Expand fixed, please retest again

Polina Naumenko 18 December 2024, 14:43

Expand stopped working

@Daniel Siara

Polina Naumenko 18 December 2024, 14:03
  1. linki nie wyswietlaja sie jako inline, card, embed
    w prodzie tez nie dziala

OK

image-20241218-135347.png

  1. attachments iare not displayed

OK

image-20241218-135419.png

  1. group mention displayed as url instead of mention

OK

image-20241218-135541.png

  1. video, image, attachment zip file are not supported in a table
    adf ES has word.doc attachment that supposed to be displayed above in issue 2.

OK

image-20241218-135713.png

  1. scrollbar is a code snippet and code is not rendered

How about rendering? In Jira some strings are in different text

image-20241218-140012.png

  1. scrollbar code snippet in expand

OK

image-20241218-140012.png

  1. image in expand is not supported

OK

image-20241218-140122.png
  1. info panels dark mode icons and strings are not visible

OK

image-20241218-140218.png

  1. image in info panel is not supported (prod the same, might need a new ticket)

OK

image-20241218-140224.png

  1. Decision macro in dark mode is not supported

OK

image-20241218-140249.png

  1. Divider should be in dark mode

OK

  1. Statuses should be in dark mode

OK

image-20241218-140314.png
Daniel Siara 17 December 2024, 08:25

@Polina Naumenko task is ready to restest

Krzysztof Bogdan 10 December 2024, 16:04

@Polina Naumenko

This new ADF render is still broken. I found numerous problems. Please re-test this fully.

Polina Naumenko 4 December 2024, 17:38

Improvement implemented - QA env

Polina Naumenko 4 December 2024, 17:37
  • image size

image-20241204-173716.png
  • smart link & comments

image-20241204-173750.png
Polina Naumenko 4 December 2024, 11:13
  • Edit do not work in old mode

  • Edit do not work in new mode

  • Embedded attachments in description in edit mode - do not work (zip)

image-20241204-103932.png
  • image size - non proper size (should be smaller)

If you adjust size in Jira and refresh a page, size is applied correctly

image-20241204-104442.png
  • Info panel issue (fyi colors are not mapped yet)

image-20241204-105232.png
image-20241204-105345.png
  • code block and inline code block is visually broken.

image-20241204-110347.png
  • unexpected margins in smart link & comments

image-20241204-111138.png
image-20241204-111652.png
Daniel Siara 29 November 2024, 13:50
  • prism removed in adf

  • external-styles-min removed in adf

  • panel-icons removed in adf

  • styles-new removed in adf

Krzysztof Bogdan 29 November 2024, 10:20

If render=adf mode:

  • Remove prism

  • Remove external-styles-min

  • Remove panel-icons css

  • Remove styles-new.css?

Fix panel render:

image-20241129-102305.png
Daniel Siara 28 November 2024, 14:34
Krzysztof Bogdan 27 November 2024, 17:10

https://jira.external-share.com/issue/fd3ceefd-0900-42a4-b54d-7d66650be17e/DS-590?render=adf

Code block is visually broken,
inline code block is visually broken.

Unexpected margins:

image-20241127-171046.png
Krzysztof Bogdan 24 November 2024, 11:47

Edit do not work in old mode:

image-20241124-114526.png


Edit do not work on new mode:
https://jira.external-share.com/issue/ad8979a1-da9c-47fc-a6db-4b58d43d09cf/SCM-1?render=adf

Ensure include EDITOR JS/CSS only if edit description / add comments is enabled

EDITOR JS
if render=adf - include our wysywig.js
by default include ckeditor

  1. Embedded attachments in description in edit mode - do not work (zip)
    https://jira.external-share.com/issue/ad8979a1-da9c-47fc-a6db-4b58d43d09cf/SCM-1?render=adf

  2. Image size - non proper size (should be smaller)
    https://jira.external-share.com/issue/ad8979a1-da9c-47fc-a6db-4b58d43d09cf/SCM-1?render=adf

Automation for Jira 22 November 2024, 11:03

Hello @Daniel Siara,

Please merge code to dev branch.
This is the best moment to add more information that can be helpful to prepare release notes.

  • Can you prepare short overview of change that can be used in release notes?

  • Please provide short GIF that showcase feature.

  • If GIF make no sense, can you provide image that highlights feature that can be used in release notes (cropped & annotated)?

Polina Naumenko 22 November 2024, 11:03

Improvement implemented - QA env

Polina Naumenko 20 November 2024, 14:48
  • expand does not work in edit mode (as per jira)

  • videos are not supported outside of a table

    • mp4 is not displayed

    • webm displayed, but unable to play a video

    • mkv displayed, but unable to play a video

image-20241120-143518.png
image-20241120-144209.png

  • info panels to be fixed in a separated bug as discussed

image-20241120-144011.png
  • status color to be fixed in a separated bug as discussed

image-20241120-144800.png
Daniel Siara 15 November 2024, 12:22
  • 1- User is able to edit description when config is disabled -

  • 2- Expand does not work (impossible to collapse) -

  • 3- Size of an image in expand gets bigger - looks good - tested

  • 5- Image size expands

  • 6 - status color is good

  • 7 - problem with mp4 in table

  • 8 - Divider is not supported -

  • 9 - looks good - tested

  • 10 - Missing leading -

  • 11 - Info panel is really weird - looks good - tested

All problems should be fixed

Polina Naumenko 15 November 2024, 11:43
  1. User is able to edit description when config is disabled

  1. Expand does not work (impossible to collapse)

    image-20241115-105813.png
  2. Size of an image in expand gets bigger

image-20241115-110535.png
  1. Image size expands

image-20241115-111032.png
  1. Status colors are not as per jira, info panel is not in dark mode

checked with multiple users, browsers, instances. The issue is replicated

image-20241115-113524.png
  1. MP4 video is not supported? Weird cuz in a table i’m able to play it

image-20241115-114030.png
  1. Divider is not supported

image-20241115-114150.png
  1. Image is not supported in expand

image-20241115-114338.png
  1. Missing leading

image-20241115-120134.png
  1. Info panel is really weird

image-20241115-120530.png

https://jes-qa.warsawdynamics.com/issue/87cd2bbe-08a5-4416-8152-4dea161220f0?render=adf

Polina Naumenko 4 November 2024, 12:58

  • Unable to render image, code snippet

  • added extra column, should be 3 instead of 4

  • Info panel is not visible

image-20241104-125616.png
image-20241104-125556.png
Automation for Jira 2 November 2024, 16:33

Hello @Daniel Siara

This is the best moment to add more information that can be helpful for tester.

  • What areas are affected?

  • What are potential edge cases?

  • Was it checked for XSS problems?

  • Does change affect security, is new data exposed?

Please attach - Before / After screenshot if possible.

Automation for Jira 25 October 2024, 07:21

Hello @Daniel Siara,
Change was reviewed and approved.
Task is ready to be deployed to QA.
Once it is deployed to QA please move ticket to "To Test"

Thank you!

Daniel Siara 17 October 2024, 07:36

@Krzysztof Bogdan you can look again, changes applied

Daniel Siara 9 September 2024, 07:24

@Krzysztof Bogdan changes applied

Krzysztof Bogdan 2 September 2024, 20:03

@Daniel Siara

Daniel Siara 27 August 2024, 10:29

@Krzysztof Bogdan please take a look again

Krzysztof Bogdan 22 August 2024, 12:56

@Daniel Siara I think some big refactoring is needed

Daniel Siara 22 August 2024, 10:42

@Krzysztof Bogdan task is ready for review

Automation for Jira 22 August 2024, 10:40

Hello [~accountid:],
Task is ready for review.

@Daniel Siara please make sure reviewer
have easy access to contend to be reviewed.

If this is code change. Please make sure PR is created.
If this is new documentation, blogpost, etc. Please provide link to page.

Daniel Siara 21 August 2024, 11:36

Added linking behaviour to comments (ESFJ-1073) and to custom fields also

Daniel Siara 17 July 2024, 09:01

@Krzysztof Bogdan ok, I will refer to https://warsaw-dynamics.atlassian.net/browse/ESFJ-1073

Daniel Siara 17 July 2024, 08:39

@Krzysztof Bogdan Comments, description, environment are ADF rendered. I am currently working on custom fields (Today will be done). I still need to fix a few things related to the editor, as I showed you on Monday call. I estimate that I will finish up to Friday, but first the https://warsaw-dynamics.atlassian.net/browse/ESFJ-863 task need to be finished, because I am using editor implemented in this task

Krzysztof Bogdan 17 July 2024, 08:11

@Daniel Siara What is status of this task? When you estimate finishing it?

Krzysztof Bogdan 17 July 2024, 08:11

@Daniel Siara Please refer tohttps://warsaw-dynamics.atlassian.net/browse/ESFJ-1073
- to update links in ADF to share if possible