mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-22 08:13:12 +09:00
Add filteredHandler to EventSubscriber
This commit is contained in:
1 file changed
+66
-27
@@ -1,8 +1,8 @@
|
|||||||
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, plainJson, JsonBoolean, StringEnum } from "./data";
|
import { Address, MessageRequest, IUser, JsonBoolean, StringEnum } from "./data";
|
||||||
import isDeepStrictEqual from "./is_deep_strict_equal";
|
import isDeepStrictEqual from "./is_deep_strict_equal";
|
||||||
import { RequestError, SessionLost } from "./errors";
|
import { RequestError } from "./errors";
|
||||||
import { logger } from "./logging";
|
import { logger } from "./logging";
|
||||||
|
|
||||||
export type SubscriptionRequestHandler<T> = RequestHandler<SubscriptionRequest, Event<T> | null>;
|
export type SubscriptionRequestHandler<T> = RequestHandler<SubscriptionRequest, Event<T> | null>;
|
||||||
@@ -67,11 +67,16 @@ export class SubscriptionFilters {
|
|||||||
return `[SubscriptionFilters ${this._all ? "All" : String(this._filters)}]`;
|
return `[SubscriptionFilters ${this._all ? "All" : String(this._filters)}]`;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Returns true if this filter accepts this string */
|
/** Returns true if this filter accepts all the given filters */
|
||||||
accepts(value: string) {
|
accepts(value: string) {
|
||||||
return this._all || this._filters.has(value);
|
return this._all || this._filters.has(value);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** Returns true if this filter extends the other */
|
||||||
|
extends(other: this) {
|
||||||
|
return this._all || (!other._all && [...other._filters.values()].every(value => this._filters.has(value)));
|
||||||
|
}
|
||||||
|
|
||||||
/** Returns true if there is overlap between two filters */
|
/** Returns true if there is overlap between two filters */
|
||||||
intersects(other: this) {
|
intersects(other: this) {
|
||||||
if (this._all) {
|
if (this._all) {
|
||||||
@@ -393,17 +398,18 @@ 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;
|
||||||
/** True if this subscriber is expecting to receive updates from the source */
|
|
||||||
private _syncing = false;
|
|
||||||
/** 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] = [null as S, false];
|
private _snapshot: readonly [S, boolean] = [null as S, false];
|
||||||
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>>();
|
||||||
|
/** Filters applied to the filtered handler, if empty the filtered handler will not be called */
|
||||||
|
private _filters = SubscriptionFilters.empty();
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
protected Event: EventClass<E>,
|
protected Event: EventClass<E>,
|
||||||
public control: Link,
|
public control: Link,
|
||||||
|
protected filteredHandler?: EventSubscriberCallback<E>,
|
||||||
) {
|
) {
|
||||||
control.handle(Event, this._handleEvent.bind(this));
|
control.handle(Event, this._handleEvent.bind(this));
|
||||||
// The events below exist only on websocket connectors, we can't early return because of test mocking
|
// The events below exist only on websocket connectors, we can't early return because of test mocking
|
||||||
@@ -423,10 +429,10 @@ export class EventSubscriber<E, S = null> {
|
|||||||
*/
|
*/
|
||||||
handleConnectionEvent(event: "connect" | "drop" | "resume" | "close") {
|
handleConnectionEvent(event: "connect" | "drop" | "resume" | "close") {
|
||||||
if (event === "connect" || event === "resume") {
|
if (event === "connect" || event === "resume") {
|
||||||
this._updateSubscription();
|
this._sendRequest("replace", this._callbacks.length > 0 ? SubscriptionFilters.all() : this._filters);
|
||||||
} else if (this.synced) {
|
} else if (this.synced) {
|
||||||
this.synced = false;
|
this.synced = false;
|
||||||
this.notify(null);
|
this._notify(null);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -436,23 +442,22 @@ export class EventSubscriber<E, S = null> {
|
|||||||
* @internal
|
* @internal
|
||||||
*/
|
*/
|
||||||
private async _handleEvent(event: E) {
|
private async _handleEvent(event: E) {
|
||||||
// Event handling logic
|
|
||||||
if (this._syncing && !this.synced) {
|
|
||||||
this._snapshotLastUpdatedMs = -1;
|
|
||||||
this.synced = true;
|
|
||||||
}
|
|
||||||
const eventTimeMs = this.getLastUpdatedTimeMs(event);
|
const eventTimeMs = this.getLastUpdatedTimeMs(event);
|
||||||
if (eventTimeMs > this.lastUpdatedMs) {
|
if (eventTimeMs > this.lastUpdatedMs) {
|
||||||
this.lastUpdatedMs = eventTimeMs;
|
this.lastUpdatedMs = eventTimeMs;
|
||||||
}
|
}
|
||||||
|
this.synced = this._hasSubscriptions();
|
||||||
this.processEvent(event);
|
this.processEvent(event);
|
||||||
this.notify(event);
|
this._notify(event);
|
||||||
}
|
}
|
||||||
|
|
||||||
private notify(event: E | null) {
|
private _notify(event: E | null) {
|
||||||
for (const callback of this._callbacks) {
|
for (const callback of this._callbacks) {
|
||||||
callback(event, this.synced);
|
callback(event, this.synced);
|
||||||
}
|
}
|
||||||
|
if (this.filteredHandler && !this._filters.isEmpty()) {
|
||||||
|
this.filteredHandler(event, this.synced);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
protected getLastUpdatedTimeMs(event: E) {
|
protected getLastUpdatedTimeMs(event: E) {
|
||||||
@@ -477,7 +482,7 @@ export class EventSubscriber<E, S = null> {
|
|||||||
subscribe(handler: EventSubscriberCallback<E>) {
|
subscribe(handler: EventSubscriberCallback<E>) {
|
||||||
this._callbacks.push(handler);
|
this._callbacks.push(handler);
|
||||||
if (this._callbacks.length === 1) {
|
if (this._callbacks.length === 1) {
|
||||||
this._updateSubscription();
|
this._sendRequest("subscribe", SubscriptionFilters.all());
|
||||||
}
|
}
|
||||||
return () => {
|
return () => {
|
||||||
// During a page transition the components currently rendered
|
// During a page transition the components currently rendered
|
||||||
@@ -498,12 +503,46 @@ export class EventSubscriber<E, S = null> {
|
|||||||
}
|
}
|
||||||
this._callbacks.splice(index, 1);
|
this._callbacks.splice(index, 1);
|
||||||
if (this._callbacks.length === 0) {
|
if (this._callbacks.length === 0) {
|
||||||
this._updateSubscription();
|
this._sendRequest("replace", this._filters);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** Returns true if all filters are present */
|
||||||
|
hasFilters(filters: string | string[] | SubscriptionFilters) {
|
||||||
|
if (!(filters instanceof SubscriptionFilters)) {
|
||||||
|
filters = SubscriptionFilters.fromShorthand(filters);
|
||||||
|
}
|
||||||
|
return this._filters.extends(filters);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Add filters to the filtered handler */
|
||||||
|
addFilters(filters: string | string[] | SubscriptionFilters) {
|
||||||
|
if (!(filters instanceof SubscriptionFilters)) {
|
||||||
|
filters = SubscriptionFilters.fromShorthand(filters);
|
||||||
|
}
|
||||||
|
this._filters.union(filters);
|
||||||
|
this._sendRequest("subscribe", filters);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Remove filters from the filtered handler */
|
||||||
|
removeFilters(filters: string | string[] | SubscriptionFilters) {
|
||||||
|
if (!(filters instanceof SubscriptionFilters)) {
|
||||||
|
filters = SubscriptionFilters.fromShorthand(filters);
|
||||||
|
}
|
||||||
|
this._filters.subtract(filters);
|
||||||
|
this._sendRequest("unsubscribe", filters);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Clear all filters from the filtered handler, it will no longer be called */
|
||||||
|
clearFilters() {
|
||||||
|
this._filters = SubscriptionFilters.empty();
|
||||||
|
if (!this._hasSubscriptions()) {
|
||||||
|
this._sendRequest("unsubscribe", SubscriptionFilters.all());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 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.
|
||||||
@@ -516,31 +555,31 @@ export class EventSubscriber<E, S = null> {
|
|||||||
return this._snapshot;
|
return this._snapshot;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** Returns true if there are any active subscription callbacks */
|
||||||
|
private _hasSubscriptions() {
|
||||||
|
return this._callbacks.length > 0 || !this._filters.isEmpty();
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Update the subscription with the controller based on current handler counts
|
* Update the subscription with the controller based on current handler counts
|
||||||
*/
|
*/
|
||||||
async _updateSubscription() {
|
private async _sendRequest(action: SubscriptionAction, filters: SubscriptionFilters) {
|
||||||
if (!this.control.connector.valid) {
|
if (!this.control.connector.valid) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
const entry = Link._eventsByClass.get(this.Event)!;
|
|
||||||
|
|
||||||
|
const entry = Link._eventsByClass.get(this.Event)!;
|
||||||
try {
|
try {
|
||||||
this._syncing = this._callbacks.length > 0;
|
|
||||||
const updatesSent = await this.control.sendTo("controller", new SubscriptionRequest(
|
const updatesSent = await this.control.sendTo("controller", new SubscriptionRequest(
|
||||||
entry.name,
|
entry.name, action, this.lastUpdatedMs, filters
|
||||||
this._syncing ? "subscribe" : "unsubscribe",
|
|
||||||
this.lastUpdatedMs
|
|
||||||
));
|
));
|
||||||
if (!updatesSent) {
|
if (!updatesSent) {
|
||||||
this.synced = this._syncing;
|
this.synced = this._hasSubscriptions();
|
||||||
this.notify(null);
|
this._notify(null);
|
||||||
}
|
}
|
||||||
} catch (err: any) {
|
} catch (err: any) {
|
||||||
if (!(err instanceof RequestError) || err.code !== "SessionLost") {
|
if (!(err instanceof RequestError) || err.code !== "SessionLost") {
|
||||||
logger.error(
|
logger.error(`Unexpected error updating ${entry.name} subscription:\n${err.stack}`);
|
||||||
`Unexpected error updating ${entry.name} subscription:\n${err.stack}`
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in new issue
Block a user