feat(editor): improve documentation editor using Remirror #6631
There are no files selected for viewing
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| import { htmlToMarkdown } from '../../../../components/editor/extensions/htmlToMarkdown'; | ||
|
|
||
| const cases = [ | ||
|
|
||
| ['strike', '<strike>Lorem ipsum</strike>', '~Lorem ipsum~'], | ||
| ['s', '<s>Lorem ipsum</s>', '~Lorem ipsum~'], | ||
| ['del', '<del>Lorem ipsum</del>', '~Lorem ipsum~'], | ||
| [ | ||
| 'should replace blank nodes in table', | ||
| '<table><thead><tr><th>Lorem ipsum</th></tr></thead><tbody><tr><td><p>Lorem</p><p>ipsum</p></td></tr></tbody></table>', | ||
| '| Lorem ipsum |\n| --- |\n| Lorem<br />ipsum |', | ||
| ], | ||
| ['should replace empty p tags to line breaks', '<p>Lorem</p><p></p><p>ipsum</p>', 'Lorem\n\n \n\nipsum'], | ||
| [ | ||
| 'should parse image if it does not have a width attribute', | ||
| '<img src="/my-image.png" style="width: 100%; min-width: 50px; object-fit: contain;" alt="my image">', | ||
| '', | ||
| ], | ||
|
|
||
| [ | ||
| 'should highlight code block with html', | ||
| '<pre><code class="language language-html"><<span class="pl-ent">p</span>>Hello world</<span class="pl-ent">p</span>></code></pre>', | ||
| '```html\n<p>Hello world</p>\n```', | ||
| ], | ||
| [ | ||
| 'should highlight code block with js', | ||
| '<pre><code class="lang lang-js">;(<span class="pl-k">function</span> () {})()</code></pre>', | ||
| '```js\n;(function () {})()\n```', | ||
| ], | ||
| [ | ||
| 'should highlighted remirror code block', | ||
| '<pre><code data-code-block-language="ts">;(<span class="pl-k">function</span> () {})()</code></pre>', | ||
| '```ts\n;(function () {})()\n```', | ||
| ], | ||
| [ | ||
| 'should parse without language code block', | ||
| '<pre><code>;(<span class="pl-k">function</span> () {})()</code></pre>', | ||
| '```\n;(function () {})()\n```', | ||
| ], | ||
| [ | ||
| 'should parse datahub mention', | ||
| '<span class="mentions" data-datahub-mention-urn="urn:li:dataset:(urn:li:dataPlatform:hive,SampleHiveDataset,PROD)">@SampleHiveDataset</span>', | ||
| '[@SampleHiveDataset](urn:li:dataset:(urn:li:dataPlatform:hive,SampleHiveDataset,PROD))', | ||
| ], | ||
| ]; | ||
|
|
||
| const skipParseCases = [ | ||
| [ | ||
| 'table if ul or li is present', | ||
| '<table><thead><tr><th>Lorem ipsum</th></tr></thead><tbody><tr><td><ul><li>Lorem</li><li>ipsum</li></ul></td></tr></tbody></table>', | ||
| ], | ||
| [ | ||
| 'table if present', | ||
| '<table><thead><tr><th>Lorem ipsum</th></tr></thead><tbody><tr><td><ul><li>Lorem</li><li>ipsum</li></ul></td></tr></tbody></table>', | ||
| ], | ||
| [ | ||
| 'image if it has a width attribute', | ||
| '<img src="/my-image.png" style="width: 100%; min-width: 50px; object-fit: contain;" alt="my image" width="200">', | ||
| ], | ||
| ]; | ||
|
|
||
| describe('htmlToMarkdown', () => { | ||
| it.each(cases)('%s', (_, input, expected) => { | ||
| expect(htmlToMarkdown(input)).toBe(expected); | ||
| }); | ||
|
|
||
| it.each(skipParseCases)('should skip parsing %s', (_, input) => { | ||
| expect(htmlToMarkdown(input)).toBe(input); | ||
| }); | ||
| }); | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| import { markdownToHtml } from '../../../../components/editor/extensions/markdownToHtml'; | ||
|
|
||
| const cases = [ | ||
| [ | ||
| 'should parse datahub mentions', | ||
| 'Lorem [@SampleHiveDataset](urn:li:dataset:(urn:li:dataPlatform:hive,SampleHiveDataset,PROD)) ipsum', | ||
| '<p>Lorem <span data-datahub-mention-urn="urn:li:dataset:(urn:li:dataPlatform:hive,SampleHiveDataset,PROD)">@SampleHiveDataset</span> ipsum</p>\n', | ||
| ], | ||
| ['should not parse github mentions', 'Lorem @githubuser ipsum', '<p>Lorem @githubuser ipsum</p>\n'], | ||
| [ | ||
| 'should parse invalid mentions as links', | ||
| 'Lorem [@Some link](/lorem-ipsum) ipsum', | ||
| '<p>Lorem <a href="/lorem-ipsum">@Some link</a> ipsum</p>\n', | ||
| ], | ||
| ]; | ||
|
|
||
| describe('markdownToHtml', () => { | ||
| it.each(cases)('%s', (_, input, expected) => { | ||
| expect(markdownToHtml(input)).toBe(expected); | ||
| }); | ||
| }); |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why is this change necessary?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh it's to resolve the failing build that was caused by
FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory.in https://github.com/datahub-project/datahub/actions/runs/3804191769/jobs/6471221050. This line simply increases the memory limit allocated to node. If there are other solutions please feel free to make changes to the PR too!There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it looks like this failure is still happening :( do you know if we need to put this type of change elsewhere?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
another initiative we've discussed is removing the unneeded dependencies from our package.json - unsure how many things we can remove but if we can shrink our dependencies this may help solve this problem! it's something i'm looking into and will see if it helps here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, the latest build passed though: https://github.com/datahub-project/datahub/actions/runs/3805789729/jobs/6559405831. The only pipeline that's failing is https://github.com/datahub-project/datahub/actions/runs/3805789729/jobs/6559407548 which looks unrelated to the documentation, probably a flaky test (but I can't rereun it :x)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also let me know if you need help looking into shrinking the dependencies 🗡️ !
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ah so it looks like it's fixed in the Docker, Build, Scan, Test runs, but i'm still seeing the error in the logs on the general build & test / build job (https://github.com/datahub-project/datahub/actions/runs/3805789734/jobs/6521531814) - you'll have to search for it cuz that's a huge log lol
also it seems that that's timing out after 60 minutes, my hunch is that it's related to this build failing or even that something is taking much longer for some reason.