Address review on the roles plugin

- Use the core role permissions rather than defining new ones. Assignments are
  only sent between the controller and an instance, so they are no longer
  addressed to control and need no permission at all.
- Split the datastore reconciliation into ensureRoleMeta, sweepRoleMeta and
  applyAutoAssign, all run on init as well as when roles change. Properties left
  behind by a role deleted while the plugin was not running are now swept up,
  where before they would be inherited by the next role given that id.
- Use a switch in onControllerConfigFieldChanged, matching instance.ts.
- Resolve pending assignments on initialise. A pending role is either confirmed,
  and so now held by synced_players, or it never landed; either way it stops
  being held locally. Roles assigned with assign_player_local are untouched.
- Drop the emit_updates juggling in reject_assignment, sync is already false.
- Send each permission name once and reference it by index, see the benchmark in
  the pull request. Single role updates stay in the plain form.
- Lay the role properties out in columns, name the apply button for the section
  it belongs to, and give every field a tooltip.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

exp_roles/controller.ts

@@ -16,8 +16,12 @@ export class ControllerPlugin extends BaseControllerPlugin {
 			).bootstrap()
 		);
 
-		// Roles created before this plugin was installed have no properties yet
+		// The datastore can be out of step with the roles, either because the
+		// plugin was installed after they were created or because it was
+		// uninstalled while they were deleted
 		this.ensureRoleMeta();
+		this.sweepRoleMeta();
+		this.applyAutoAssign();
 
 		this.controller.subscriptions.handle(messages.RoleUpdatedEvent, this.handleRoleSubscription.bind(this));
 		this.controller.subscriptions.handle(
@@ -65,6 +69,28 @@ export class ControllerPlugin extends BaseControllerPlugin {
 		return created;
 	}
 
+	/**
+	 * Delete properties left behind by roles which no longer exist.
+	 *
+	 * Without this they would be picked up by whichever role is next given the
+	 * same id, which happens when a role is deleted while the plugin is not
+	 * running.
+	 */
+	sweepRoleMeta() {
+		const orphaned = [];
+		for (const meta of this.roleMeta.valuesMutable()) {
+			if (!this.controller.roles.has(meta.id)) {
+				orphaned.push(meta);
+			}
+		}
+
+		if (orphaned.length) {
+			this.roleMeta.deleteMany(orphaned);
+		}
+
+		return orphaned;
+	}
+
 	/** Combine a clusterio role with its in game properties. */
 	buildRoleRecord(role: Readonly<lib.Role>) {
 		const meta = this.roleMeta.get(role.id) ?? new messages.RoleMetaRecord(role.id, role.id);
@@ -80,9 +106,11 @@ export class ControllerPlugin extends BaseControllerPlugin {
 	}
 
 	async onControllerConfigFieldChanged(field: string, curr: unknown, prev: unknown) {
-		// Which role is the default is carried on the role records themselves
+		switch (field) {
-		if (field === "controller.default_role_id") {
+			// Which role is the default is carried on the role records themselves
-			this.controller.subscriptions.broadcast(new messages.RoleUpdatedEvent(this.listRoleRecords()));
+			case "controller.default_role_id":
+				this.controller.subscriptions.broadcast(new messages.RoleUpdatedEvent(this.listRoleRecords()));
+				break;
 		}
 	}
 
@@ -107,21 +135,7 @@ export class ControllerPlugin extends BaseControllerPlugin {
 	/** A clusterio role was created, changed or deleted. */
 	rolesUpdated(roles: lib.Role[]) {
 		const created = this.ensureRoleMeta();
-
+		this.sweepRoleMeta();
-		// Deleting a role leaves its properties behind, which would be reused by
-		// the next role to be given the same id
-		const orphaned = [];
-		for (const role of roles) {
-			if (role.isDeleted) {
-				const meta = this.roleMeta.getMutable(role.id);
-				if (meta) {
-					orphaned.push(meta);
-				}
-			}
-		}
-		if (orphaned.length) {
-			this.roleMeta.deleteMany(orphaned);
-		}
 
 		// Newly created properties broadcast on their own through roleMetaUpdated
 		const createdIds = new Set(created.map(meta => meta.id));

exp_roles/index.ts

@@ -7,36 +7,9 @@ declare module "@clusterio/lib" {
 	}
 }
 
-lib.definePermission({
+// The in game properties of a role are part of the role, so they are covered by
-	name: "exp_roles.role.list",
+// the core role permissions rather than permissions of their own. Assignments
-	title: "List In Game Roles",
+// are only ever sent between the controller and an instance, so they need none.
-	description: "List the in game properties of all roles.",
-	grantByDefault: true,
-});
-lib.definePermission({
-	name: "exp_roles.role.subscribe",
-	title: "Subscribe to In Game Role Updates",
-	description: "Receive updates when the in game properties of a role change.",
-	grantByDefault: true,
-});
-lib.definePermission({
-	name: "exp_roles.role.update",
-	title: "Update In Game Roles",
-	description: "Modify the in game properties of a role, such as its order and colour.",
-});
-
-lib.definePermission({
-	name: "exp_roles.assignment.list",
-	title: "List Role Assignments",
-	description: "List the roles held by each player in game.",
-	grantByDefault: true,
-});
-lib.definePermission({
-	name: "exp_roles.assignment.subscribe",
-	title: "Subscribe to Role Assignment Updates",
-	description: "Receive updates when the roles held by a player change.",
-	grantByDefault: true,
-});
 
 export const plugin: lib.PluginDeclaration = {
 	name: "exp_roles",

exp_roles/instance.ts

@@ -49,7 +49,7 @@ export class InstancePlugin extends BaseInstancePlugin {
 		]);
 
 		await this.luaSend("initialise", {
-			roles: roles.map(role => role.toJSON()),
+			...messages.encodeRolesForLua(roles),
 			assignments: assignments.map(assignment => assignment.toJSON()),
 		});
 		await this.luaSetEmitEvents(this.syncMode === "bidirectional");

exp_roles/messages.ts

@@ -240,6 +240,37 @@ export class AssignmentRecord {
 	}
 }
 
+/**
+ * Encode roles for the lua initialise call.
+ *
+ * Roles repeat the same permission names over and over, so each name is sent
+ * once and referenced by index. At 15 roles this is 17 KiB rather than 38 KiB
+ * and decodes in 0.37 ms rather than 0.50 ms; at 60 roles it is 30 KiB rather
+ * than 122 KiB and 0.87 ms rather than 1.52 ms.
+ *
+ * Single role updates stay in the plain form, they have nothing to share.
+ */
+export function encodeRolesForLua(roles: RoleRecord[]) {
+	const names: string[] = [];
+	const indexes = new Map<string, number>();
+
+	const encoded = roles.map(role => {
+		const permissions = role.permissions.map(permission => {
+			let index = indexes.get(permission);
+			if (index === undefined) {
+				index = names.length;
+				names.push(permission);
+				indexes.set(permission, index);
+			}
+			return index;
+		});
+
+		return { ...role.toJSON(), permissions };
+	});
+
+	return { permission_names: names, roles: encoded };
+}
+
 /*
 	Update events
 */
@@ -250,7 +281,7 @@ export class RoleUpdatedEvent {
 	static type = "event" as const;
 	static src = "controller" as const;
 	static dst = ["control", "instance"] as const;
-	static permission = "exp_roles.role.subscribe" as const;
+	static permission = "core.role.subscribe" as const;
 
 	constructor(
 		public updates: RoleRecord[],
@@ -274,8 +305,7 @@ export class AssignmentUpdatedEvent {
 	static plugin = "exp_roles" as const;
 	static type = "event" as const;
 	static src = "controller" as const;
-	static dst = ["control", "instance"] as const;
+	static dst = "instance" as const;
-	static permission = "exp_roles.assignment.subscribe" as const;
 
 	constructor(
 		public updates: AssignmentRecord[],
@@ -304,7 +334,7 @@ export class RoleListRequest {
 	static type = "request" as const;
 	static src = ["control", "instance"] as const;
 	static dst = "controller" as const;
-	static permission = "exp_roles.role.list" as const;
+	static permission = "core.role.list" as const;
 	static Response = lib.jsonArray(RoleRecord);
 
 	constructor() {}
@@ -316,7 +346,7 @@ export class RoleMetaUpdateRequest {
 	static type = "request" as const;
 	static src = "control" as const;
 	static dst = "controller" as const;
-	static permission = "exp_roles.role.update" as const;
+	static permission = "core.role.update" as const;
 
 	constructor(
 		public meta: RoleMetaRecord,
@@ -343,9 +373,8 @@ export class AssignmentListRequest {
 	declare ["constructor"]: typeof AssignmentListRequest;
 	static plugin = "exp_roles" as const;
 	static type = "request" as const;
-	static src = ["control", "instance"] as const;
+	static src = "instance" as const;
 	static dst = "controller" as const;
-	static permission = "exp_roles.assignment.list" as const;
 	static Response = lib.jsonArray(AssignmentRecord);
 
 	constructor() {}
@@ -359,7 +388,7 @@ export class AssignmentUpdateRequest {
 	declare ["constructor"]: typeof AssignmentUpdateRequest;
 	static plugin = "exp_roles" as const;
 	static type = "request" as const;
-	static src = ["control", "instance"] as const;
+	static src = "instance" as const;
 	static dst = "controller" as const;
 	static permission = "core.user.update_roles" as const;
 

exp_roles/module/control.lua

@@ -141,12 +141,20 @@ end
 
 --- Build a role from the record sent by the controller
 --- @param record table
+--- @param names string[]? When given, record.permissions holds indexes into it
 --- @return ExpRoles.Role
-local function decode_role(record)
+local function decode_role(record, names)
     local meta = record.meta
     local allowed_actions = {}
-    for _, permission in pairs(record.permissions) do
+    if names then
-        allowed_actions[permission] = true
+        -- Indexes are zero based, having come from javascript
+        for _, index in pairs(record.permissions) do
+            allowed_actions[names[index + 1]] = true
+        end
+    else
+        for _, permission in pairs(record.permissions) do
+            allowed_actions[permission] = true
+        end
     end
 
     local flags = {}
@@ -732,6 +740,26 @@ end
     Sync entry points
 ]]
 
+--- Stop holding a pending role locally once the controller has confirmed it
+--- Roles assigned with assign_player_local are never pending so are untouched
+--- @param player_name string
+local function drop_confirmed_local(player_name)
+    local pending = script_data.pending[player_name]
+    if pending then
+        for _, role_id in pairs(script_data.synced_players[player_name] or {}) do
+            if remove_role_id(pending, role_id) then
+                remove_role_id(script_data.local_players[player_name], role_id)
+            end
+        end
+        if not next(pending) then script_data.pending[player_name] = nil end
+    end
+
+    local local_roles = script_data.local_players[player_name]
+    if local_roles and not next(local_roles) then
+        script_data.local_players[player_name] = nil
+    end
+end
+
 --- Restore local references to persistent script data after load
 function ExpRoles.on_load()
     script_data = compat.script_data["exp_roles"]
@@ -748,16 +776,18 @@ function ExpRoles.set_emit_events(enabled)
 end
 
 --- Replace all local state with the state held by the controller
---- @param payload { roles: table[], assignments: table[] }
+--- Permission names are sent once and referenced by index, see encodeRolesForLua
+--- @param payload { permission_names: string[], roles: table[], assignments: table[] }
 function ExpRoles.initialise(payload)
     local emit_updates = script_data.emit_updates
     script_data.emit_updates = false
 
+    local names = payload.permission_names
     script_data.roles = {}
     script_data.default_role_id = nil
     for _, record in pairs(payload.roles) do
         if not record.is_deleted then
-            script_data.roles[record.id] = decode_role(record)
+            script_data.roles[record.id] = decode_role(record, names)
             if record.is_default then
                 script_data.default_role_id = record.id
             end
@@ -771,8 +801,19 @@ function ExpRoles.initialise(payload)
         end
     end
 
-    -- Anything still pending was sent before the connection was lost, the
+    -- The state received here is authoritative, so a pending role is either
-    -- controller state received here is authoritative
+    -- confirmed and now held by synced_players, or it never landed and has to
+    -- be given up; either way it stops being held locally
+    for player_name, pending in pairs(script_data.pending) do
+        drop_confirmed_local(player_name)
+        for _, role_id in pairs(pending) do
+            remove_role_id(script_data.local_players[player_name], role_id)
+        end
+        local local_roles = script_data.local_players[player_name]
+        if local_roles and not next(local_roles) then
+            script_data.local_players[player_name] = nil
+        end
+    end
     script_data.pending = {}
 
     rebuild_role_views()
@@ -823,22 +864,7 @@ function ExpRoles.receive_assignment_updates(records)
             script_data.synced_players[player_name] = record.role_ids or {}
         end
 
-        -- Anything confirmed by the controller no longer needs to be held locally
+        drop_confirmed_local(player_name)
-        local pending = script_data.pending[player_name]
-        if pending then
-            for _, role_id in pairs(script_data.synced_players[player_name] or {}) do
-                if remove_role_id(pending, role_id) then
-                    remove_role_id(script_data.local_players[player_name], role_id)
-                end
-            end
-            if not next(pending) then script_data.pending[player_name] = nil end
-        end
-
-        local local_roles = script_data.local_players[player_name]
-        if local_roles and not next(local_roles) then
-            script_data.local_players[player_name] = nil
-        end
-
         rebuild_player_view(player_name)
 
         local player = game.get_player(player_name)
@@ -858,10 +884,8 @@ function ExpRoles.reject_assignment(payload)
 
     if #roles == 0 then return end
 
-    local emit_updates = script_data.emit_updates
+    -- Sync is false, so this is never sent back to the controller
-    script_data.emit_updates = false
     change_player_roles(player_name, roles, "unassign", "<server>", true, false)
-    script_data.emit_updates = emit_updates
 end
 
 --- Get the current script data for debugging purposes

exp_roles/web/components/RoleProperties.tsx

@@ -1,5 +1,5 @@
 import React, { useContext, useEffect, useState } from "react";
-import { Button, ColorPicker, Form, Input, InputNumber, Space, Switch, Tooltip } from "antd";
+import { Button, Col, ColorPicker, Form, Input, InputNumber, Row, Switch, Tooltip } from "antd";
 
 import * as lib from "@clusterio/lib";
 import { ControlContext, SectionHeader, useAccount, notifyErrorHandler } from "@clusterio/web_ui";
@@ -34,7 +34,7 @@ export default function RoleProperties(props: { plugin: WebPlugin, role?: lib.Ro
 	const [roles] = props.plugin.useRoles();
 	const record = props.role ? roles.get(props.role.id) : undefined;
 	const meta = record?.meta;
-	const canUpdate = account.hasPermission("exp_roles.role.update");
+	const canUpdate = account.hasPermission("core.role.update");
 
 	useEffect(() => {
 		if (!meta) {
@@ -85,61 +85,93 @@ export default function RoleProperties(props: { plugin: WebPlugin, role?: lib.Ro
 		)));
 	}
 
+	const labelled = (text: string, tip: string) => <Tooltip title={tip}>{text}</Tooltip>;
+
 	return <>
-		<SectionHeader title="In Game Properties" />
+		<SectionHeader
-		<Form form={form} labelCol={{ span: 8 }} wrapperCol={{ span: 16 }} disabled={!canUpdate}>
+			title="In Game Properties"
-			<Form.Item
+			extra={canUpdate ? <Button
-				name="order"
+				type="primary"
-				label={<Tooltip title="A lower value is a more privileged role">Order</Tooltip>}
+				loading={applying}
-			>
+				onClick={() => {
-				<InputNumber />
+					setApplying(true);
-			</Form.Item>
+					apply()
-			<Form.Item
+						.catch(notifyErrorHandler("Error updating role properties"))
-				name="priority"
+						.finally(() => setApplying(false));
-				label={
+				}}
-					<Tooltip title="Only the highest priority roles a player holds apply, used by Jail">
+			>Apply in game properties</Button> : undefined}
-						Priority
+		/>
-					</Tooltip>
+		<Form
-				}
+			form={form}
-			>
+			disabled={!canUpdate}
-				<InputNumber />
+			labelCol={{ span: 12 }}
-			</Form.Item>
+			wrapperCol={{ span: 12 }}
-			<Form.Item name="shortHand" label="Short hand">
+			labelWrap
-				<Input />
+		>
-			</Form.Item>
+			<Row gutter={[16, 0]}>
-			<Form.Item name="tag" label="Tag">
+				<Col xs={24} md={12} xl={8}>
-				<Input />
+					<Form.Item
-			</Form.Item>
+						name="order"
-			<Form.Item name="color" label="Colour">
+						label={labelled("Order", "A lower value is a more privileged role")}
-				<ColorPicker allowClear format="rgb" disabledAlpha />
+					>
-			</Form.Item>
+						<InputNumber style={{ width: "100%" }} />
-			<Form.Item
+					</Form.Item>
-				name="autoAssignHours"
+					<Form.Item
-				label={
+						name="priority"
-					<Tooltip title="Granted once a player reaches this much online time across the cluster">
+						label={labelled(
-						Auto assign after (hours)
+							"Priority",
-					</Tooltip>
+							"Only the roles with the highest priority a player holds apply, "
-				}
+							+ "which is how Jail suppresses every other role"
-			>
+						)}
-				<InputNumber min={0} placeholder="Never" />
+					>
-			</Form.Item>
+						<InputNumber style={{ width: "100%" }} />
-			<Form.Item name="blockAutoAssign" label="Block auto assign" valuePropName="checked">
+					</Form.Item>
-				<Switch />
+				</Col>
-			</Form.Item>
+
-			{canUpdate && <Form.Item wrapperCol={{ offset: 8 }}>
+				<Col xs={24} md={12} xl={8}>
-				<Space>
+					<Form.Item
-					<Button
+						name="shortHand"
-						type="primary"
+						label={labelled("Short hand", "Short form of the name, used where space is limited")}
-						loading={applying}
+					>
-						onClick={() => {
+						<Input />
-							setApplying(true);
+					</Form.Item>
-							apply()
+					<Form.Item
-								.catch(notifyErrorHandler("Error updating role properties"))
+						name="tag"
-								.finally(() => setApplying(false));
+						label={labelled("Tag", "Shown next to the names of players with this role")}
-						}}
+					>
-					>Apply</Button>
+						<Input />
-				</Space>
+					</Form.Item>
-			</Form.Item>}
+					<Form.Item
+						name="color"
+						label={labelled("Colour", "Used for the role name and tag in game")}
+					>
+						<ColorPicker allowClear format="rgb" disabledAlpha />
+					</Form.Item>
+				</Col>
+
+				<Col xs={24} md={12} xl={8}>
+					<Form.Item
+						name="autoAssignHours"
+						label={labelled(
+							"Auto assign after (hours)",
+							"Granted once a player reaches this much online time across the cluster. "
+							+ "Leave empty to never grant it automatically"
+						)}
+					>
+						<InputNumber min={0} placeholder="Never" style={{ width: "100%" }} />
+					</Form.Item>
+					<Form.Item
+						name="blockAutoAssign"
+						label={labelled(
+							"Block auto assign",
+							"Players holding this role are never granted any other role automatically"
+						)}
+						valuePropName="checked"
+					>
+						<Switch />
+					</Form.Item>
+				</Col>
+			</Row>
 		</Form>
 	</>;
 }