Refactor User and Role into data classes (#531)

Use the JSON data class pattern for User, Role, and PlayerStats and move
them into lib/src/data.  This means that User is purely data now and
can't reference role objects directly.  To make it possible easily check
permissions attached to roles and store data only visible on the
controller on user objects a ControllerUser type is introduced which is
linked with the UserManager and can therefore reference role objects
directly.

Resolves #525.
This commit is contained in:
Hornwitser authored and GitHub committed 2023-12-02 01:41:43 +01:00
1 parent f802e6ba67
commit e453a80155
37 files changed
+629 -613

No files matched your search

@@ -13,7 +13,7 @@ import PluginExtra from "./PluginExtra";
import { notifyErrorHandler } from "../util/notify";
export type RawRoleState = Partial<lib.RawRole> & {
export type RawRoleState = Partial<lib.Role> & {
loading?: boolean;
missing?: boolean;
present?: boolean;
@@ -76,7 +76,7 @@ export default function RoleViewPage() {
description: role["description"],
permissions: {
...Object.fromEntries([...lib.permissions.values()].map(perm => [
perm.name, role.permissions!.includes(perm.name),
perm.name, [...role.permissions!].includes(perm.name),
])),
},
};
+1 -1
View File
@@ -63,7 +63,7 @@ export default function RolesPage() {
let control = useContext(ControlContext);
let navigate = useNavigate();
let [roles, setRoles] = useState<lib.RawRole[]>([]);
let [roles, setRoles] = useState<lib.Role[]>([]);
useEffect(() => {
control.send(new lib.RoleListRequest()).then(newRoles => {
@@ -35,7 +35,7 @@ export default function UserViewPage() {
let control = useContext(ControlContext);
let [instanceList] = useInstanceList();
let [user] = useUser(userName);
let [roles, setRoles] = useState<Map<number, lib.RawRole>>(new Map());
let [roles, setRoles] = useState<Map<number, lib.Role>>(new Map());
let [form] = Form.useForm();
let [rolesDirty, setRolesDirty] = useState<boolean>(false);
let [banReasonDirty, setBanReasonDirty] = useState<boolean>(false);
@@ -78,7 +78,7 @@ export default function UserViewPage() {
let roleSelector = <Form.Item
noStyle
name="roles"
initialValue={user.roles}
initialValue={user.roleIds}
rules={[
{ validator: () => (rolesError ? Promise.reject(rolesError) : Promise.resolve()) },
]}
@@ -181,7 +181,7 @@ export default function UserViewPage() {
<Col flex="auto">
{account.hasPermission("core.user.update_roles")
? roleSelector
: [...user.roles!].map(id => <Tag key={id}>{
: [...user.roleIds!].map(id => <Tag key={id}>{
roles ? (roles.get(id) || { name: id }).name : id
}</Tag>)
}
+5 -5
View File
@@ -82,7 +82,7 @@ export default function UsersPage() {
{
title: "Name",
key: "name",
render: (user: lib.RawUser) => <Space>
render: (user: lib.User) => <Space>
{user.name}
<span>
{user.isAdmin && <Tag color="gold">Admin</Tag>}
@@ -96,14 +96,14 @@ export default function UsersPage() {
{
title: "Roles",
key: "roles",
render: (user: lib.RawUser) => (
user.roles.map(id => <Tag key={id}>{(roles.get(id) || { name: id }).name}</Tag>)
render: (user: lib.User) => (
[...user.roleIds].map(id => <Tag key={id}>{(roles.get(id) || { name: id }).name}</Tag>)
),
},
{
title: "Online time",
key: "onlineTime",
render: (user: lib.RawUser) => (user.playerStats?.onlineTimeMs
render: (user: lib.User) => (user.playerStats?.onlineTimeMs
? formatDuration(user.playerStats.onlineTimeMs) : null),
sorter: (a, b) => (a.playerStats?.onlineTimeMs ?? 0) -
(b.playerStats?.onlineTimeMs ?? 0),
@@ -112,7 +112,7 @@ export default function UsersPage() {
{
title: "Last seen",
key: "lastSeen",
render: (user: lib.RawUser) => formatLastSeen(user),
render: (user: lib.User) => formatLastSeen(user),
sorter: (a, b) => sortLastSeen(a, b),
responsive: ["lg"],
},
+6 -6
View File
@@ -26,7 +26,7 @@ function calculateLastSeen(user: RawUserState, instanceId?: number) {
}
export function formatLastSeen(user: RawUserState, instanceId?: number) {
if (user.instances && user.instances.some(id => instanceId === undefined || id === instanceId)) {
if (user.instances && [...user.instances].some(id => instanceId === undefined || id === instanceId)) {
return <Tag color="green">Online</Tag>;
}
let lastSeen = calculateLastSeen(user, instanceId);
@@ -38,7 +38,7 @@ export function formatLastSeen(user: RawUserState, instanceId?: number) {
export function sortLastSeen(userA:RawUserState, userB:RawUserState, instanceIdA?: number, instanceIdB?: number) {
function epoch(user:RawUserState, instanceId?: number) {
return user.instances && user.instances.some(id => instanceId === undefined || id === instanceId);
return user.instances && [...user.instances].some(id => instanceId === undefined || id === instanceId);
}
let epochA = epoch(userA, instanceIdA);
@@ -52,7 +52,7 @@ export function sortLastSeen(userA:RawUserState, userB:RawUserState, instanceIdA
return lastSeenA - lastSeenB;
}
export type RawUserState = Partial<lib.RawUser> & {
export type RawUserState = Partial<lib.User> & {
loading?: boolean;
present?: boolean;
missing?: boolean;
@@ -78,7 +78,7 @@ export function useUser(name: string): [RawUserState, () => void] {
}
updateUser();
function updateHandler(newUser: lib.RawUser) {
function updateHandler(newUser: lib.User) {
setUser({ ...newUser, present: true });
}
@@ -93,7 +93,7 @@ export function useUser(name: string): [RawUserState, () => void] {
export function useUserList() {
let control = useContext(ControlContext);
let [userList, setUserList] = useState<lib.RawUser[]>([]);
let [userList, setUserList] = useState<lib.User[]>([]);
function updateUserList() {
control.send(new lib.UserListRequest()).then(users => {
@@ -106,7 +106,7 @@ export function useUserList() {
useEffect(() => {
updateUserList();
function updateHandler(newUser: lib.RawUser) {
function updateHandler(newUser: lib.User) {
setUserList(oldList => {
let newList = oldList.concat();
let index = newList.findIndex(u => u.name === newUser.name);
+2 -2
View File
@@ -10,7 +10,7 @@ type instanceHandler = (instanceDetails: lib.InstanceDetails) => void;
type saveListHandler = (saveListEvent: lib.InstanceSaveListUpdateEvent) => void;
type modPackHandler = (modPack: lib.ModPack) => void;
type modInfoHandler = (modInfo: lib.ModInfo) => void;
type userHandler = (rawUser: lib.RawUser) => void;
type userHandler = (rawUser: lib.User) => void;
type logHandler = (info: { level:string, message:string }) => void;
/**
@@ -80,7 +80,7 @@ export class Control extends lib.Link {
lib.ModUpdateEvent, event => event.mod,
);
userUpdate = new lib.EventSubscriber<lib.UserUpdateEvent, lib.RawUser>(
userUpdate = new lib.EventSubscriber<lib.UserUpdateEvent, lib.User>(
lib.UserUpdateEvent, event => event.user,
);