Skip to content

feat: log available roles when a roles query fails #321

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 1 commit into from
Jul 12, 2019
Merged

feat: log available roles when a roles query fails #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions src/__tests__/element-queries.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
import jestSerializerAnsi from 'jest-serializer-ansi'
import {configure} from '../config'
import {render, renderIntoDocument} from './helpers/test-utils'

expect.addSnapshotSerializer(jestSerializerAnsi)
beforeEach(() => {
document.defaultView.Cypress = null
})
Expand Down Expand Up @@ -88,7 +86,9 @@ test('get throws a useful error message', () => {
</div>"
`)
expect(() => getByRole('LucyRicardo')).toThrowErrorMatchingInlineSnapshot(`
"Unable to find an element by [role=LucyRicardo]
"Unable to find an element with the role "LucyRicardo"

Here are the available roles:

<div>
<div />
Expand Down
9 changes: 3 additions & 6 deletions src/__tests__/pretty-dom.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
import jestSerializerAnsi from 'jest-serializer-ansi'
import {prettyDOM} from '../pretty-dom'
import {render} from './helpers/test-utils'

expect.addSnapshotSerializer(jestSerializerAnsi)

test('it prints out the given DOM element tree', () => {
test('prints out the given DOM element tree', () => {
const {container} = render('<div>Hello World!</div>')
expect(prettyDOM(container)).toMatchInlineSnapshot(`
"<div>
Expand All @@ -15,12 +12,12 @@ test('it prints out the given DOM element tree', () => {
`)
})

test('it supports truncating the output length', () => {
test('supports truncating the output length', () => {
const {container} = render('<div>Hello World!</div>')
expect(prettyDOM(container, 5)).toMatch(/\.\.\./)
})

test('it supports receiving the document element', () => {
test('supports receiving the document element', () => {
expect(prettyDOM(document)).toMatchInlineSnapshot(`
"<html>
<head />
Expand Down
22 changes: 22 additions & 0 deletions src/__tests__/role.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import {render} from './helpers/test-utils'

test('logs available roles when it fails', () => {
const {getByRole} = render(`<h1>Hi</h1>`)
expect(() => getByRole('article')).toThrowErrorMatchingInlineSnapshot(`
"Unable to find an element with the role "article"

Here are the available roles:

heading:

<h1 />

--------------------------------------------------

<div>
<h1>
Hi
</h1>
</div>"
`)
})
16 changes: 13 additions & 3 deletions src/queries/role.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {getImplicitAriaRoles} from '../role-helpers'
import {getImplicitAriaRoles, prettyRoles} from '../role-helpers'
import {buildQueries, fuzzyMatches, makeNormalizer, matches} from './all-utils'

function queryAllByRole(
Expand All @@ -24,8 +24,18 @@ function queryAllByRole(
})
}

const getMultipleError = (c, id) => `Found multiple elements by [role=${id}]`
const getMissingError = (c, id) => `Unable to find an element by [role=${id}]`
const getMultipleError = (c, role) =>
`Found multiple elements with the role "${role}"`
const getMissingError = (container, role) =>
`
Unable to find an element with the role "${role}"

Here are the available roles:

${prettyRoles(container)
.replace(/\n/g, '\n ')
.replace(/\n\s\s\n/g, '\n\n')}
`.trim()

const [
queryByRole,
Expand Down
10 changes: 6 additions & 4 deletions src/role-helpers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,10 @@ function getRoles(container) {
}, {})
}

function logRoles(container) {
function prettyRoles(container) {
const roles = getRoles(container)

const rolesStr = Object.entries(roles)
return Object.entries(roles)
.map(([role, elements]) => {
const delimiterBar = '-'.repeat(50)
const elementsString = elements
Expand All @@ -86,9 +86,11 @@ function logRoles(container) {
return `${role}:\n\n${elementsString}\n\n${delimiterBar}`
})
.join('\n')
}

function logRoles(container) {
// eslint-disable-next-line no-console
console.log(rolesStr)
console.log(prettyRoles(container))
}

export {getRoles, logRoles, getImplicitAriaRoles}
export {getRoles, logRoles, getImplicitAriaRoles, prettyRoles}