diff --git a/docs/config-system.md b/docs/config-system.md index 3cfdec8b..a1f4018a 100644 --- a/docs/config-system.md +++ b/docs/config-system.md @@ -2,36 +2,34 @@ This document describes the implementation and inner working of the configuration system in Clusterio, and unless you're developing Clusterio it's probably not going to be very useful for you. -Clusterio uses a group based configuration system to manage settings for the controller, instances, hosts, and the clusterioctl utility. -Plugins get their own config group for the controller and instances which they can add their own fields to. -The fields are defined early in the startup, and the groups and their fields for disabled plugins will still be created. +Clusterio uses a field based configuration system to manage settings for the controller, instances, hosts, and the clusterioctl utility. +Plugins can add their own config fields for the controller and instances configs. +The fields are defined early in the startup, and fields for disabled plugins will still be created. -The built-in config groups and their fields are defined in [packages/lib/config/definitions.js](/packages/lib/config/definitions.js) while plugins can add their own config groups to the `ControllerConfigGroup` and `InstanceConfigGroup` properties of the `info.js` export using subclasses of `PluginConfigGroup`. -The plugin group has the enabled field pre-defined on it, and it's used to enable/disable plugins. +The built-in config fields are defined in [packages/lib/config/definitions.js](/packages/lib/config/definitions.js) while plugins can add their own config field definitions to the `controllerConfigFields` and `instanceConfigFields` properties of the `info.js` export. +A `.load_plugin` field is automatically created for each plugin and it's used to enable/disable the loading plugins on startup. ## Defing Fields -Fields are defined using the `define` class method on group classes after the groupName have been set and before the class has been finalized. -The `define` method takes an object as argument with the following properties: +Fields are defined as POJS object properties where the name of the property correspond to the name of the configuration field. +The property name is the primary way the field is accessed both in code and on the command line, as such it should follow the lower\_case\_underscore style and consist of a group name and a field name separated by a dot. +For plugins the group name is the name of the plugin, e.g., the `level` field of the `foo_frobber` plugin would be named `foo_frobber.lavel`. **access**: The locations this config field can be read and modified from. This is an array of strings which can contain the values `"controller"`, `"host"` and `"control"`. If a party is missing in this array then that party will not receive the value of this field when the config is shared, and will be unable to modify the field. - Takes the value of `defaultAccess` set on the config group class if not passed. - Note that instance config groups should have both `"controller"` and `"host"` for all of its fields or unexpected behaviour may occur. + If not set any party can read and modify this config entry. + Note that instance config fields should have both `"controller"` and `"host"` or unexpected behaviour may occur. **type**: The type of config value this field will support. The supported values are boolean, string, number, and object, and if an attept is made to set the field to a value that is not of the right type it will be reject unless it's a string that can be converted to the right type. -**name**: - Name of the configuration field, this is the primary way the field is accessed, both in code and on the command line. - As such it should follow the lower\_case\_underscore style and not contain any spaces or dots. - **title** (optional): Text used to identify the config field in user interfaces. + This should not contain the grouping used in `name`. **description** (optional): Text used to describe the config field in user interfaces. @@ -44,7 +42,7 @@ The `define` method takes an object as argument with the following properties: True if this field can be set to null. Defaults to false. -**initial_value** (optional if optional is true): +**initialValue** (optional if optional is true): Value this config field should take in a newly initialized config. This can also be an async function returning the value to use. @@ -53,24 +51,24 @@ If the value for a field stored in on disk somehow ends up being invalid the fie ## Accessing Fields -On the Config instance there's two ways to access fields: through the set and get methods using dot notation. +On the Config instance there's two ways to access fields: through the set and get methods. E.g.: let value = configInstance.get("group.field"); -Or by getting the group first and then calling set or get on that. +Or by through the raw fields object (which is best avoided as it doesn't check types or whether the accessed field exists). E.g.: - let value = configInstance.group("group").get("field") + let value = configInstance.fields["group.field"] -The set method takes an extra argument, which is the value to set the field to. -If the value is not valid this will throw an InvalidValue exception, if the group or field doesn't exist it will throw an InvalidField exception. +The set method also takes an extra argument, which is the value to set the field to. +If the value is not valid this will throw an InvalidValue exception, if the field doesn't exist it will throw an InvalidField exception. ## Config Lifecycle Values for all config fields are created when the config is initialized, as well as for any fields with missing values when a config is loaded. -Once a field has a value it is never automatically removed, even if the field or group it was part of no longer exists. +Once a field has a value it is never automatically removed, even if the field it was part of no longer exists. This ensures that plugin configuration is not lost should the server be started up without the plugins that defined the configuration installed. For instance configs, they are kept on the controller and serialized and sent over to the relevant hosts on startup. diff --git a/docs/writing-plugins.md b/docs/writing-plugins.md index 6888df99..5aab0f3a 100644 --- a/docs/writing-plugins.md +++ b/docs/writing-plugins.md @@ -82,8 +82,8 @@ The following properties are recognized: This is an optional paramater. A plugin may have code only for instances but it must still be loaded on the controller in order for it to be possible to load it on an instance. -**InstanceConfigGroup**: - Subclass of `PluginConfigGroup` for defining the per instance configuration fields for this plugin. +**instanceConfigFields**: + Object mapping instance configuration fields to `FieldDefinitions`for this plugin. See [Plugin Configuration](#plugin-configuration) **controllerEntrypoint**: @@ -92,7 +92,7 @@ The following properties are recognized: A plugin can be made that only runs on the controller. **ControllerConfigGroup**: - Subclass of `PluginConfigGroup` for defining the controller configuration fields for this plugin. + Object mapping controller configuration fields to `FieldDefinitions`for this plugin. See [Plugin Configuration](#plugin-configuration) **ctlEntrypoint**: @@ -202,32 +202,35 @@ For plugin hooks expections thrown are automatically catched and logged, but for ## Plugin Configuration Clusterio provides a configuration system that handles storing, distributing, editing and validating config fields for you. -You can take advantage of it by subclassing `PluginConfigGroup`, setting `defaultAccess` to where config entries can be accessed from, setting the `groupName` to your plugin name, defining fields on it, finalizing it, and passing it as either `ControllerConfigGroup` or `InstanceConfigGroup` in the `info.js` export. +You can take advantage of it by declaring config fields under either `controllerConfigFields` or `instanceConfigFields` in the `info.js` export. For example in info.js: -```js -const lib = require("@clusterio/lib"); +```ts +import type * as lib from "@clusterio/lib"; -class ControllerConfigGroup extends lib.PluginConfigGroup { } -ControllerConfigGroup.defaultAccess = ["controller", "host", "control"]; -ControllerConfigGroup.groupName = "foo_frobber"; -ControllerConfigGroup.define({ - name: "level", - description: "Level of frobnication done", - type: "number", - initial_value: 2, -}); -ControllerConfigGroup.finalize(); +declare module "@clusterio/lib" { + // Extend the interface defining available fields so that instance.config.get(...) + // will have our own options. + export interface ControllerConfigFields { + "foo_frobber.level": number, // If optional is true then this should have | null in addition. + } +} -module.exports = { +export default { ... - ControllerConfigGroup: ControllerConfigGroup, -}; + controllerConfigFields: { + "foo_frobber.level": { + description: "Level of frobnication done", + type: "number", + initialValue: 2, + }, + } +} satisfies lib.PluginDeclaration; ``` Code inside the `ControllerPlugin` class will then be able to access the level config field through the `Config` object at `this.controller.config`, for example in the ControllerPluginClass: -```js +```ts async init() { let level = this.controller.config.get("foo_frobber.level"); this.logger.info(`I got a frobnication level of ${level}`); diff --git a/packages/controller/controller.ts b/packages/controller/controller.ts index 2d19298c..08f3a71f 100644 --- a/packages/controller/controller.ts +++ b/packages/controller/controller.ts @@ -156,7 +156,6 @@ async function handleBootstrapCommand( return; } let controlConfig = new lib.ControlConfig("control"); - await controlConfig.init(); controlConfig.set("control.controller_url", Controller.calculateControllerUrl(controllerConfig)); controlConfig.set( @@ -164,7 +163,7 @@ async function handleBootstrapCommand( userManager.signUserToken(admin.name), ); - let content = JSON.stringify(controlConfig.serialize(), null, "\t"); + let content = JSON.stringify(controlConfig, null, "\t"); if (args.output === "-") { // eslint-disable-next-line no-console console.log(content); @@ -317,20 +316,19 @@ async function initialize(): Promise { logger.info("Loading Plugin info"); const pluginInfos = await lib.loadPluginInfos(pluginList); lib.registerPluginMessages(pluginInfos); - lib.registerPluginConfigGroups(pluginInfos); - lib.finalizeConfigs(); + lib.addPluginConfigFields(pluginInfos); const controllerConfigPath = args.config; logger.info(`Loading config from ${controllerConfigPath}`); - const controllerConfig = new lib.ControllerConfig("controller"); + let controllerConfig = new lib.ControllerConfig("controller"); try { - let fileData = await fs.readFile(controllerConfigPath, { encoding: "utf8" }); - await controllerConfig.load(JSON.parse(fileData)); + let jsonConfig = JSON.parse(await fs.readFile(controllerConfigPath, { encoding: "utf8" })); + controllerConfig = lib.ControllerConfig.fromJSON(jsonConfig, "controller"); } catch (err: any) { if (err.code === "ENOENT") { logger.info("Config not found, initializing new config"); - await controllerConfig.init(); + controllerConfig = new lib.ControllerConfig("controller"); } else { throw new lib.StartupError(`Failed to load ${controllerConfigPath}: ${err.message}`); @@ -343,7 +341,7 @@ async function initialize(): Promise { let bytes = await asyncRandomBytes(256); controllerConfig.set("controller.auth_secret", bytes.toString("base64")); await lib.safeOutputFile( - controllerConfigPath, JSON.stringify(controllerConfig.serialize(), null, "\t") + controllerConfigPath, JSON.stringify(controllerConfig, null, "\t") ); } diff --git a/packages/controller/src/BaseControllerPlugin.ts b/packages/controller/src/BaseControllerPlugin.ts index 9aec578b..281810c9 100644 --- a/packages/controller/src/BaseControllerPlugin.ts +++ b/packages/controller/src/BaseControllerPlugin.ts @@ -1,5 +1,5 @@ import type { - CollectorResult, ConfigGroup, Event, InstanceStatus, Logger, + CollectorResult, Event, InstanceStatus, Logger, ModPack, ModInfo, PlayerEvent, PluginNodeEnvInfo, } from "@clusterio/lib"; import type Controller from "./Controller"; @@ -99,12 +99,11 @@ export default class BaseControllerPlugin { * Invoked after the value of the config field given by `field` has * changed on the controller. * - * @param group - - * The group who's field got changed. * @param field - Name of the field that changed. + * @param curr - The current value of the field. * @param prev - The previous value of the field. */ - async onControllerConfigFieldChanged(group: ConfigGroup, field: string, prev: unknown) { } + async onControllerConfigFieldChanged(field: string, curr: unknown, prev: unknown) { } /** * Called when the value of an instance config field changed. @@ -114,12 +113,11 @@ export default class BaseControllerPlugin { * * @param instance - * The instance the config changed on. - * @param group - - * The group who's field got changed. * @param field - Name of the field that changed. + * @param curr - The current value of the field. * @param prev - The previous value of the field. */ - async onInstanceConfigFieldChanged(instance: InstanceInfo, group: ConfigGroup, field: string, prev: unknown) { } + async onInstanceConfigFieldChanged(instance: InstanceInfo, field: string, curr: unknown, prev: unknown) { } /** * Called before collecting Prometheus metrics diff --git a/packages/controller/src/ControlConnection.ts b/packages/controller/src/ControlConnection.ts index b1740ea5..6cf9deca 100644 --- a/packages/controller/src/ControlConnection.ts +++ b/packages/controller/src/ControlConnection.ts @@ -169,17 +169,17 @@ export default class ControlConnection extends BaseConnection { throw new Error("Should be unreachable"); } - async handleControllerConfigGetRequest(): Promise { - return new lib.RawConfig(this._controller.config.serialize("control")); + async handleControllerConfigGetRequest() { + return this._controller.config.toRemote("control"); } async handleControllerConfigSetFieldRequest(request: lib.ControllerConfigSetFieldRequest) { - this._controller.config.set(request.field, request.value, "control"); + this._controller.config.set(request.field as keyof lib.ControllerConfigFields, request.value, "control"); } async handleControllerConfigSetPropRequest(request: lib.ControllerConfigSetPropRequest) { let { field, prop, value } = request; - this._controller.config.setProp(field, prop, value, "control"); + this._controller.config.setProp(field as keyof lib.ControllerConfigFields, prop, value, "control"); } async handleHostRevokeTokensRequest(request: lib.HostRevokeTokensRequest) { @@ -211,8 +211,7 @@ export default class ControlConnection extends BaseConnection { } async handleHostConfigCreateRequest(request: lib.HostConfigCreateRequest) { - let hostConfig = new lib.HostConfig("control"); - await hostConfig.init(); + const hostConfig = new lib.HostConfig("host"); hostConfig.set("host.controller_url", this._controller.getControllerUrl()); if (request.id !== undefined) { @@ -225,7 +224,7 @@ export default class ControlConnection extends BaseConnection { this.user.checkPermission("core.host.generate_token"); hostConfig.set("host.controller_token", this._controller.generateHostToken(hostConfig.get("host.id"))); } - return new lib.RawConfig(hostConfig.serialize()); + return hostConfig.toJSON(); } async handleInstanceDetailsGetRequest(request: lib.InstanceDetailsGetRequest) { @@ -236,10 +235,9 @@ export default class ControlConnection extends BaseConnection { return [...this._controller.instances.values()].map(instance => instance.toInstanceDetails()); } - // XXX should probably add a hook for host reuqests? async handleInstanceCreateRequest(request: lib.InstanceCreateRequest) { - let instanceConfig = new lib.InstanceConfig("controller"); - await instanceConfig.load(request.config as lib.SerializedConfig); + const instanceConfig = new lib.InstanceConfig("controller"); + instanceConfig.update(request.config, false, "control"); await this._controller.instanceCreate(instanceConfig); } @@ -249,7 +247,7 @@ export default class ControlConnection extends BaseConnection { async handleInstanceConfigGetRequest(request: lib.InstanceConfigGetRequest) { let instance = this._controller.getRequestInstance(request.instanceId); - return new lib.InstanceConfigGetRequest.Response(instance.config.serialize("control")); + return instance.config.toRemote("control"); } async handleInstanceConfigSetFieldRequest(request: lib.InstanceConfigSetFieldRequest) { @@ -263,14 +261,14 @@ export default class ControlConnection extends BaseConnection { throw new lib.RequestError("Setting instance.id is not supported"); } - instance.config.set(request.field, request.value, "control"); + instance.config.set(request.field as keyof lib.InstanceConfigFields, request.value, "control"); await this._controller.instanceConfigUpdated(instance); } async handleInstanceConfigSetPropRequest(request: lib.InstanceConfigSetPropRequest) { let instance = this._controller.getRequestInstance(request.instanceId); let { field, prop, value } = request; - instance.config.setProp(field, prop, value, "control"); + instance.config.setProp(field as keyof lib.InstanceConfigFields, prop, value, "control"); await this._controller.instanceConfigUpdated(instance); } diff --git a/packages/controller/src/Controller.ts b/packages/controller/src/Controller.ts index 28750608..015389f4 100644 --- a/packages/controller/src/Controller.ts +++ b/packages/controller/src/Controller.ts @@ -216,11 +216,11 @@ export default class Controller { this._startDevServer(args); } - this.config.on("fieldChanged", (group, field, prev) => { - if (group.name === "controller" && field === "autosave_interval") { + this.config.on("fieldChanged", (field, curr, prev) => { + if (field === "controller.autosave_interval") { this.onAutosaveIntervalChanged(); } - lib.invokeHook(this.plugins, "onControllerConfigFieldChanged", group, field, prev); + lib.invokeHook(this.plugins, "onControllerConfigFieldChanged", field, curr, prev); }); for (let instance of this.instances.values()) { this.addInstanceHooks(instance); @@ -421,7 +421,7 @@ export default class Controller { private async _saveDataInternal() { if (this.config.dirty) { this.config.dirty = false; - await lib.safeOutputFile(this.configPath, JSON.stringify(this.config.serialize(), null, "\t")); + await lib.safeOutputFile(this.configPath, JSON.stringify(this.config, null, "\t")); } let databaseDirectory = this.config.get("controller.database_directory"); @@ -495,11 +495,9 @@ export default class Controller { ) as Static[]; for (let json of serialized) { if (!json.config) { // migrate: from pre Alpha 14 format. - json = { config: json, status: "running" }; // Use running to force updatedAt + json = { config: json as any, status: "running" }; // Use running to force updatedAt } - let instanceConfig = new lib.InstanceConfig("controller"); - await instanceConfig.load(json.config as lib.SerializedConfig); - let instance = InstanceInfo.fromJSON(json, instanceConfig); + const instance = InstanceInfo.fromJSON(json, "controller"); const status = instance.config.get("instance.assigned_host") === null ? "unassigned" : "unknown"; if (instance.status !== status) { instance.status = status; @@ -519,7 +517,7 @@ export default class Controller { } static async saveInstances(filePath: string, instances: Map) { - let serialized = [...instances.values()].map(instance => instance.toJSON()); + let serialized = [...instances.values()]; await lib.safeOutputFile(filePath, JSON.stringify(serialized, null, "\t")); } @@ -690,7 +688,6 @@ export default class Controller { * * @example * let instanceConfig = new lib.InstanceConfig("controller"); - * await instanceConfig.init(); * instanceConfig.set("instance.name", "My instance"); * let instance = await controller.instanceAssign(instanceConfig); * await controller.instanceAssign(instance.id, hostId); @@ -802,11 +799,11 @@ export default class Controller { this.clearSavesOfInstance(instanceId); // Assign to target - instance.config.set("instance.assigned_host", hostId); + instance.config.set("instance.assigned_host", hostId ?? null); // "fieldChanged" event handler will set this.instancesDirty if (hostId !== undefined && newHostConnection) { await newHostConnection.send( - new lib.InstanceAssignInternalRequest(instanceId, instance.config.serialize("host")) + new lib.InstanceAssignInternalRequest(instanceId, instance.config.toRemote("host")) ); } else { instance.status = "unassigned"; @@ -855,21 +852,21 @@ export default class Controller { let connection = this.wsServer.hostConnections.get(hostId); if (connection) { await connection.send( - new lib.InstanceAssignInternalRequest(instance.id, instance.config.serialize("host")) + new lib.InstanceAssignInternalRequest(instance.id, instance.config.toRemote("host")) ); } } } addInstanceHooks(instance: InstanceInfo) { - instance.config.on("fieldChanged", (group: lib.ConfigGroup, field: string, prev: any) => { + instance.config.on("fieldChanged", (field: string, curr: any, prev: any) => { instance.updatedAt = Date.now(); - if (group.name === "instance" && field === "name") { + if (field === "instance.name") { this.instanceDetailsUpdated([instance]); } this.instancesDirty = true; - lib.invokeHook(this.plugins, "onInstanceConfigFieldChanged", instance, group, field, prev); + lib.invokeHook(this.plugins, "onInstanceConfigFieldChanged", instance, field, curr, prev); }); } @@ -991,7 +988,7 @@ export default class Controller { logger.warn(`Unable to load dist/web/manifest.json for plugin ${pluginInfo.name}`); } - if (!this.config.group(pluginInfo.name).get("load_plugin")) { + if (!this.config.get(`${pluginInfo.name}.load_plugin` as keyof lib.ControllerConfigFields)) { continue; } diff --git a/packages/controller/src/HostConnection.ts b/packages/controller/src/HostConnection.ts index 164f3e82..037dabc8 100644 --- a/packages/controller/src/HostConnection.ts +++ b/packages/controller/src/HostConnection.ts @@ -189,7 +189,7 @@ export default class HostConnection extends BaseConnection { for (let instance of this._controller.instances.values()) { if (instance.config.get("instance.assigned_host") === this._id) { await this.send( - new lib.InstanceAssignInternalRequest(instance.id, instance.config.serialize("host")) + new lib.InstanceAssignInternalRequest(instance.id, instance.config.toRemote("host")) ); } } @@ -197,8 +197,8 @@ export default class HostConnection extends BaseConnection { // Assign instances the host has but controller does not const instanceUpdates: InstanceInfo[] = []; for (let instanceData of request.instances) { - let instanceConfig = new lib.InstanceConfig("controller"); - await instanceConfig.load(instanceData.config as lib.SerializedConfig, "host"); + const instanceConfig = new lib.InstanceConfig("controller"); + instanceConfig.update(instanceData.config, false, "host"); let controllerInstance = this._controller.instances.get(instanceConfig.get("instance.id")); if (controllerInstance) { @@ -237,7 +237,7 @@ export default class HostConnection extends BaseConnection { this._controller.addInstanceHooks(newInstance); await this.send( new lib.InstanceAssignInternalRequest( - instanceConfig.get("instance.id"), instanceConfig.serialize("host") + instanceConfig.get("instance.id"), instanceConfig.toRemote("host") ) ); instanceUpdates.push(newInstance); diff --git a/packages/controller/src/InstanceInfo.ts b/packages/controller/src/InstanceInfo.ts index 320fa32c..e7db6cbf 100644 --- a/packages/controller/src/InstanceInfo.ts +++ b/packages/controller/src/InstanceInfo.ts @@ -18,30 +18,21 @@ export default class InstanceInfo { } static jsonSchema = Type.Object({ - "config": Type.Object({}), + "config": lib.InstanceConfig.jsonSchema, "status": lib.InstanceStatus, "gamePort": Type.Optional(Type.Number()), "updatedAt": Type.Optional(Type.Number()), }); - static fromJSON(json: Static, config: lib.InstanceConfig) { + static fromJSON(json: Static, location: lib.ConfigLocation) { return new this( - config, + lib.InstanceConfig.fromJSON(json.config, location), json.status, json.gamePort, json.updatedAt, ); } - toJSON(): Static { - return { - config: this.config.serialize(), - status: this.status, - gamePort: this.gamePort, - updatedAt: this.updatedAt, - }; - } - toInstanceDetails() { return new lib.InstanceDetails( this.config.get("instance.name"), diff --git a/packages/controller/src/routes.ts b/packages/controller/src/routes.ts index 5fceb72a..852f4b59 100644 --- a/packages/controller/src/routes.ts +++ b/packages/controller/src/routes.ts @@ -109,7 +109,12 @@ function getPlugins(req: Request, res: Response) { for (let pluginInfo of req.app.locals.controller.pluginInfos) { let name = pluginInfo.name; let loaded = req.app.locals.controller.plugins.has(name); - let enabled = loaded && req.app.locals.controller.config.group(pluginInfo.name).get("load_plugin") as boolean; + let enabled = loaded && req.app.locals.controller.config.get( + `${pluginInfo.name}.load_plugin` as keyof lib.ControllerConfigFields, + ) as unknown as boolean; + // Note: Cast through unknown is needed because load_plugin is + // defined at runtime and no other fields in the controller config + // currently have the boolean type. let web: { main:any, error:string|undefined } = { main: undefined, error: undefined}; let devPlugins = req.app.locals.devPlugins; if (devPlugins && devPlugins.has(name)) { diff --git a/packages/ctl/ctl.ts b/packages/ctl/ctl.ts index 86512ff7..46863461 100755 --- a/packages/ctl/ctl.ts +++ b/packages/ctl/ctl.ts @@ -114,8 +114,7 @@ export class Control extends lib.Link { async function loadPlugins(pluginList: Map) { let pluginInfos = await lib.loadPluginInfos(pluginList); lib.registerPluginMessages(pluginInfos); - lib.registerPluginConfigGroups(pluginInfos); - lib.finalizeConfigs(); + lib.addPluginConfigFields(pluginInfos); let ctlPlugins = new Map(); for (let pluginInfo of pluginInfos) { @@ -219,14 +218,15 @@ async function startControl() { ; logger.verbose(`Loading config from ${args.config}`); - let controlConfig = new lib.ControlConfig("control"); + let controlConfig; try { - await controlConfig.load(JSON.parse(await fs.readFile(args.config, "utf8"))); + const jsonConfig = JSON.parse(await fs.readFile(args.config, "utf8")); + controlConfig = lib.ControlConfig.fromJSON(jsonConfig, "control"); } catch (err: any) { if (err.code === "ENOENT") { logger.verbose("Config not found, initializing new config"); - await controlConfig.init(); + controlConfig = new lib.ControlConfig("control"); } else { throw new lib.StartupError(`Failed to load ${args.config}: ${err.message}`); @@ -260,16 +260,16 @@ async function startControl() { } let tlsCa: string | undefined; - let tlsCaPath = controlConfig.get("control.tls_ca") as string | null; + let tlsCaPath = controlConfig.get("control.tls_ca"); if (tlsCaPath) { tlsCa = await fs.readFile(tlsCaPath, "utf8"); } let controlConnector = new ControlConnector( - controlConfig.get("control.controller_url") as string, - controlConfig.get("control.max_reconnect_delay") as number, + controlConfig.get("control.controller_url")!, + controlConfig.get("control.max_reconnect_delay"), tlsCa, - controlConfig.get("control.controller_token") as string, + controlConfig.get("control.controller_token")!, ); let control = new Control(controlConnector, controlConfig, tlsCa, ctlPlugins); try { diff --git a/packages/ctl/src/commands.ts b/packages/ctl/src/commands.ts index c112c162..215c67b3 100644 --- a/packages/ctl/src/commands.ts +++ b/packages/ctl/src/commands.ts @@ -56,29 +56,27 @@ async function configToKeyVal(data: string) { return final; } -async function serializedConfigToString( - serializedConfig: any, - configGroup: typeof lib.Config, +function serializedConfigToString( + serializedConfig: lib.ConfigSchema, + configGroup: typeof lib.ControllerConfig | typeof lib.InstanceConfig, disallowedList: Record, ) { let allConfigElements = ""; - for (let group of serializedConfig.groups) { - for (let [name, value] of Object.entries(group.fields)) { - if (`${group.name}.${name}` in disallowedList) { - continue; - } - let desc = ""; - try { - desc += configGroup.groups.get(group.name)!._definitions.get(name)!.description; - } catch (err) { - desc += "No description found"; - } - // split onto two lines for readability and es-lint - if (String(value) === "null") { - value = ""; - } - allConfigElements += `${group.name}.${name} = ${value}\n\n`; + for (let [name, value] of Object.entries(serializedConfig)) { + if (name in disallowedList) { + continue; } + let desc = ""; + try { + desc += (configGroup.fieldDefinitions as any)[name]!.description; + } catch (err) { + desc += "No description found"; + } + // split onto two lines for readability and es-lint + if (String(value) === "null") { + value = ""; + } + allConfigElements += `${name} = ${value}\n\n`; } return allConfigElements; } @@ -91,12 +89,10 @@ const controllerConfigCommands = new lib.CommandTree({ controllerConfigCommands.add(new lib.Command({ definition: ["list", "List controller configuration"], handler: async function(args: object, control: Control) { - let response = await control.send(new lib.ControllerConfigGetRequest()); + let config = await control.send(new lib.ControllerConfigGetRequest()); - for (let group of (response.serializedConfig as any).groups) { - for (let [name, value] of Object.entries(group.fields)) { - print(`${group.name}.${name} ${JSON.stringify(value)}`); - } + for (let [name, value] of Object.entries(config)) { + print(`${name} ${JSON.stringify(value)}`); } }, })); @@ -115,7 +111,7 @@ controllerConfigCommands.add(new lib.Command({ } else if (args.value === undefined) { args.value = ""; } - await control.send(new lib.ControllerConfigSetFieldRequest(args.field as string, args.value as string)); + await control.send(new lib.ControllerConfigSetFieldRequest(args.field, args.value)); }, })); @@ -156,15 +152,15 @@ controllerConfigCommands.add(new lib.Command({ }); }], handler: async function(args: { editor: string }, control: Control) { - let response = await control.send(new lib.ControllerConfigGetRequest()); + let config = await control.send(new lib.ControllerConfigGetRequest()); let tmpFile = await lib.getTempFile("ctl-", "-tmp", os.tmpdir()); let editor = await getEditor(args.editor); if (editor === undefined) { throw new lib.CommandError(`No editor avalible. Checked CLI input, EDITOR and VISUAL env vars Try "ctl controller config edit "`); } - let allConfigElements = await serializedConfigToString( - response.serializedConfig, lib.ControllerConfig, {} + let allConfigElements = serializedConfigToString( + config, lib.ControllerConfig, {} ); await fs.writeFile(tmpFile, allConfigElements); let editorSpawn = child_process.spawn(editor, [tmpFile], { @@ -214,7 +210,7 @@ const controllerPluginCommands = new lib.CommandTree({ controllerPluginCommands.add(new lib.Command({ definition: ["list", "List plugins on controller"], handler: async function(args: object, control: Control) { - let url = new URL(control.config.get("control.controller_url") as string); + let url = new URL(control.config.get("control.controller_url")!); url.pathname += "api/plugins"; let response = await phin<[]>({ url, @@ -272,11 +268,11 @@ hostCommands.add(new lib.Command({ args: { id?: number, name?: string, generateToken: boolean, output: string }, control: Control ) { - let rawConfig = await control.send( + let config = await control.send( new lib.HostConfigCreateRequest(args.id, args.name, args.generateToken) ); - let content = JSON.stringify(rawConfig.serializedConfig, null, "\t"); + let content = JSON.stringify(config, null, "\t"); if (args.output === "-") { print(content); } else { @@ -315,12 +311,11 @@ instanceCommands.add(new lib.Command({ }], handler: async function(args: { name: string, id?: number }, control: Control) { let instanceConfig = new lib.InstanceConfig("control"); - await instanceConfig.init(); if (args.id !== undefined) { instanceConfig.set("instance.id", args.id); } instanceConfig.set("instance.name", args.name); - let serializedConfig = instanceConfig.serialize("controller"); + const serializedConfig = instanceConfig.toRemote("controller"); await control.send(new lib.InstanceCreateRequest(serializedConfig)); }, })); @@ -334,12 +329,10 @@ instanceConfigCommands.add(new lib.Command({ }], handler: async function(args: { instance: string }, control: Control) { let instanceId = await lib.resolveInstance(control, args.instance); - let response = await control.send(new lib.InstanceConfigGetRequest(instanceId)); + let config = await control.send(new lib.InstanceConfigGetRequest(instanceId)); - for (let group of response.serializedConfig.groups) { - for (let [name, value] of Object.entries(group.fields)) { - print(`${group.name}.${name} ${JSON.stringify(value)}`); - } + for (let [name, value] of Object.entries(config)) { + print(`${name} ${JSON.stringify(value)}`); } }, })); @@ -427,7 +420,7 @@ instanceConfigCommands.add(new lib.Command({ }], handler: async function(args: { instance: string, editor: string }, control: Control) { let instanceId = await lib.resolveInstance(control, args.instance); - let response = await control.send(new lib.InstanceConfigGetRequest(instanceId)); + let config = await control.send(new lib.InstanceConfigGetRequest(instanceId)); let tmpFile = await lib.getTempFile("ctl-", "-tmp", os.tmpdir()); let editor = await getEditor(args.editor); if (editor === undefined) { @@ -435,8 +428,8 @@ instanceConfigCommands.add(new lib.Command({ Try "ctl controller config edit "`); } let disallowedList = {"instance.id": 0, "instance.assigned_host": 0, "factorio.settings": 0}; - let allConfigElements = await serializedConfigToString( - response.serializedConfig, + let allConfigElements = serializedConfigToString( + config, lib.InstanceConfig, disallowedList ); @@ -613,7 +606,7 @@ instanceSaveCommands.add(new lib.Command({ let content = await fs.readFile(args.filepath); let instanceId = await lib.resolveInstance(control, args.instance); - let url = new URL(control.config.get("control.controller_url") as string); + let url = new URL(control.config.get("control.controller_url")!); url.pathname += "api/upload-save"; url.searchParams.append("instance_id", String(instanceId)); url.searchParams.append("filename", filename); @@ -695,7 +688,7 @@ instanceSaveCommands.add(new lib.Command({ let instanceId = await lib.resolveInstance(control, args.instance); let streamId = await control.send(new lib.InstanceDownloadSaveRequest(instanceId, args.save)); - let url = new URL(control.config.get("control.controller_url") as string); + let url = new URL(control.config.get("control.controller_url")!); url.pathname += `api/stream/${streamId}`; let response = await phin({ url, method: "GET", @@ -1281,7 +1274,7 @@ modCommands.add(new lib.Command({ // phin doesn't support streaming requests :( let content = await fs.readFile(args.file); - let url = new URL(control.config.get("control.controller_url") as string); + let url = new URL(control.config.get("control.controller_url")!); url.pathname += "api/upload-mod"; url.searchParams.append("filename", filename); @@ -1325,7 +1318,7 @@ modCommands.add(new lib.Command({ handler: async function(args: { name: string, modVersion: string }, control: Control) { let streamId = await control.send(new lib.ModDownloadRequest(args.name, args.modVersion)); - let url = new URL(control.config.get("control.controller_url") as string); + let url = new URL(control.config.get("control.controller_url")!); url.pathname += `api/stream/${streamId}`; let response = await phin({ url, method: "GET", diff --git a/packages/host/host.ts b/packages/host/host.ts index 5b3daf19..56a8c346 100755 --- a/packages/host/host.ts +++ b/packages/host/host.ts @@ -142,18 +142,18 @@ async function startHost() { logger.info("Loading Plugin info"); let pluginInfos = await lib.loadPluginInfos(pluginList); lib.registerPluginMessages(pluginInfos); - lib.registerPluginConfigGroups(pluginInfos); - lib.finalizeConfigs(); + lib.addPluginConfigFields(pluginInfos); logger.info(`Loading config from ${args.config}`); - let hostConfig = new lib.HostConfig("host"); + let hostConfig; try { - await hostConfig.load(JSON.parse(await fs.readFile(args.config, "utf8"))); + const jsonConfig = JSON.parse(await fs.readFile(args.config, "utf8")); + hostConfig = lib.HostConfig.fromJSON(jsonConfig, "host"); } catch (err: any) { if (err.code === "ENOENT") { logger.info("Config not found, initializing new config"); - await hostConfig.init(); + hostConfig = new lib.HostConfig("host"); } else { throw new lib.StartupError(`Failed to load ${args.config}: ${err.message}`); diff --git a/packages/host/src/BaseHostPlugin.ts b/packages/host/src/BaseHostPlugin.ts index d161fcab..87664cff 100644 --- a/packages/host/src/BaseHostPlugin.ts +++ b/packages/host/src/BaseHostPlugin.ts @@ -1,5 +1,5 @@ import type { - ConfigGroup, CollectorResult, Logger, ParsedFactorioOutput, PlayerEvent, PluginNodeEnvInfo, + CollectorResult, Logger, ParsedFactorioOutput, PlayerEvent, PluginNodeEnvInfo, } from "@clusterio/lib"; import type Host from "./Host"; @@ -46,12 +46,11 @@ export default class BaseHostPlugin { * Invoked after the value of the config field given by `field` has * changed on this host. * - * @param group - - * The group who's field got changed. * @param field - Name of the field that changed. + * @param curr - The current value of the field. * @param prev - The previous value of the field. */ - async onHostConfigFieldChanged(group: ConfigGroup, field: string, prev: unknown) { } + async onHostConfigFieldChanged(field: string, curr: unknown, prev: unknown) { } /** * Called before collecting Prometheus metrics diff --git a/packages/host/src/BaseInstancePlugin.ts b/packages/host/src/BaseInstancePlugin.ts index dd5f929d..2792f404 100644 --- a/packages/host/src/BaseInstancePlugin.ts +++ b/packages/host/src/BaseInstancePlugin.ts @@ -1,5 +1,5 @@ import type { - ConfigGroup, CollectorResult, Logger, ParsedFactorioOutput, PlayerEvent, PluginNodeEnvInfo, + CollectorResult, Logger, ParsedFactorioOutput, PlayerEvent, PluginNodeEnvInfo, } from "@clusterio/lib"; import type Instance from "./Instance"; import type Host from "./Host"; @@ -70,12 +70,11 @@ export default class BaseInstancePlugin { * Invoked after the value of the config field given by `field` has * changed. * - * @param group - - * The group who's field got changed. * @param field - Name of the field that changed. + * @param curr - The current value of the field. * @param prev - The previous value of the field. */ - async onInstanceConfigFieldChanged(group: ConfigGroup, field: string, prev: unknown) { } + async onInstanceConfigFieldChanged(field: string, curr: unknown, prev: unknown) { } /** * Called before collecting Prometheus metrics diff --git a/packages/host/src/Host.ts b/packages/host/src/Host.ts index a2c700e3..436efe1b 100644 --- a/packages/host/src/Host.ts +++ b/packages/host/src/Host.ts @@ -47,7 +47,8 @@ async function discoverInstances(instancesDir: string) { let configPath = path.join(instancesDir, entry.name, "instance.json"); try { - await instanceConfig.load(JSON.parse(await fs.readFile(configPath, "utf8"))); + const jsonConfig = JSON.parse(await fs.readFile(configPath, "utf8")); + instanceConfig = lib.InstanceConfig.fromJSON(jsonConfig, "host"); } catch (err: any) { if (err.code === "ENOENT") { @@ -286,8 +287,8 @@ export default class Host extends lib.Link { this.configPath = hostConfigPath; this.config = hostConfig; - this.config.on("fieldChanged", (group, field, prev) => { - lib.invokeHook(this.plugins, "onHostConfigFieldChanged", group, field, prev); + this.config.on("fieldChanged", (name, curr, prev) => { + lib.invokeHook(this.plugins, "onHostConfigFieldChanged", name, curr, prev); }); this.connector.on("hello", data => { @@ -361,7 +362,7 @@ export default class Host extends lib.Link { async loadPlugins() { for (let pluginInfo of this.pluginInfos) { - if (!this.config.group(pluginInfo.name).get("load_plugin")) { + if (!this.config.get(`${pluginInfo.name}.load_plugin` as keyof lib.HostConfigFields)) { continue; } @@ -564,17 +565,17 @@ export default class Host extends lib.Link { let { instanceId, config } = request; let instanceInfo = this.instanceInfos.get(instanceId); if (instanceInfo) { - instanceInfo.config.update(config as any, true, "controller"); + instanceInfo.config.update(config, true, "controller"); logger.verbose(`Updated config for ${instanceInfo.path}`, this.instanceLogMeta(instanceId, instanceInfo)); } else { instanceInfo = this.discoveredInstanceInfos.get(instanceId); if (instanceInfo) { - instanceInfo.config.update(config as any, true, "controller"); + instanceInfo.config.update(config, true, "controller"); } else { let instanceConfig = new lib.InstanceConfig("host"); - await instanceConfig.load(config as any, "controller"); + instanceConfig.update(config, false, "controller"); let instanceDir = await this._createNewInstanceDir(instanceConfig.get("instance.name")); @@ -608,7 +609,7 @@ export default class Host extends lib.Link { // save a copy of the instance config let warnedOutput = { _warning: "Changes to this file will be overwritten by the controller's copy.", - ...instanceInfo.config.serialize(), + ...instanceInfo.config.toJSON(), }; await lib.safeOutputFile( path.join(instanceInfo.path, "instance.json"), @@ -919,8 +920,8 @@ export default class Host extends lib.Link { let list = []; for (let [instanceId, instanceInfo] of this.discoveredInstanceInfos) { let instanceConnection = this.instanceConnections.get(instanceId); - list.push(new lib.RawInstanceInfo( - instanceInfo.config.serialize("controller"), + list.push(new lib.HostInstanceUpdate( + instanceInfo.config.toRemote("controller"), instanceConnection ? instanceConnection.instance.status : "stopped", instanceConnection ? instanceConnection.instance.server.gamePort : undefined, )); @@ -984,7 +985,7 @@ export default class Host extends lib.Link { } logger.info("Saving config"); - await lib.safeOutputFile(this.configPath, JSON.stringify(this.config.serialize(), null, "\t")); + await lib.safeOutputFile(this.configPath, JSON.stringify(this.config, null, "\t")); try { // Clear silly interval in pidfile library. diff --git a/packages/host/src/Instance.ts b/packages/host/src/Instance.ts index 22c43cf7..09acb34c 100644 --- a/packages/host/src/Instance.ts +++ b/packages/host/src/Instance.ts @@ -121,7 +121,7 @@ export default class Instance extends lib.Link { _host: Host; _dir: string; - _configFieldChanged: (group: lib.ConfigGroup, field: string, prev: unknown) => void; + _configFieldChanged: (field: string, curr: unknown, prev: unknown) => void; _status: "stopped" | "starting" | "running" | "stopping" | "creating_save" | "exporting_data" = "stopped"; _loadedSave: string | null = null; _playerCheckInterval: ReturnType | undefined; @@ -150,16 +150,16 @@ export default class Instance extends lib.Link { instance_name: this.name, }); - this._configFieldChanged = (group: lib.ConfigGroup, field: string, prev: unknown) => { - let hook = () => lib.invokeHook(this.plugins, "onInstanceConfigFieldChanged", group, field, prev); + this._configFieldChanged = (field: string, curr: unknown, prev: unknown) => { + let hook = () => lib.invokeHook(this.plugins, "onInstanceConfigFieldChanged", field, curr, prev); - if (group.name === "factorio" && field === "settings") { - this.updateFactorioSettings(group.get(field) as any, prev as any).finally(hook); - } else if (group.name === "factorio" && field === "enable_whitelist") { - this.updateFactorioWhitelist(group.get(field) as any).finally(hook); + if (field === "factorio.settings") { + this.updateFactorioSettings(curr as any, prev as any).finally(hook); + } else if (field === "factorio.enable_whitelist") { + this.updateFactorioWhitelist(curr as any).finally(hook); } else { - if (group.name === "factorio" && field === "max_concurrent_commands") { - this.server.maxConcurrentCommands = group.get(field) as number; + if (field === "factorio.max_concurrent_commands") { + this.server.maxConcurrentCommands = curr as number; } hook(); } @@ -546,7 +546,7 @@ rcon.print(game.table_to_json(players))`.replace(/\r?\n/g, " "); if ( !pluginInfo.instanceEntrypoint || !this._host.serverPlugins.has(pluginInfo.name) - || !this.config.group(pluginInfo.name).get("load_plugin") + || !this.config.get(`${pluginInfo.name}.load_plugin` as keyof lib.InstanceConfigFields) ) { continue; } diff --git a/packages/lib/browser.ts b/packages/lib/browser.ts index 9e06d1db..5c430809 100644 --- a/packages/lib/browser.ts +++ b/packages/lib/browser.ts @@ -14,3 +14,4 @@ export * from "./src/subscriptions"; export { default as ExponentialBackoff } from "./src/ExponentialBackoff"; export { default as RateLimiter } from "./src/RateLimiter"; +export { default as TypedEventEmitter } from "./src/TypedEventEmitter"; diff --git a/packages/lib/index.ts b/packages/lib/index.ts index d6385d7c..508b900c 100644 --- a/packages/lib/index.ts +++ b/packages/lib/index.ts @@ -31,3 +31,4 @@ export * from "./src/subscriptions"; export { default as ExponentialBackoff } from "./src/ExponentialBackoff"; export { default as ModStore } from "./src/ModStore"; export { default as RateLimiter } from "./src/RateLimiter"; +export { default as TypedEventEmitter } from "./src/TypedEventEmitter"; diff --git a/packages/lib/src/ModStore.ts b/packages/lib/src/ModStore.ts index 83cb0167..8240d8f5 100644 --- a/packages/lib/src/ModStore.ts +++ b/packages/lib/src/ModStore.ts @@ -2,17 +2,7 @@ import fs from "fs-extra"; import path from "path"; import { logger } from "./logging"; import { ModInfo } from "./data"; -import EventEmitter from "events"; - -abstract class TypedEventEmitter< - Keys extends string, - Events extends Record void>, -> extends EventEmitter { - declare ["on"]: (event: E, listener: Events[E]) => this; - declare ["off"]: (event: E, listener: Events[E]) => this; - declare ["once"]: (event: E, listener: Events[E]) => this; - declare ["emit"]: (event: E, ...args: Parameters) => boolean; -} +import TypedEventEmitter from "./TypedEventEmitter"; export interface ModStoreEvents { /** A stored mod was created, updated or deleted */ diff --git a/packages/lib/src/TypedEventEmitter.ts b/packages/lib/src/TypedEventEmitter.ts new file mode 100644 index 00000000..206282e8 --- /dev/null +++ b/packages/lib/src/TypedEventEmitter.ts @@ -0,0 +1,27 @@ +import EventEmitter from "events"; + +/** + * Type checked version of EventEmitter + * + * @example + * ```ts + * interface Events { + * "foo": (a: number, b: number) => void, + * "bar": (spam: string) => void, + * } + * + * class Emitter extends TypedEventEmitter {} + * + * const e = new Emitter(); + * e.emit("foo", 1, 2) // type checked arguments + * ``` + */ +export default abstract class TypedEventEmitter< + Keys extends string, + Events extends Record void>, +> extends EventEmitter { + declare ["on"]: (event: E, listener: Events[E]) => this; + declare ["off"]: (event: E, listener: Events[E]) => this; + declare ["once"]: (event: E, listener: Events[E]) => this; + declare ["emit"]: (event: E, ...args: Parameters) => boolean; +} diff --git a/packages/lib/src/config/classes.ts b/packages/lib/src/config/classes.ts index c809a34c..2963ee36 100644 --- a/packages/lib/src/config/classes.ts +++ b/packages/lib/src/config/classes.ts @@ -1,12 +1,14 @@ // Configuration classes import { Type, Static } from "@sinclair/typebox"; -import events from "events"; +import TypedEventEmitter from "../TypedEventEmitter"; import isDeepStrictEqual from "../is_deep_strict_equal"; import { basicType } from "../helpers"; +import * as libSchema from "../schema"; +import { StringEnum } from "../data/composites"; - -export type ConfigLocation = "controller" | "host" | "instance" | "control"; +const ConfigLocation = StringEnum(["controller", "host", "instance", "control"]); +export type ConfigLocation = Static; /** * Invalid Access exception @@ -38,52 +40,123 @@ export class InvalidValue extends Error { }; */ export class InvalidField extends Error { }; -/** - * Split the given string on the first instance of separator - * - * Splits `string` on the first instance of `separator` and returns an - * array consisting of the string up to the separator and the string - * after the separator. Returns an array with the string and an empty - * string if the separator is not present. - * - * @param separator - Separator to split string by. - * @param string - String to split - * @returns string split on separator. - * @internal - */ -function splitOn(separator: string, string: string) { - let index = string.indexOf(separator); - if (index === -1) { - return [string, ""]; - } - return [string.slice(0, index), string.slice(index + separator.length)]; + +const OldConfigGroupSchema = Type.Object({ + "name": Type.String(), + "fields": Type.Record(Type.String(), Type.Unknown()), +}); +type OldConfigGroupSchema = Static; + +const OldConfigSchema = Type.Object({ + "groups": Type.Array(OldConfigGroupSchema), +}); +export type OldConfigSchema = Static + +export const ConfigSchema = Type.Record(Type.String(), Type.Union([ + Type.Null(), + Type.Boolean(), + Type.Number(), + Type.String(), + Type.Object({}), +])); +export type ConfigSchema = Static; + +type FieldType = "boolean" | "string" | "number" | "object"; +type FieldValue = null | boolean | string | number | object; +export interface FieldDefinition { + /** + * string declaring the type of the config value, supports boolean, + * string, number and object. + */ + type: FieldType; + /** + * Text used to identify the config field in user interfaces. + */ + title?: string; + /** + * Text used to describe the config field in user interfaces. + */ + description?: string; + /** + * True if this field can be set to null. Defaults to false. + */ + optional?: boolean; + /** + * Value this config field should take in a newly initialized config. + * This can also be an function returning the value to use. + */ + initialValue?: unknown | (() => unknown); + /** + * Array of all values that are acceptible. Useful for making + * enumerated values. + */ + enum?: unknown[]; + /** + * True if a restart of the entity this config is attached to is + * required for changes to take effect. Informative only, defaults to + * false. + */ + restartRequired?: boolean; + /** + * Properties to invert the value of restartRequired for if present. + */ + restartRequiredProps?: string[]; + /** + * Array of strings declaring where this config entry can be read and + * modified from. + */ + access?: ConfigLocation[]; } -export type SerializedConfig = ReturnType; -type SerializedGroup = ReturnType; +export type ConfigDefs = { + [Prop in keyof Fields]: FieldDefinition; +} + +function defaultValue(def: FieldDefinition) { + if (def.initialValue === undefined) { + return null; + } + if (typeof def.initialValue === "function") { + return def.initialValue(); + } + return def.initialValue; +} + +export type ConfigEvents = { + fieldChanged: (name: string, curr: FieldValue, prev: FieldValue) => void; +} /** - * Collection of config groups + * Collection of config entries * - * Represents a collection of ConfigGroup instances that can be - * managed as one. + * Type checks and stores a collection of related config entries. Attempt + * to set invalid values for fields will result in an error thrown while + * loading a config with invalid values will result in those being replaced + * by the innitial value for those fields. * * This is an EventEmitter with the following events: * - fieldChanged - - * invoked after a field has been updated in one of the config groups - * belonging to this config. Takes three parameters: group, field, - * prev. + * invoked after a field has been updated. Takes three parameters: name, + * curr, prev. * * @extends events.EventEmitter */ -export class Config extends events.EventEmitter { - declare static _finalized: boolean; - declare static _initialized: boolean; - declare static _groups: Map; +export class Config< + Fields extends { [Field in keyof Fields]: FieldValue }, +> extends TypedEventEmitter< + keyof ConfigEvents, + ConfigEvents +> { + /** + * Mapping of config name to field meta data + * Note that mutating this object will lead to unexpected behaviour. + */ + declare static fieldDefinitions: ConfigDefs; + declare ["constructor"]: typeof Config; - _initialized = false; - _groups = new Map(); - _unknownGroups = new Map(); + + fields: Fields; + _unknownFields: Record = {}; /** Set to true when a field in the config is changed. */ dirty = false; @@ -93,314 +166,38 @@ export class Config extends events.EventEmitter { * * @param location - * Location to evaluate access for this instance from + * @param fields - + * Serialized representation of fields to load. */ constructor( public location: ConfigLocation, + fields?: Static, + public defaultAccess: ConfigLocation[] = ["controller", "host", "control"], ) { - super(); - - if (!(this.constructor as typeof Config)._finalized) { - throw new Error(`Cannot instantiate incomplete Config class ${this.constructor.name}`); - } - if (typeof location !== "string") { throw new Error("location must be a string"); } - } + super(); - async init() { - for (let [name, GroupClass] of (this.constructor as typeof Config)._groups) { - if (!this._groups.has(name)) { - let group = new GroupClass(this); - await group.init(); - this._groups.set(name, group); - } - } - this._initialized = true; - } + this.fields = Object.fromEntries( + Object.entries( + this.constructor.fieldDefinitions + ).filter( + ([name, def]) => this._checkAccess(name, def, location, false) + ).map( + ([name, def]) => [name, defaultValue(def)] + ) + ) as Fields; - _validate(serializedConfig: SerializedConfig) { - if (basicType(serializedConfig) !== "object") { - throw new Error(`Expected object, not ${basicType(serializedConfig)} for config`); - } - - if (basicType(serializedConfig.groups) !== "array") { - throw new Error(`Expected groups to be an array, not ${basicType(serializedConfig.groups)}`); - } - } - - /** - * Load config from a serialized object - * - * @param serializedConfig - Serialized config to load. - * @param location - Location used for access control. - */ - async load( - serializedConfig: SerializedConfig, - location = this.location - ) { - this._validate(serializedConfig); - for (let serializedGroup of serializedConfig.groups) { - let GroupClass = (this.constructor as typeof Config)._groups.get(serializedGroup.name); - if (!GroupClass) { - this._unknownGroups.set(serializedGroup.name, serializedGroup); - continue; - } - - let group = new GroupClass(this); - await group.load(serializedGroup, location); - this._groups.set(group.name, group); - } - - await this.init(); - } - - /** - * Serialize the config to a plain JavaScript object - * - * @param location - Location used for access control. - * @returns JSON serializable representation of the config. - */ - serialize(location = this.location) { - let groups: SerializedGroup[] = [...this._unknownGroups.values()]; - for (let group of this._groups.values()) { - groups.push(group.serialize(location)); - } - - return { groups }; - } - - /** - * Update the configuration based on a serialized config - * - * Updates all groups in the config with groups in the serialized - * config passed. - * - * @param serializedConfig - Output from .serialize(). - * @param notify - Invoke fieldChanged events if true. - * @param location - Location used for access control. - */ - update( - serializedConfig: SerializedConfig, - notify: boolean, - location = this.location - ) { - this._validate(serializedConfig); - for (let serializedGroup of serializedConfig.groups) { - let group = this._groups.get(serializedGroup.name); - if (group) { - group.update(serializedGroup, notify, location); - } else { - this._unknownGroups.set(serializedGroup.name, serializedGroup); - } - } - } - - /** - * Check if field can be accessed from the given location - * - * @param name - Name of the field to check. - * @param location - Location used for access control. - * @returns true if field is accessible - */ - canAccess(name: string, location = this.location) { - let [group, field] = splitOn(".", name); - return this.group(group).canAccess(field, location); - } - - /** - * Get the value for a config field - * - * @param name - Name of field to get. - * @param location - Location used for access control. - * @returns the value for the field. - */ - get(name: string, location = this.location) { - let [group, field] = splitOn(".", name); - return this.group(group).get(field, location); - } - - /** - * Set the value for a config field - * - * @param name - Name of field to set. - * @param value - the value to set on field - * @param location - Location used for access control. - */ - set(name: string, value: unknown, location = this.location) { - let [group, field] = splitOn(".", name); - this.group(group).set(field, value, location); - } - - /** - * Set property of an object value for a config field - * - * @param name - Name of field to set property on. - * @param prop - Name of property to set on field. - * @param value - the value to set the property to. - * @param location - Location used for access control. - */ - setProp(name: string, prop: string, value: unknown, location = this.location) { - let [group, field] = splitOn(".", name); - this.group(group).setProp(field, prop, value, location); - } - - /** - * Get the config group instance with the given name - * - * @param name - Name of group to get. - * @returns config group. - */ - group(name: string) { - if (!this._initialized) { - throw new Error(`${this.constructor.name} instance is uninitialized`); - } - let group = this._groups.get(name); - if (!group) { - throw new InvalidField(`No config group named '${name}'`); - } - return group; - } - - static _initSubclass() { - // These properties are initialized here in order to ensure that - // they end up on the sub-class. - if (!this._initialized) { - this._initialized = true; - this._finalized = false; - this._groups = new Map(); - } - } - - /** - * Mapping of group name to group class - * - * Returns the internal mapping of group names to group classes that - * mave been registered with this config. Note that mutating this - * object will lead to unexpected behaviour. - * - * @returns config groups - */ - static get groups() { - this._initSubclass(); - return this._groups; - } - - /** - * Locks this Config class from adding more groups. - */ - static finalize() { - this._initSubclass(); - this._finalized = true; - } - - /** - * Register a ConfigGroup with this Config - * - * Adds the ConfigGroup to this config as a group that will get - * initialized, loaded and serialized with this config class. - * - * @param group - class to register. - */ - static registerGroup(group: typeof ConfigGroup) { - this._initSubclass(); - - if (this._finalized) { - throw new Error("Cannot register group on finalized config"); - } - - if (!group._finalized) { - throw new Error("Group must be finalized before it can be registered"); - } - - if (this._groups.has(group.groupName)) { - throw new Error(`${group.groupName} has already been registered`); - } - - this._groups.set(group.groupName, group); - } -} - -// TODO: remove after config refactor -export class RawConfig { - constructor( - public serializedConfig: SerializedConfig - ) { } - - static jsonSchema = Type.Object({ - "serializedConfig": Type.Object({ - "groups": Type.Array( - Type.Object({ - "name": Type.String(), - "fields": Type.Record( - Type.String(), - Type.Unknown(), - ), - }), - ), - }), - }); - - static fromJSON(json: Static) { - return new this(json.serializedConfig); - } -} - - -type FieldType = "boolean" | "string" | "number" | "object"; -export interface FieldDefinition { - type: FieldType; - name: string; - fullName: string; - title?: string; - description?: string; - optional: boolean; - initial_value?: unknown | (() => unknown); - enum?: unknown[]; - restartRequired: boolean; - restartRequiredProps?: string[]; - access: ConfigLocation[]; -} - -/** - * Collection of related config entries - * - * Type checks and stores a collection of related config entries. Attempt - * to set invalid values for fields will result in an error thrown while - * loading a config with invalid values will result in those being replaced - * by the innitial value for those fields. - */ -export class ConfigGroup { - declare static _finalized: boolean; - declare static _initialized: boolean; - declare static _definitions: Map; - declare static groupName: string; - declare static defaultAccess: ConfigLocation[]; - - _fields = new Map(); - _unknownFields = new Map(); - - - /** - * Creates a new config group. - * - * After the creation of the new config group you have to call - * either .init() or .load() on it in order to fully initialize it. - * - * @param config - - * Parent config for this group instance. - */ - constructor( - public config: Config - ) { - if (!(this.constructor as typeof ConfigGroup)._finalized) { - throw new Error(`Cannot instantiate incomplete ConfigGroup class ${this.constructor.name}`); + if (fields) { + this.update(fields, false, location); } } /** * Check access for a field * + * @param name - Name of the field to check. * @param def - definition for for the field to check. * @param remote - location of remote access to check for. * @param error - throw on failure to pass check. @@ -409,11 +206,11 @@ export class ConfigGroup { * @returns true if access is granted * @private */ - _checkAccess(def: FieldDefinition, remote: ConfigLocation, error: boolean) { - for (let loc of [remote, this.config.location]) { - if (!def.access.includes(loc)) { + _checkAccess(name: string, def: FieldDefinition, remote: ConfigLocation, error: boolean) { + for (let loc of [remote, this.location]) { + if (!(def.access ?? this.defaultAccess).includes(loc)) { if (error) { - throw new InvalidAccess(`Field '${def.name}' is not accessible from ${loc}`); + throw new InvalidAccess(`Field '${name}' is not accessible from ${loc}`); } else { return false; } @@ -422,56 +219,122 @@ export class ConfigGroup { return true; } + static jsonSchema = ConfigSchema; + + static validate = libSchema.compile(this.jsonSchema as any); + /** - * Initialize new config group + * Create config from a serialized object * - * Computes and assigns the initial values for all fields of the - * config group. + * @param json - Serialized config to load. + * @param location - Location used for access control. + * @returns Instance of this config */ - async init() { - for (let [name, def] of (this.constructor as typeof ConfigGroup)._definitions) { - if (this._fields.has(name)) { - continue; - } - if (!def.access.includes(this.config.location)) { - continue; - } - - let value = null; - if (typeof def.initial_value === "function") { - value = await def.initial_value(); - - } else if (def.initial_value !== undefined) { - value = def.initial_value; - } - - this._fields.set(name, value); + static fromJSON( + json: Static, + location: ConfigLocation, + ) { + // migrate: Pre alpha 14 config format + if (typeof json === "object" && json !== null && json.groups instanceof Array) { + json = Object.fromEntries( + (json.groups as unknown as OldConfigGroupSchema[]).flatMap( + group => Object.entries(group.fields).map( + ([name, value]) => [`${group.name}.${name}`, value as FieldValue] + ), + ), + ); } + const valid = Config.validate(json); + if (!valid) { + throw new Error("Invalid config"); + } + return new this(location, json); + } + + toJSON() { + return this.toRemote(this.location); } /** - * Load from serialized group + * Serialize the config to a plain JavaScript object * - * Loads all the values from the passed serialized version of the - * group and then initializes any possible missing fields from it to - * their default values. + * @param location - Location used for access control. + * @returns JSON serializable representation of the group. + */ + toRemote(location: ConfigLocation): Static { + let fields: Record = {}; + for (let [name, value] of Object.entries(this.fields)) { + let def = this.constructor.fieldDefinitions[name]; + if (!this._checkAccess(name, def, location, false)) { + continue; + } + + fields[name] = value as FieldValue; + } + + for (let [name, value] of Object.entries(this._unknownFields)) { + fields[name] = value; + } + + return fields; + } + + /** + * Update a config from a serialized config * - * @param serializedGroup - - * Result from a previous call to .serialize(). + * Overwrites the values of all the fields in this config that has a + * valid value in the passed serialized config with that value. + * + * @param json - + * Result from a previous call to .toRemote(). + * @param notify - Invoke fieldChanged events if true. * @param location - Location used for access control. */ - async load(serializedGroup: SerializedGroup, location = this.config.location) { - this.update(serializedGroup, false, location); - await this.init(); - } + update( + json: Static, + notify: boolean, + location = this.location + ) { + const valid = Config.validate(json); + if (!valid) { + throw new Error("Invalid config"); + } - /** - * Name of the group - * - * Shortcut for `group.constructor.groupName` - */ - get name() { - return (this.constructor as typeof ConfigGroup).groupName; + if (basicType(json) !== "object") { + throw new Error(`Expected object, not ${basicType(json)} for Config`); + } + + for (let [name, value] of Object.entries(json) as [keyof Fields & string, FieldValue][]) { + let def = this.constructor.fieldDefinitions[name]; + if (!def) { + this._unknownFields[name as string] = value; + continue; + } + + if (!this._checkAccess(name, def, location, false)) { + continue; + } + + if (def.optional) { + if (value !== null && basicType(value) !== def.type) { + continue; + } + + } else if (basicType(value) !== def.type) { + continue; + } + + if (def.enum && !def.enum.includes(value)) { + continue; + } + + let prev = this.fields[name]; + this.fields[name] = value as any; + if (notify && !isDeepStrictEqual(value, prev)) { + this.dirty = true; + this.emit("fieldChanged", name, value, prev); + } + } } /** @@ -481,12 +344,12 @@ export class ConfigGroup { * @param location - Location used for access control. * @returns true if field is accessible */ - canAccess(name: string, location = this.config.location) { - let def = (this.constructor as typeof ConfigGroup)._definitions.get(name); + canAccess(name: string, location = this.location) { + let def = this.constructor.fieldDefinitions[name]; if (!def) { throw new InvalidField(`No field named '${name}'`); } - return this._checkAccess(def, location, false); + return this._checkAccess(name, def, location, false); } /** @@ -496,14 +359,14 @@ export class ConfigGroup { * @param location - Location used for access control. * @returns Value stored for the field. */ - get(name: string, location = this.config.location) { - let def = (this.constructor as typeof ConfigGroup)._definitions.get(name); + get(name: Field, location = this.location) { + let def = this.constructor.fieldDefinitions[name]; if (!def) { throw new InvalidField(`No field named '${name}'`); } - this._checkAccess(def, location, true); + this._checkAccess(name, def, location, true); - return this._fields.get(name); + return this.fields[name]; } /** @@ -513,17 +376,18 @@ export class ConfigGroup { * type checked against the field definition. * * @param name - Name of field to set. - * @param value - Value to set for field. + * @param newValue - Value to set for field. * @param location - Location used for access control. * @throws {InvalidField} if field is not defined. * @throws {InvalidValue} if value is not allowed for the field. */ - set(name: string, value: unknown, location = this.config.location) { - let def = (this.constructor as typeof ConfigGroup)._definitions.get(name); + set(name: Field, newValue: Fields[Field], location = this.location) { + let value: FieldValue = newValue; + let def = this.constructor.fieldDefinitions[name]; if (!def) { throw new InvalidField(`No field named '${name}'`); } - this._checkAccess(def, location, true); + this._checkAccess(name, def, location, true); // Empty strings are treates as null if (value === "") { @@ -566,11 +430,11 @@ export class ConfigGroup { throw new InvalidValue(`Expected type of ${name} to be ${def.type}, not ${basicType(value)}`); } - let prev = this._fields.get(name); - this._fields.set(name, value); - if (this.config && !isDeepStrictEqual(value, prev)) { - this.config.dirty = true; - this.config.emit("fieldChanged", this, name, prev); + let prev = this.fields[name]; + this.fields[name] = value as Fields[Field]; + if (!isDeepStrictEqual(value, prev)) { + this.dirty = true; + this.emit("fieldChanged", name, value, prev); } } @@ -587,18 +451,23 @@ export class ConfigGroup { * @throws {InvalidField} if field is not defined. * @throws {InvalidValue} if field is not an object. */ - setProp(name: string, prop: string, value: unknown, location = this.config.location) { - let def = (this.constructor as typeof ConfigGroup)._definitions.get(name); + setProp( + name: Field, + prop: string, + value: unknown, + location = this.location, + ) { + let def = this.constructor.fieldDefinitions[name]; if (!def) { throw new InvalidField(`No field named '${name}'`); } - this._checkAccess(def, location, true); + this._checkAccess(name, def, location, true); if (def.type !== "object") { throw new InvalidValue(`Cannot set property on non-object field '${name}'`); } - let prev = this._fields.get(name) as Record; + let prev = this.fields[name] as Record; let updated = {...prev || {}}; if (value !== undefined) { @@ -606,319 +475,10 @@ export class ConfigGroup { } else { delete updated[prop]; } - this._fields.set(name, updated); - if (this.config && !isDeepStrictEqual(updated, prev)) { - this.config.dirty = true; - this.config.emit("fieldChanged", this, name, prev); - } - } - - /** - * Update a config group from a serialized group - * - * Overwrites the values of all the fields in this config group that - * has a valid value in the passed serialized group with that value. - * - * @param serializedGroup - - * Result from a previous call to .serialize(). - * @param notify - Invoke fieldChanged events if true. - * @param location - Location used for access control. - */ - update( - serializedGroup: SerializedGroup, - notify: boolean, - location = this.config.location - ) { - if (basicType(serializedGroup) !== "object") { - throw new Error(`Expected object, not ${basicType(serializedGroup)} for ConfigGroup`); - } - - if (serializedGroup.name !== this.name) { - throw new Error(`Expected group name ${this.name}, not ${serializedGroup.name}`); - } - - if (basicType(serializedGroup.fields) !== "object") { - throw new Error(`Expected fields to be an object, not ${basicType(serializedGroup.fields)}`); - } - - for (let [name, value] of Object.entries(serializedGroup.fields)) { - let def = (this.constructor as typeof ConfigGroup)._definitions.get(name); - if (!def) { - this._unknownFields.set(name, value); - continue; - } - - if (!this._checkAccess(def, location, false)) { - continue; - } - - if (def.optional) { - if (value !== null && basicType(value) !== def.type) { - continue; - } - - } else if (basicType(value) !== def.type) { - continue; - } - - if (def.enum && !def.enum.includes(value)) { - continue; - } - - let prev = this._fields.get(name); - this._fields.set(name, value); - if (notify && this.config && !isDeepStrictEqual(value, prev)) { - this.config.dirty = true; - this.config.emit("fieldChanged", this, name, prev); - } - } - } - - /** - * Serialize the config to a plain JavaScript object - * - * @param location - Location used for access control. - * @returns JSON serializable representation of the group. - */ - serialize(location: ConfigLocation = this.config.location) { - let fields: Record = {}; - for (let [name, value] of this._fields) { - let def = (this.constructor as typeof ConfigGroup)._definitions.get(name)!; - if (!this._checkAccess(def, location, false)) { - continue; - } - - fields[name] = value; - } - - for (let [name, value] of this._unknownFields) { - fields[name] = value; - } - - return { - name: this.name, - fields, - }; - } - - static _initSubclass() { - // These properties are initialized here in order to ensure that - // they end up on the sub-class. - if (!this._initialized) { - this._initialized = true; - this._definitions = new Map(); - } - } - - /** - * Mapping of config name to field meta data - * - * Returns the internal meta data for the fields of this class. - * Note that mutating this object will lead to unexpected behaviour. - */ - static get definitions() { - this._initSubclass(); - return this._definitions; - } - - /** - * Define a new configuration field - * - * @param item - Field definition. - * @param item.access - - * Array of strings declaring where this config entry can be read - * and modified from. - * @param item.type - - * string declaring the type of the config value, supports - * boolean, string, number and object. - * @param item.name - - * Name of the configuration field. Should follow the - * lower_case_underscore style. - * @param item.title - - * Text used to identify the config field in user interfaces. - * @param item.description - - * Text used to describe the config field in user interfaces. - * @param item.enum - - * Array of all values that are acceptible. Useful for making - * enumerated values. - * @param item.restartRequired - - * True if a restart of the entity this config is attached to is - * required for changes to take effect. Informative only, defaults - * to false. - * @param item.restartRequiredProps - - * Properties to invert the value of restartRequired for if present. - * @param item.optional - - * True if this field can be set to null. Defaults to false. - * @param item.initial_value - - * Value this config field should take in a newly initialized - * config. This can also be an async function returning the - * value to use. - */ - // eslint-disable-next-line complexity - static define(item: { - access?: ConfigLocation[], - type: FieldType, - name: string, - title?: string, - description?: string, - enum?: unknown[], - restartRequired?: boolean, - restartRequiredProps?: string[], - optional?: boolean, - initial_value?: unknown | (() => unknown), - }) { - if (this._finalized) { - throw new Error(`Cannot define field for ConfigGroup class ${this.name} after it has been finalized`); - } - - if (basicType(this.groupName) !== "string") { - throw new Error(`Expected ConfigGroup class ${this.name} to have the groupName property set to a string`); - } - - this._initSubclass(); - - let itemKeys = Object.keys(item); - - // Check for required properties - ["name", "type"].forEach(prop => { - if (!itemKeys.includes(prop)) { - throw new Error(`${prop} is required when defining an field`); - } - }); - - // Validate properties - { - const { - type, access, enum: enum_, name, title, description, restartRequired, - restartRequiredProps, optional, initial_value, ...rest - } = item; - - let validTypes = ["boolean", "string", "number", "object"]; - if (type !== undefined) { - if (!validTypes.includes(type)) { - throw new Error(`${type} is not a valid type`); - } - } - - if (access !== undefined) { - if (basicType(access) !== "array") { - throw new Error("access must be an array"); - } - } - - if (enum_ !== undefined) { - if (basicType(enum_) !== "array") { - throw new Error("enum must be an array"); - } - } - - if (name !== undefined) { - if (typeof name !== "string") { - throw new Error("name must be a string"); - } - } - - if (title !== undefined) { - if (typeof title !== "string") { - throw new Error("title must be a string"); - } - } - - if (description !== undefined) { - if (typeof description !== "string") { - throw new Error("description must be a string"); - } - } - - if (restartRequired !== undefined) { - if (typeof restartRequired !== "boolean") { - throw new Error("restartRequired must be a boolean"); - } - } - - if (restartRequiredProps !== undefined) { - if (basicType(restartRequiredProps) !== "array") { - throw new Error("restartRequiredProps must be a array"); - } - } - - if (optional !== undefined) { - if (typeof optional !== "boolean") { - throw new Error("optional must be a boolean"); - } - } - - if (initial_value !== undefined) { - if (basicType(initial_value) !== item.type && basicType(initial_value) !== "function") { - throw new Error("initial_value must match the type or be a function"); - } - } - - for (let key of Object.keys(rest)) { - throw new Error(`Unknown property ${key}`); - } - } - - if (this._definitions.has(item.name)) { - throw new Error(`Config field ${item.name} has already been defined`); - } - - let computed: FieldDefinition = { - access: this.defaultAccess, - optional: false, - fullName: `${this.groupName}.${item.name}`, - restartRequired: false, - ...item, - }; - - if (item.restartRequiredProps && item.type !== "object") { - throw new Error("restartRequiredProps is only allowed if type is object"); - } - - if (!computed.access) { - throw new Error(`access not set and no defaultAccess defined for ${this.name}`); - } - - if (!computed.optional && computed.initial_value === undefined) { - throw new Error(`Non-optional field ${item.name} needs an initial_value`); - } - - this._definitions.set(item.name, computed); - } - - /** - * Locks this ConfigGroup class from adding more definitons. - */ - static finalize() { - if (basicType(this.groupName) !== "string") { - throw new Error(`Expected ConfigGroup class ${this.name} to have the groupName property set to a string`); - } - - this._initSubclass(); - this._finalized = true; - } -} - -/** - * Config group for plugins - * - * Grouping that includes per plugin fields clusterio uses to manage - * plugins. This is currently only the enabled field. It is otherwise - * identical to the ConfigGroup class. - * - * @extends ConfigGroup - */ -export class PluginConfigGroup extends ConfigGroup { - static _initSubclass() { - if (!this._initialized) { - super._initSubclass(); - this.define({ - name: "load_plugin", - title: "Load Plugin", - restartRequired: true, - type: "boolean", - initial_value: true, - }); + this.fields[name] = updated as Fields[Field]; + if (!isDeepStrictEqual(updated, prev)) { + this.dirty = true; + this.emit("fieldChanged", name, updated, prev); } } } diff --git a/packages/lib/src/config/definitions.ts b/packages/lib/src/config/definitions.ts index 098e8522..eb5dbb51 100644 --- a/packages/lib/src/config/definitions.ts +++ b/packages/lib/src/config/definitions.ts @@ -3,565 +3,469 @@ import * as classes from "./classes"; import type { PluginNodeEnvInfo, PluginWebpackEnvInfo } from "../plugin"; -/** - * Controller config group for {@link ControllerConfig} - * @extends classes.ConfigGroup - */ -export class ControllerGroup extends classes.ConfigGroup { } -ControllerGroup.defaultAccess = ["controller", "host", "control"]; -ControllerGroup.groupName = "controller"; -ControllerGroup.define({ - name: "name", - title: "Name", - description: "Name of the cluster.", - type: "string", - initial_value: "Your Cluster", -}); -ControllerGroup.define({ - name: "mods_directory", - title: "Mods Directory", - description: "Path to directory where mods shared with the cluster are stored.", - restartRequired: true, - type: "string", - initial_value: "mods", -}); -ControllerGroup.define({ - name: "database_directory", - title: "Database directory", - description: "Directory where item and configuration data is stored.", - type: "string", - initial_value: "database", -}); -ControllerGroup.define({ - name: "autosave_interval", - title: "Autosave Interval", - description: "Interval in seconds to autosave data in memory to disk.", - type: "number", - initial_value: 60, -}); -ControllerGroup.define({ - name: "http_port", - title: "HTTP Port", - description: "Port to listen for HTTP connections on, set to null to not listen for HTTP connections.", - restartRequired: true, - type: "number", - optional: true, - initial_value: 8080, -}); -ControllerGroup.define({ - name: "https_port", - title: "HTTPS Port", - description: "Port to listen for HTTPS connection on, set to null to not listen for HTTPS connections.", - restartRequired: true, - type: "number", - optional: true, -}); -ControllerGroup.define({ - name: "bind_address", - title: "Bind Address", - description: "IP address to bind the HTTP and HTTPS ports on.", - restartRequired: true, - type: "string", - optional: true, -}); -ControllerGroup.define({ - name: "external_address", - title: "External Address", - description: "Public facing address the controller is hosted on.", - type: "string", - optional: true, -}); -ControllerGroup.define({ - name: "tls_certificate", - title: "TLS Certificate", - description: "Path to the certificate to use for HTTPS.", - restartRequired: true, - type: "string", - optional: true, -}); -ControllerGroup.define({ - name: "tls_private_key", - title: "TLS Private Key", - description: "Path to the private key to use for HTTPS.", - restartRequired: true, - type: "string", - optional: true, -}); -ControllerGroup.define({ - access: ["controller"], - name: "auth_secret", - title: "Controller Authentication Secret", - description: - "Secret used to generate and verify authentication tokens. " + - "Should be a long string of random letters and numbers. " + - "Do not share this.", - restartRequired: true, - type: "string", - optional: true, -}); -ControllerGroup.define({ - name: "heartbeat_interval", - title: "Heartbeat Interval", - description: "Interval heartbeats are sent out on WebSocket connections.", - type: "number", - initial_value: 15, -}); -ControllerGroup.define({ - name: "session_timeout", - title: "Session Timeout", - description: "Time in seconds before giving up resuming a dropped WebSocket session.", - type: "number", - initial_value: 60, -}); -ControllerGroup.define({ - name: "metrics_timeout", - title: "Metrics Timeout", - description: "Timeout in seconds for metrics gathering from hosts.", - type: "number", - initial_value: 8, -}); -ControllerGroup.define({ - name: "proxy_stream_timeout", - title: "Proxy Stream Timeout", - description: "Timeout in seconds for proxy streams to start flowing.", - type: "number", - initial_value: 15, -}); -ControllerGroup.define({ - name: "default_mod_pack_id", - title: "Default Mod Pack", - description: "Mod pack used by default for instances.", - type: "number", - optional: true, -}); -ControllerGroup.define({ - name: "default_role_id", - title: "Default role", - description: "ID of role assigned by default to new users.", - type: "number", - optional: true, - initial_value: 1, -}); -ControllerGroup.finalize(); +export interface ControllerConfigFields { + "controller.name": string; + "controller.mods_directory": string; + "controller.database_directory": string; + "controller.http_port": number | null; + "controller.https_port": number | null; + "controller.bind_address": string | null; + "controller.external_address": string | null; + "controller.tls_certificate": string | null; + "controller.tls_private_key": string | null; + "controller.auth_secret": string; + "controller.heartbeat_interval": number; + "controller.session_timeout": number; + "controller.metrics_timeout": number; + "controller.proxy_stream_timeout": number; + "controller.default_mod_pack_id": number | null; + "controller.default_role_id": number | null; + "controller.autosave_interval": number; +} /** * Controller Config class * @extends classes.Config */ -export class ControllerConfig extends classes.Config { - get(name: "controller.name"): string; - get(name: "controller.mods_directory"): string; - get(name: "controller.database_directory"): string; - get(name: "controller.http_port"): number | null; - get(name: "controller.https_port"): number | null; - get(name: "controller.bind_address"): string | null; - get(name: "controller.external_address"): string | null; - get(name: "controller.tls_certificate"): string | null; - get(name: "controller.tls_private_key"): string | null; - get(name: "controller.auth_secret"): string; - get(name: "controller.heartbeat_interval"): number; - get(name: "controller.session_timeout"): number; - get(name: "controller.metrics_timeout"): number; - get(name: "controller.proxy_stream_timeout"): number; - get(name: "controller.default_mod_pack_id"): number | null; - get(name: "controller.default_role_id"): number | null; - get(name: "controller.autosave_interval"): number; - get(name: string): unknown; - get(name: string) { - return super.get(name); - } +export class ControllerConfig extends classes.Config { + declare static fromJSON: (json: classes.ConfigSchema, location: classes.ConfigLocation) => ControllerConfig; + static fieldDefinitions: classes.ConfigDefs = { + "controller.name": { + title: "Name", + description: "Name of the cluster.", + type: "string", + initialValue: "Your Cluster", + }, + "controller.mods_directory": { + title: "Mods Directory", + description: "Path to directory where mods shared with the cluster are stored.", + restartRequired: true, + type: "string", + initialValue: "mods", + }, + "controller.database_directory": { + title: "Database directory", + description: "Directory where item and configuration data is stored.", + type: "string", + initialValue: "database", + }, + "controller.autosave_interval": { + title: "Autosave Interval", + description: "Interval in seconds to autosave data in memory to disk.", + type: "number", + initialValue: 60, + }, + "controller.http_port": { + title: "HTTP Port", + description: "Port to listen for HTTP connections on, set to null to not listen for HTTP connections.", + restartRequired: true, + type: "number", + optional: true, + initialValue: 8080, + }, + "controller.https_port": { + title: "HTTPS Port", + description: "Port to listen for HTTPS connection on, set to null to not listen for HTTPS connections.", + restartRequired: true, + type: "number", + optional: true, + }, + "controller.bind_address": { + title: "Bind Address", + description: "IP address to bind the HTTP and HTTPS ports on.", + restartRequired: true, + type: "string", + optional: true, + }, + "controller.external_address": { + title: "External Address", + description: "Public facing address the controller is hosted on.", + type: "string", + optional: true, + }, + "controller.tls_certificate": { + title: "TLS Certificate", + description: "Path to the certificate to use for HTTPS.", + restartRequired: true, + type: "string", + optional: true, + }, + "controller.tls_private_key": { + title: "TLS Private Key", + description: "Path to the private key to use for HTTPS.", + restartRequired: true, + type: "string", + optional: true, + }, + "controller.auth_secret": { + access: ["controller"], + title: "Controller Authentication Secret", + description: + "Secret used to generate and verify authentication tokens. " + + "Should be a long string of random letters and numbers. " + + "Do not share this.", + restartRequired: true, + type: "string", + optional: true, + }, + "controller.heartbeat_interval": { + title: "Heartbeat Interval", + description: "Interval heartbeats are sent out on WebSocket connections.", + type: "number", + initialValue: 15, + }, + "controller.session_timeout": { + title: "Session Timeout", + description: "Time in seconds before giving up resuming a dropped WebSocket session.", + type: "number", + initialValue: 60, + }, + "controller.metrics_timeout": { + title: "Metrics Timeout", + description: "Timeout in seconds for metrics gathering from hosts.", + type: "number", + initialValue: 8, + }, + "controller.proxy_stream_timeout": { + title: "Proxy Stream Timeout", + description: "Timeout in seconds for proxy streams to start flowing.", + type: "number", + initialValue: 15, + }, + "controller.default_mod_pack_id": { + title: "Default Mod Pack", + description: "Mod pack used by default for instances.", + type: "number", + optional: true, + }, + "controller.default_role_id": { + title: "Default role", + description: "ID of role assigned by default to new users.", + type: "number", + optional: true, + initialValue: 1, + }, + }; } -ControllerConfig.registerGroup(ControllerGroup); - -/** - * Host config group for {@link HostConfig} - * @extends classes.ConfigGroup - */ -export class HostGroup extends classes.ConfigGroup {} -HostGroup.defaultAccess = ["controller", "host", "control"]; -HostGroup.groupName = "host"; -HostGroup.define({ - name: "name", - description: "Name of the host", - type: "string", - initial_value: "New Host", -}); -HostGroup.define({ - name: "id", - description: "ID of the host", - type: "number", - initial_value: () => Math.random() * 2**31 | 0, -}); -HostGroup.define({ - name: "factorio_directory", - description: "Path to directory to look for factorio installs", - type: "string", - initial_value: "factorio", -}); -HostGroup.define({ - name: "mods_directory", - title: "Mods Directory", - description: "Path to directory where mods for instances are cached.", - restartRequired: true, - type: "string", - initial_value: "mods", -}); -HostGroup.define({ - name: "instances_directory", - description: "Path to directory to store instances in.", - restartRequired: true, - type: "string", - initial_value: "instances", -}); -HostGroup.define({ - name: "controller_url", - description: "URL to connect to the controller at", - restartRequired: true, - type: "string", - initial_value: "http://localhost:8080/", -}); -HostGroup.define({ - name: "controller_token", - description: "Token to authenticate to controller with.", - restartRequired: true, - type: "string", - initial_value: "enter token here", -}); -HostGroup.define({ - name: "tls_ca", - description: "Path to Certificate Authority to validate TLS connection to controller against.", - restartRequired: true, - type: "string", - optional: true, -}); -HostGroup.define({ - name: "public_address", - description: "Public facing address players should connect to in order to join instances on this host", - type: "string", - initial_value: "localhost", -}); -HostGroup.define({ - name: "max_reconnect_delay", - title: "Max Reconnect Delay", - description: "Maximum delay to wait before attempting to reconnect WebSocket", - type: "number", - initial_value: 60, -}); -HostGroup.finalize(); +export interface HostConfigFields { + "host.name": string; + "host.id": number; + "host.factorio_directory": string; + "host.mods_directory": string; + "host.instances_directory": string; + "host.controller_url": string; + "host.controller_token": string; + "host.tls_ca": string | null; + "host.public_address": string; + "host.max_reconnect_delay": number; +} /** * Host Config class * @extends classes.Config */ -export class HostConfig extends classes.Config { - get(name: "host.name"): string; - get(name: "host.id"): number; - get(name: "host.factorio_directory"): string; - get(name: "host.mods_directory"): string; - get(name: "host.instances_directory"): string; - get(name: "host.controller_url"): string; - get(name: "host.controller_token"): string; - get(name: "host.tls_ca"): string | null; - get(name: "host.public_address"): string; - get(name: "host.max_reconnect_delay"): number; - get(name: string): unknown; - get(name: string) { - return super.get(name); - } +export class HostConfig extends classes.Config { + declare static fromJSON: (json: classes.ConfigSchema, location: classes.ConfigLocation) => HostConfig; + static fieldDefinitions: classes.ConfigDefs = { + "host.name": { + description: "Name of the host", + type: "string", + initialValue: "New Host", + }, + "host.id": { + description: "ID of the host", + type: "number", + initialValue: () => Math.random() * 2**31 | 0, + }, + "host.factorio_directory": { + description: "Path to directory to look for factorio installs", + type: "string", + initialValue: "factorio", + }, + "host.mods_directory": { + title: "Mods Directory", + description: "Path to directory where mods for instances are cached.", + restartRequired: true, + type: "string", + initialValue: "mods", + }, + "host.instances_directory": { + description: "Path to directory to store instances in.", + restartRequired: true, + type: "string", + initialValue: "instances", + }, + "host.controller_url": { + description: "URL to connect to the controller at", + restartRequired: true, + type: "string", + initialValue: "http://localhost:8080/", + }, + "host.controller_token": { + access: ["host"], + description: "Token to authenticate to controller with.", + restartRequired: true, + type: "string", + initialValue: "enter token here", + }, + "host.tls_ca": { + description: "Path to Certificate Authority to validate TLS connection to controller against.", + restartRequired: true, + type: "string", + optional: true, + }, + "host.public_address": { + description: "Public facing address players should connect to in order to join instances on this host", + type: "string", + initialValue: "localhost", + }, + "host.max_reconnect_delay": { + title: "Max Reconnect Delay", + description: "Maximum delay to wait before attempting to reconnect WebSocket", + type: "number", + initialValue: 60, + }, + }; } -HostConfig.registerGroup(HostGroup); +export interface InstanceConfigFields { + "instance.name": string; + "instance.id": number; + "instance.assigned_host": number | null; + "instance.auto_start": boolean; -/** - * Instance config group for {@link classes.InstanceConfig} - * @extends classes.ConfigGroup - */ -export class InstanceGroup extends classes.ConfigGroup { } -InstanceGroup.defaultAccess = ["controller", "host", "control"]; -InstanceGroup.groupName = "instance"; -InstanceGroup.define({ - name: "name", - type: "string", - initial_value: "New Instance", -}); -InstanceGroup.define({ - name: "id", - description: "ID of the instance", - type: "number", - initial_value: () => Math.random() * 2**31 | 0, -}); -InstanceGroup.define({ - name: "assigned_host", - type: "number", - optional: true, -}); -InstanceGroup.define({ - name: "auto_start", - description: "Automatically start this instance when the host hosting it is started up", - type: "boolean", - initial_value: false, -}); -InstanceGroup.finalize(); + "factorio.version": string; + "factorio.game_port": number | null; + "factorio.rcon_port": number | null; + "factorio.rcon_password": string | null; + "factorio.player_online_autosave_slots": number; + "factorio.mod_pack": number | null; + "factorio.enable_save_patching": boolean; + "factorio.enable_whitelist": boolean; + "factorio.enable_authserver_bans": boolean; + "factorio.settings": Record; + "factorio.verbose_logging": boolean; + "factorio.strip_paths": boolean; + "factorio.sync_adminlist": boolean; + "factorio.sync_whitelist": boolean; + "factorio.sync_banlist": boolean; + "factorio.max_concurrent_commands": number; +} -/** - * Factorio config group for {@link classes.InstanceConfig} - * @extends classes.ConfigGroup - */ -export class FactorioGroup extends classes.ConfigGroup { } -FactorioGroup.defaultAccess = ["controller", "host", "control"]; -FactorioGroup.groupName = "factorio"; -FactorioGroup.define({ - name: "version", - description: "Version of the game to run, use latest to run the latest installed version", - restartRequired: true, - type: "string", - initial_value: "latest", -}); -FactorioGroup.define({ - name: "game_port", - description: "UDP port to run game on, uses a random port if null", - restartRequired: true, - type: "number", - optional: true, -}); -FactorioGroup.define({ - name: "rcon_port", - description: "TCP port to run RCON on, uses a random port if null", - restartRequired: true, - type: "number", - optional: true, -}); -FactorioGroup.define({ - name: "rcon_password", - description: "Password for RCON, randomly generated if null", - restartRequired: true, - type: "string", - optional: true, -}); -FactorioGroup.define({ - name: "player_online_autosave_slots", - description: - "Rename autosaves where players have been online since the previous autosave into a separate autosave " + - "pool with this many slots. Requires autosaves to be enabled to work. Set to 0 to disable.", - type: "number", - initial_value: 5, -}); -FactorioGroup.define({ - name: "mod_pack", - description: "Mod pack to use on this server", - restartRequired: true, - type: "number", - optional: true, -}); -FactorioGroup.define({ - name: "enable_save_patching", - description: "Patch saves with Lua code. Required for Clusterio integrations, lua modules, and most plugins.", - restartRequired: true, - type: "boolean", - initial_value: true, -}); -FactorioGroup.define({ - name: "enable_whitelist", - description: "Turn on whitelist for joining the server.", - type: "boolean", - initial_value: false, -}); -FactorioGroup.define({ - name: "enable_authserver_bans", - description: "Turn on Factorio.com based multiplayer bans.", - restartRequired: true, - type: "boolean", - initial_value: false, -}); -FactorioGroup.define({ - name: "settings", - description: "Settings overridden in server-settings.json", - restartRequired: true, - restartRequiredProps: [ - "afk_autokick_interval", "allow_commands", "autosave_interval", "autosave_only_on_server", "description", - "ignore_player_limit_for_returning_players", "max_players", "max_upload_slots", - "max_upload_in_kilobytes_per_second", "name", "only_admins_can_pause_the_game", "game_password", - "require_user_verification", "tags", "visibility", - ], - type: "object", - initial_value: {}, // See create instance handler in controller. -}); -FactorioGroup.define({ - name: "verbose_logging", - description: "Enable verbose logging on the Factorio server", - restartRequired: true, - type: "boolean", - initial_value: false, -}); -FactorioGroup.define({ - name: "strip_paths", - description: "Strip down instance paths in the log", - restartRequired: true, - type: "boolean", - initial_value: true, -}); -FactorioGroup.define({ - name: "sync_adminlist", - description: "Synchronize adminlist with controller", - type: "boolean", - initial_value: true, -}); -FactorioGroup.define({ - name: "sync_whitelist", - description: "Synchronize whitelist with controller", - type: "boolean", - initial_value: true, -}); -FactorioGroup.define({ - name: "sync_banlist", - description: "Synchronize banlist with controller", - type: "boolean", - initial_value: true, -}); -FactorioGroup.define({ - name: "max_concurrent_commands", - description: "Maximum number of RCON commands trasmitted in parallel", - restartRequired: true, - type: "number", - initial_value: 5, -}); -FactorioGroup.finalize(); /** * Instance config class * @extends classes.Config */ -export class InstanceConfig extends classes.Config { - get(name: "instance.name"): string; - get(name: "instance.id"): number; - get(name: "instance.assigned_host"): number | null; - get(name: "instance.auto_start"): boolean; - - get(name: "factorio.version"): string; - get(name: "factorio.game_port"): number | null; - get(name: "factorio.rcon_port"): number | null; - get(name: "factorio.rcon_password"): string | null; - get(name: "factorio.player_online_autosave_slots"): number; - get(name: "factorio.mod_pack"): number | null; - get(name: "factorio.enable_save_patching"): boolean; - get(name: "factorio.enable_whitelist"): boolean; - get(name: "factorio.enable_authserver_bans"): boolean; - get(name: "factorio.settings"): Record; - get(name: "factorio.verbose_logging"): boolean; - get(name: "factorio.strip_paths"): boolean; - get(name: "factorio.sync_adminlist"): boolean; - get(name: "factorio.sync_whitelist"): boolean; - get(name: "factorio.sync_banlist"): boolean; - get(name: "factorio.max_concurrent_commands"): number; - get(name: string): unknown; - get(name: string) { - return super.get(name); - } +export class InstanceConfig extends classes.Config { + declare static fromJSON: (json: classes.ConfigSchema, location: classes.ConfigLocation) => InstanceConfig; + static fieldDefinitions: classes.ConfigDefs = { + "instance.name": { + type: "string", + initialValue: "New Instance", + }, + "instance.id": { + description: "ID of the instance", + type: "number", + initialValue: () => Math.random() * 2**31 | 0, + }, + "instance.assigned_host": { + type: "number", + optional: true, + }, + "instance.auto_start": { + description: "Automatically start this instance when the host hosting it is started up", + type: "boolean", + initialValue: false, + }, + "factorio.version": { + description: "Version of the game to run, use latest to run the latest installed version", + restartRequired: true, + type: "string", + initialValue: "latest", + }, + "factorio.game_port": { + description: "UDP port to run game on, uses a random port if null", + restartRequired: true, + type: "number", + optional: true, + }, + "factorio.rcon_port": { + description: "TCP port to run RCON on, uses a random port if null", + restartRequired: true, + type: "number", + optional: true, + }, + "factorio.rcon_password": { + description: "Password for RCON, randomly generated if null", + restartRequired: true, + type: "string", + optional: true, + }, + "factorio.player_online_autosave_slots": { + description: + "Rename autosaves where players have been online since the previous autosave into a separate " + + "autosave pool with this many slots. Requires autosaves to be enabled to work. Set to 0 to disable.", + type: "number", + initialValue: 5, + }, + "factorio.mod_pack": { + description: "Mod pack to use on this server", + restartRequired: true, + type: "number", + optional: true, + }, + "factorio.enable_save_patching": { + description: + "Patch saves with Lua code. Required for Clusterio integrations, lua modules, and most plugins.", + restartRequired: true, + type: "boolean", + initialValue: true, + }, + "factorio.enable_whitelist": { + description: "Turn on whitelist for joining the server.", + type: "boolean", + initialValue: false, + }, + "factorio.enable_authserver_bans": { + description: "Turn on Factorio.com based multiplayer bans.", + restartRequired: true, + type: "boolean", + initialValue: false, + }, + "factorio.settings": { + description: "Settings overridden in server-settings.json", + restartRequired: true, + restartRequiredProps: [ + "afk_autokick_interval", "allow_commands", "autosave_interval", "autosave_only_on_server", + "description", "ignore_player_limit_for_returning_players", "max_players", "max_upload_slots", + "max_upload_in_kilobytes_per_second", "name", "only_admins_can_pause_the_game", "game_password", + "require_user_verification", "tags", "visibility", + ], + type: "object", + initialValue: {}, // See create instance handler in controller. + }, + "factorio.verbose_logging": { + description: "Enable verbose logging on the Factorio server", + restartRequired: true, + type: "boolean", + initialValue: false, + }, + "factorio.strip_paths": { + description: "Strip down instance paths in the log", + restartRequired: true, + type: "boolean", + initialValue: true, + }, + "factorio.sync_adminlist": { + description: "Synchronize adminlist with controller", + type: "boolean", + initialValue: true, + }, + "factorio.sync_whitelist": { + description: "Synchronize whitelist with controller", + type: "boolean", + initialValue: true, + }, + "factorio.sync_banlist": { + description: "Synchronize banlist with controller", + type: "boolean", + initialValue: true, + }, + "factorio.max_concurrent_commands": { + description: "Maximum number of RCON commands trasmitted in parallel", + restartRequired: true, + type: "number", + initialValue: 5, + }, + }; } -InstanceConfig.registerGroup(InstanceGroup); -InstanceConfig.registerGroup(FactorioGroup); - -/** - * Control config group for {@link classes.ControlConfig} - * @extends classes.ConfigGroup - */ -export class ControlGroup extends classes.ConfigGroup {} -ControlGroup.defaultAccess = ["control"]; -ControlGroup.groupName = "control"; -ControlGroup.define({ - name: "controller_url", - description: "URL to connect to the controller at", - type: "string", - optional: true, -}); -ControlGroup.define({ - name: "controller_token", - description: "Token to authenticate to controller with.", - type: "string", - optional: true, -}); -ControlGroup.define({ - name: "tls_ca", - description: "Path to Certificate Authority to validate TLS connection to controller against.", - type: "string", - optional: true, -}); -ControlGroup.define({ - name: "max_reconnect_delay", - title: "Max Reconnect Delay", - description: "Maximum delay to wait before attempting to reconnect WebSocket", - type: "number", - initial_value: 60, -}); -ControlGroup.finalize(); +export interface ControlConfigFields { + "control.controller_url": string | null; + "control.controller_token": string | null; + "control.tls_ca": string | null; + "control.max_reconnect_delay": number; +} /** * Control config class * @extends classes.Config */ -export class ControlConfig extends classes.Config { } -ControlConfig.registerGroup(ControlGroup); +export class ControlConfig extends classes.Config { + declare static fromJSON: (json: classes.ConfigSchema, location: classes.ConfigLocation) => ControlConfig; + static fieldDefinitions: classes.ConfigDefs = { + "control.controller_url": { + description: "URL to connect to the controller at", + type: "string", + optional: true, + }, + "control.controller_token": { + access: ["control"], + description: "Token to authenticate to controller with.", + type: "string", + optional: true, + }, + "control.tls_ca": { + description: "Path to Certificate Authority to validate TLS connection to controller against.", + type: "string", + optional: true, + }, + "control.max_reconnect_delay": { + title: "Max Reconnect Delay", + description: "Maximum delay to wait before attempting to reconnect WebSocket", + type: "number", + initialValue: 60, + }, + }; +} -function validateGroup( - pluginInfo: PluginNodeEnvInfo | PluginWebpackEnvInfo, - groupName: "ControllerConfigGroup" | "HostConfigGroup" | "InstanceConfigGroup", +function validateFields( + pluginName: string, + fields: Record, ) { - if (!(pluginInfo[groupName]?.prototype instanceof classes.PluginConfigGroup)) { - throw new Error( - `Expected ${groupName} for ${pluginInfo.name} to be a subclass of PluginConfigGroup` - ); - } - - if (pluginInfo[groupName]?.groupName !== pluginInfo.name) { - throw new Error( - `Expected ${groupName} for ${pluginInfo.name} to be named after the plugin` - ); + for (const [name, field] of Object.entries(fields)) { + if (!name.startsWith(`${pluginName}.`)) { + throw new Error( + `Expected name of config field '${name}' for ${pluginName} to start with '${pluginName}.'` + ); + } } } /** - * Registers the config groups for the provided plugin infos + * Add config fields defined by the provided plugin infos * * @param {Array} pluginInfos - Array of plugin info objects. */ -export function registerPluginConfigGroups(pluginInfos: PluginNodeEnvInfo[] | PluginWebpackEnvInfo[]) { +export function addPluginConfigFields(pluginInfos: PluginNodeEnvInfo[] | PluginWebpackEnvInfo[]) { function pluginConfig( pluginInfo: PluginNodeEnvInfo | PluginWebpackEnvInfo, - group: "ControllerConfigGroup" | "HostConfigGroup" | "InstanceConfigGroup", - Config: typeof classes.Config, + kind: "controllerConfigFields" | "hostConfigFields" | "instanceConfigFields", + Config: typeof ControllerConfig | typeof HostConfig | typeof InstanceConfig, ) { - if (pluginInfo[group]) { - validateGroup(pluginInfo, group); - Config.registerGroup(pluginInfo[group]!); + (Config.fieldDefinitions as any)[`${pluginInfo.name}.load_plugin`] = { + title: "Load Plugin", + restartRequired: true, + type: "boolean", + initialValue: true, + }; - } else { - class ConfigGroup extends classes.PluginConfigGroup { } - ConfigGroup.defaultAccess = ["controller", "host", "control"]; - ConfigGroup.groupName = pluginInfo.name; - ConfigGroup.finalize(); - Config.registerGroup(ConfigGroup); + const fields = pluginInfo[kind]; + if (fields) { + validateFields(pluginInfo.name, fields); + Object.assign(Config.fieldDefinitions, fields); } } for (let pluginInfo of pluginInfos) { - pluginConfig(pluginInfo, "ControllerConfigGroup", ControllerConfig); + pluginConfig(pluginInfo, "controllerConfigFields", ControllerConfig); if (pluginInfo.hostEntrypoint || pluginInfo.instanceEntrypoint) { - pluginConfig(pluginInfo, "HostConfigGroup", HostConfig); + pluginConfig(pluginInfo, "hostConfigFields", HostConfig); } if (pluginInfo.instanceEntrypoint) { - pluginConfig(pluginInfo, "InstanceConfigGroup", InstanceConfig); + pluginConfig(pluginInfo, "instanceConfigFields", InstanceConfig); } } } - -/** - * Lock configs from adding more groups and make them usable - */ -export function finalizeConfigs() { - ControllerConfig.finalize(); - HostConfig.finalize(); - InstanceConfig.finalize(); - ControlConfig.finalize(); -} diff --git a/packages/lib/src/data/composites.ts b/packages/lib/src/data/composites.ts index c4f912ef..ccf28b9f 100644 --- a/packages/lib/src/data/composites.ts +++ b/packages/lib/src/data/composites.ts @@ -1,4 +1,4 @@ -import { Type } from "@sinclair/typebox"; +import { Static, TSchema, Type } from "@sinclair/typebox"; export function StringEnum(values: [...T]) { return Type.Unsafe({ type: "string", enum: values }); @@ -32,3 +32,12 @@ export function jsonPrimitive(type: U) { export const JsonBoolean = jsonPrimitive("boolean"); export const JsonNumber = jsonPrimitive("number"); export const JsonString = jsonPrimitive("string"); + +export function plainJson(schema: T) { + return { + jsonSchema: schema, + fromJSON(json: Static) { + return json; + }, + }; +} diff --git a/packages/lib/src/data/messages_controller.ts b/packages/lib/src/data/messages_controller.ts index 5a0aefc8..d4a7d6f5 100644 --- a/packages/lib/src/data/messages_controller.ts +++ b/packages/lib/src/data/messages_controller.ts @@ -1,7 +1,7 @@ import { Type, Static } from "@sinclair/typebox"; -import { JsonString, StringEnum } from "./composites"; +import { JsonString, StringEnum, plainJson } from "./composites"; import { levels } from "../logging"; -import { RawConfig } from "../config"; +import { ControllerConfig, HostConfig } from "../config"; export class ControllerConfigGetRequest { declare ["constructor"]: typeof ControllerConfigGetRequest; @@ -9,7 +9,7 @@ export class ControllerConfigGetRequest { static src = "control" as const; static dst = "controller" as const; static permission = "core.controller.get_config" as const; - static Response = RawConfig; + static Response = plainJson(ControllerConfig.jsonSchema); } export class ControllerConfigSetFieldRequest { @@ -103,7 +103,7 @@ export class HostConfigCreateRequest { return new this(json.id, json.name, json.generateToken); } - static Response = RawConfig; + static Response = plainJson(HostConfig.jsonSchema); } export class LogSetSubscriptionsRequest { diff --git a/packages/lib/src/data/messages_instance.ts b/packages/lib/src/data/messages_instance.ts index dbc32be1..b943ea6c 100644 --- a/packages/lib/src/data/messages_instance.ts +++ b/packages/lib/src/data/messages_instance.ts @@ -1,7 +1,7 @@ import { Type, Static } from "@sinclair/typebox"; import PlayerStats from "./PlayerStats"; -import { JsonString, StringEnum, jsonArray } from "./composites"; -import { RawConfig } from "../config"; +import { JsonString, StringEnum, jsonArray, plainJson } from "./composites"; +import { InstanceConfig } from "../config"; import type { IControllerUser } from "./User"; import type { MessageRequest } from "./messages_core"; import { CollectorResultSerialized } from "../prometheus"; @@ -133,15 +133,14 @@ export class InstanceCreateRequest { static permission = "core.instance.create" as const; constructor( - public config: object, + public config: Static, ) { } static jsonSchema = Type.Object({ - "config": Type.Object({}), + "config": InstanceConfig.jsonSchema, }); static fromJSON(json: Static) { - // TODO deserialise config here after config refactor return new this(json.config); } } @@ -152,8 +151,7 @@ export class InstanceConfigGetRequest { static src = "control" as const; static dst = "controller" as const; static permission = "core.instance.get_config" as const; - // TODO replace with InstanceConfig after config refactor - static Response = RawConfig; + static Response = plainJson(InstanceConfig.jsonSchema); constructor( public instanceId: number, @@ -714,17 +712,15 @@ export class InstanceSendRconRequest { static Response = JsonString; } -// TODO remove this after config refactor -export class RawInstanceInfo { - +export class HostInstanceUpdate { constructor( - public config: object, + public config: Static, public status: InstanceStatus, public gamePort: undefined | number, ) { } static jsonSchema = Type.Object({ - "config": Type.Object({}), + "config": InstanceConfig.jsonSchema, "status": StringEnum([ "stopped", "starting", "running", "stopping", "creating_save", "exporting_data", ]), @@ -743,17 +739,17 @@ export class InstancesUpdateRequest { static dst = "controller" as const; constructor( - public instances: RawInstanceInfo[], + public instances: HostInstanceUpdate[], ) { } - static jsonSchema = Type.Array(RawInstanceInfo.jsonSchema); + static jsonSchema = Type.Array(HostInstanceUpdate.jsonSchema); toJSON() { return this.instances; } static fromJSON(json: Static) { - return new this(json.map(i => RawInstanceInfo.fromJSON(i))); + return new this(json.map(i => HostInstanceUpdate.fromJSON(i))); } } @@ -765,16 +761,15 @@ export class InstanceAssignInternalRequest { constructor( public instanceId: number, - public config: object, + public config: Static, ) { } static jsonSchema = Type.Object({ "instanceId": Type.Integer(), - "config": Type.Object({}), + "config": InstanceConfig.jsonSchema, }); static fromJSON(json: Static) { - // TODO deserialise config here after config refactor return new this(json.instanceId, json.config); } } diff --git a/packages/lib/src/helpers.ts b/packages/lib/src/helpers.ts index c9589d92..b322cf7c 100644 --- a/packages/lib/src/helpers.ts +++ b/packages/lib/src/helpers.ts @@ -177,6 +177,25 @@ export async function readStream(stream: NodeJS.ReadableStream & { isTTY?: boole return Buffer.concat(chunks); } +/** + * Split the given string on the first instance of separator + * + * Splits `string` on the first instance of `separator` and returns an + * array consisting of the string up to the separator and the string + * after the separator. Returns an array with the string and an empty + * string if the separator is not present. + * + * @param separator - Separator to split string by. + * @param string - String to split + * @returns string split on separator. + */ +export function splitOn(separator: string, string: string) { + let index = string.indexOf(separator); + if (index === -1) { + return [string, ""]; + } + return [string.slice(0, index), string.slice(index + separator.length)]; +} /** * Escapes text for inclusion in a RegExp diff --git a/packages/lib/src/plugin.ts b/packages/lib/src/plugin.ts index 6cf323af..a08cac9a 100644 --- a/packages/lib/src/plugin.ts +++ b/packages/lib/src/plugin.ts @@ -4,7 +4,7 @@ */ import * as libHelpers from "./helpers"; import type { Logger } from "./logging"; -import type { PluginConfigGroup } from "./config"; +import type { FieldDefinition } from "./config"; import type { PlayerStats } from "./data"; // TODO Add proper typing for plugins @@ -15,17 +15,17 @@ export type PluginDeclaration = { description?: string; controllerEntrypoint?: string; - ControllerConfigGroup?: typeof PluginConfigGroup; + controllerConfigFields?: Record; hostEntrypoint?: string; - HostConfigGroup?: typeof PluginConfigGroup; + hostConfigFields?: Record; instanceEntrypoint?: string; - InstanceConfigGroup?: typeof PluginConfigGroup; + instanceConfigFields?: Record; ctlEntrypoint?: string; webEntrypoint?: string; - ControlConfigGroup?: typeof PluginConfigGroup; + controlConfigFields?: Record; messages?: any[]; routes?: string[]; diff --git a/packages/lib/src/shared_commands.ts b/packages/lib/src/shared_commands.ts index 801f54e0..6b9ea138 100644 --- a/packages/lib/src/shared_commands.ts +++ b/packages/lib/src/shared_commands.ts @@ -128,17 +128,14 @@ export function configCommand(yargs: any) { */ export async function handleConfigCommand( args: Record, - instance: libConfig.Config, + instance: libConfig.Config, configPath: string ) { let command = (args._ as string[])[1]; if (command === "list") { - for (let GroupClass of (instance.constructor as typeof libConfig.Config).groups.values()) { - for (let def of GroupClass.definitions.values()) { - let value = instance.get(def.fullName); - print(`${def.fullName} ${JSON.stringify(value)}`); - } + for (const name of Object.keys(instance.constructor.fieldDefinitions)) { + print(`${name} ${JSON.stringify(instance.get(name))}`); } } else if (command === "show") { @@ -162,7 +159,7 @@ export async function handleConfigCommand( try { instance.set(args.field as string, args.value); - await libFileOps.safeOutputFile(configPath, JSON.stringify(instance.serialize(), null, "\t")); + await libFileOps.safeOutputFile(configPath, JSON.stringify(instance, null, "\t")); } catch (err) { if (err instanceof libConfig.InvalidField || err instanceof libConfig.InvalidValue) { logger.error(err.message); diff --git a/packages/web_ui/src/bootstrap.tsx b/packages/web_ui/src/bootstrap.tsx index 6db05d58..bc3aef2e 100644 --- a/packages/web_ui/src/bootstrap.tsx +++ b/packages/web_ui/src/bootstrap.tsx @@ -104,8 +104,7 @@ export default async function bootstrap() { })); let pluginInfos = await loadPluginInfos(); lib.registerPluginMessages(pluginInfos); - lib.registerPluginConfigGroups(pluginInfos); - lib.finalizeConfigs(); + lib.addPluginConfigFields(pluginInfos); let wsUrl = new URL(webRoot, document.location.href); let controlConnector = new ControlConnector(wsUrl.href, 120, undefined); diff --git a/packages/web_ui/src/components/BaseConfigTree.tsx b/packages/web_ui/src/components/BaseConfigTree.tsx index 93aab9ea..81feb511 100644 --- a/packages/web_ui/src/components/BaseConfigTree.tsx +++ b/packages/web_ui/src/components/BaseConfigTree.tsx @@ -1,4 +1,4 @@ -import type * as lib from "@clusterio/lib"; +import * as lib from "@clusterio/lib"; import React, { useEffect, useState } from "react"; import { Button, Card, Checkbox, Form, Input, InputNumber, Space, Spin, Tooltip, Tree, Typography } from "antd"; @@ -6,41 +6,35 @@ import ReloadOutlined from "@ant-design/icons/ReloadOutlined"; const { Title } = Typography; -function getInitialValues(config: lib.Config, props: BaseConfigTreeProps) { +function getInitialValues(config: lib.Config, props: BaseConfigTreeProps) { let initialValues: any = {}; - for (let [name, GroupClass] of props.ConfigClass.groups) { - let group = config.group(name); - for (let def of GroupClass.definitions.values()) { - if (!group.canAccess(def.name)) { - continue; - } + for (let [name, def] of Object.entries(config.constructor.fieldDefinitions)) { + if (!config.canAccess(name)) { + continue; + } - let value = group.get(def.name) as any; - let fieldName = `${group.name}.${def.name}`; - - if (def.type === "object") { - for (let prop of Object.keys(value)) { - let propPath = `${group.name}.${def.name}.${prop}`; - initialValues[propPath] = JSON.stringify(value[prop]); - } - } else { - initialValues[fieldName] = value; + let value = config.get(name) as any; + if (def.type === "object") { + for (let prop of Object.keys(value)) { + initialValues[`${name}.${prop}`] = JSON.stringify(value[prop]); } + } else { + initialValues[name] = value; } } return initialValues; } type BaseConfigTreeProps = { - ConfigClass: typeof lib.Config; - retrieveConfig: () => Promise; + ConfigClass: typeof lib.ControllerConfig | typeof lib.InstanceConfig; + retrieveConfig: () => Promise; setField: (field:string, value:any) => Promise; setProp: (field:string, prop:string, value:any) => Promise; id?: number; onApply?: () => void; }; export default function BaseConfigTree(props: BaseConfigTreeProps) { - let [config, setConfig] = useState(null); + let [config, setConfig] = useState|null>(null); let [form] = Form.useForm(); let [changedFields, setChangedFields] = useState>(new Set()); let [errorFields, setErrorFields] = useState(new Map()); @@ -48,8 +42,7 @@ export default function BaseConfigTree(props: BaseConfigTreeProps) { async function updateConfig() { let serializedConfig = await props.retrieveConfig(); - let newConfig = new props.ConfigClass("control"); - await newConfig.load(serializedConfig); + const newConfig = props.ConfigClass.fromJSON(serializedConfig, "control"); setConfig(newConfig); return newConfig; } @@ -117,21 +110,30 @@ export default function BaseConfigTree(props: BaseConfigTreeProps) { let treeData = []; let propsMap = new Map(); - for (let [name, GroupClass] of props.ConfigClass.groups) { - let group = config.group(name); + const groups = new Map(); + for (let [fieldName, def] of Object.entries(props.ConfigClass.fieldDefinitions)) { + const [groupName, field] = lib.splitOn(".", fieldName); + let group = groups.get(groupName); + if (!group) { + group = {}; + groups.set(groupName, group); + } + group[field] = def; + } + for (let [groupName, groupDefs] of groups) { let treeNode: TreeNode = { - key: group.name, - title: group.name, + key: groupName, + title: groupName, children: [], }; - for (let def of GroupClass.definitions.values()) { - if (!group.canAccess(def.name)) { + for (let [field, def] of Object.entries(groupDefs)) { + if (!config.canAccess(`${groupName}.${field}`)) { continue; } - let value = group.get(def.name) as any; - let fieldName = `${group.name}.${def.name}`; + let fieldName = `${groupName}.${field}`; + let value = config.get(fieldName) as any; let childNode: ChildNode = { key: fieldName, children: [], @@ -141,13 +143,13 @@ export default function BaseConfigTree(props: BaseConfigTreeProps) { let restartRequiredProps = new Set(def.restartRequiredProps || []); childNode.title = - {def.title || def.name} + {def.title || field} {!def.restartRequiredProps && def.restartRequired && restartTip} } tooltip={def.description} />; for (let prop of Object.keys(value)) { - let propPath = `${group.name}.${def.name}.${prop}`; + let propPath = `${groupName}.${field}.${prop}`; let restart = Boolean( def.restartRequiredProps && Number(def.restartRequired) ^ Number(restartRequiredProps.has(prop)) ); @@ -179,7 +181,7 @@ export default function BaseConfigTree(props: BaseConfigTreeProps) { propsMap.set(propPath, [fieldName, prop]); } - let newPropPath = `${group.name}.${def.name}:add`; + let newPropPath = `${groupName}.${field}:add`; childNode.children.push({ key: newPropPath, title: @@ -197,17 +199,16 @@ export default function BaseConfigTree(props: BaseConfigTreeProps) {