[EuiMarkdown] Allow mailto: links by default & allow customization of link validation by chandlerprall · Pull Request #5790 · elastic/eui

chandlerprall · 2022-04-13T16:02:29Z

Summary

Fixes #5770 by adding mailto: markdown links to the list of allowed protocols (now http:, https:, and mailto:), and made the validation customizable.

When a link protocol is disallowed, the link will render as the markdown syntax so the URL and its display text are still present. The exception to this rule is if mailto: is disabled, only the link text will be displayed.

I also took this opportunity to add a documentation section to explain the various plugin defaults used by the markdown components, and extended the existing markdown link validation to accept a configuration object, and documented that 😅.

Also took the time the update isDomainSecure as we can now use the URL method (bye ie11!), avoiding a nasty regex.

Checklist

~~- [ ] Checked in both light and dark modes~~
- [ ] Checked in mobile
- [ ] Checked in Chrome, Safari, Edge, and Firefox
- [ ] Props have proper autodocs and playground toggles

Added documentation
~~- [ ] Checked Code Sandbox works for any docs examples~~
Added or updated jest and cypress tests
Checked for breaking changes and labeled appropriately
~~- [ ] Checked for accessibility including keyboard-only and screenreader modes~~
~~- [ ] Updated the Figma library counterpart~~
A changelog entry exists and is marked appropriately

upcoming_changelogs/5770.md

kibanamachine · 2022-04-13T16:36:51Z

Preview documentation changes for this PR: https://eui.elastic.co/pr_5790/

kibanamachine · 2022-04-13T17:05:51Z

Preview documentation changes for this PR: https://eui.elastic.co/pr_5790/

src-docs/src/views/markdown_editor/markdown_format_links.js

src-docs/src/views/markdown_editor/mardown_format_example.js

kibanamachine · 2022-04-13T18:09:41Z

Preview documentation changes for this PR: https://eui.elastic.co/pr_5790/

src/components/markdown_editor/plugins/markdown_link_validator.test.tsx

src/components/markdown_editor/plugins/markdown_link_validator.tsx

src-docs/src/views/markdown_editor/mardown_format_example.js

src/components/markdown_editor/plugins/markdown_link_validator.tsx

elizabetdev

Thanks, @chandlerprall for fixing this issue.

IMO the links should be presented as links. Not as normal text. We say that we follow the GitHub flavoured markdown:

In Github, if we pass helpdesk@elastic.co or [helpdesk@elastic.co](mailto:helpdesk@elastic.co) both creates a link:

But I think we can be a little bit different from Github here. But my expectation as a user is when I pass a link syntax [](url) a link is actually created. Why would I have so much work to try to create a link for nothing?

So if I pass helpdesk@elastic.co it's ok to be normal text. But [helpdesk@elastic.co](mailto:helpdesk@elastic.co) should be a link. If consumers don't want to create link they just pass the text without a link syntax.

… unlink those values for security reasons

kibanamachine · 2022-05-05T22:06:31Z

Preview documentation changes for this PR: https://eui.elastic.co/pr_5790/

cee-chen · 2022-05-06T17:03:47Z

src/services/url.ts

 */

-const isElasticDomain = /(https?:\/\/(.+?\.)?elastic\.co((\/|\?)[A-Za-z0-9\-\._~:\/\?#\[\]@!$&'\(\)\*\+,;\=]*)?)/g;
+const isElasticHost = /^([a-zA-Z0-9]+\.)*elastic\.co$/;


Wonderful cleanup! 🎉

src-docs/src/views/markdown_editor/mardown_format_example.js

src/components/markdown_editor/plugins/markdown_link_validator.tsx

src/components/markdown_editor/plugins/markdown_link_validator.test.tsx

kibanamachine · 2022-05-06T18:03:16Z

Preview documentation changes for this PR: https://eui.elastic.co/pr_5790/

kibanamachine · 2022-05-06T21:47:19Z

Preview documentation changes for this PR: https://eui.elastic.co/pr_5790/

upcoming_changelogs/5790.md

cee-chen · 2022-05-07T01:43:49Z

src-docs/src/views/markdown_editor/markdown_plugin_example.js


  sections: [
+    {
+      title: 'Default plugins',


This new documentation is fantastic!! Thank you for adding it!

cee-chen

This is fantastic. Since Chandler is on PTO starting next Monday and it's late there for him (apologies this took me so long to circle back to this), I'm going to go ahead and commit the suggested changelog request and turn on auto merge.

kibanamachine · 2022-05-07T02:18:12Z

Preview documentation changes for this PR: https://eui.elastic.co/pr_5790/

chandlerprall added the markdown editor label Apr 13, 2022

chandlerprall requested a review from cee-chen April 13, 2022 16:02

cee-chen reviewed Apr 13, 2022

View reviewed changes

upcoming_changelogs/5770.md Outdated Show resolved Hide resolved

chandlerprall force-pushed the bug/5770-markdown-mailto branch from f7872ac to a58ede3 Compare April 13, 2022 16:36

cee-chen reviewed Apr 13, 2022

View reviewed changes

src-docs/src/views/markdown_editor/markdown_format_links.js Outdated Show resolved Hide resolved

cee-chen reviewed Apr 13, 2022

View reviewed changes

src-docs/src/views/markdown_editor/mardown_format_example.js Outdated Show resolved Hide resolved

chandlerprall changed the title ~~[EuiMarkdownEditor] Transform mailto: links back to plain text emails~~ [EuiMarkdownEditor] Remove mailto: links from markdown Apr 13, 2022

chandlerprall requested a review from cee-chen April 13, 2022 17:40

cee-chen reviewed Apr 13, 2022

View reviewed changes

src/components/markdown_editor/plugins/markdown_link_validator.tsx Outdated Show resolved Hide resolved

cchaos requested a review from elizabetdev April 13, 2022 18:56

elizabetdev reviewed Apr 14, 2022

View reviewed changes

chandlerprall added 7 commits May 5, 2022 15:28

Transform mailto: links in markdown to just the target address, as we…

272c3d6

… unlink those values for security reasons

documentation

9daeb61

changelog

c8c2ae8

corrected changelog entry filename

04af037

Lint issues

15f4f71

Refactored markdownLinkValidator to be configurable

20bae8a

documentation, documentation, documentation

fdac6a1

chandlerprall force-pushed the bug/5770-markdown-mailto branch from b63fca8 to fdac6a1 Compare May 5, 2022 21:28

PR feedback

b5a9644

chandlerprall requested review from brittanyjoiner15, cee-chen and elizabetdev May 5, 2022 21:39

cee-chen reviewed May 6, 2022

View reviewed changes

enable mailto: links by default in markdown

d42cfe3

updated comment

fd76cae

cee-chen reviewed May 6, 2022

View reviewed changes

src/components/markdown_editor/plugins/markdown_link_validator.tsx Outdated Show resolved Hide resolved

cee-chen reviewed May 6, 2022

View reviewed changes

src/components/markdown_editor/plugins/markdown_link_validator.test.tsx Show resolved Hide resolved

chandlerprall changed the title ~~[EuiMarkdownEditor] Remove mailto: links from markdown~~ [EuiMarkdown] Allow mailto: links by default & allow customization of link validation May 6, 2022

chandlerprall added 2 commits May 6, 2022 15:02

test to verify mailto protocol is supported

5b3e2f2

pr feedback

4e31ab0

cee-chen reviewed May 7, 2022

View reviewed changes

upcoming_changelogs/5790.md Outdated Show resolved Hide resolved

cee-chen reviewed May 7, 2022

View reviewed changes

cee-chen approved these changes May 7, 2022

View reviewed changes

[PR feedback] Changelog

0ce1ee9

cee-chen enabled auto-merge (squash) May 7, 2022 01:48

cee-chen merged commit 47e869e into elastic:main May 7, 2022

breehall mentioned this pull request May 16, 2022

Upgrade EUI to v58.0.0 elastic/kibana#132257

Merged

chandlerprall deleted the bug/5770-markdown-mailto branch June 1, 2022 14:12

Conversation

chandlerprall commented Apr 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

Uh oh!

kibanamachine commented Apr 13, 2022

Uh oh!

kibanamachine commented Apr 13, 2022

Uh oh!

Uh oh!

Uh oh!

kibanamachine commented Apr 13, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

elizabetdev left a comment

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented May 5, 2022

Uh oh!

cee-chen May 6, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kibanamachine commented May 6, 2022

Uh oh!

kibanamachine commented May 6, 2022

Uh oh!

Uh oh!

cee-chen May 7, 2022

Choose a reason for hiding this comment

Uh oh!

cee-chen left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented May 7, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chandlerprall commented Apr 13, 2022 •

edited

Loading

cee-chen left a comment •

edited

Loading