Refactor to use subsribers

This commit is contained in:
Cooldude2606 committed 2023-09-05 01:46:45 +01:00
1 parent 17943c48c3
commit da25196830
16 files changed
+120 -707

No files matched your search

+1 -23
View File
@@ -35,34 +35,12 @@ export class HostListRequest {
static Response = jsonArray(HostDetails);
}
export class HostSetSubscriptionsRequest {
declare ["constructor"]: typeof HostSetSubscriptionsRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.host.subscribe" as const;
constructor(
public all: boolean,
public hostIds: number[],
) { }
static jsonSchema = Type.Object({
"all": Type.Boolean(),
"hostIds": Type.Array(Type.Integer()),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.all, json.hostIds);
}
}
export class HostUpdateEvent {
declare ["constructor"]: typeof HostUpdateEvent;
static type = "event" as const;
static src = "controller" as const;
static dst = "control" as const;
static permission = "core.host.subscribe" as const;
constructor(
public update: HostDetails,
+2 -44
View File
@@ -67,33 +67,12 @@ export class InstanceDetailsListRequest {
static Response = jsonArray(InstanceDetails);
};
export class InstanceDetailsSetSubscriptionsRequest {
declare ["constructor"]: typeof InstanceDetailsSetSubscriptionsRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.instance.subscribe" as const;
constructor(
public all: boolean = false,
public instanceIds: number[] = [],
) { }
static jsonSchema = Type.Object({
"all": Type.Boolean(),
"instanceIds": Type.Array(Type.Integer()),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.all, json.instanceIds);
}
};
export class InstanceDetailsUpdateEvent {
declare ["constructor"]: typeof InstanceDetailsUpdateEvent;
static type = "event" as const;
static src = "controller" as const;
static dst = "control" as const;
static permission = "core.instance.subscribe" as const;
constructor(
public details: InstanceDetails,
@@ -299,33 +278,12 @@ export class InstanceListSavesRequest {
static Response = jsonArray(SaveDetails);
}
export class InstanceSetSaveListSubscriptionsRequest {
declare ["constructor"]: typeof InstanceSetSaveListSubscriptionsRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.instance.save.list_subscribe" as const;
constructor(
public all: boolean = false,
public instanceIds: number[] = [],
) { }
static jsonSchema = Type.Object({
"all": Type.Boolean(),
"instanceIds": Type.Array(Type.Integer()),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.all, json.instanceIds);
}
};
export class InstanceSaveListUpdateEvent {
declare ["constructor"]: typeof InstanceSaveListUpdateEvent;
static type = "event" as const;
static src = ["instance", "host", "controller"] as const;
static dst = ["controller", "control"] as const;
static permission = "core.instance.save.list_subscribe" as const;
constructor(
public instanceId: number,
+2 -44
View File
@@ -104,28 +104,6 @@ export class ModPackDeleteRequest {
}
}
export class ModPackSetSubscriptionsRequest {
declare ["constructor"]: typeof ModPackSetSubscriptionsRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.mod_pack.subscribe" as const;
constructor(
public all: boolean,
public modPackIds: number[],
) { }
static jsonSchema = Type.Object({
"all": Type.Boolean(),
"modPackIds": Type.Array(Type.Integer()),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.all, json.modPackIds);
}
}
export class ModGetRequest {
declare ["constructor"]: typeof ModGetRequest;
static type = "request" as const;
@@ -217,28 +195,6 @@ export class ModSearchRequest {
};
}
export class ModSetSubscriptionsRequest {
declare ["constructor"]: typeof ModSetSubscriptionsRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.mod.subscribe" as const;
constructor(
public all: boolean,
public modNames: string[],
) { }
static jsonSchema = Type.Object({
"all": Type.Boolean(),
"modNames": Type.Array(Type.String()),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.all, json.modNames);
}
}
export class ModDownloadRequest {
declare ["constructor"]: typeof ModDownloadRequest;
static type = "request" as const;
@@ -290,6 +246,7 @@ export class ModPackUpdateEvent {
static type = "event" as const;
static src = "controller" as const;
static dst = "control" as const;
static permission = "core.mod_pack.subscribe" as const;
constructor(
public modPack: ModPack,
@@ -309,6 +266,7 @@ export class ModUpdateEvent {
static type = "event" as const;
static src = "controller" as const;
static dst = "control" as const;
static permission = "core.mod.subscribe" as const;
constructor(
public mod: ModInfo,
+1 -22
View File
@@ -251,28 +251,6 @@ export class UserListRequest {
static Response = jsonArray(RawUser);
}
export class UserSetSubscriptionsRequest {
declare ["constructor"]: typeof UserSetSubscriptionsRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.user.subscribe" as const;
constructor(
public all: boolean,
public names: string[],
) { }
static jsonSchema = Type.Object({
"all": Type.Boolean(),
"names": Type.Array(Type.String()),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.all, json.names);
}
}
export class UserCreateRequest {
declare ["constructor"]: typeof UserCreateRequest;
static type = "request" as const;
@@ -460,6 +438,7 @@ export class UserUpdateEvent {
static type = "event" as const;
static src = "controller" as const;
static dst = "control" as const;
static permission = "core.user.subscribe" as const;
constructor(
public user: RawUser,
+3 -6
View File
@@ -5,6 +5,7 @@ import * as host from "../data/messages_host";
import * as instance from "../data/messages_instance";
import * as mod from "../data/messages_mod";
import * as user from "../data/messages_user";
import * as subscriptions from "../subscriptions"
import type { RequestClass, EventClass } from "./link";
/**
@@ -27,8 +28,9 @@ export const dataClasses: (RequestClass<unknown, unknown> | EventClass<unknown>)
controller.DebugDumpWsRequest,
controller.DebugWsMessageEvent,
subscriptions.SubscriptionRequest,
host.HostListRequest,
host.HostSetSubscriptionsRequest,
host.HostUpdateEvent,
host.HostMetricsRequest,
host.ControllerConnectionEvent,
@@ -37,7 +39,6 @@ export const dataClasses: (RequestClass<unknown, unknown> | EventClass<unknown>)
instance.InstanceDetailsGetRequest,
instance.InstanceDetailsListRequest,
instance.InstanceDetailsSetSubscriptionsRequest,
instance.InstanceDetailsUpdateEvent,
instance.InstanceCreateRequest,
instance.InstanceConfigGetRequest,
@@ -47,7 +48,6 @@ export const dataClasses: (RequestClass<unknown, unknown> | EventClass<unknown>)
instance.InstanceMetricsRequest,
instance.InstanceStartRequest,
instance.InstanceListSavesRequest,
instance.InstanceSetSaveListSubscriptionsRequest,
instance.InstanceSaveListUpdateEvent,
instance.InstanceCreateSaveRequest,
instance.InstanceRenameSaveRequest,
@@ -82,11 +82,9 @@ export const dataClasses: (RequestClass<unknown, unknown> | EventClass<unknown>)
mod.ModPackCreateRequest,
mod.ModPackUpdateRequest,
mod.ModPackDeleteRequest,
mod.ModPackSetSubscriptionsRequest,
mod.ModGetRequest,
mod.ModListRequest,
mod.ModSearchRequest,
mod.ModSetSubscriptionsRequest,
mod.ModDownloadRequest,
mod.ModDeleteRequest,
mod.ModPackUpdateEvent,
@@ -100,7 +98,6 @@ export const dataClasses: (RequestClass<unknown, unknown> | EventClass<unknown>)
user.RoleDeleteRequest,
user.UserGetRequest,
user.UserListRequest,
user.UserSetSubscriptionsRequest,
user.UserCreateRequest,
user.UserRevokeTokenRequest,
user.UserUpdateRolesRequest,
+25 -16
View File
@@ -3,9 +3,9 @@ import { Link, Event, EventClass, RequestHandler, WebSocketClientConnector, WebS
import { Address, MessageRequest } from "./data";
import { User } from "./users";
export type SubscriptionChannelCategoriser<T> = (event: Event<T>) => string | number;
export type SubscriptionChannelCategoriser<T> = (event: T) => string | number;
export type SubscriptionRequestHandler<T> = RequestHandler<SubscriptionRequest, Event<T> | null>;
export type EventSubscriberCallback<T> = (event: Event<T>) => Promise<void>;
export type EventSubscriberCallback<T> = (value: T) => void;
/**
* Response received by the subscriber after a request
@@ -192,15 +192,17 @@ export class SubscriptionController {
/**
* A class component to handle incoming subscription requests and offers a method to broadcast to subscribers
* After creation, no other handler can be registered for SubscriptionRequest
* An optional prehandler can be given to extract data from the event to be used by the subscribed handlers
*/
export class EventSubscriber<T> {
_callbacks = new Array<EventSubscriberCallback<T>>()
_channelCallbacks = new Map<string | number, Array<EventSubscriberCallback<T>>>()
lastResponse: Event<T> | null = null;
export class EventSubscriber<T, V=T> {
_callbacks = new Array<EventSubscriberCallback<V>>()
_channelCallbacks = new Map<string | number, Array<EventSubscriberCallback<V>>>()
lastResponse: T | null = null; // Does not work with Event<T>
lastResponseTime = 0;
constructor(
private event: EventClass<T>,
private prehandler?: (event: T) => V,
private control?: Link
) {
const entry = Link._eventsByClass.get(this.event);
@@ -212,26 +214,33 @@ export class EventSubscriber<T> {
}
}
async _handle(response: Event<T>) {
async _handle(response: T) {
this.lastResponse = response;
this.lastResponseTime = Date.now();
for (let callback of this._callbacks) {
callback(response);
}
if (this.prehandler) {
for (let callback of this._callbacks) {
callback(this.prehandler(response));
}
} else {
for (let callback of this._callbacks) {
callback(response as any); // Default behaviour is to pass the event unchanged
}
}
}
connectControl(control: Link) {
if (this.control === control) return;
if (this.control === control) return Promise.resolve();
this.control = control;
this.control.handle(this.event, this._handle.bind(this));
return this._updateSubscription();
}
subscribe(handler: EventSubscriberCallback<T>) {
subscribe(handler: EventSubscriberCallback<V>) {
this._callbacks.push(handler);
this._updateSubscription();
}
subscribeToChannel(channel: string | number, handler: EventSubscriberCallback<T>) {
subscribeToChannel(channel: string | number, handler: EventSubscriberCallback<V>) {
if (!this._channelCallbacks.get(channel)) {
this._channelCallbacks.set(channel, []);
}
@@ -239,7 +248,7 @@ export class EventSubscriber<T> {
this._updateSubscription();
}
unsubscribe(handler: EventSubscriberCallback<T>) {
unsubscribe(handler: EventSubscriberCallback<V>) {
let index = this._callbacks.lastIndexOf(handler);
if (index === -1) {
throw new Error("handler is not registered");
@@ -249,7 +258,7 @@ export class EventSubscriber<T> {
this._updateSubscription();
}
unsubscribeFromChannel(channel: string | number, handler: EventSubscriberCallback<T>) {
unsubscribeFromChannel(channel: string | number, handler: EventSubscriberCallback<V>) {
const channelCallbacks = this._channelCallbacks.get(channel);
if (!channelCallbacks) {
throw new Error("handler is not registered");
@@ -280,7 +289,7 @@ export class EventSubscriber<T> {
));
if (response.eventReplay) {
this._handle(response.eventReplay);
this._handle(response.eventReplay as T);
}
}
}