-
-
Notifications
You must be signed in to change notification settings - Fork 255
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.
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
Expose registerHook and runHooks as official public APIs #1344
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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
78 changes: 0 additions & 78 deletions
78
addon-test-support/@ember/test-helpers/-internal/helper-hooks.ts
This file was deleted.
Oops, something went wrong.
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
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
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
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
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
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
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
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
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
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
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
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
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
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,95 @@ | ||
export type Hook = (...args: any[]) => void | Promise<void>; | ||
export type HookLabel = 'start' | 'end' | 'targetFound'; | ||
export type HookUnregister = { | ||
unregister: () => void; | ||
}; | ||
|
||
const registeredHooks = new Map<string, Set<Hook>>(); | ||
|
||
/** | ||
* @private | ||
* @param {string} helperName The name of the test helper in which to run the hook. | ||
* @param {string} label A label to help identify the hook. | ||
* @returns {string} The compound key for the helper. | ||
*/ | ||
function getHelperKey(helperName: string, label: string): string { | ||
return `${helperName}:${label}`; | ||
} | ||
|
||
/** | ||
* Registers a function to be run during the invocation of a test helper. | ||
* | ||
* @param {string} helperName The name of the test helper in which to run the hook. | ||
* Test helper names include `blur`, `click`, `doubleClick`, `fillIn`, | ||
* `fireEvent`, `focus`, `render`, `scrollTo`, `select`, `tab`, `tap`, `triggerEvent`, | ||
* `triggerKeyEvent`, `typeIn`, and `visit`. | ||
* @param {string} label A label to help identify the hook. Built-in labels include `start`, `end`, | ||
* and `targetFound`, the former designating either the start or end of | ||
* the helper invocation. | ||
* @param {Function} hook The hook function to run when the test helper is invoked. | ||
* @returns {HookUnregister} An object containing an `unregister` function that unregisters | ||
* the specific hook initially registered to the helper. | ||
* @example | ||
* <caption> | ||
* Registering a hook for the `end` point of the `click` test helper invocation | ||
* </caption> | ||
* | ||
* const hook = registerHook('click', 'end', () => { | ||
* console.log('Running `click:end` test helper hook'); | ||
* }); | ||
* | ||
* // Unregister the hook at some later point in time | ||
* hook.unregister(); | ||
*/ | ||
export function registerHook( | ||
helperName: string, | ||
label: HookLabel, | ||
hook: Hook | ||
): HookUnregister { | ||
let helperKey = getHelperKey(helperName, label); | ||
let hooksForHelper = registeredHooks.get(helperKey); | ||
|
||
if (hooksForHelper === undefined) { | ||
hooksForHelper = new Set<Hook>(); | ||
registeredHooks.set(helperKey, hooksForHelper); | ||
} | ||
|
||
hooksForHelper.add(hook); | ||
|
||
return { | ||
unregister() { | ||
hooksForHelper!.delete(hook); | ||
}, | ||
}; | ||
} | ||
|
||
/** | ||
* Runs all hooks registered for a specific test helper. | ||
* | ||
* @param {string} helperName The name of the test helper in which to run the hook. | ||
* Test helper names include `blur`, `click`, `doubleClick`, `fillIn`, | ||
* `fireEvent`, `focus`, `render`, `scrollTo`, `select`, `tab`, `tap`, `triggerEvent`, | ||
* `triggerKeyEvent`, `typeIn`, and `visit`. | ||
* @param {string} label A label to help identify the hook. Built-in labels include `start`, `end`, | ||
* and `targetFound`, the former designating either the start or end of | ||
* the helper invocation. | ||
* @param {unknown[]} args Any arguments originally passed to the test helper. | ||
* @returns {Promise<void>} A promise representing the serial invocation of the hooks. | ||
*/ | ||
export function runHooks( | ||
helperName: string, | ||
label: HookLabel, | ||
...args: unknown[] | ||
): Promise<void> { | ||
let hooks = | ||
registeredHooks.get(getHelperKey(helperName, label)) || new Set<Hook>(); | ||
let promises: Array<void | Promise<void>> = []; | ||
|
||
hooks.forEach((hook) => { | ||
let hookResult = hook(...args); | ||
|
||
promises.push(hookResult); | ||
}); | ||
|
||
return Promise.all(promises).then(() => {}); | ||
} |
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
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
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
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
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
Oops, something went wrong.
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.
As is, this will break any current users of ember-a11y-testing (and will require ember-a11y-testing to do a major release that only works with @ember/test-helpers@2.10.0 or whatever this PR is released as).
We should add the following (to this file) BEFORE releasing:
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.
@rwjblue I think a new release of both will resolve the issue, yes? Coordinating a major version bump for this package now, and then it can be updated in
ember-a11y-testing
.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.
@MelSumner we absolutely do not want to do a major of this right now. We have other TS things in flight which we want to land backwards-compatibly before that. This doesn't need a breaking change to release, it just needs a deprecation-and-not-removal here.