mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-20 15:43:13 +09:00
Refactor EventSubscriber to track its resource
Process updates of the resource EventSubscriber are subscribed to and have it keep a mapping of id to value syncronised with event provider as long as there are subscription callbacks registered with it. The mapping is kept around after the last callback is unsubscribed so that it can be efficiently resynced with the resource based on the updatedAt timestaps of individual elements. This allows the EventSubscriber to provide the right building blocks to provide its values to React components via the the useSyncExternalStore hook. This in turn greatly simplifies the web_ui models for the subscribed resources.
This commit is contained in:
1 parent
867bb0c646
commit
8c17adf15b
27 files changed
+410
-713
No files matched your search
@@ -1,92 +1,13 @@
|
||||
import { useEffect, useContext, useState } from "react";
|
||||
import { useCallback, useContext, useSyncExternalStore } from "react";
|
||||
import ControlContext from "../components/ControlContext";
|
||||
|
||||
import * as lib from "@clusterio/lib";
|
||||
|
||||
|
||||
export type HostState = Partial<lib.HostDetails> & {
|
||||
loading?: boolean,
|
||||
present?: boolean,
|
||||
missing?: boolean,
|
||||
export function useHost(id?: number) {
|
||||
const [hosts, synced] = useHosts();
|
||||
return [id !== undefined ? hosts.get(id) : undefined, synced] as const;
|
||||
}
|
||||
|
||||
export function useHost(id: number): [ HostState, () => void ] {
|
||||
let control = useContext(ControlContext);
|
||||
let [host, setHost] = useState<HostState>({ loading: true });
|
||||
|
||||
function updateHost() {
|
||||
// XXX optimize by requesting only the host in question
|
||||
control.send(
|
||||
new lib.HostListRequest()
|
||||
).then((hosts: lib.HostDetails[]) => {
|
||||
let match = hosts.find(i => i.id === id);
|
||||
if (!match) {
|
||||
setHost({ missing: true });
|
||||
} else {
|
||||
setHost({ ...match, present: true });
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
if (!Number.isInteger(id)) {
|
||||
setHost({ missing: true });
|
||||
return undefined;
|
||||
}
|
||||
updateHost();
|
||||
|
||||
function updateHandler(newHosts: lib.HostDetails[]) {
|
||||
const newHost = newHosts.find(h => h.id === id);
|
||||
if (newHost) {
|
||||
setHost({ ...newHost, loading: false, missing: false, present: true });
|
||||
}
|
||||
}
|
||||
|
||||
control.hostUpdate.subscribe(updateHandler);
|
||||
return () => {
|
||||
control.hostUpdate.unsubscribe(updateHandler);
|
||||
};
|
||||
}, [id]);
|
||||
|
||||
return [host, updateHost];
|
||||
}
|
||||
|
||||
export function useHostList() {
|
||||
let control = useContext(ControlContext);
|
||||
let [hostList, setHostList] = useState<lib.HostDetails[]>([]);
|
||||
|
||||
function updateHostList() {
|
||||
control.send(
|
||||
new lib.HostListRequest()
|
||||
).then((hosts: lib.HostDetails[]) => {
|
||||
setHostList(hosts);
|
||||
});
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
updateHostList();
|
||||
|
||||
function updateHandler(newHosts: lib.HostDetails[]) {
|
||||
setHostList(oldList => {
|
||||
let newList = oldList.concat();
|
||||
for (const newHost of newHosts) {
|
||||
let index = newList.findIndex(s => s.id === newHost.id);
|
||||
if (index !== -1) {
|
||||
newList[index] = newHost;
|
||||
} else {
|
||||
newList.push(newHost);
|
||||
}
|
||||
}
|
||||
return newList;
|
||||
});
|
||||
}
|
||||
|
||||
control.hostUpdate.subscribe(updateHandler);
|
||||
return () => {
|
||||
control.hostUpdate.unsubscribe(updateHandler);
|
||||
};
|
||||
}, []);
|
||||
|
||||
|
||||
return [hostList];
|
||||
export function useHosts() {
|
||||
const control = useContext(ControlContext);
|
||||
const subscribe = useCallback((callback: () => void) => control.hosts.subscribe(callback), [control]);
|
||||
return useSyncExternalStore(subscribe, () => control.hosts.getSnapshot());
|
||||
}
|
||||
@@ -1,91 +1,13 @@
|
||||
import { useEffect, useContext, useState } from "react";
|
||||
import { useCallback, useContext, useSyncExternalStore } from "react";
|
||||
import ControlContext from "../components/ControlContext";
|
||||
|
||||
import * as lib from "@clusterio/lib";
|
||||
|
||||
const { logger } = lib;
|
||||
|
||||
export type InstanceState = Partial<lib.InstanceDetails> & {
|
||||
loading?: boolean,
|
||||
present?: boolean,
|
||||
missing?: boolean,
|
||||
export function useInstance(id?: number) {
|
||||
const [instances, synced] = useInstances();
|
||||
return [id !== undefined ? instances.get(id) : undefined, synced] as const;
|
||||
}
|
||||
|
||||
export function useInstance(id: number): [InstanceState, ()=>void] {
|
||||
let control = useContext(ControlContext);
|
||||
let [instance, setInstance] = useState<InstanceState>({ loading: true });
|
||||
|
||||
function updateInstance() {
|
||||
control.send(new lib.InstanceDetailsGetRequest(id)).then(updatedInstance => {
|
||||
setInstance({ ...updatedInstance, present: true });
|
||||
}).catch((err: any) => {
|
||||
logger.error(`Failed to get instance: ${err}`);
|
||||
setInstance({ missing: true });
|
||||
});
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
if (!Number.isInteger(id)) {
|
||||
setInstance({ missing: true });
|
||||
return undefined;
|
||||
}
|
||||
updateInstance();
|
||||
|
||||
function updateHandler(newInstances: lib.InstanceDetails[]) {
|
||||
const newInstance = newInstances.find(i => i.id === id);
|
||||
if (newInstance) {
|
||||
setInstance({ ...newInstance, present: true });
|
||||
}
|
||||
}
|
||||
|
||||
control.instanceUpdate.subscribe(updateHandler);
|
||||
return () => {
|
||||
control.instanceUpdate.unsubscribe(updateHandler);
|
||||
};
|
||||
}, [id]);
|
||||
|
||||
return [instance, updateInstance];
|
||||
}
|
||||
|
||||
export function useInstanceList() {
|
||||
let control = useContext(ControlContext);
|
||||
let [instanceList, setInstanceList] = useState<lib.InstanceDetails[]>([]);
|
||||
|
||||
function updateInstanceList() {
|
||||
control.send(new lib.InstanceDetailsListRequest()).then(instances => {
|
||||
setInstanceList(instances);
|
||||
}).catch(err => {
|
||||
logger.error(`Failed to list instances:\n${err}`);
|
||||
});
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
updateInstanceList();
|
||||
|
||||
function updateHandler(newInstances: lib.InstanceDetails[]) {
|
||||
setInstanceList(oldList => {
|
||||
let newList = oldList.concat();
|
||||
for (const newInstance of newInstances) {
|
||||
let index = newList.findIndex(s => s.id === newInstance.id);
|
||||
if (newInstance.status !== "deleted") {
|
||||
if (index !== -1) {
|
||||
newList[index] = newInstance;
|
||||
} else {
|
||||
newList.push(newInstance);
|
||||
}
|
||||
} else if (index !== -1) {
|
||||
newList.splice(index, 1);
|
||||
}
|
||||
}
|
||||
return newList;
|
||||
});
|
||||
}
|
||||
|
||||
control.instanceUpdate.subscribe(updateHandler);
|
||||
return () => {
|
||||
control.instanceUpdate.unsubscribe(updateHandler);
|
||||
};
|
||||
}, []);
|
||||
|
||||
return [instanceList];
|
||||
export function useInstances() {
|
||||
const control = useContext(ControlContext);
|
||||
const subscribe = useCallback((callback: () => void) => control.instances.subscribe(callback), [control]);
|
||||
return useSyncExternalStore(subscribe, () => control.instances.getSnapshot());
|
||||
}
|
||||
@@ -1,93 +1,13 @@
|
||||
import { useContext, useEffect, useState } from "react";
|
||||
|
||||
import * as lib from "@clusterio/lib";
|
||||
|
||||
import { useCallback, useContext, useSyncExternalStore } from "react";
|
||||
import ControlContext from "../components/ControlContext";
|
||||
|
||||
const { logger } = lib;
|
||||
|
||||
|
||||
export type StateLoadStatus = {
|
||||
loading?: boolean;
|
||||
present?: boolean;
|
||||
missing?: boolean;
|
||||
};
|
||||
|
||||
export function useModPack(id: number) {
|
||||
let control = useContext(ControlContext);
|
||||
let [modPack, setModPack] = useState<lib.ModPack|StateLoadStatus>({ loading: true });
|
||||
|
||||
function updateModPack() {
|
||||
control.send(new lib.ModPackGetRequest(id)).then(updatedModPack => {
|
||||
setModPack(updatedModPack);
|
||||
}).catch(err => {
|
||||
logger.error(`Failed to get mod pack: ${err}`);
|
||||
setModPack({ missing: true });
|
||||
});
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
if (typeof id !== "number") {
|
||||
setModPack({ missing: true });
|
||||
return undefined;
|
||||
}
|
||||
updateModPack();
|
||||
|
||||
function updateHandler(modPacks: lib.ModPack[]) {
|
||||
const newModPack = modPacks.find(m => m.id === id);
|
||||
if (newModPack) {
|
||||
setModPack(newModPack);
|
||||
}
|
||||
}
|
||||
control.modPackUpdate.subscribe(updateHandler);
|
||||
return () => {
|
||||
control.modPackUpdate.unsubscribe(updateHandler);
|
||||
};
|
||||
}, [id]);
|
||||
|
||||
return [modPack];
|
||||
export function useModPack(id?: number) {
|
||||
const [modPacks, synced] = useModPacks();
|
||||
return [id !== undefined ? modPacks.get(id) : undefined, synced] as const;
|
||||
}
|
||||
|
||||
export function useModPackList() {
|
||||
let control = useContext(ControlContext);
|
||||
let [modPackList, setModPackList] = useState<lib.ModPack[]>([]);
|
||||
|
||||
function updateModPackList() {
|
||||
control.send(new lib.ModPackListRequest()).then(modPacks => {
|
||||
setModPackList(modPacks);
|
||||
}).catch(err => {
|
||||
logger.error(`Failed to list mod packs:\n${err}`);
|
||||
});
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
updateModPackList();
|
||||
|
||||
function updateHandler(newModPacks: lib.ModPack[]) {
|
||||
setModPackList(oldList => {
|
||||
let newList = oldList.concat();
|
||||
for (const newModPack of newModPacks) {
|
||||
let index = newList.findIndex(u => u.id === newModPack.id);
|
||||
if (!newModPack.isDeleted) {
|
||||
if (index !== -1) {
|
||||
newList[index] = newModPack;
|
||||
} else {
|
||||
newList.push(newModPack);
|
||||
}
|
||||
} else if (index !== -1) {
|
||||
newList.splice(index, 1);
|
||||
}
|
||||
}
|
||||
return newList;
|
||||
});
|
||||
}
|
||||
|
||||
control.modPackUpdate.subscribe(updateHandler);
|
||||
return () => {
|
||||
control.modPackUpdate.unsubscribe(updateHandler);
|
||||
};
|
||||
}, []);
|
||||
|
||||
return [modPackList];
|
||||
|
||||
export function useModPacks() {
|
||||
const control = useContext(ControlContext);
|
||||
const subscribe = useCallback((callback: () => void) => control.modPacks.subscribe(callback), [control]);
|
||||
return useSyncExternalStore(subscribe, () => control.modPacks.getSnapshot());
|
||||
}
|
||||
@@ -1,51 +1,13 @@
|
||||
import { useContext, useEffect, useState } from "react";
|
||||
|
||||
import * as lib from "@clusterio/lib";
|
||||
|
||||
import { useCallback, useContext, useSyncExternalStore } from "react";
|
||||
import ControlContext from "../components/ControlContext";
|
||||
|
||||
const { logger } = lib;
|
||||
|
||||
export function useModList() {
|
||||
let control = useContext(ControlContext);
|
||||
let [modList, setModList] = useState<lib.ModInfo[]>([]);
|
||||
|
||||
function updateModList() {
|
||||
control.send(new lib.ModListRequest()).then(mods => {
|
||||
setModList(mods);
|
||||
}).catch(err => {
|
||||
logger.error(`Failed to list mods:\n${err}`);
|
||||
});
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
updateModList();
|
||||
|
||||
function updateHandler(newMods: lib.ModInfo[]) {
|
||||
setModList(oldList => {
|
||||
let newList = oldList.concat();
|
||||
for (const newMod of newMods) {
|
||||
let index = newList.findIndex(mod => mod.name === newMod.name && mod.version === newMod.version);
|
||||
if (!newMod.isDeleted) {
|
||||
if (index !== -1) {
|
||||
newList[index] = newMod;
|
||||
} else {
|
||||
newList.push(newMod);
|
||||
}
|
||||
} else if (index !== -1) {
|
||||
newList.splice(index, 1);
|
||||
}
|
||||
}
|
||||
return newList;
|
||||
});
|
||||
}
|
||||
|
||||
control.modUpdate.subscribe(updateHandler);
|
||||
return () => {
|
||||
control.modUpdate.unsubscribe(updateHandler);
|
||||
};
|
||||
}, []);
|
||||
|
||||
return [modList];
|
||||
export function useMod(id?: string) {
|
||||
const [mods, synced] = useMods();
|
||||
return [id !== undefined ? mods.get(id) : undefined, synced] as const;
|
||||
}
|
||||
|
||||
export function useMods() {
|
||||
const control = useContext(ControlContext);
|
||||
const subscribe = useCallback((callback: () => void) => control.mods.subscribe(callback), [control]);
|
||||
return useSyncExternalStore(subscribe, () => control.mods.getSnapshot());
|
||||
}
|
||||
@@ -1,57 +1,14 @@
|
||||
import { useEffect, useContext, useState } from "react";
|
||||
import { useCallback, useContext, useSyncExternalStore } from "react";
|
||||
import ControlContext from "../components/ControlContext";
|
||||
|
||||
import * as lib from "@clusterio/lib";
|
||||
|
||||
const { logger } = lib;
|
||||
|
||||
export function useSaves(instanceId?: number): lib.SaveDetails[] {
|
||||
let control = useContext(ControlContext);
|
||||
let [saves, setSaves] = useState<lib.SaveDetails[]>([]);
|
||||
|
||||
function updateSaves() {
|
||||
control.sendTo("controller", new lib.InstanceSaveDetailsListRequest()).then(updatedSaves => {
|
||||
setSaves(updatedSaves.filter(save => save.instanceId === instanceId));
|
||||
}).catch(err => {
|
||||
logger.error(`Failed to list instance saves: ${err}`);
|
||||
setSaves([]);
|
||||
});
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
if (!Number.isInteger(instanceId)) {
|
||||
setSaves([]);
|
||||
return undefined;
|
||||
}
|
||||
updateSaves();
|
||||
|
||||
function updateHandler(updates: lib.SaveDetails[]) {
|
||||
setSaves(oldList => {
|
||||
let newList = oldList.concat();
|
||||
for (const newSave of updates) {
|
||||
if (newSave.instanceId !== instanceId) {
|
||||
continue;
|
||||
}
|
||||
let index = newList.findIndex(s => s.id === newSave.id);
|
||||
if (!newSave.isDeleted) {
|
||||
if (index !== -1) {
|
||||
newList[index] = newSave;
|
||||
} else {
|
||||
newList.push(newSave);
|
||||
}
|
||||
} else if (index !== -1) {
|
||||
newList.splice(index, 1);
|
||||
}
|
||||
}
|
||||
return newList;
|
||||
});
|
||||
}
|
||||
|
||||
control.saveListUpdate.subscribe(updateHandler);
|
||||
return () => {
|
||||
control.saveListUpdate.unsubscribe(updateHandler);
|
||||
};
|
||||
}, [instanceId]);
|
||||
|
||||
return saves;
|
||||
export function useSavesOfInstance(instanceId?: number) {
|
||||
const [saves, synced] = useSaves();
|
||||
const savesOfInstance = new Map([...saves].filter(([_id, save]) => save.instanceId === instanceId));
|
||||
return [savesOfInstance, synced] as const;
|
||||
}
|
||||
|
||||
export function useSaves() {
|
||||
const control = useContext(ControlContext);
|
||||
const subscribe = useCallback((callback: () => void) => control.saves.subscribe(callback), [control]);
|
||||
return useSyncExternalStore(subscribe, () => control.saves.getSnapshot());
|
||||
}
|
||||
@@ -1,31 +1,29 @@
|
||||
import React, { useEffect, useContext, useState } from "react";
|
||||
import React, { useCallback, useContext, useSyncExternalStore } from "react";
|
||||
import { Tag } from "antd";
|
||||
import ControlContext from "../components/ControlContext";
|
||||
|
||||
import * as lib from "@clusterio/lib";
|
||||
|
||||
const { logger } = lib;
|
||||
|
||||
function calculateLastSeen(user: RawUserState, instanceId?: number) {
|
||||
function calculateLastSeen(user: lib.User, instanceId?: number) {
|
||||
let stats;
|
||||
if (instanceId === undefined) {
|
||||
stats = user.playerStats;
|
||||
} else {
|
||||
stats = (user.instanceStats || new Map()).get(instanceId);
|
||||
stats = user.instanceStats.get(instanceId);
|
||||
if (!stats) {
|
||||
return undefined;
|
||||
}
|
||||
}
|
||||
if (stats.lastLeaveAt > stats.lastJoinAt) {
|
||||
return stats.lastLeaveAt;
|
||||
if ((stats.lastLeaveAt?.getTime() ?? 0) > (stats.lastJoinAt?.getTime() ?? 0)) {
|
||||
return stats.lastLeaveAt?.getTime();
|
||||
}
|
||||
if (stats.lastJoinAt) {
|
||||
return stats.lastLeaveAt;
|
||||
return stats.lastLeaveAt?.getTime();
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
|
||||
export function formatLastSeen(user: RawUserState, instanceId?: number) {
|
||||
export function formatLastSeen(user: lib.User, instanceId?: number) {
|
||||
if (user.instances && [...user.instances].some(id => instanceId === undefined || id === instanceId)) {
|
||||
return <Tag color="green">Online</Tag>;
|
||||
}
|
||||
@@ -36,8 +34,8 @@ export function formatLastSeen(user: RawUserState, instanceId?: number) {
|
||||
return new Date(lastSeen).toLocaleString();
|
||||
}
|
||||
|
||||
export function sortLastSeen(userA:RawUserState, userB:RawUserState, instanceIdA?: number, instanceIdB?: number) {
|
||||
function epoch(user:RawUserState, instanceId?: number) {
|
||||
export function sortLastSeen(userA: lib.User, userB: lib.User, instanceIdA?: number, instanceIdB?: number) {
|
||||
function epoch(user: lib.User, instanceId?: number) {
|
||||
return user.instances && [...user.instances].some(id => instanceId === undefined || id === instanceId);
|
||||
}
|
||||
|
||||
@@ -52,87 +50,13 @@ export function sortLastSeen(userA:RawUserState, userB:RawUserState, instanceIdA
|
||||
return lastSeenA - lastSeenB;
|
||||
}
|
||||
|
||||
export type RawUserState = Partial<lib.User> & {
|
||||
loading?: boolean;
|
||||
present?: boolean;
|
||||
missing?: boolean;
|
||||
};
|
||||
|
||||
export function useUser(name: string): [RawUserState, () => void] {
|
||||
let control = useContext(ControlContext);
|
||||
let [user, setUser] = useState<RawUserState>({ loading: true });
|
||||
|
||||
function updateUser() {
|
||||
control.send(new lib.UserGetRequest(name)).then(updatedUser => {
|
||||
setUser({ ...updatedUser, present: true });
|
||||
}).catch(err => {
|
||||
logger.error(`Failed to get user: ${err}`);
|
||||
setUser({ missing: true });
|
||||
});
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
if (typeof name !== "string") {
|
||||
setUser({ missing: true });
|
||||
return undefined;
|
||||
}
|
||||
updateUser();
|
||||
|
||||
function updateHandler(newUsers: lib.User[]) {
|
||||
const newUser = newUsers.find(u => u.name === name);
|
||||
if (newUser) {
|
||||
setUser({ ...newUser, present: true });
|
||||
}
|
||||
}
|
||||
|
||||
control.userUpdate.subscribe(updateHandler);
|
||||
return () => {
|
||||
control.userUpdate.unsubscribe(updateHandler);
|
||||
};
|
||||
}, [name]);
|
||||
|
||||
return [user, updateUser];
|
||||
export function useUser(name?: string) {
|
||||
const [users, synced] = useUsers();
|
||||
return [name !== undefined ? users.get(name) : undefined, synced] as const;
|
||||
}
|
||||
|
||||
export function useUserList() {
|
||||
let control = useContext(ControlContext);
|
||||
let [userList, setUserList] = useState<lib.User[]>([]);
|
||||
|
||||
function updateUserList() {
|
||||
control.send(new lib.UserListRequest()).then(users => {
|
||||
setUserList(users);
|
||||
}).catch(err => {
|
||||
logger.error(`Failed to list users:\n${err}`);
|
||||
});
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
updateUserList();
|
||||
|
||||
function updateHandler(newUsers: lib.User[]) {
|
||||
setUserList(oldList => {
|
||||
let newList = oldList.concat();
|
||||
for (const newUser of newUsers) {
|
||||
let index = newList.findIndex(u => u.name === newUser.name);
|
||||
if (!newUser.isDeleted) {
|
||||
if (index !== -1) {
|
||||
newList[index] = newUser;
|
||||
} else {
|
||||
newList.push(newUser);
|
||||
}
|
||||
} else if (index !== -1) {
|
||||
newList.splice(index, 1);
|
||||
}
|
||||
}
|
||||
return newList;
|
||||
});
|
||||
}
|
||||
|
||||
control.userUpdate.subscribe(updateHandler);
|
||||
return () => {
|
||||
control.userUpdate.unsubscribe(updateHandler);
|
||||
};
|
||||
}, []);
|
||||
|
||||
return [userList];
|
||||
export function useUsers() {
|
||||
const control = useContext(ControlContext);
|
||||
const subscribe = useCallback((callback: () => void) => control.users.subscribe(callback), [control]);
|
||||
return useSyncExternalStore(subscribe, () => control.users.getSnapshot());
|
||||
}
|
||||
Reference in new issue
Block a user