Skip to content

feat: export configure function with data-testid override #39

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 4 commits into from
Aug 7, 2020
Merged

feat: export configure function with data-testid override #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
529ec92
feat: export configure function with data-testid override
silviuaavram Aug 5, 2020
da84093
address comments from review
silviuaavram Aug 7, 2020
19cc5af
more tests
silviuaavram Aug 7, 2020
419ca94
fix lint
silviuaavram Aug 7, 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
21 changes: 19 additions & 2 deletions lib/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import * as path from 'path'
import {ElementHandle, EvaluateFn, JSHandle, Page} from 'puppeteer'
import waitForExpect from 'wait-for-expect'

import {IQueryUtils, IScopedQueryUtils} from './typedefs'
import {IConfigureOptions, IQueryUtils, IScopedQueryUtils} from './typedefs'

const domLibraryAsString = readFileSync(
path.join(__dirname, '../dom-testing-library.js'),
Expand All @@ -17,7 +17,7 @@ function mapArgument(argument: any, index: number): any {
: argument
}

const delegateFnBodyToExecuteInPage = `
const delegateFnBodyToExecuteInPageInitial = `
${domLibraryAsString};

const mappedArgs = args.map(${mapArgument.toString()});
Expand All @@ -27,6 +27,8 @@ const delegateFnBodyToExecuteInPage = `
return moduleWithFns[fnName](container, ...mappedArgs);
`

let delegateFnBodyToExecuteInPage = delegateFnBodyToExecuteInPageInitial

type DOMReturnType = ElementHandle | ElementHandle[] | null

type ContextFn = (...args: any[]) => ElementHandle
Expand Down Expand Up @@ -130,6 +132,21 @@ export function wait(
return waitForExpect(callback, timeout, interval)
}

export function configure(options: Partial<IConfigureOptions>): void {
if (!options) {
return
}

const { testIdAttribute } = options

if (testIdAttribute) {
delegateFnBodyToExecuteInPage = delegateFnBodyToExecuteInPageInitial.replace(
/testIdAttribute: (['|"])data-testid(['|"])/g,
`testIdAttribute: $1${testIdAttribute}$2`,
)
}
}

export function getQueriesForElement<T>(
object: T,
contextFn?: ContextFn,
Expand Down
4 changes: 4 additions & 0 deletions lib/typedefs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,7 @@ export interface IQueryUtils extends IQueryMethods {
getQueriesForElement(): IQueryUtils & IScopedQueryUtils
getNodeText(el: Element): Promise<string>
}

export interface IConfigureOptions {
testIdAttribute: string
}
6 changes: 3 additions & 3 deletions test/fixtures/page.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
<html>

<body>
<h1>Hello h1</h1>
<h2>Hello h2</h2>
<h1 data-new-id="first-level-header">Hello h1</h1>
<h2 data-id="second-level-header">Hello h2</h2>
<img alt="Image A" src="">
<input type="text" data-testid="testid-text-input">
<label for="label-text-input">Label A</label>
<label for="label-text-input" data-testid="testid-label">Label A</label>
<input id="label-text-input" type="text">

<div id="scoped">
Expand Down
30 changes: 29 additions & 1 deletion test/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import * as path from 'path'
import * as puppeteer from 'puppeteer'
import {getDocument, queries, getQueriesForElement, wait} from '../lib'
import {getDocument, queries, getQueriesForElement, wait, configure} from '../lib'

describe('lib/index.ts', () => {
let browser: puppeteer.Browser
Expand All @@ -18,6 +18,30 @@ describe('lib/index.ts', () => {
expect(await queries.getNodeText(element)).toEqual('Hello h1')
})

it('should support custom data-testid attribute name', async () => {
configure({testIdAttribute: 'data-id'})
const document = await getDocument(page)
const element = await queries.getByTestId(document, 'second-level-header')
expect(await queries.getNodeText(element)).toEqual('Hello h2')
})

it('should support subsequent changing the data-testid attribute names', async () => {
configure({testIdAttribute: 'data-id'})
configure({testIdAttribute: 'data-new-id'})
const document = await getDocument(page)
const element = await queries.getByTestId(document, 'first-level-header')
expect(await queries.getNodeText(element)).toEqual('Hello h1')
})

it('should keep the default data-testid when input passed is invalid', async () => {
;[{}, undefined, null, {testIdAttribute: ''}].forEach(async options => {
const document = await getDocument(page)
configure(options as any)
const element = await queries.getByTestId(document, 'testid-label')
expect(await queries.getNodeText(element)).toEqual('Label A')
})
})

it('should support regex on raw queries object', async () => {
const scope = await page.$('#scoped')
if (!scope) throw new Error('Should have scope')
Expand All @@ -41,6 +65,10 @@ describe('lib/index.ts', () => {
expect(await getByText('Loaded!')).toBeTruthy()
}, 9000)

afterEach(() => {
configure({testIdAttribute: 'data-testid'}) //cleanup
})

afterAll(async () => {
await browser.close()
})
Expand Down