#14403

Committed 14 May 2025 05:45PM UTC coverage: 87.003% (-2.0%) from 89.017%

Build Type

push

Committed by

Commit Message

Merge 343773173 into a194c3925

Coverage Stats

13887 of 16869 branches covered (82.32%)

Branch coverage included in aggregate %.

174 of 191 new or added lines in 11 files covered. (91.1%)

839 existing lines in 51 files now uncovered.

14750 of 16046 relevant lines covered (91.92%)

21898.44 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

77.59

/src/PluginInterface.ts

import type { Plugin } from './interfaces';
import { LogLevel, createLogger } from './logging';
import type { Logger } from './logging';
/*
 * we use `Required` everywhere here because we expect that the methods on plugin objects will
 * be optional, and we don't want to deal with `undefined`.
 * `extends (...args: any[]) => any` determines whether the thing we're dealing with is a function.
 * Returning `never` in the `as` clause of the `[key in object]` step deletes that key from the
 * resultant object.
 * on the right-hand side of the mapped type we are forced to use a conditional type a second time,
 * in order to be able to use the `Parameters` utility type on `Required<T>[K]`. This will always
 * be true because of the filtering done by the `[key in object]` clause, but TS requires the duplication.
 *
 * so put together: we iterate over all of the fields in T, deleting ones which are not (potentially
 * optional) functions. For the ones that are, we replace them with their parameters.
 *
 * this returns the type of an object whose keys are the names of the methods of T and whose values
 * are tuples containing the arguments that each method accepts.
 */
export type PluginEventArgs<T> = {
    [K in keyof Required<T> as Required<T>[K] extends (...args: any[]) => any ? K : never]:
    Required<T>[K] extends (...args: any[]) => any ? Parameters<Required<T>[K]> : never
};

export default class PluginInterface<T extends Plugin = Plugin> {
    constructor(
        plugins?: Plugin[],
        options?: {
            logger?: Logger;
            suppressErrors?: boolean;
        }
    ) {
        this.logger = options?.logger;
        this.suppressErrors = (options as any)?.suppressErrors === false ? false : true;
        for (const plugin of plugins ?? []) {
            this.add(plugin);
        }
        if (!this.logger) {
            this.logger = createLogger();
        }
        if (!this.logger) {
            this.logger = createLogger();
        }
    }

    private plugins: Plugin[] = [];
    private logger: Logger;

    /**
     * Should plugin errors cause the program to fail, or should they be caught and simply logged
     */
    private suppressErrors: boolean | undefined;

    /**
     * Call `event` on plugins
     */
    public emit<K extends keyof PluginEventArgs<T> & string>(event: K, ...args: PluginEventArgs<T>[K]) {
        this.logger.debug(`Emitting plugin event: ${event}`);
        for (let plugin of this.plugins) {
            if ((plugin as any)[event]) {
                try {
                    this.logger?.time(LogLevel.debug, [plugin.name, event], () => {
                        (plugin as any)[event](...args);
                    });
                } catch (err) {
                    this.logger?.error(`Error when calling plugin ${plugin.name}.${event}:`, (err as Error).stack);
                    if (!this.suppressErrors) {
                        throw err;
                    }
                }
            }
        }
        return args[0];
    }

    /**
     * Call `event` on plugins, but allow the plugins to return promises that will be awaited before the next plugin is notified
     */
    public async emitAsync<K extends keyof PluginEventArgs<T> & string>(event: K, ...args: PluginEventArgs<T>[K]): Promise< PluginEventArgs<T>[K][0]> {
        this.logger.debug(`Emitting async plugin event: ${event}`);
        for (let plugin of this.plugins) {
            if ((plugin as any)[event]) {
                try {
                    await this.logger?.time(LogLevel.debug, [plugin.name, event], async () => {
                        await Promise.resolve(
                            (plugin as any)[event](...args)
                        );
                    });
                } catch (err) {
                    this.logger?.error(`Error when calling plugin ${plugin.name}.${event}:`, err);
                }
            }
        }
        return args[0];
    }

    /**
     * Add a plugin to the beginning of the list of plugins
     */
    public addFirst<T extends Plugin = Plugin>(plugin: T) {
        if (!this.has(plugin)) {
            this.plugins.unshift(plugin);
        }
        return plugin;
    }

    /**
     * Add a plugin to the end of the list of plugins
     */
    public add<T extends Plugin = Plugin>(plugin: T) {
        if (!this.has(plugin)) {
            this.sanitizePlugin(plugin);
            this.plugins.push(plugin);
        }
        return plugin;
    }

    /**
     * Find deprecated or removed historic plugin hooks, and warn about them.
     * Some events can be forwards-converted
     */
    private sanitizePlugin(plugin: Plugin) {
        const removedHooks = [
            'beforePrepublish',
            'afterPrepublish'
        ];
        for (const removedHook of removedHooks) {
            if (plugin[removedHook]) {
                this.logger?.error(`Plugin "${plugin.name}": event ${removedHook} is no longer supported and will never be called`);
            }
        }

        const upgradeWithWarn = {
            beforePublish: 'beforeSerializeProgram',
            afterPublish: 'afterSerializeProgram',
            beforeProgramTranspile: 'beforeBuildProgram',
            afterProgramTranspile: 'afterBuildProgram',
            beforeFileParse: 'beforeProvideFile',
            afterFileParse: 'afterProvideFile',
            beforeFileTranspile: 'beforePrepareFile',
            afterFileTranspile: 'afterPrepareFile',
            beforeFileDispose: 'beforeFileRemove',
            afterFileDispose: 'afterFileRemove'
        };

        for (const [oldEvent, newEvent] of Object.entries(upgradeWithWarn)) {
            if (plugin[oldEvent]) {
                if (!plugin[newEvent]) {
                    plugin[newEvent] = plugin[oldEvent];
                    this.logger?.warn(`Plugin '${plugin.name}': event '${oldEvent}' is no longer supported. It has been converted to '${newEvent}' but you may encounter issues as their signatures do not match.`);
                } else {
                    this.logger?.warn(`Plugin "${plugin.name}": event '${oldEvent}' is no longer supported and will never be called`);
                }
            }
        }
    }

    public has(plugin: Plugin) {
        return this.plugins.includes(plugin);
    }

    public remove<T extends Plugin = Plugin>(plugin: T) {
        if (this.has(plugin)) {
            this.plugins.splice(this.plugins.indexOf(plugin), 1);
        }
        return plugin;
    }

    /**
     * Remove all plugins
     */
    public clear() {
        this.plugins = [];
    }
}

1	import type { Plugin } from './interfaces';
2	import { LogLevel, createLogger } from './logging';	1✔
3	import type { Logger } from './logging';
4	/*
5	* we use `Required` everywhere here because we expect that the methods on plugin objects will
6	* be optional, and we don't want to deal with `undefined`.
7	* `extends (...args: any[]) => any` determines whether the thing we're dealing with is a function.
8	* Returning `never` in the `as` clause of the `[key in object]` step deletes that key from the
9	* resultant object.
10	* on the right-hand side of the mapped type we are forced to use a conditional type a second time,
11	* in order to be able to use the `Parameters` utility type on `Required<T>[K]`. This will always
12	* be true because of the filtering done by the `[key in object]` clause, but TS requires the duplication.
13	*
14	* so put together: we iterate over all of the fields in T, deleting ones which are not (potentially
15	* optional) functions. For the ones that are, we replace them with their parameters.
16	*
17	* this returns the type of an object whose keys are the names of the methods of T and whose values
18	* are tuples containing the arguments that each method accepts.
19	*/
20	export type PluginEventArgs<T> = {
21	[K in keyof Required<T> as Required<T>[K] extends (...args: any[]) => any ? K : never]:
22	Required<T>[K] extends (...args: any[]) => any ? Parameters<Required<T>[K]> : never
23	};
24
25	export default class PluginInterface<T extends Plugin = Plugin> {	1✔
26	constructor(
27	plugins?: Plugin[],
28	options?: {
29	logger?: Logger;
30	suppressErrors?: boolean;
31	}
32	) {
33	this.logger = options?.logger;	2,030✔
34	this.suppressErrors = (options as any)?.suppressErrors === false ? false : true;	2,030!
35	for (const plugin of plugins ?? []) {	2,030✔
UNCOV 36	this.add(plugin);	×
37	}
38	if (!this.logger) {	2,030✔
39	this.logger = createLogger();	1✔
40	}
41	if (!this.logger) {	2,030!
UNCOV 42	this.logger = createLogger();	×
43	}
44	}
45
46	private plugins: Plugin[] = [];	2,030✔
47	private logger: Logger;
48
49	/**
50	* Should plugin errors cause the program to fail, or should they be caught and simply logged
51	*/
52	private suppressErrors: boolean \| undefined;
53
54	/**
55	* Call `event` on plugins
56	*/
57	public emit<K extends keyof PluginEventArgs<T> & string>(event: K, ...args: PluginEventArgs<T>[K]) {
58	this.logger.debug(`Emitting plugin event: ${event}`);	39,037✔
59	for (let plugin of this.plugins) {	39,037✔
60	if ((plugin as any)[event]) {	41,629✔
61	try {	13,428✔
62	this.logger?.time(LogLevel.debug, [plugin.name, event], () => {	13,428!
63	(plugin as any)[event](...args);	13,428✔
64	});
65	} catch (err) {
66	this.logger?.error(`Error when calling plugin ${plugin.name}.${event}:`, (err as Error).stack);	4!
67	if (!this.suppressErrors) {	4!
UNCOV 68	throw err;	×
69	}
70	}
71	}
72	}
73	return args[0];	39,037✔
74	}
75
76	/**
77	* Call `event` on plugins, but allow the plugins to return promises that will be awaited before the next plugin is notified
78	*/
79	public async emitAsync<K extends keyof PluginEventArgs<T> & string>(event: K, ...args: PluginEventArgs<T>[K]): Promise< PluginEventArgs<T>[K][0]> {
80	this.logger.debug(`Emitting async plugin event: ${event}`);	11,322✔
81	for (let plugin of this.plugins) {	11,322✔
82	if ((plugin as any)[event]) {	21,654✔
83	try {	4,078✔
84	await this.logger?.time(LogLevel.debug, [plugin.name, event], async () => {	4,078!
85	await Promise.resolve(	4,078✔
86	(plugin as any)[event](...args)
87	);
88	});
89	} catch (err) {
90	this.logger?.error(`Error when calling plugin ${plugin.name}.${event}:`, err);	2!
91	}
92	}
93	}
94	return args[0];	11,322✔
95	}
96
97	/**
98	* Add a plugin to the beginning of the list of plugins
99	*/
100	public addFirst<T extends Plugin = Plugin>(plugin: T) {
101	if (!this.has(plugin)) {	2,342!
102	this.plugins.unshift(plugin);	2,342✔
103	}
104	return plugin;	2,342✔
105	}
106
107	/**
108	* Add a plugin to the end of the list of plugins
109	*/
110	public add<T extends Plugin = Plugin>(plugin: T) {
111	if (!this.has(plugin)) {	133✔
112	this.sanitizePlugin(plugin);	132✔
113	this.plugins.push(plugin);	132✔
114	}
115	return plugin;	133✔
116	}
117
118	/**
119	* Find deprecated or removed historic plugin hooks, and warn about them.
120	* Some events can be forwards-converted
121	*/
122	private sanitizePlugin(plugin: Plugin) {
123	const removedHooks = [	132✔
124	'beforePrepublish',
125	'afterPrepublish'
126	];
127	for (const removedHook of removedHooks) {	132✔
128	if (plugin[removedHook]) {	264!
UNCOV 129	this.logger?.error(`Plugin "${plugin.name}": event ${removedHook} is no longer supported and will never be called`);	×
130	}
131	}
132
133	const upgradeWithWarn = {	132✔
134	beforePublish: 'beforeSerializeProgram',
135	afterPublish: 'afterSerializeProgram',
136	beforeProgramTranspile: 'beforeBuildProgram',
137	afterProgramTranspile: 'afterBuildProgram',
138	beforeFileParse: 'beforeProvideFile',
139	afterFileParse: 'afterProvideFile',
140	beforeFileTranspile: 'beforePrepareFile',
141	afterFileTranspile: 'afterPrepareFile',
142	beforeFileDispose: 'beforeFileRemove',
143	afterFileDispose: 'afterFileRemove'
144	};
145
146	for (const [oldEvent, newEvent] of Object.entries(upgradeWithWarn)) {	132✔
147	if (plugin[oldEvent]) {	1,320✔
148	if (!plugin[newEvent]) {	7!
149	plugin[newEvent] = plugin[oldEvent];	7✔
150	this.logger?.warn(`Plugin '${plugin.name}': event '${oldEvent}' is no longer supported. It has been converted to '${newEvent}' but you may encounter issues as their signatures do not match.`);	7!
151	} else {
UNCOV 152	this.logger?.warn(`Plugin "${plugin.name}": event '${oldEvent}' is no longer supported and will never be called`);	×
153	}
154	}
155	}
156	}
157
158	public has(plugin: Plugin) {
159	return this.plugins.includes(plugin);	2,813✔
160	}
161
162	public remove<T extends Plugin = Plugin>(plugin: T) {
163	if (this.has(plugin)) {	335!
164	this.plugins.splice(this.plugins.indexOf(plugin), 1);	335✔
165	}
166	return plugin;	335✔
167	}
168
169	/**
170	* Remove all plugins
171	*/
172	public clear() {
UNCOV 173	this.plugins = [];	×
174	}
175	}

rokucommunity / brighterscript / #14403

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous