mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-19 15:33:12 +09:00
research_sync: cluster research queue on the controller
- QueueUpdateEvent, QueueEvent and QueueSyncRequest messages. - The controller keeps one queue (max 7 names) in research_queue.json, saved with the other data. - An update that changes the queue replaces it and is broadcast as QueueEvent; an equal update is ignored. - QueueSyncRequest returns the queue and seeds it from the request when the queue is empty. - A finished technology (completing contribution, advancing FinishedEvent, technology sync) drops its first queue entry without a broadcast. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This commit is contained in:
1 parent
43243eab86
commit
e3099e1e05
4 files changed
+265
No files matched your search
@@ -0,0 +1,119 @@
|
||||
import assert from "node:assert/strict";
|
||||
import fs from "node:fs/promises";
|
||||
import path from "node:path";
|
||||
|
||||
import * as lib from "@clusterio/lib";
|
||||
import * as mock from "../../../test/mock.js";
|
||||
import controllerEntrypoint from "../dist/node/controller.js";
|
||||
import { plugin as info } from "../dist/node/index.js";
|
||||
import {
|
||||
ContributionEvent, FinishedEvent, QueueEvent, QueueSyncRequest, QueueUpdateEvent,
|
||||
SyncTechnologiesRequest, TechnologySync,
|
||||
} from "../dist/node/messages.js";
|
||||
|
||||
describe("research_sync controller", function() {
|
||||
const databaseDir = path.join("temp", "test", "research_sync");
|
||||
let controller, sent;
|
||||
|
||||
before(function() {
|
||||
try {
|
||||
lib.registerPluginMessages([info]);
|
||||
} catch (err) {
|
||||
// Already registered by the full test suite
|
||||
}
|
||||
});
|
||||
beforeEach(async function() {
|
||||
await fs.rm(databaseDir, { recursive: true, force: true });
|
||||
await fs.mkdir(databaseDir, { recursive: true });
|
||||
controller = await load();
|
||||
});
|
||||
|
||||
async function load() {
|
||||
const c = await mock.loadControllerPlugin(async (context) => {
|
||||
context.controller.mockConfigEntries.set("controller.database_directory", databaseDir);
|
||||
await controllerEntrypoint(context);
|
||||
}, info);
|
||||
sent = [];
|
||||
c.sendTo = (dst, message) => { sent.push([dst, message]); };
|
||||
c.instances = new Map([[1, { config: { get: () => "rs-1" } }]]);
|
||||
return c;
|
||||
}
|
||||
|
||||
const src = { id: 1 };
|
||||
const update = (queue, player = null) => mock.getHandler(controller, QueueUpdateEvent)(
|
||||
new QueueUpdateEvent(queue, player), src
|
||||
);
|
||||
const sync = (queue = null, player = null) => mock.getHandler(controller, QueueSyncRequest)(
|
||||
new QueueSyncRequest(queue, player), src
|
||||
);
|
||||
const queueEvents = () => sent.filter(([, m]) => m instanceof QueueEvent);
|
||||
|
||||
it("should store and broadcast an update", async function() {
|
||||
await update(["a", "b"], "Bob");
|
||||
assert.equal(sent.length, 1);
|
||||
assert.equal(sent[0][0], "allInstances");
|
||||
assert.ok(sent[0][1] instanceof QueueEvent);
|
||||
assert.deepEqual(sent[0][1].queue, ["a", "b"]);
|
||||
assert.equal(sent[0][1].player, "Bob");
|
||||
assert.equal(sent[0][1].instance, "rs-1");
|
||||
assert.deepEqual(await sync(), ["a", "b"]);
|
||||
});
|
||||
it("should not broadcast an unchanged update", async function() {
|
||||
await update(["a", "b"]);
|
||||
await update(["a", "b"]);
|
||||
assert.equal(queueEvents().length, 1);
|
||||
});
|
||||
it("should cap the queue at 7", async function() {
|
||||
await update(["1", "2", "3", "4", "5", "6", "7", "8", "9"]);
|
||||
assert.deepEqual(queueEvents()[0][1].queue, ["1", "2", "3", "4", "5", "6", "7"]);
|
||||
assert.deepEqual(await sync(), ["1", "2", "3", "4", "5", "6", "7"]);
|
||||
});
|
||||
it("should seed an empty queue from a sync request", async function() {
|
||||
assert.deepEqual(await sync(["x"], "Bob"), ["x"]);
|
||||
assert.equal(queueEvents().length, 1);
|
||||
assert.deepEqual(queueEvents()[0][1].queue, ["x"]);
|
||||
assert.equal(queueEvents()[0][1].player, "Bob");
|
||||
assert.equal(queueEvents()[0][1].instance, "rs-1");
|
||||
});
|
||||
it("should not replace a non-empty queue from a sync request", async function() {
|
||||
await update(["a"]);
|
||||
sent.length = 0;
|
||||
assert.deepEqual(await sync(["x"]), ["a"]);
|
||||
assert.equal(sent.length, 0);
|
||||
assert.deepEqual(await sync(), ["a"]);
|
||||
});
|
||||
it("should not broadcast when seeding with an empty queue", async function() {
|
||||
assert.deepEqual(await sync([]), []);
|
||||
assert.equal(sent.length, 0);
|
||||
});
|
||||
|
||||
describe("finished technologies", function() {
|
||||
it("should drop one entry when a contribution completes a technology", async function() {
|
||||
await update(["m", "m", "x"]);
|
||||
await mock.getHandler(controller, ContributionEvent)(new ContributionEvent("m", 3, 1), src);
|
||||
assert.deepEqual(await sync(), ["m", "x"]);
|
||||
});
|
||||
it("should drop one entry per advancing FinishedEvent only", async function() {
|
||||
await update(["m", "m", "x"]);
|
||||
const finished = mock.getHandler(controller, FinishedEvent);
|
||||
await finished(new FinishedEvent("m", 3), src);
|
||||
assert.deepEqual(await sync(), ["m", "x"]);
|
||||
await finished(new FinishedEvent("m", 3), src);
|
||||
assert.deepEqual(await sync(), ["m", "x"]);
|
||||
});
|
||||
it("should drop an entry finished through a technology sync", async function() {
|
||||
await update(["m", "x"]);
|
||||
await mock.getHandler(controller, SyncTechnologiesRequest)(
|
||||
new SyncTechnologiesRequest([new TechnologySync("m", 1, null, true)]), src
|
||||
);
|
||||
assert.deepEqual(await sync(), ["x"]);
|
||||
});
|
||||
});
|
||||
|
||||
it("should persist the queue across loads", async function() {
|
||||
await update(["a", "b"]);
|
||||
await controller.hooks.save.invoke();
|
||||
controller = await load();
|
||||
assert.deepEqual(await sync(), ["a", "b"]);
|
||||
});
|
||||
});
|
||||
Reference in new issue
Block a user