Add base instances for instance config inheritance

Instances can be marked as a base with instance.is_base and other
instances inherit config values from it through instance.base_id.
The controller copies base values into inheriting configs and keeps
track of inherited fields in the hidden instance.inherited_fields, so
hosts receive resolved configs and need no changes. Setting a field
stops inheriting it, `instance config inherit` undoes that.

Bases cannot be assigned to a host, are hidden from `instance list`
unless --bases is given, and cannot be deleted or unmarked while
other instances inherit from them. Chains of bases are allowed and
cycles are rejected.

Part of #200

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
bbassieandClaude Opus 5.5 committed 2026-11-02 11:54:21 +00:00
1 parent 024d7b427a
commit 01cf789f5d
16 files changed
+769 -26

No files matched your search

+44
View File
@@ -488,6 +488,9 @@ export interface InstanceConfigFields {
"instance.assigned_host": number | null;
"instance.auto_start": boolean;
"instance.exclude_from_start_all": boolean;
"instance.is_base": boolean;
"instance.base_id": number | null;
"instance.inherited_fields": Record<string, true>;
[key: `${string}.load_plugin`]: boolean;
[key: `${string}.version`]: string;
@@ -539,6 +542,23 @@ export class InstanceConfig extends classes.Config<InstanceConfigFields> {
return config;
}
/** Fields that are never inherited from a base instance */
static uninheritableFields = ["instance.name", "instance.is_base", "instance.base_id"];
/** True if the field can take its value from a base instance */
static isInheritable(name: string) {
const def = this.fieldDefinitions[name as keyof InstanceConfigFields];
return Boolean(def)
&& !def.hidden
&& (def.access ?? this.defaultAccess).includes("controller")
&& !this.uninheritableFields.includes(name);
}
/** True if the field currently takes its value from the base instance */
isInherited(name: string) {
return this.get("instance.base_id") !== null && Boolean(this.get("instance.inherited_fields")[name]);
}
static fieldDefinitions: classes.ConfigDefs<InstanceConfigFields> = {
"instance.name": {
type: "string",
@@ -566,6 +586,30 @@ export class InstanceConfig extends classes.Config<InstanceConfigFields> {
type: "boolean",
initialValue: false,
},
"instance.is_base": {
description:
"Mark this instance as a base other instances can inherit config from. " +
"Bases cannot be assigned to a host or started.",
access: ["controller", "control"],
type: "boolean",
initialValue: false,
},
"instance.base_id": {
title: "Base Instance",
description: "ID of the base instance to inherit config values from",
access: ["controller", "control"],
type: "number",
optional: true,
// Checked by the controller
},
"instance.inherited_fields": {
description: "Fields whose value comes from the base instance",
access: ["controller", "control"],
readonly: ["controller"],
type: "object",
initialValue: {},
hidden: true,
},
"factorio.version": {
description:
"Version of the game to run. Use 'latest' for the latest installed version, a release " +
+8 -2
View File
@@ -41,7 +41,8 @@ export default class InstanceDetails {
public startedAtMs = 0,
/** Millisecond Unix timestamp this entry was last updated at */
public updatedAtMs = 0,
public excludeFromStartAll = false
public excludeFromStartAll = false,
public isBase = false,
) {}
get isDeleted() {
@@ -61,6 +62,7 @@ export default class InstanceDetails {
"startedAtMs": Type.Optional(Type.Number()),
"updatedAtMs": Type.Optional(Type.Number()),
"excludeFromStartAll": Type.Optional(Type.Boolean()),
"isBase": Type.Optional(Type.Boolean()),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
@@ -73,7 +75,8 @@ export default class InstanceDetails {
json.factorioVersion,
json.startedAtMs,
json.updatedAtMs,
json.excludeFromStartAll
json.excludeFromStartAll,
json.isBase,
);
}
@@ -102,6 +105,9 @@ export default class InstanceDetails {
if (this.excludeFromStartAll !== false) {
json.excludeFromStartAll = this.excludeFromStartAll;
}
if (this.isBase !== false) {
json.isBase = this.isBase;
}
return json;
}
@@ -176,6 +176,28 @@ export class InstanceConfigSetPropRequest {
}
}
export class InstanceConfigInheritFieldRequest {
declare ["constructor"]: typeof InstanceConfigInheritFieldRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.instance.update_config" as const;
constructor(
public instanceId: number,
public field: string,
) { }
static jsonSchema = Type.Object({
"instanceId": Type.Integer(),
"field": Type.String(),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.instanceId, json.field);
}
}
export class InstanceAssignRequest {
declare ["constructor"]: typeof InstanceAssignRequest;
static type = "request" as const;
+1
View File
@@ -71,6 +71,7 @@ export const dataClasses: (RequestClass<unknown, unknown> | EventClass<unknown>)
instance.InstanceConfigSetRequest,
instance.InstanceConfigSetFieldRequest,
instance.InstanceConfigSetPropRequest,
instance.InstanceConfigInheritFieldRequest,
instance.InstanceAssignRequest,
instance.InstanceMetricsRequest,
instance.InstanceStartRequest,