Skip to content

fix: escape regexps that are used as query suggestion arguments #694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 12, 2020
Merged

fix: escape regexps that are used as query suggestion arguments #694

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10023dc
test: add failing tests
marcosvega91 Jul 12, 2020
c7a6a89
fix: escape regex for all queries
marcosvega91 Jul 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 44 additions & 3 deletions src/__tests__/suggestions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,13 +172,54 @@ test('should suggest img role w/ alt text', () => {
})

test('escapes regular expressions in suggestion', () => {
renderIntoDocument(
`<img src="foo.png" alt="The Problem (picture of a question mark)" data-testid="foo" />`,
)
const {container} = renderIntoDocument(`
<label for="superInput">inp-t lab^l w{th c+ars to esc\\pe</label>
<input id="superInput" type="text" value="my super string +-('{}^$)" placeholder="should escape +-'(/" />
<p>
Loading ... (1)
</p>
<img src="foo.png" alt="The Problem (picture of a question mark)" data-testid="foo" />
`)

expect(() => screen.getByTestId('foo')).toThrowError(
/getByRole\('img', \{ name: \/the problem \\\(picture of a question mark\\\)\/i \}\)/,
)

expect(
getSuggestedQuery(
container.querySelector('img'),
'get',
'altText',
).toString(),
).toEqual(`getByAltText(/the problem \\(picture of a question mark\\)/i)`)

expect(getSuggestedQuery(container.querySelector('p')).toString()).toEqual(
`getByText(/loading \\.\\.\\. \\(1\\)/i)`,
)

expect(
getSuggestedQuery(
container.querySelector('input'),
'get',
'placeholderText',
).toString(),
).toEqual(`getByPlaceholderText(/should escape \\+\\-'\\(\\//i)`)

expect(
getSuggestedQuery(
container.querySelector('input'),
'get',
'displayValue',
).toString(),
).toEqual(`getByDisplayValue(/my super string \\+\\-\\('\\{\\}\\^\\$\\)/i)`)

expect(
getSuggestedQuery(
container.querySelector('input'),
'get',
'labelText',
).toString(),
).toEqual(`getByLabelText(/inp\\-t lab\\^l w\\{th c\\+ars to esc\\\\pe/i)`)
})

test('should suggest getByLabelText when no role available', () => {
Expand Down
4 changes: 2 additions & 2 deletions src/suggestions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ function escapeRegExp(string) {
}

function getRegExpMatcher(string) {
return new RegExp(string.toLowerCase(), 'i')
return new RegExp(escapeRegExp(string.toLowerCase()), 'i')
}

function makeSuggestion(queryName, content, {variant, name}) {
Expand All @@ -46,7 +46,7 @@ function makeSuggestion(queryName, content, {variant, name}) {
]

if (name) {
queryArgs.push({name: new RegExp(escapeRegExp(name.toLowerCase()), 'i')})
queryArgs.push({name: getRegExpMatcher(name)})
}

const queryMethod = `${variant}By${queryName}`
Expand Down