aperx/factorio-clusterio
1
0 Fork 0
mirror of https://github.com/clusterio/clusterio.git synced 2026-11-14 07:24:52 +09:00
Code Issues Packages Projects Releases Wiki Activity

Require an impact for each known compat break

Browse Source 
Entries now explain why end users are not or only minimally affected,
and the docs say which version to key by and point to the breaking
changes decision.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
bbassieandClaude Opus 5.5 committed 2026-10-29 00:45:27 +00:00
1 parent 9bd6effd40
commit 3c2ee3e372
5 files changed
+44 -25
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

test/version_compat_breaks.js
+16 -10
View File
@@ -5,17 +5,17 @@ import {
} from "../scripts/version-compat-breaks.js";
describe("version compatibility known breaks", function() {
describe("scripts/version-compat-breaks", function() {
const breaks = {
"2.0.3": {
messages: {
"request ListedRequest": { pr: 1, reason: "Listed." },
"event UnchangedEvent": { pr: 2, reason: "Unchanged." },
"request ListedRequest": { pr: 1, reason: "Listed.", impact: "None." },
"event UnchangedEvent": { pr: 2, reason: "Unchanged.", impact: "None." },
},
connect: { pr: 3, reason: "Cannot connect." },
connect: { pr: 3, reason: "Cannot connect.", impact: "None." },
},
"2.0.2": {
messages: { "request OldRequest": { pr: 4, reason: "Old." } },
messages: { "request OldRequest": { pr: 4, reason: "Old.", impact: "None." } },
},
};
@@ -27,24 +27,30 @@ describe("version compatibility known breaks", function() {
validateBreaks(breaks);
validateBreaks({});
});
it("should require a pr number and reason", function() {
it("should require a pr number, reason and impact", function() {
assert.throws(
() => validateBreaks({ "1.0.0": { messages: { "request A": { reason: "A." } } } }),
/must have a pr number/
);
assert.throws(
() => validateBreaks({ "1.0.0": { messages: { "request A": { pr: 1, reason: " " } } } }),
/must have a reason/
/is missing reason/
);
assert.throws(
() => validateBreaks({ "1.0.0": { messages: { "request A": { pr: 1, reason: "A." } } } }),
/is missing impact/
);
assert.throws(
() => validateBreaks({ "1.0.0": { connect: { pr: 1 } } }),
/connect must have a reason/
/connect is missing reason/
);
});
it("should reject unknown properties and bad message names", function() {
assert.throws(() => validateBreaks({ "1.0.0": { connected: false } }), /unknown properties connected/);
assert.throws(
() => validateBreaks({ "1.0.0": { messages: { "request A": { pr: 1, reason: "A.", x: 1 } } } }),
() => validateBreaks({
"1.0.0": { messages: { "request A": { pr: 1, reason: "A.", impact: "A.", x: 1 } } },
}),
/unknown properties x/
);
assert.throws(
@@ -58,7 +64,7 @@ describe("version compatibility known breaks", function() {
it("should pick the entry for the published version", function() {
const selected = selectBreaks(breaks, "2.0.3");
assert.deepEqual([...selected.messages.keys()], ["request ListedRequest", "event UnchangedEvent"]);
assert.deepEqual(selected.connect, { pr: 3, reason: "Cannot connect." });
assert.deepEqual(selected.connect, { pr: 3, reason: "Cannot connect.", impact: "None." });
assert.deepEqual(selected.ignored, ["2.0.2"]);
});
it("should ignore every entry when the version is not listed", function() {