All files / src Module.ts

100% Statements 16/16
100% Branches 4/4
100% Functions 6/6
100% Lines 14/14

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67          1x                         1x   1x 47x 47x                           222x 222x 222x       602x       3x                     3x 2x     1x 1x        
/*
 * © Copyright 2022 HP Development Company, L.P.
 * SPDX-License-Identifier: MIT
 */
 
import { EventEmitter } from 'events';
import type { App } from './App';
 
export type ModuleStatus =
	| 'unloaded'
	| 'registering'
	| 'registered'
	| 'initializing'
	| 'initialized'
	| 'destroying'
	| 'destroyed'
	| 'error';
 
const statusSym = Symbol('status');
 
export abstract class Module {
	[statusSym]: ModuleStatus = 'unloaded';
	eventBus = new EventEmitter();
 
	/**
	 * @returns {string | string[]} the identifier (or identifiers) of the module
	 */
	abstract getModuleId(): string | string[];
 
	onRegister?(app: App): unknown | Promise<unknown>;
 
	onInit?(app: App): unknown | Promise<unknown>;
 
	onDestroy?(app: App): unknown | Promise<unknown>;
 
	public setStatus(newStatus: ModuleStatus) {
		this[statusSym] = newStatus;
		const eventName = newStatus === 'error' ? 'module-error' : newStatus;
		this.eventBus.emit(eventName);
	}
 
	public getStatus() {
		return this[statusSym];
	}
 
	public async waitForStatus(status: ModuleStatus): Promise<this> {
		const WEIGHTED_STATUSES: Array<ModuleStatus> = [
			'unloaded',
			'registering',
			'registered',
			'initializing',
			'initialized',
			'destroying',
			'destroyed',
			'error'
		];
 
		if (WEIGHTED_STATUSES.indexOf(this.getStatus()) >= WEIGHTED_STATUSES.indexOf(status)) {
			return this;
		}
 
		return new Promise(resolve => {
			this.eventBus.once(status, () => resolve(this));
		});
	}
}