From 079340e5ddd3de66c71a28587f4720eec4120bb1 Mon Sep 17 00:00:00 2001 From: bbassie <17990055+bbassie@users.noreply.github.com> Date: Sat, 21 Nov 2026 16:29:03 +0000 Subject: [PATCH] Reset crash restart attempts on a manual start A stop is always followed by a start, so the start is the one place that needs it. The crash restart calls _startSave directly to keep its count. Rename _runningSinceMs to _startedAtMs to match InstanceDetails. Co-Authored-By: Claude Opus 5.5 --- docs/configuration.md | 2 +- packages/host/src/Host.ts | 2 +- packages/host/src/Instance.ts | 18 ++++++++++-------- packages/lib/src/config/definitions.ts | 2 +- test/host/Instance.js | 11 ++++++----- 5 files changed, 19 insertions(+), 16 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 49b7d7c2..90465063 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -560,7 +560,7 @@ Defaults to false. ### instance.crash_retry_attempts Number of times the host restarts this instance after a crash before giving up and logging an error. -The count resets when the instance is stopped or restarted by a user, or the host is restarted. +The count resets when a user starts or restarts the instance, or the host is restarted. Set to 0 for no limit. Defaults to 3. diff --git a/packages/host/src/Host.ts b/packages/host/src/Host.ts index f46e5555..deee9e6a 100644 --- a/packages/host/src/Host.ts +++ b/packages/host/src/Host.ts @@ -351,7 +351,7 @@ export default class Host extends lib.Link { _shuttingDown = false; /** Instances waiting on {@link Instance.fromConfig} */ _startingInstances = new Set(); - /** Restarts after a crash per instance ID since the last manual stop */ + /** Restarts after a crash per instance ID since the last manual start */ _crashRetryAttempts = new Map(); startedAtMs = Date.now(); diff --git a/packages/host/src/Instance.ts b/packages/host/src/Instance.ts index 61fea792..67d1265c 100644 --- a/packages/host/src/Instance.ts +++ b/packages/host/src/Instance.ts @@ -197,7 +197,7 @@ export default class Instance extends lib.Link { _playerAutosaveSlot = 1; _expectedUserUpdates: { action: string, name: string, reason: string }[] = []; _settleWaiters: (() => void)[] = []; - _runningSinceMs: number | null = null; + _startedAtMs: number | null = null; _killRequested = false; constructor( @@ -600,7 +600,7 @@ end`.replace(/\r?\n/g, " "); notifyStatus(status: Instance["_status"]) { this._status = status; if (status === "running") { - this._runningSinceMs = Date.now(); + this._startedAtMs = Date.now(); } if (!transitoryStatuses.has(status)) { const waiters = this._settleWaiters; @@ -679,7 +679,7 @@ end`.replace(/\r?\n/g, " "); this._saveStats().catch(err => this.logger.error(`Error saving stats:\n${err.stack}`)); if (crashed && this.config.get("instance.restart_after_crash") && !this._host._shuttingDown) { - this._restartAfterCrash(Date.now() - this._runningSinceMs!); + this._restartAfterCrash(Date.now() - this._startedAtMs!); } } @@ -698,7 +698,7 @@ end`.replace(/\r?\n/g, " "); const of = limit > 0 ? ` of ${limit}` : ""; this.logger.warn(`Restarting instance ${this.name} after crash, attempt ${attempts + 1}${of}`); this._host._connectInstance(this.id) - .then(connection => connection.instance.handleInstanceStartRequest(new lib.InstanceStartRequest())) + .then(connection => connection.instance._startSave()) .catch(err => this.logger.error(`Error restarting instance ${this.name} after crash:\n${err.stack}`)); } @@ -1428,7 +1428,11 @@ end`.replace(/\r?\n/g, " "); } async handleInstanceStartRequest(request: lib.InstanceStartRequest) { - let saveName = request.save; + this._host._crashRetryAttempts.delete(this.id); + await this._startSave(request.save); + } + + async _startSave(saveName?: string) { if (saveName !== undefined) { checkRequestSaveName(saveName); } @@ -1457,6 +1461,7 @@ end`.replace(/\r?\n/g, " "); } async handleInstanceLoadScenarioRequest(request: lib.InstanceLoadScenarioRequest) { + this._host._crashRetryAttempts.delete(this.id); if (this.config.get("factorio.enable_save_patching")) { this.notifyExit(); throw new lib.ConflictError("Load scenario cannot be used with save patching enabled"); @@ -1573,7 +1578,6 @@ end`.replace(/\r?\n/g, " "); } async handleInstanceRestartRequest(request: lib.InstanceRestartRequest) { - this._host._crashRetryAttempts.delete(this.id); await this._stopWhenSettled(); // Stopping invalidates this instance object, a new one must be created by the host // To do this we simulate a waking an instance and sending a start request @@ -1582,12 +1586,10 @@ end`.replace(/\r?\n/g, " "); } async handleInstanceStopRequest() { - this._host._crashRetryAttempts.delete(this.id); await this._stopWhenSettled(); } async handleInstanceKillRequest() { - this._host._crashRetryAttempts.delete(this.id); await this.kill(); } diff --git a/packages/lib/src/config/definitions.ts b/packages/lib/src/config/definitions.ts index b4e3a396..f003c220 100644 --- a/packages/lib/src/config/definitions.ts +++ b/packages/lib/src/config/definitions.ts @@ -641,7 +641,7 @@ export class InstanceConfig extends classes.Config { initialValue: false, }, "instance.crash_retry_attempts": { - description: "Restarts after a crash before giving up, 0 for no limit. Reset when the instance is stopped", + description: "Restarts after a crash before giving up, 0 for no limit. Reset when the instance is started", type: "number", initialValue: 3, }, diff --git a/test/host/Instance.js b/test/host/Instance.js index 9840cad0..e3247a89 100644 --- a/test/host/Instance.js +++ b/test/host/Instance.js @@ -321,13 +321,13 @@ describe("class Instance", function() { instance._saveStats = async () => {}; instance._host._connectInstance = async id => { starts.push(id); - return { instance: { handleInstanceStartRequest: async () => {} } }; + return { instance: { _startSave: async () => {} } }; }; instance.config.set("instance.restart_after_crash", true); }); function crash(uptimeMinutes) { instance.notifyStatus("running"); - instance._runningSinceMs = Date.now() - uptimeMinutes * 60e3; + instance._startedAtMs = Date.now() - uptimeMinutes * 60e3; instance.notifyExit(); } @@ -360,7 +360,7 @@ describe("class Instance", function() { it("should not restart after a stop or kill", async function() { instance.server.kill = async () => {}; instance.notifyStatus("running"); - instance._runningSinceMs = 0; + instance._startedAtMs = 0; await instance.handleInstanceKillRequest(); instance.notifyExit(); instance.notifyStatus("stopping"); @@ -373,10 +373,11 @@ describe("class Instance", function() { crash(11); assert.deepEqual(starts, []); }); - it("should reset the attempts on a manual stop", async function() { + it("should reset the attempts on a manual start", async function() { instance.config.set("instance.crash_retry_attempts", 1); + instance._startSave = async () => {}; crash(11); - await instance.handleInstanceStopRequest(); + await instance.handleInstanceStartRequest(new lib.InstanceStartRequest()); crash(11); assert.equal(starts.length, 2); });