feat(typed-ipc): main process IpcListener cleanup functions
#20
+717
−13
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The main process `IpcListener` now returns cleanup functions for its `on` and `handle` methods which remove the registered listener or handler. Its `dispose` method now unsubscribes only listeners and handlers registered with this class instance. Closes alex8088#19
psychedelicious
commented
Dec 8, 2024
Comment on lines
57
to
68
| /** | ||
| * Dispose all listeners and handlers. | ||
| * Dispose all registered listeners and handlers. | ||
| */ | ||
| dispose(): void { | ||
| this.listeners.forEach(c => ipcMain.removeAllListeners(c)) | ||
| this.listeners = [] | ||
| this.handlers.forEach(c => ipcMain.removeHandler(c)) | ||
| this.handlers = [] | ||
| this.listeners.forEach((listeners, channel) => { | ||
| listeners.forEach(listener => ipcMain.removeListener(channel, listener)) | ||
| }) | ||
| this.listeners.clear() | ||
| this.handlers.forEach(channel => ipcMain.removeHandler(channel)) | ||
| this.handlers.clear() | ||
| } | ||
| } |
There was a problem hiding this comment.
- Old behavior:
disposeremoves all listeners for each channel, even those which were not registered by the instance. - New behavior:
disposeremoves listeners registered by this specific instance.
I think the new behavior is less surprising than the old behavior, but you could argue that this is a breaking change.
| private listeners: string[] = [] | ||
| private handlers: string[] = [] | ||
| private listeners: Map<string, Set<(...args: any[]) => void>> = new Map() | ||
| private handlers: Set<string> = new Set() |
There was a problem hiding this comment.
Using a Set fixes a subtle issue. With an array, it's possible that we could end up with duplicates channels in the array.
You can only have 1 handler per channel, but the handle method will add the channel to the array even if a handler already exists for the channel.
When we dispose, we may end up attempting to remove listeners for a channel multiple times.
I don't think this causes any problems in practice, but using Set prevents the situation from happening in the first place.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The main process
IpcListenernow returns cleanup functions for itsonandhandlemethods which remove the registered listener or handler.Its
disposemethod now unsubscribes only listeners and handlers registered with this class instance.Closes #19
Additional context
I added
vitestand tests for the main process'sIpcListener.I'll add some notes to the code.
What is the purpose of this pull request?
Before submitting the PR, please make sure you do the following
fixes #123).