Let plugins migrate the data core stores for them

Plugins had no way to update the config fields and permissions core stores
for them, so renaming inventory_sync needed migrations in core packages.

A plugin can now declare a migrationEntrypoint. It's loaded on the
controller and hosts before configs and roles are read, for every plugin in
the plugin list, and attaches handlers to sync hooks for the controller,
host and instance configs and roles. lib gets helpers to rename config
fields and permissions, and each config gets a hidden <plugin>.version field
set after load so migrations can tell which version saved the data.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
bbassieandClaude Opus 5.5 committed 2026-10-14 15:33:27 +00:00
1 parent 24586a4b7c
commit aec0fc7a1e
19 files changed
+562 -7

No files matched your search

+12 -1
View File
@@ -10,6 +10,7 @@ import { StringEnum } from "../data/composites.js";
import { safeOutputFile } from "../file_ops.js";
import * as validators from "./validators.js";
import { RequestError } from "../errors.js";
import type { SyncHook } from "../SyncHook.js";
const ConfigLocation = StringEnum(["controller", "host", "control"]);
export type ConfigLocation = Static<typeof ConfigLocation>;
@@ -224,6 +225,12 @@ export class Config<
return config;
}
/**
* Migrations attached by plugins, run after {@link Config.migrations}.
* Declared by each subclass that plugins can add fields to.
*/
declare static pluginMigrations?: SyncHook<ConfigSchema>;
/** Defines the default access locations for the config class */
static defaultAccess: ConfigLocation[] = ["controller", "host", "control"];
@@ -269,7 +276,11 @@ export class Config<
) as Fields;
if (fields) {
this.update(this.constructor.migrations(fields), false, location);
let migrated = this.constructor.migrations(fields);
if (this.constructor.pluginMigrations) {
migrated = this.constructor.pluginMigrations.reduce(migrated);
}
this.update(migrated, false, location);
}
}
+37
View File
@@ -4,6 +4,7 @@ import * as validators from "./validators.js";
import type { PluginNodeEnvInfo, PluginWebpackEnvInfo } from "../plugin.js";
import { Static } from "@sinclair/typebox";
import { isTargetVersion } from "../data/version.js";
import { SyncHook } from "../SyncHook.js";
type configFromJSON<T> = (...args: Parameters<typeof classes.Config.fromJSON>) => T;
type configFromFile<T> = (...args: Parameters<typeof classes.Config.fromFile>) => Promise<T>;
@@ -42,6 +43,7 @@ export interface ControllerConfigFields {
"controller.allow_plugin_updates": boolean;
"controller.allow_plugin_install": boolean;
[key: `${string}.load_plugin`]: boolean;
[key: `${string}.version`]: string;
}
/**
@@ -51,6 +53,7 @@ export interface ControllerConfigFields {
export class ControllerConfig extends classes.Config<ControllerConfigFields> {
declare static fromJSON: configFromJSON<ControllerConfig>;
declare static fromFile: configFromFile<ControllerConfig>;
static pluginMigrations = new SyncHook<classes.ConfigSchema>();
static migrations(config: Static<typeof this.jsonSchema>) {
if (config.hasOwnProperty("controller.external_address")) {
config["controller.public_url"] = config["controller.external_address"];
@@ -334,6 +337,7 @@ export interface HostConfigFields {
"host.allow_plugin_updates": boolean;
"host.allow_plugin_install": boolean;
[key: `${string}.load_plugin`]: boolean;
[key: `${string}.version`]: string;
}
/**
@@ -343,6 +347,7 @@ export interface HostConfigFields {
export class HostConfig extends classes.Config<HostConfigFields> {
declare static fromJSON: configFromJSON<HostConfig>;
declare static fromFile: configFromFile<HostConfig>;
static pluginMigrations = new SyncHook<classes.ConfigSchema>();
static fieldDefinitions: classes.ConfigDefs<HostConfigFields> = {
"host.version": {
type: "string",
@@ -468,6 +473,7 @@ export interface InstanceConfigFields {
"instance.auto_start": boolean;
"instance.exclude_from_start_all": boolean;
[key: `${string}.load_plugin`]: boolean;
[key: `${string}.version`]: string;
"factorio.version": string;
"factorio.executable_path": string | null;
@@ -500,6 +506,7 @@ export interface InstanceConfigFields {
export class InstanceConfig extends classes.Config<InstanceConfigFields> {
declare static fromJSON: configFromJSON<InstanceConfig>;
declare static fromFile: configFromFile<InstanceConfig>;
static pluginMigrations = new SyncHook<classes.ConfigSchema>();
static migrations(config: Static<typeof this.jsonSchema>) {
function boolToEnableDisable(name: string) {
if (config.hasOwnProperty(name) && typeof config[name] === "boolean") {
@@ -805,6 +812,14 @@ export function addPluginFieldDefinitions(
Config.fieldDefinitions[`${pluginInfo.name}.load_plugin`] = fieldDef;
// Version of the plugin the config was last loaded with, see setPluginVersions
Config.fieldDefinitions[`${pluginInfo.name}.version`] = {
type: "string",
initialValue: "version" in pluginInfo ? pluginInfo.version : "",
readonly: ["controller", "host"],
hidden: true,
};
// Merge in other fields from the plugin
const fields = pluginInfo[kind];
if (fields) {
@@ -829,3 +844,25 @@ export function addPluginConfigFields(pluginInfos: PluginNodeEnvInfo[] | PluginW
}
}
}
/**
* Set the version field of each plugin to the version that was loaded
*
* Done after loading a config so the plugin migrations can compare the
* stored version against the one now running.
*
* @param config - Config to update.
* @param pluginInfos - Plugins loaded.
* @returns true if any version changed.
*/
export function setPluginVersions(config: classes.Config<any>, pluginInfos: PluginNodeEnvInfo[]) {
let changed = false;
for (const pluginInfo of pluginInfos) {
const name = `${pluginInfo.name}.version`;
if (config.constructor.fieldDefinitions[name] && config.get(name) !== pluginInfo.version) {
config.set(name, pluginInfo.version);
changed = true;
}
}
return changed;
}