Merge pull request #510 from Cooldude2606/refactor/subscriptions

Refactor/subscriptions - Create a generalized event subscription class
This commit is contained in:
Hornwitser authored and GitHub committed 2023-10-13 14:45:44 +02:00
commit 60f09b11f9
20 files changed
+1048 -696

No files matched your search

+4 -4
View File
@@ -38,9 +38,9 @@ export function useHost(id: number): [ HostState, () => void ] {
setHost({ ...newHost, loading:false, missing:false, present:true });
}
control.onHostUpdate(id, updateHandler);
control.hostUpdate.subscribeToChannel(id, updateHandler);
return () => {
control.offHostUpdate(id, updateHandler);
control.hostUpdate.unsubscribeFromChannel(id, updateHandler);
};
}, [id]);
@@ -74,9 +74,9 @@ export function useHostList() {
});
}
control.onHostUpdate(null, updateHandler);
control.hostUpdate.subscribe(updateHandler);
return () => {
control.offHostUpdate(null, updateHandler);
control.hostUpdate.unsubscribe(updateHandler);
};
}, []);
+4 -4
View File
@@ -35,9 +35,9 @@ export function useInstance(id: number): [InstanceState, ()=>void] {
setInstance({ ...newInstance, present: true });
}
control.onInstanceUpdate(id, updateHandler);
control.instanceUpdate.subscribeToChannel(id, updateHandler);
return () => {
control.offInstanceUpdate(id, updateHandler);
control.instanceUpdate.unsubscribeFromChannel(id, updateHandler);
};
}, [id]);
@@ -76,9 +76,9 @@ export function useInstanceList() {
});
}
control.onInstanceUpdate(null, updateHandler);
control.instanceUpdate.subscribe(updateHandler);
return () => {
control.offInstanceUpdate(null, updateHandler);
control.instanceUpdate.unsubscribe(updateHandler);
};
}, []);
+4 -4
View File
@@ -33,9 +33,9 @@ export function useModPack(id: number) {
}
updateModPack();
control.onModPackUpdate(id, setModPack);
control.modPackUpdate.subscribeToChannel(id, setModPack);
return () => {
control.offModPackUpdate(id, setModPack);
control.modPackUpdate.unsubscribeFromChannel(id, setModPack);
};
}, [id]);
@@ -74,9 +74,9 @@ export function useModPackList() {
});
}
control.onModPackUpdate(null, updateHandler);
control.modPackUpdate.subscribe(updateHandler);
return () => {
control.offModPackUpdate(null, updateHandler);
control.modPackUpdate.unsubscribe(updateHandler);
};
}, []);
+2 -2
View File
@@ -38,9 +38,9 @@ export function useModList() {
});
}
control.onModUpdate(null, updateHandler);
control.modUpdate.subscribe(updateHandler);
return () => {
control.offModUpdate(null, updateHandler);
control.modUpdate.unsubscribe(updateHandler);
};
}, []);
+2 -2
View File
@@ -29,9 +29,9 @@ export function useSaves(instanceId?: number): lib.SaveDetails[] {
setSaves(data.saves);
}
control.onSaveListUpdate(instanceId!, updateHandler);
control.saveListUpdate.subscribeToChannel(instanceId!, updateHandler);
return () => {
control.offSaveListUpdate(instanceId!, updateHandler);
control.saveListUpdate.unsubscribeFromChannel(instanceId!, updateHandler);
};
}, [instanceId]);
+4 -4
View File
@@ -82,9 +82,9 @@ export function useUser(name: string): [RawUserState, () => void] {
setUser({ ...newUser, present: true });
}
control.onUserUpdate(name, updateHandler);
control.userUpdate.subscribeToChannel(name, updateHandler);
return () => {
control.offUserUpdate(name, updateHandler);
control.userUpdate.unsubscribeFromChannel(name, updateHandler);
};
}, [name]);
@@ -123,9 +123,9 @@ export function useUserList() {
});
}
control.onUserUpdate(null, updateHandler);
control.userUpdate.subscribe(updateHandler);
return () => {
control.offUserUpdate(null, updateHandler);
control.userUpdate.unsubscribe(updateHandler);
};
}, []);
+17 -362
View File
@@ -50,15 +50,19 @@ export class Control extends lib.Link {
accountName: string | null = null;
/** Roles of the account this control link is connected as. */
accountRoles: lib.AccountRole[] | null = null;
/** Updates not handled by the subscription service */
accountUpdateHandlers: Function[] = [];
hostUpdateHandlers: Map<number|null, hostHandler[]> = new Map();
instanceUpdateHandlers: Map<number|null, instanceHandler[]> = new Map();
saveListUpdateHandlers: Map<number|null, saveListHandler[]> = new Map();
modPackUpdateHandlers: Map<number|null, modPackHandler[]> = new Map();
modUpdateHandlers: Map<string|null, modInfoHandler[]> = new Map();
userUpdateHandlers: Map<string|null, userHandler[]> = new Map();
logHandlers: Map<lib.LogFilter, logHandler[]> = new Map();
/** Updates handled by the subscription service */
hostUpdate = new lib.EventSubscriber<lib.HostUpdateEvent, lib.HostDetails>(lib.HostUpdateEvent, event => event.update);
instanceUpdate = new lib.EventSubscriber<lib.InstanceDetailsUpdateEvent, lib.InstanceDetails>(lib.InstanceDetailsUpdateEvent, event => event.details);
saveListUpdate = new lib.EventSubscriber<lib.InstanceSaveListUpdateEvent>(lib.InstanceSaveListUpdateEvent);
modPackUpdate = new lib.EventSubscriber<lib.ModPackUpdateEvent, lib.ModPack>(lib.ModPackUpdateEvent, event => event.modPack);
modUpdate = new lib.EventSubscriber<lib.ModUpdateEvent, lib.ModInfo>(lib.ModUpdateEvent, event => event.mod);
userUpdate = new lib.EventSubscriber<lib.UserUpdateEvent, lib.RawUser>(lib.UserUpdateEvent, event => event.user);
declare connector: ControlConnector;
constructor(
@@ -75,22 +79,22 @@ export class Control extends lib.Link {
this.accountName = data.account.name;
this.accountRoles = data.account.roles;
this.emitAccountUpdate();
this.updateHostSubscriptions().catch(err => logger.error(
this.hostUpdate.connectControl(this).catch(err => logger.error(
`Unexpected error updating host subscriptions:\n${err.stack}`
));
this.updateInstanceSubscriptions().catch(err => logger.error(
));;
this.instanceUpdate.connectControl(this).catch(err => logger.error(
`Unexpected error updating instance subscriptions:\n${err.stack}`
));
this.updateSaveListSubscriptions().catch(err => logger.error(
this.saveListUpdate.connectControl(this).catch(err => logger.error(
`Unexpected error updating save list subscriptions:\n${err.stack}`
));
this.updateModPackSubscriptions().catch(err => logger.error(
this.modPackUpdate.connectControl(this).catch(err => logger.error(
`Unexpected error updating mod pack subscriptions:\n${err.stack}`
));
this.updateModSubscriptions().catch(err => logger.error(
this.modUpdate.connectControl(this).catch(err => logger.error(
`Unexpected error updating mod subscriptions:\n${err.stack}`
));
this.updateUserSubscriptions().catch(err => logger.error(
this.userUpdate.connectControl(this).catch(err => logger.error(
`Unexpected error updating user subscriptions:\n${err.stack}`
));
this.updateLogSubscriptions().catch(err => logger.error(
@@ -113,12 +117,6 @@ export class Control extends lib.Link {
}
this.handle(lib.AccountUpdateEvent, this.handleAccountUpdateEvent.bind(this));
this.handle(lib.HostUpdateEvent, this.handleHostUpdateEvent.bind(this));
this.handle(lib.InstanceDetailsUpdateEvent, this.handleInstanceDetailsUpdateEvent.bind(this));
this.handle(lib.InstanceSaveListUpdateEvent, this.handleInstanceSaveListUpdateEvent.bind(this));
this.handle(lib.ModPackUpdateEvent, this.handleModPackUpdateEvent.bind(this));
this.handle(lib.ModUpdateEvent, this.handleModUpdateEvent.bind(this));
this.handle(lib.UserUpdateEvent, this.handleUserUpdateEvent.bind(this));
this.handle(lib.LogMessageEvent, this.handleLogMessageEvent.bind(this));
this.handle(lib.DebugWsMessageEvent, this.handleDebugWsMessageEvent.bind(this));
}
@@ -149,349 +147,6 @@ export class Control extends lib.Link {
this.accountUpdateHandlers.splice(index, 1);
}
async handleHostUpdateEvent(event: lib.HostUpdateEvent) {
let handlers: Function[] = ([] as Function[]).concat(
this.hostUpdateHandlers.get(null) || [],
this.hostUpdateHandlers.get(event.update.id) || [],
);
for (let handler of handlers) {
handler(event.update);
}
}
async onHostUpdate(id: number|null, handler: hostHandler) {
if (id !== null && !Number.isInteger(id)) {
throw new Error("Invalid host id");
}
let handlers = this.hostUpdateHandlers.get(id);
if (!handlers) {
handlers = [];
this.hostUpdateHandlers.set(id, handlers);
}
handlers.push(handler);
if (handlers.length === 1) {
await this.updateHostSubscriptions();
}
}
async offHostUpdate(id: number|null, handler: hostHandler) {
let handlers = this.hostUpdateHandlers.get(id);
if (!handlers || !handlers.length) {
throw new Error(`No handlers for host ${id} exists`);
}
let index = handlers.lastIndexOf(handler);
if (index === -1) {
throw new Error(`Given handler is not registered for host ${id}`);
}
handlers.splice(index, 1);
if (!handlers.length) {
this.hostUpdateHandlers.delete(id);
await this.updateHostSubscriptions();
}
}
async updateHostSubscriptions() {
if (!this.connector.connected) {
return;
}
await this.send(new lib.HostSetSubscriptionsRequest(
this.hostUpdateHandlers.has(null),
[...this.hostUpdateHandlers.keys()].filter(e => e !== null) as number[],
));
}
async handleInstanceDetailsUpdateEvent(event: lib.InstanceDetailsUpdateEvent) {
let handlers = ([] as Function[]).concat(
this.instanceUpdateHandlers.get(null) || [],
this.instanceUpdateHandlers.get(event.details.id) || [],
);
for (let handler of handlers) {
handler(event.details);
}
};
async onInstanceUpdate(id: number|null, handler: instanceHandler) {
if (id !== null && !Number.isInteger(id)) {
throw new Error("Invalid instance id");
}
let handlers = this.instanceUpdateHandlers.get(id);
if (!handlers) {
handlers = [];
this.instanceUpdateHandlers.set(id, handlers);
}
handlers.push(handler);
if (handlers.length === 1) {
await this.updateInstanceSubscriptions();
}
}
async offInstanceUpdate(id: number|null, handler: instanceHandler) {
let handlers = this.instanceUpdateHandlers.get(id);
if (!handlers || !handlers.length) {
throw new Error(`No handlers for instance ${id} exist`);
}
let index = handlers.lastIndexOf(handler);
if (index === -1) {
throw new Error(`Given handler is not registered for instance ${id}`);
}
handlers.splice(index, 1);
if (!handlers.length) {
this.instanceUpdateHandlers.delete(id);
await this.updateInstanceSubscriptions();
}
}
async updateInstanceSubscriptions() {
if (!this.connector.connected) {
return;
}
await this.send(new lib.InstanceDetailsSetSubscriptionsRequest(
this.instanceUpdateHandlers.has(null),
[...this.instanceUpdateHandlers.keys()].filter(e => e !== null) as number[],
));
}
async handleInstanceSaveListUpdateEvent(event: lib.InstanceSaveListUpdateEvent) {
let handlers = this.saveListUpdateHandlers.get(event.instanceId);
for (let handler of handlers || []) {
handler(event);
}
};
async onSaveListUpdate(id: number, handler: saveListHandler) {
if (!Number.isInteger(id)) {
throw new Error("Invalid instance id");
}
let handlers = this.saveListUpdateHandlers.get(id);
if (!handlers) {
handlers = [];
this.saveListUpdateHandlers.set(id, handlers);
}
handlers.push(handler);
if (handlers.length === 1) {
await this.updateSaveListSubscriptions();
}
}
async offSaveListUpdate(id: number, handler: saveListHandler) {
let handlers = this.saveListUpdateHandlers.get(id);
if (!handlers) {
throw new Error(`No handlers for instance ${id} exists`);
}
let index = handlers.lastIndexOf(handler);
if (index === -1) {
throw new Error(`Given handler is not registered for instance ${id}`);
}
handlers.splice(index, 1);
if (!handlers.length) {
this.saveListUpdateHandlers.delete(id);
await this.updateSaveListSubscriptions();
}
}
async updateSaveListSubscriptions() {
if (!this.connector.connected) {
return;
}
await this.send(new lib.InstanceSetSaveListSubscriptionsRequest(
false,
[...this.saveListUpdateHandlers.keys()].filter(e => e !== null) as number[],
));
}
async handleModPackUpdateEvent(event: lib.ModPackUpdateEvent) {
let modPack = event.modPack;
let handlers = ([] as modPackHandler[]).concat(
this.modPackUpdateHandlers.get(null) || [],
this.modPackUpdateHandlers.get(modPack.id??null) || [],
);
for (let handler of handlers) {
handler(modPack);
}
}
async onModPackUpdate(id: number|null, handler: modPackHandler) {
if (id !== null && typeof id !== "number") {
throw new Error("Invalid mod pack id");
}
let handlers = this.modPackUpdateHandlers.get(id);
if (!handlers) {
handlers = [];
this.modPackUpdateHandlers.set(id, handlers);
}
handlers.push(handler);
if (handlers.length === 1) {
await this.updateModPackSubscriptions();
}
}
async offModPackUpdate(id: number|null, handler: modPackHandler) {
let handlers = this.modPackUpdateHandlers.get(id);
if (!handlers || !handlers.length) {
throw new Error(`No handlers for mod pack ${id} exist`);
}
let index = handlers.lastIndexOf(handler);
if (index === -1) {
throw new Error(`Given handler is not registered for mod pack ${id}`);
}
handlers.splice(index, 1);
if (!handlers.length) {
this.modPackUpdateHandlers.delete(id);
await this.updateModPackSubscriptions();
}
}
async updateModPackSubscriptions() {
if (!this.connector.connected) {
return;
}
await this.send(new lib.ModPackSetSubscriptionsRequest(
this.modPackUpdateHandlers.has(null),
[...this.modPackUpdateHandlers.keys()]
.filter(k => k !== null && k !== undefined) as number[],
));
}
async handleModUpdateEvent(event: lib.ModUpdateEvent) {
let mod = event.mod;
let handlers = ([] as modInfoHandler[]).concat(
this.modUpdateHandlers.get(null) || [],
this.modUpdateHandlers.get(mod.name) || []
);
for (let handler of handlers) {
handler(mod);
}
}
async onModUpdate(name: string|null, handler: modInfoHandler) {
if (name !== null && typeof name !== "string") {
throw new Error("Invalid mod name");
}
let handlers = this.modUpdateHandlers.get(name);
if (!handlers) {
handlers = [];
this.modUpdateHandlers.set(name, handlers);
}
handlers.push(handler);
if (handlers.length === 1) {
await this.updateModSubscriptions();
}
}
async offModUpdate(name: string|null, handler: modInfoHandler) {
let handlers = this.modUpdateHandlers.get(name);
if (!handlers || !handlers.length) {
throw new Error(`No handlers for mod ${name} exist`);
}
let index = handlers.lastIndexOf(handler);
if (index === -1) {
throw new Error(`Given handler is not registered for mod ${name}`);
}
handlers.splice(index, 1);
if (!handlers.length) {
this.modUpdateHandlers.delete(name);
await this.updateModSubscriptions();
}
}
async updateModSubscriptions() {
if (!this.connector.connected) {
return;
}
await this.send(new lib.ModSetSubscriptionsRequest(
this.modUpdateHandlers.has(null),
[...this.modUpdateHandlers.keys()].filter(k => k !== null) as string[],
));
}
async handleUserUpdateEvent(event: lib.UserUpdateEvent) {
let handlers = ([] as userHandler[]).concat(
this.userUpdateHandlers.get(null) || [],
this.userUpdateHandlers.get(event.user.name) || [],
);
for (let handler of handlers) {
handler(event.user);
}
};
async onUserUpdate(name: string|null, handler: userHandler) {
if (name !== null && typeof name !== "string") {
throw new Error("Invalid user name");
}
let handlers = this.userUpdateHandlers.get(name);
if (!handlers) {
handlers = [];
this.userUpdateHandlers.set(name, handlers);
}
handlers.push(handler);
if (handlers.length === 1) {
await this.updateUserSubscriptions();
}
}
async offUserUpdate(name: string|null, handler: userHandler) {
let handlers = this.userUpdateHandlers.get(name);
if (!handlers || !handlers.length) {
throw new Error(`No handlers for user ${name} exist`);
}
let index = handlers.lastIndexOf(handler);
if (index === -1) {
throw new Error(`Given handler is not registered for user ${name}`);
}
handlers.splice(index, 1);
if (!handlers.length) {
this.userUpdateHandlers.delete(name);
await this.updateUserSubscriptions();
}
}
async updateUserSubscriptions() {
if (!this.connector.connected) {
return;
}
await this.send(new lib.UserSetSubscriptionsRequest(
this.userUpdateHandlers.has(null),
[...this.userUpdateHandlers.keys()].filter(e => e !== null) as string[],
));
}
async handleLogMessageEvent(event: lib.LogMessageEvent) {
let info = event.info;