mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-23 00:13:13 +09:00
Merge pull request #1031 from bbassie/fix/stop-before-rcon-ready
Resolve instance stop when Factorio exits before RCON is ready
This commit is contained in:
2 files changed
+152
-3
No files matched your search
@@ -1318,6 +1318,34 @@ export class FactorioServer extends events.EventEmitter<FactorioServerEvents> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// Not using events.once here as it rejects on error events, which are not
|
||||||
|
// emitted when the process exits while stopping. Rejects with the error
|
||||||
|
// emitted with the exit, if there was one, for the caller to report.
|
||||||
|
async _waitForRconReadyOrExit() {
|
||||||
|
return await new Promise<void>((resolve, reject) => {
|
||||||
|
let exitError: Error | undefined;
|
||||||
|
const cleanup = () => {
|
||||||
|
this.off("error", onError);
|
||||||
|
this.off("rcon-ready", onRconReady);
|
||||||
|
this.off("exit", onExit);
|
||||||
|
};
|
||||||
|
const onError = (err: Error) => {
|
||||||
|
exitError = err;
|
||||||
|
};
|
||||||
|
const onRconReady = () => {
|
||||||
|
cleanup();
|
||||||
|
resolve();
|
||||||
|
};
|
||||||
|
const onExit = () => {
|
||||||
|
cleanup();
|
||||||
|
reject(exitError ?? new Error("RCON connection lost"));
|
||||||
|
};
|
||||||
|
this.on("error", onError);
|
||||||
|
this.once("rcon-ready", onRconReady);
|
||||||
|
this.once("exit", onExit);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Send message over RCON
|
* Send message over RCON
|
||||||
*
|
*
|
||||||
@@ -1333,7 +1361,8 @@ export class FactorioServer extends events.EventEmitter<FactorioServerEvents> {
|
|||||||
async sendRcon(message: string, expectEmpty?: boolean) {
|
async sendRcon(message: string, expectEmpty?: boolean) {
|
||||||
this._check(["running", "stopping"]);
|
this._check(["running", "stopping"]);
|
||||||
if (!this._rconReady) {
|
if (!this._rconReady) {
|
||||||
await events.once(this, "rcon-ready");
|
// Rejects with the reason the server gave for exiting, if there was one.
|
||||||
|
await this._waitForRconReadyOrExit();
|
||||||
}
|
}
|
||||||
if (!this._rconClient) {
|
if (!this._rconClient) {
|
||||||
throw new Error("RCON connection lost");
|
throw new Error("RCON connection lost");
|
||||||
@@ -1404,8 +1433,8 @@ export class FactorioServer extends events.EventEmitter<FactorioServerEvents> {
|
|||||||
// If RCON is not yet fully connected that operation needs to
|
// If RCON is not yet fully connected that operation needs to
|
||||||
// complete before the RCON connection can be used
|
// complete before the RCON connection can be used
|
||||||
if (!this._rconReady) {
|
if (!this._rconReady) {
|
||||||
// Not using events.once here to avoid throwing on error events.
|
// An exit error is not reported here as stopping is done once the process is gone.
|
||||||
await new Promise<void>(resolve => this.once("rcon-ready", resolve));
|
await this._waitForRconReadyOrExit().catch(() => {});
|
||||||
}
|
}
|
||||||
|
|
||||||
// The Factorio server may have decided to get ahead of us and
|
// The Factorio server may have decided to get ahead of us and
|
||||||
|
|||||||
@@ -0,0 +1,120 @@
|
|||||||
|
import assert from "node:assert/strict";
|
||||||
|
import events from "node:events";
|
||||||
|
import path from "node:path";
|
||||||
|
|
||||||
|
import * as lib from "@clusterio/lib";
|
||||||
|
import { FactorioServer } from "@clusterio/host/dist/node/src/server.js";
|
||||||
|
|
||||||
|
|
||||||
|
// Stand-in for the Factorio child process, only exit and kill are used here.
|
||||||
|
class FakeProcess extends events.EventEmitter {
|
||||||
|
killed = false;
|
||||||
|
kill() {
|
||||||
|
this.killed = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function createStartedServer() {
|
||||||
|
const server = new FactorioServer(path.join("test", "file", "factorio"), path.join("temp", "test", "server"), {});
|
||||||
|
server._state = "running";
|
||||||
|
server._rconReady = false;
|
||||||
|
server._server = new FakeProcess();
|
||||||
|
server._watchExit();
|
||||||
|
// Instance keeps an error listener on the server for as long as it runs.
|
||||||
|
server.on("error", () => {});
|
||||||
|
return server;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fail instead of hanging if the call never settles.
|
||||||
|
async function withTimeout(promise, message) {
|
||||||
|
let timeoutId;
|
||||||
|
const timeout = new Promise((resolve, reject) => {
|
||||||
|
timeoutId = setTimeout(() => reject(new Error(message)), 500);
|
||||||
|
});
|
||||||
|
try {
|
||||||
|
return await Promise.race([promise, timeout]);
|
||||||
|
} finally {
|
||||||
|
clearTimeout(timeoutId);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("host/src/server", function() {
|
||||||
|
describe("FactorioServer.stop()", function() {
|
||||||
|
it("returns if the process exits before RCON is ready", async function() {
|
||||||
|
const server = createStartedServer();
|
||||||
|
const stopped = server.stop();
|
||||||
|
server._server.emit("exit", 1, null);
|
||||||
|
await withTimeout(stopped, "stop() did not resolve");
|
||||||
|
assert.equal(server._state, "init");
|
||||||
|
assert.equal(server.listenerCount("rcon-ready"), 0);
|
||||||
|
assert.equal(server.listenerCount("error"), 1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("returns if the process fails before RCON is ready", async function() {
|
||||||
|
const server = createStartedServer();
|
||||||
|
const stopped = server.stop();
|
||||||
|
// Failing to spawn emits an error event followed by exit.
|
||||||
|
server._server.emit("error", Object.assign(new Error("spawn failed"), { code: "EACCES" }));
|
||||||
|
await withTimeout(stopped, "stop() did not resolve");
|
||||||
|
assert.equal(server._state, "init");
|
||||||
|
assert.equal(server.listenerCount("rcon-ready"), 0);
|
||||||
|
assert.equal(server.listenerCount("error"), 1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("does not reject if the process exits with an error before RCON is ready", async function() {
|
||||||
|
const server = createStartedServer();
|
||||||
|
const stopped = server.stop();
|
||||||
|
// The wait rejects with this error, stopping succeeds regardless.
|
||||||
|
server.emit("error", new lib.EnvironmentError("Factorio server was killed"));
|
||||||
|
server._server.emit("exit", null, "SIGKILL");
|
||||||
|
await assert.doesNotReject(withTimeout(stopped, "stop() did not resolve"));
|
||||||
|
assert.equal(server._state, "init");
|
||||||
|
assert.equal(server.listenerCount("rcon-ready"), 0);
|
||||||
|
assert.equal(server.listenerCount("exit"), 0);
|
||||||
|
assert.equal(server.listenerCount("error"), 1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("stops the server if RCON becomes ready", async function() {
|
||||||
|
const server = createStartedServer();
|
||||||
|
const stopped = server.stop();
|
||||||
|
server._rconReady = true;
|
||||||
|
server.emit("rcon-ready");
|
||||||
|
await new Promise(resolve => setImmediate(resolve));
|
||||||
|
assert.equal(server.listenerCount("exit"), 0);
|
||||||
|
const fakeProcess = server._server;
|
||||||
|
assert.equal(fakeProcess.killed, true);
|
||||||
|
fakeProcess.emit("exit", 0, null);
|
||||||
|
await withTimeout(stopped, "stop() did not resolve");
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("FactorioServer.sendRcon()", function() {
|
||||||
|
it("throws if the process is killed before RCON is ready", async function() {
|
||||||
|
const server = createStartedServer();
|
||||||
|
const sent = server.sendRcon("/version");
|
||||||
|
// kill() sets the state before killing, which suppresses the error event.
|
||||||
|
server._state = "stopping";
|
||||||
|
server._server.emit("exit", null, "SIGKILL");
|
||||||
|
await assert.rejects(
|
||||||
|
withTimeout(sent, "sendRcon() did not settle"),
|
||||||
|
new Error("RCON connection lost"),
|
||||||
|
);
|
||||||
|
assert.equal(server.listenerCount("rcon-ready"), 0);
|
||||||
|
assert.equal(server.listenerCount("error"), 1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("throws the exit error if the process exits before RCON is ready", async function() {
|
||||||
|
const server = createStartedServer();
|
||||||
|
const sent = server.sendRcon("/version");
|
||||||
|
// An unexpected exit emits why the server went away before the exit event.
|
||||||
|
server._server.emit("exit", 1, null);
|
||||||
|
await assert.rejects(
|
||||||
|
withTimeout(sent, "sendRcon() did not settle"),
|
||||||
|
new lib.EnvironmentError("Factorio server unexpectedly shut down with code 1"),
|
||||||
|
);
|
||||||
|
assert.equal(server.listenerCount("rcon-ready"), 0);
|
||||||
|
assert.equal(server.listenerCount("exit"), 0);
|
||||||
|
assert.equal(server.listenerCount("error"), 1);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
Reference in new issue
Block a user