Skip to content

Fix: getGlobalSettings accumulates orphaned listeners under concurrent or interleaved calls #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
popcornhax wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix: getGlobalSettings accumulates orphaned listeners under concurrent or interleaved calls #139

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75be8e3
getGlobalSettings accumulates orphaned listeners under concurrent or …
popcornhax Mar 4, 2026
2f7f4d2
import issue & formatting
popcornhax Mar 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 25 additions & 7 deletions src/plugin/settings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { IDisposable, JsonObject } from "@elgato/utils";
import { withResolvers } from "@elgato/utils";
import { randomUUID } from "node:crypto";

import type { DidReceiveGlobalSettings, DidReceiveSettings } from "../api/index.js";
Expand All @@ -8,6 +9,8 @@ import { ActionEvent } from "./events/action-event.js";
import { DidReceiveGlobalSettingsEvent, type DidReceiveSettingsEvent } from "./events/index.js";
import { requiresVersion } from "./validation.js";

const REQUEST_TIMEOUT = 15 * 1000; // 15s

let __useExperimentalMessageIdentifiers = false;

export const settings = {
Expand Down Expand Up @@ -41,14 +44,29 @@ export const settings = {
* @returns Promise containing the plugin's global settings.
*/
getGlobalSettings: <T extends JsonObject = JsonObject>(): Promise<T> => {
return new Promise((resolve) => {
connection.once("didReceiveGlobalSettings", (ev: DidReceiveGlobalSettings<T>) => resolve(ev.payload.settings));
connection.send({
event: "getGlobalSettings",
context: connection.registrationParameters.pluginUUID,
id: randomUUID(),
});
const id = randomUUID();
const { promise, resolve, reject } = withResolvers<T>();

const timeoutId = setTimeout(() => {
listener.dispose();
reject(new Error("getGlobalSettings timed out"));
}, REQUEST_TIMEOUT);

const listener = connection.disposableOn("didReceiveGlobalSettings", (ev: DidReceiveGlobalSettings<T>): void => {
if (ev.id === id) {
Copy link
Copy Markdown
Member

@GeekyEggo GeekyEggo Mar 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This id check can be removed; with global settings being shared, it's safe to assume that any didReceiveGlobalSettings event can fulfil any-and-all pending promises.

For request completeness, the id should still be sent with the request, but needn't be checked when receiving the global settings, e.g. the following is fine:

connection.send({
		event: "getGlobalSettings",
		context: connection.registrationParameters.pluginUUID,
		id: randomUUID(),
});

clearTimeout(timeoutId);
listener.dispose();
resolve(ev.payload.settings);
}
});

connection.send({
event: "getGlobalSettings",
context: connection.registrationParameters.pluginUUID,
id,
});

return promise;
},

/**
Expand Down