1
0
mirror of https://github.com/bitwarden/browser.git synced 2024-12-19 15:57:42 +01:00
bitwarden-browser/libs/common/spec/matchers/promise-fulfilled.ts
Matt Gibson 5b5c165e10
[PM-8847] Delay browser local storage operations during reseed (#9536)
* Define matchers to test promise fulfillment

These are useful for validating that promises depend on other events prior to fulfilling.

* Expose custom matchers to jest projects

Team-specific projects are not touched here to try and reduce review burden.

* Block browser local operations awaiting reseed

This should closes a narrow race condition resulting from storage operations during a reseed event.

* Import from barrel file

This might fix the failing test, but I'm not sure _why_

* Document helper methods

* Validate as few properties as possible per test

* Simplify expected value representation

* Allow waiting in promise matchers

* Specify resolution times in promise orchestration tests.

* Test behavior triggering multiple reseeds.

* Fix typo

* Avoid testing implementation details

* Clear reseed on startup

in case a previous process was aborted in the middle of a reseed.

* Correct formatting
2024-07-19 16:12:29 -04:00

80 lines
2.3 KiB
TypeScript

async function wait(ms: number): Promise<void> {
return new Promise((resolve) => setTimeout(resolve, ms));
}
/**
* Matches whether the received promise has been fulfilled.
*
* Failure if the promise is not currently fulfilled.
*
* @param received The promise to test
* @param withinMs The time within the promise should be fulfilled. Defaults to 0, indicating that the promise should already be fulfilled
* @returns CustomMatcherResult indicating whether or not the test passed
*/
export const toBeFulfilled: jest.CustomMatcher = async function (
received: Promise<unknown>,
withinMs = 0,
) {
return {
pass: await Promise.race([
wait(withinMs).then(() => false),
received.then(
() => true,
() => true,
),
]),
message: () => `expected promise to be fulfilled`,
};
};
/**
* Matches whether the received promise has been resolved.
*
* Failure if the promise is not currently fulfilled or if it has been rejected.
*
* @param received The promise to test
* @param withinMs The time within the promise should be resolved. Defaults to 0, indicating that the promise should already be resolved
* @returns CustomMatcherResult indicating whether or not the test passed
*/
export const toBeResolved: jest.CustomMatcher = async function (
received: Promise<unknown>,
withinMs = 0,
) {
return {
pass: await Promise.race([
wait(withinMs).then(() => false),
received.then(
() => true,
() => false,
),
]),
message: () => `expected promise to be resolved`,
};
};
/**
* Matches whether the received promise has been rejected.
*
* Failure if the promise is not currently fulfilled or if it has been resolved, but not rejected.
*
* @param received The promise to test
* @param withinMs The time within the promise should be rejected. Defaults to 0, indicating that the promise should already be rejected
* @returns CustomMatcherResult indicating whether or not the test passed
*/
export const toBeRejected: jest.CustomMatcher = async function (
received: Promise<unknown>,
withinMs = 0,
) {
return {
pass: await Promise.race([
wait(withinMs).then(() => false),
received.then(
() => false,
() => true,
),
]),
message: () => `expected promise to be rejected`,
};
};