Expose error on event subscriber snapshot

This commit is contained in:
Cooldude2606 committed 2026-06-26 22:04:06 +01:00
1 parent e135d37878
commit 95ea073b77
2 files changed
+36 -6

No files matched your search

+15 -5
View File
@@ -1,6 +1,6 @@
import { Type, Static } from "@sinclair/typebox"; import { Type, Static } from "@sinclair/typebox";
import { Link, Event, EventClass, RequestHandler, WebSocketBaseConnector } from "./link"; import { Link, Event, EventClass, RequestHandler, WebSocketBaseConnector } from "./link";
import { Address, MessageRequest, IUser, JsonBoolean, StringEnum } from "./data"; import { Address, MessageRequest, IUser, JsonBoolean, StringEnum, AccountDetails } from "./data";
import isDeepStrictEqual from "./is_deep_strict_equal"; import isDeepStrictEqual from "./is_deep_strict_equal";
import { RequestError } from "./errors"; import { RequestError } from "./errors";
import { logger } from "./logging"; import { logger } from "./logging";
@@ -408,8 +408,10 @@ export class EventSubscriber<E, S = null> {
lastUpdatedMs = -1; lastUpdatedMs = -1;
/** True if this subscriber is currently synced with the source */ /** True if this subscriber is currently synced with the source */
synced = false; synced = false;
/** Error value from last attempted subscription event */
error = null as Error | null;
/** Repeat calls to getSnapshot will return the same readonly copy unless values has updated */ /** Repeat calls to getSnapshot will return the same readonly copy unless values has updated */
private _snapshot: readonly [S, boolean] = [this.makeSnapshot(), false]; private _snapshot: readonly [S, boolean, Error | null] = [this.makeSnapshot(), false, null];
private _snapshotLastUpdatedMs = -1; private _snapshotLastUpdatedMs = -1;
/** Callbacks will be called when an event is received or the synced state changes */ /** Callbacks will be called when an event is received or the synced state changes */
private _callbacks = new Array<EventSubscriberCallback<E>>(); private _callbacks = new Array<EventSubscriberCallback<E>>();
@@ -557,10 +559,14 @@ export class EventSubscriber<E, S = null> {
* Obtain a snapshot of the current state of the tracked resource * Obtain a snapshot of the current state of the tracked resource
* @returns tuple of values map snapshot and synced property. * @returns tuple of values map snapshot and synced property.
*/ */
getSnapshot(): readonly [S, boolean] { getSnapshot(): readonly [S, boolean, Error | null] {
if (this._snapshotLastUpdatedMs !== this.lastUpdatedMs || this._snapshot[1] !== this.synced) { if (
this._snapshotLastUpdatedMs !== this.lastUpdatedMs
|| this._snapshot[1] !== this.synced
|| this._snapshot[2] !== this.error
) {
this._snapshotLastUpdatedMs = this.lastUpdatedMs; this._snapshotLastUpdatedMs = this.lastUpdatedMs;
this._snapshot = [this.makeSnapshot(), this.synced]; this._snapshot = [this.makeSnapshot(), this.synced, this.error];
} }
return this._snapshot; return this._snapshot;
} }
@@ -583,6 +589,7 @@ export class EventSubscriber<E, S = null> {
const updatesSent = await this.control.sendTo("controller", new SubscriptionRequest( const updatesSent = await this.control.sendTo("controller", new SubscriptionRequest(
entry.name, action, this.lastUpdatedMs, filters entry.name, action, this.lastUpdatedMs, filters
)); ));
this.error = null;
if (!updatesSent) { if (!updatesSent) {
this.synced = this._hasSubscriptions(); this.synced = this._hasSubscriptions();
this._notify(null); this._notify(null);
@@ -591,6 +598,9 @@ export class EventSubscriber<E, S = null> {
if (!(err instanceof RequestError) || err.code !== "SessionLost") { if (!(err instanceof RequestError) || err.code !== "SessionLost") {
logger.error(`Unexpected error updating ${entry.name} subscription:\n${err.stack}`); logger.error(`Unexpected error updating ${entry.name} subscription:\n${err.stack}`);
} }
if (err instanceof Error) {
this.error = err;
}
} }
} }
} }
+21 -1
View File
@@ -792,7 +792,10 @@ describe("lib/subscriptions", function() {
}); });
describe("class EventSubscriber", function() { describe("class EventSubscriber", function() {
let mockControl, eventSubscriber; /** @type {MockControl} */
let mockControl;
/** @type {lib.EventSubscriber} */
let eventSubscriber;
beforeEach(function() { beforeEach(function() {
mockControl = new MockControl(new MockConnector( mockControl = new MockControl(new MockConnector(
@@ -1120,6 +1123,23 @@ describe("lib/subscriptions", function() {
} }
assert.equal(logged, undefined); assert.equal(logged, undefined);
}); });
it("should expose errors through the snapshot", async function() {
eventSubscriber.control.sendTo = function() {
throw new lib.PermissionError("Permission denied");
};
const unsubscribe = eventSubscriber.subscribe(() => {});
await new Promise(r => setImmediate(r));
const [,, error1] = eventSubscriber.getSnapshot();
assert.deepEqual(error1, new lib.PermissionError("Permission denied"));
eventSubscriber.control.sendTo = function() {};
unsubscribe();
await new Promise(r => setImmediate(r));
const [,, error2] = eventSubscriber.getSnapshot();
assert.deepEqual(error2, null);
});
}); });
}); });