#13605

Committed 13 Jan 2025 08:51PM UTC coverage: 86.913% (+0.01%) from 86.902%

Build Type

push

Committed by

Commit Message

Merge 8c5f8741e into 9d6ef67ba

Run Details

11976 of 14547 branches covered (82.33%)

Branch coverage included in aggregate %.

1 of 1 new or added line in 1 file covered. (100.0%)

103 existing lines in 10 files now uncovered.

12982 of 14169 relevant lines covered (91.62%)

31777.91 hits per line

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

71.93

/src/PluginInterface.ts

import type { CompilerPlugin } from './interfaces';
import { LogLevel, createLogger, 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 CompilerPlugin = CompilerPlugin> {
    constructor(
        plugins?: CompilerPlugin[],
        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: CompilerPlugin[] = [];
    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]) {
        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]> {
        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 CompilerPlugin = CompilerPlugin>(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 CompilerPlugin = CompilerPlugin>(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: CompilerPlugin) {
        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: CompilerPlugin) {
        return this.plugins.includes(plugin);
    }

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

rokucommunity / brighterscript / #13605

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