This repository has been archived by the owner on Oct 6, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Don't use dangerous HTML in Linkify #10
Merged
Merged
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
7354bf3
fix(Linkify): escape HTML characters
e6c82f4
Don't set HTML dangerously
6ad9d3b
Fix test and copy-pasta
297520f
Improve link parsing; Update docs to showcase more complex functionality
kylealwyn 0252a69
Fix doc formatting
kylealwyn 98742c1
Remove unnecessary filter
kylealwyn ab1637c
Add linkStyle test
kylealwyn File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,46 @@ | ||
import React from 'react'; | ||
import styled from 'styled-components'; | ||
|
||
const Container = styled.span` | ||
a { | ||
color: inherit; | ||
text-decoration: underline; | ||
} | ||
`; | ||
const URL_REGEX = /(\b(https?|ftp|file):\/\/[-A-Z0-9+&@#/%?=~_|!:,.;]*[-A-Z0-9+&@#/%=~_|])/gi; | ||
|
||
const REGEX = /(\b(https?|ftp|file):\/\/[-A-Z0-9+&@#\/%?=~_|!:,.;]*[-A-Z0-9+&@#\/%=~_|])/gi; | ||
const detectLinks = ({ children, linkStyle = {} }) => | ||
React.Children.map(children, child => { | ||
if (!child) return null; | ||
|
||
const parse = string => string.replace(REGEX, url => `<a target="_blank" href="${url}">${url}</a>`); | ||
if (typeof child === 'string') { | ||
const words = child.split(' '); | ||
return words.map((word, index) => { | ||
const isLastWord = words.length === index - 1; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. copy pasta from my example but this should be |
||
|
||
const Linkify = props => ( | ||
<Container style={props.style || {}} dangerouslySetInnerHTML={{ __html: parse(props.children) }} /> | ||
); | ||
if (URL_REGEX.test(word)) { | ||
return ( | ||
<> | ||
<a | ||
key={word} | ||
target="_blank" | ||
rel="noopener noreferrer" | ||
style={{ | ||
color: 'inherit', | ||
textDecoration: 'underline', | ||
...linkStyle, | ||
}} | ||
href={word}> | ||
{word} | ||
</a> | ||
|
||
export default Linkify; | ||
{isLastWord ? '' : ' '} | ||
</> | ||
); | ||
} | ||
|
||
return isLastWord ? word : `${word} `; | ||
}); | ||
} | ||
|
||
if (React.isValidElement(child)) { | ||
return detectLinks({ children: child.props.children, linkStyle }); | ||
} | ||
|
||
return child; | ||
}); | ||
|
||
export default props => detectLinks(props); |
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,22 @@ | ||
import React from 'react'; | ||
import { renderWithTheme } from '../../test/utils'; | ||
import Linkify from './Linkify'; | ||
|
||
describe('Linkify', () => { | ||
test('converts links to anchor tags', () => { | ||
const component = renderWithTheme(<Linkify>Hello! https://google.com is a cool site.</Linkify>); | ||
|
||
expect(component).toMatchSnapshot(); | ||
}); | ||
|
||
test('escapes HTML entities', () => { | ||
const component = renderWithTheme( | ||
<Linkify> | ||
<img src="fake.jpg" onError={() => {}} alt="hacker" /> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. shouldn't this all be in a template string to test escaping? |
||
<span>heheh got hacked</span> | ||
</Linkify> | ||
); | ||
|
||
expect(component).toMatchSnapshot(); | ||
}); | ||
}); |
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,33 @@ | ||
// Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
||
exports[`Linkify converts links to anchor tags 1`] = ` | ||
Array [ | ||
"Hello! ", | ||
<a | ||
href="https://google.com" | ||
rel="noopener noreferrer" | ||
style={ | ||
Object { | ||
"color": "inherit", | ||
"textDecoration": "underline", | ||
} | ||
} | ||
target="_blank" | ||
> | ||
https://google.com | ||
</a>, | ||
" ", | ||
"is ", | ||
"a ", | ||
"cool ", | ||
"site. ", | ||
] | ||
`; | ||
|
||
exports[`Linkify escapes HTML entities 1`] = ` | ||
Array [ | ||
"heheh ", | ||
"got ", | ||
"hacked ", | ||
] | ||
`; |
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.
Do we want to add some rules around domain extensions so that URLs like
duckduckgo.com
in the playground below will also be converted into links?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.
In the future, probably yes. We can add rules to our doctors for now :)
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.
@kylealwyn cool. LGTM 🚢