1
0
mirror of https://github.com/bitwarden/browser.git synced 2024-11-14 10:26:19 +01:00
bitwarden-browser/libs/common/spec/matchers/index.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

58 lines
2.2 KiB
TypeScript

import { toBeFulfilled, toBeResolved, toBeRejected } from "./promise-fulfilled";
import { toAlmostEqual } from "./to-almost-equal";
import { toEqualBuffer } from "./to-equal-buffer";
export * from "./to-equal-buffer";
export * from "./to-almost-equal";
export * from "./promise-fulfilled";
export function addCustomMatchers() {
expect.extend({
toEqualBuffer: toEqualBuffer,
toAlmostEqual: toAlmostEqual,
toBeFulfilled: toBeFulfilled,
toBeResolved: toBeResolved,
toBeRejected: toBeRejected,
});
}
export interface CustomMatchers<R = unknown> {
toEqualBuffer(expected: Uint8Array | ArrayBuffer): R;
/**
* Matches the expected date within an optional ms precision
* @param expected The expected date
* @param msPrecision The optional precision in milliseconds
*/
toAlmostEqual(expected: Date, msPrecision?: number): R;
/**
* 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
*/
toBeFulfilled(withinMs?: number): Promise<R>;
/**
* 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
*/
toBeResolved(withinMs?: number): Promise<R>;
/**
* 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
*/
toBeRejected(withinMs?: number): Promise<R>;
}