21283815940

Committed 23 Jan 2026 10:59AM UTC coverage: 92.838% (+0.01%) from 92.825%

Build # 21283815940

Build Type

Pull #8423

github

Committed by

web-flow

Commit Message

Merge 74416f189 into 405411fa8

Pull Request Pull Request #8423: fix: Add NotifyEmitter

Run Details

8874 of 10620 branches covered (83.56%)

62 of 64 new or added lines in 3 files covered. (96.88%)

4 existing lines in 2 files now uncovered.

17734 of 19102 relevant lines covered (92.84%)

31510.24 hits per line

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

95.24

/packages/cspell-lib/src/rpc/MessagePortEvents.ts

import type { MessagePortLike } from './messagePort.js';
import type { NotifyEvent } from './notify.js';
import { NotifyEmitter } from './notify.js';

/**
 * Wraps a {@link MessagePortLike} and exposes its key events through a
 * {@link NotifyEmitter}-based interface.
 *
 * This class listens to the underlying port's `message`,
 * `messageerror`, and `close` events and re-emits them as
 * {@link NotifyEvent} instances, making it easier to subscribe to and manage
 * notifications from a message port.
 */
export class MessagePortNotifyEvents {
    #notifyMessage: NotifyEmitter<unknown> = new NotifyEmitter();
    #notifyClose: NotifyEmitter<Event> = new NotifyEmitter();
    #notifyMessageError: NotifyEmitter<Error> = new NotifyEmitter();
    #port: MessagePortLike;
    #disposed = false;

    constructor(port: MessagePortLike) {
        this.#port = port;
        this.#port.addListener('message', this.#notifyMessage.notify);
        this.#port.addListener('messageerror', this.#notifyMessageError.notify);
        this.#port.addListener('close', this.#notifyClose.notify);
    }

    [Symbol.dispose](): void {
        if (this.#disposed) return;
        this.#disposed = true;
        this.#port.removeListener('message', this.#notifyMessage.notify);
        this.#port.removeListener('messageerror', this.#notifyMessageError.notify);
        this.#port.removeListener('close', this.#notifyClose.notify);
        this.#notifyMessage[Symbol.dispose]();
        this.#notifyClose[Symbol.dispose]();
        this.#notifyMessageError[Symbol.dispose]();
    }

    /**
     * Register a handler to called when a message is received.
     */
    get onMessage(): NotifyEvent<unknown> {
        return this.#notifyMessage.onEvent;
    }

    /**
     * Return a Promise that resolves on the next message.
     * @param signal - A signal to abort the wait.
     * @returns A Promise that resolves with the next message received.
     */
    readonly awaitNextMessage = (signal?: AbortSignal): Promise<unknown> => this.#notifyMessage.awaitNext(signal);

    /**
     * Return a Promise that resolves on the close event.
     * @param signal - A signal to abort the wait.
     * @returns A Promise that resolves when the port is closed.
     */
    readonly awaitClose = (signal?: AbortSignal): Promise<unknown> => this.#notifyClose.awaitNext(signal);

    /**
     * Register a handler to called when the port is closed.
     */
    get onClose(): NotifyEvent<Event> {
        return this.#notifyClose.onEvent;
    }

    /**
     * Register a handler to called when a message error is received.
     */
    get onMessageError(): NotifyEvent<Error> {
        return this.#notifyMessageError.onEvent;
    }
}

1	import type { MessagePortLike } from './messagePort.js';
2	import type { NotifyEvent } from './notify.js';
3	import { NotifyEmitter } from './notify.js';
4
5	/**
6	* Wraps a {@link MessagePortLike} and exposes its key events through a
7	* {@link NotifyEmitter}-based interface.
8	*
9	* This class listens to the underlying port's `message`,
10	* `messageerror`, and `close` events and re-emits them as
11	* {@link NotifyEvent} instances, making it easier to subscribe to and manage
12	* notifications from a message port.
13	*/
14	export class MessagePortNotifyEvents {
15	#notifyMessage: NotifyEmitter<unknown> = new NotifyEmitter();	8✔
16	#notifyClose: NotifyEmitter<Event> = new NotifyEmitter();	8✔
17	#notifyMessageError: NotifyEmitter<Error> = new NotifyEmitter();	8✔
18	#port: MessagePortLike;
19	#disposed = false;	8✔
20
21	constructor(port: MessagePortLike) {
22	this.#port = port;	8✔
23	this.#port.addListener('message', this.#notifyMessage.notify);	8✔
24	this.#port.addListener('messageerror', this.#notifyMessageError.notify);	8✔
25	this.#port.addListener('close', this.#notifyClose.notify);	8✔
26	}
27
28	[Symbol.dispose](): void {
29	if (this.#disposed) return;	10✔
30	this.#disposed = true;	8✔
31	this.#port.removeListener('message', this.#notifyMessage.notify);	8✔
32	this.#port.removeListener('messageerror', this.#notifyMessageError.notify);	8✔
33	this.#port.removeListener('close', this.#notifyClose.notify);	8✔
34	this.#notifyMessage[Symbol.dispose]();	8✔
35	this.#notifyClose[Symbol.dispose]();	8✔
36	this.#notifyMessageError[Symbol.dispose]();	8✔
37	}
38
39	/**
40	* Register a handler to called when a message is received.
41	*/
42	get onMessage(): NotifyEvent<unknown> {
43	return this.#notifyMessage.onEvent;	3✔
44	}
45
46	/**
47	* Return a Promise that resolves on the next message.
48	* @param signal - A signal to abort the wait.
49	* @returns A Promise that resolves with the next message received.
50	*/
51	readonly awaitNextMessage = (signal?: AbortSignal): Promise<unknown> => this.#notifyMessage.awaitNext(signal);	8✔
52
53	/**
54	* Return a Promise that resolves on the close event.
55	* @param signal - A signal to abort the wait.
56	* @returns A Promise that resolves when the port is closed.
57	*/
58	readonly awaitClose = (signal?: AbortSignal): Promise<unknown> => this.#notifyClose.awaitNext(signal);	8✔
59
60	/**
61	* Register a handler to called when the port is closed.
62	*/
63	get onClose(): NotifyEvent<Event> {
64	return this.#notifyClose.onEvent;	2✔
65	}
66
67	/**
68	* Register a handler to called when a message error is received.
69	*/
70	get onMessageError(): NotifyEvent<Error> {
NEW 71	return this.#notifyMessageError.onEvent;	×
72	}
73	}

streetsidesoftware / cspell / 21283815940

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