inventoresed/packages/core/src/test/assertZWaveError.ts

Z-Wave driver written entirely in JavaScript/TypeScript

import type { ZWaveError, ZWaveErrorCodes } from "../error/ZWaveError";

export interface AssertZWaveErrorOptions {
	messageMatches?: string | RegExp;
	errorCode?: ZWaveErrorCodes;
	context?: unknown;
}

/**
 * Asserts that a value is or a method returns a ZWaveError.
 * @param valueOrFactory An error object or method that is expected to throw
 * @param options Additional assertions
 */
export function assertZWaveError<T>(
	valueOrFactory: T,
	options: AssertZWaveErrorOptions = {},
): T extends () => PromiseLike<any> ? Promise<void> : void {
	const { messageMatches, errorCode, context } = options;

	function _assertZWaveError(e: any): asserts e is ZWaveError {
		expect(e.constructor.name).toBe("ZWaveError");
		expect(e.code).toBeNumber();
	}

	function handleError(e: any): void {
		_assertZWaveError(e);
		if (messageMatches != undefined)
			expect(e.message).toMatch(messageMatches);
		if (errorCode != undefined) expect(e.code).toBe(errorCode);
		if (context != undefined) expect(e.context).toBe(context);
	}
	function fail(): never {
		// We should not be here
		throw new Error("The factory function did not throw any error!");
	}

	if (typeof valueOrFactory === "function") {
		try {
			// This call is expected to throw if valueOrFactory is a synchronous function
			const result = valueOrFactory();
			if (result instanceof Promise) {
				return result.then(
					fail, // If valueOrFactory is an async function the promise should be rejected
					handleError,
				) as any;
			}
		} catch (e) {
			return void handleError(e) as any;
		}
		fail();
	} else {
		// Directly assert the error object
		handleError(valueOrFactory);
	}
	return undefined as any;
}