fix(monitor): use global console channel and implement shard filtering (#87)
This PR fixes the issue where console monitoring was empty when a specific shard was targeted on the official Screeps server. ### Changes: - **Unified Subscription**: Changed WebSocket subscription path from `shard/console` (invalid) to the global `console` channel. - **Shard Filtering**: Implemented client-side filtering in `handleConsoleEvent` to only display logs matching the targeted shard. - **Precise Timing**: Retained the shard-specific `api.time()` call for accurate tick duration tracking. - **Tests**: Added and updated 48 unit tests verifying the fix and shard filtering logic. - **Distribution**: Rebuilt `dist/index.js` and bumped version to `v0.2.1`. Reviewed-on: #87
This commit was merged in pull request #87.
This commit is contained in:
+161
-35
@@ -11,12 +11,15 @@ vi.mock("@actions/core", () => ({
|
||||
endGroup: vi.fn(),
|
||||
}));
|
||||
|
||||
// ── mock @actions/artifact so tests never attempt real uploads ──────────────
|
||||
vi.mock("@actions/artifact", () => ({
|
||||
DefaultArtifactClient: vi.fn().mockImplementation(() => ({
|
||||
import * as artifact from "@actions/artifact";
|
||||
vi.mock("@actions/artifact", () => {
|
||||
const mockClient = {
|
||||
uploadArtifact: vi.fn().mockResolvedValue({}),
|
||||
})),
|
||||
}));
|
||||
};
|
||||
return {
|
||||
create: vi.fn(() => mockClient),
|
||||
};
|
||||
});
|
||||
|
||||
import * as core from "@actions/core";
|
||||
import fs from "fs";
|
||||
@@ -28,8 +31,10 @@ import {
|
||||
buildSubscribePath,
|
||||
detectTraceback,
|
||||
detectWarning,
|
||||
outputMultiline,
|
||||
buildProgressMessage,
|
||||
writeLogFile,
|
||||
uploadLogArtifacts,
|
||||
handleConsoleEvent,
|
||||
monitorConsole,
|
||||
} from "../monitor.js";
|
||||
@@ -53,20 +58,20 @@ describe("isOfficialServer", () => {
|
||||
});
|
||||
|
||||
describe("buildSubscribePath", () => {
|
||||
it("returns shard0/console for official server (no shard provided)", () => {
|
||||
expect(buildSubscribePath("screeps.com")).toBe("shard0/console");
|
||||
it("returns console for official server (no shard provided)", () => {
|
||||
expect(buildSubscribePath("screeps.com")).toBe("console");
|
||||
});
|
||||
|
||||
it("returns console for private server (no shard provided)", () => {
|
||||
expect(buildSubscribePath("builder64")).toBe("console");
|
||||
});
|
||||
|
||||
it("returns <shard>/console when shard is provided (official)", () => {
|
||||
expect(buildSubscribePath("screeps.com", "shard3")).toBe("shard3/console");
|
||||
it("returns console when shard is provided (official)", () => {
|
||||
expect(buildSubscribePath("screeps.com", "shard3")).toBe("console");
|
||||
});
|
||||
|
||||
it("returns <shard>/console when shard is provided (private)", () => {
|
||||
expect(buildSubscribePath("builder64", "myshard")).toBe("myshard/console");
|
||||
it("returns console when shard is provided (private)", () => {
|
||||
expect(buildSubscribePath("builder64", "myshard")).toBe("console");
|
||||
});
|
||||
});
|
||||
|
||||
@@ -123,6 +128,33 @@ describe("detectWarning", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("outputMultiline", () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
it("prefixes lines with shard when provided", () => {
|
||||
outputMultiline("line1\nline2", "info", "shard0");
|
||||
expect(core.info).toHaveBeenCalledWith("[shard0] line1");
|
||||
expect(core.info).toHaveBeenCalledWith("[shard0] line2");
|
||||
});
|
||||
|
||||
it("does not prefix when shard is missing", () => {
|
||||
outputMultiline("line1", "info");
|
||||
expect(core.info).toHaveBeenCalledWith("line1");
|
||||
});
|
||||
|
||||
it("uses core.warning for level=warning", () => {
|
||||
outputMultiline("warn", "warning", "s0");
|
||||
expect(core.warning).toHaveBeenCalledWith("[s0] warn");
|
||||
});
|
||||
|
||||
it("uses core.error for level=error", () => {
|
||||
outputMultiline("err", "error", "s0");
|
||||
expect(core.error).toHaveBeenCalledWith("[s0] err");
|
||||
});
|
||||
});
|
||||
|
||||
describe("buildProgressMessage", () => {
|
||||
it("formats correctly at 0 elapsed", () => {
|
||||
expect(buildProgressMessage(0, 50)).toBe("[Monitor] 0/50 ticks elapsed...");
|
||||
@@ -141,48 +173,79 @@ describe("buildProgressMessage", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("uploadLogArtifacts", () => {
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
it("instantiates client and calls uploadArtifact", async () => {
|
||||
await uploadLogArtifacts(
|
||||
["/path/to/shard0_console_log.txt"],
|
||||
"custom-name",
|
||||
);
|
||||
expect(artifact.create().uploadArtifact).toHaveBeenCalledWith(
|
||||
"custom-name",
|
||||
["/path/to/shard0_console_log.txt"],
|
||||
"/path/to",
|
||||
{ continueOnError: true },
|
||||
);
|
||||
});
|
||||
|
||||
it("does nothing if filePaths is empty", async () => {
|
||||
await uploadLogArtifacts([]);
|
||||
expect(artifact.create().uploadArtifact).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
|
||||
// ────────────────────────────────────────────────────────────────────────────
|
||||
// handleConsoleEvent
|
||||
// ────────────────────────────────────────────────────────────────────────────
|
||||
|
||||
describe("handleConsoleEvent", () => {
|
||||
let state;
|
||||
let stdoutBuffer;
|
||||
let shardBuffers;
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
state = { sawTraceback: false, sawErrorLog: false, sawWarningLog: false };
|
||||
stdoutBuffer = [];
|
||||
shardBuffers = {};
|
||||
});
|
||||
|
||||
const makeEvent = (log = [], results = [], error = null) => ({
|
||||
data: { messages: { log, results }, error },
|
||||
});
|
||||
|
||||
it("calls core.info for each stdout line when logToFile=false", () => {
|
||||
const event = makeEvent(["line1", "line2"]);
|
||||
handleConsoleEvent(event, { logToFile: false }, stdoutBuffer, state);
|
||||
expect(core.info).toHaveBeenCalledWith("line1");
|
||||
expect(core.info).toHaveBeenCalledWith("line2");
|
||||
expect(stdoutBuffer).toHaveLength(0);
|
||||
it("calls core.info for each stdout line with shard prefix when logToFile=false", () => {
|
||||
const event = {
|
||||
data: {
|
||||
shard: "shard0",
|
||||
messages: { log: ["line1"], results: ["line2"] },
|
||||
},
|
||||
};
|
||||
handleConsoleEvent(event, { logToFile: false }, shardBuffers, state);
|
||||
expect(core.info).toHaveBeenCalledWith("[shard0] line1");
|
||||
expect(core.info).toHaveBeenCalledWith("[shard0] line2");
|
||||
expect(Object.keys(shardBuffers)).toHaveLength(0);
|
||||
});
|
||||
|
||||
it("buffers stdout when logToFile=true; does not call core.info", () => {
|
||||
const event = makeEvent(["line1", "line2"]);
|
||||
handleConsoleEvent(event, { logToFile: true }, stdoutBuffer, state);
|
||||
const event = {
|
||||
data: { shard: "shard0", messages: { log: ["line1", "line2"] } },
|
||||
};
|
||||
handleConsoleEvent(event, { logToFile: true }, shardBuffers, state);
|
||||
expect(core.info).not.toHaveBeenCalled();
|
||||
expect(stdoutBuffer).toEqual(["line1", "line2"]);
|
||||
expect(shardBuffers["shard0"]).toEqual(["line1", "line2"]);
|
||||
});
|
||||
|
||||
it("includes results lines in output", () => {
|
||||
const event = makeEvent([], ["result1"]);
|
||||
handleConsoleEvent(event, { logToFile: false }, stdoutBuffer, state);
|
||||
handleConsoleEvent(event, { logToFile: false }, shardBuffers, state);
|
||||
expect(core.info).toHaveBeenCalledWith("result1");
|
||||
});
|
||||
|
||||
it("calls core.error when error field is non-empty", () => {
|
||||
const event = makeEvent([], [], "Script crashed");
|
||||
handleConsoleEvent(event, { logToFile: false }, stdoutBuffer, state);
|
||||
handleConsoleEvent(event, { logToFile: false }, shardBuffers, state);
|
||||
expect(core.error).toHaveBeenCalledWith("Script crashed");
|
||||
expect(state.sawErrorLog).toBe(true);
|
||||
});
|
||||
@@ -190,44 +253,74 @@ describe("handleConsoleEvent", () => {
|
||||
it("sets state.sawTraceback when error contains stack frames", () => {
|
||||
const error = "TypeError: boom\n at Object.<anonymous> (main:1:1)";
|
||||
const event = makeEvent([], [], error);
|
||||
handleConsoleEvent(event, { logToFile: false }, stdoutBuffer, state);
|
||||
handleConsoleEvent(event, { logToFile: false }, shardBuffers, state);
|
||||
expect(state.sawTraceback).toBe(true);
|
||||
expect(state.sawErrorLog).toBe(true);
|
||||
});
|
||||
|
||||
it("does not set sawTraceback for plain error without stack frames", () => {
|
||||
const event = makeEvent([], [], "Script error: low CPU");
|
||||
handleConsoleEvent(event, { logToFile: false }, stdoutBuffer, state);
|
||||
handleConsoleEvent(event, { logToFile: false }, shardBuffers, state);
|
||||
expect(state.sawTraceback).toBe(false);
|
||||
expect(state.sawErrorLog).toBe(true);
|
||||
});
|
||||
|
||||
it("sets state.sawWarningLog and calls core.warning for warn lines", () => {
|
||||
const event = makeEvent(["<font color='orange'>low energy</font>"]);
|
||||
handleConsoleEvent(event, { logToFile: false }, stdoutBuffer, state);
|
||||
handleConsoleEvent(event, { logToFile: false }, shardBuffers, state);
|
||||
expect(state.sawWarningLog).toBe(true);
|
||||
expect(core.warning).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("calls core.warning regardless of logToFile setting", () => {
|
||||
const event = makeEvent(["<font color='orange'>warn line</font>"]);
|
||||
handleConsoleEvent(event, { logToFile: true }, stdoutBuffer, state);
|
||||
handleConsoleEvent(event, { logToFile: true }, shardBuffers, state);
|
||||
expect(core.warning).toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("handles missing messages gracefully (no crash on empty event)", () => {
|
||||
const event = { data: {} };
|
||||
expect(() =>
|
||||
handleConsoleEvent(event, { logToFile: false }, stdoutBuffer, state),
|
||||
handleConsoleEvent(event, { logToFile: false }, shardBuffers, state),
|
||||
).not.toThrow();
|
||||
});
|
||||
|
||||
it("handles completely empty event gracefully", () => {
|
||||
const event = {};
|
||||
expect(() =>
|
||||
handleConsoleEvent(event, { logToFile: false }, stdoutBuffer, state),
|
||||
handleConsoleEvent(event, { logToFile: false }, shardBuffers, state),
|
||||
).not.toThrow();
|
||||
});
|
||||
|
||||
it("filters messages by shard when targetShard is provided", () => {
|
||||
const event = { data: { shard: "shard0", messages: { log: ["msg0"] } } };
|
||||
handleConsoleEvent(event, { shard: "shard1" }, shardBuffers, state);
|
||||
expect(core.info).not.toHaveBeenCalled();
|
||||
|
||||
handleConsoleEvent(event, { shard: "shard0" }, shardBuffers, state);
|
||||
expect(core.info).toHaveBeenCalledWith("[shard0] msg0");
|
||||
});
|
||||
|
||||
it("does not filter when targetShard is undefined", () => {
|
||||
const event = { data: { shard: "shard0", messages: { log: ["msg0"] } } };
|
||||
handleConsoleEvent(event, {}, shardBuffers, state);
|
||||
expect(core.info).toHaveBeenCalledWith("[shard0] msg0");
|
||||
});
|
||||
|
||||
it("buffers messages separately for different shards", () => {
|
||||
const event0 = { data: { shard: "shard0", messages: { log: ["msg0"] } } };
|
||||
const event1 = { data: { shard: "shard1", messages: { log: ["msg1"] } } };
|
||||
handleConsoleEvent(event0, { logToFile: true }, shardBuffers, state);
|
||||
handleConsoleEvent(event1, { logToFile: true }, shardBuffers, state);
|
||||
expect(shardBuffers["shard0"]).toEqual(["msg0"]);
|
||||
expect(shardBuffers["shard1"]).toEqual(["msg1"]);
|
||||
});
|
||||
|
||||
it("uses 'default' key when shard is missing in event", () => {
|
||||
const event = { data: { messages: { log: ["msg"] } } };
|
||||
handleConsoleEvent(event, { logToFile: true }, shardBuffers, state);
|
||||
expect(shardBuffers["default"]).toEqual(["msg"]);
|
||||
});
|
||||
});
|
||||
|
||||
// ────────────────────────────────────────────────────────────────────────────
|
||||
@@ -357,19 +450,19 @@ describe("monitorConsole", () => {
|
||||
);
|
||||
});
|
||||
|
||||
it("subscribes to 'shard0/console' for the official server (default)", async () => {
|
||||
it("subscribes to 'console' for the official server (default)", async () => {
|
||||
const api = buildMockApi({
|
||||
hostname: "screeps.com",
|
||||
ticks: [100, 101, 102, 103],
|
||||
});
|
||||
await monitorConsole(api, { ...BASE_OPTS, hostname: "screeps.com" });
|
||||
expect(api.socket.subscribe).toHaveBeenCalledWith(
|
||||
"shard0/console",
|
||||
"console",
|
||||
expect.any(Function),
|
||||
);
|
||||
});
|
||||
|
||||
it("subscribes to custom shard when provided", async () => {
|
||||
it("subscribes to 'console' even when custom shard is provided", async () => {
|
||||
const api = buildMockApi({
|
||||
hostname: "screeps.com",
|
||||
ticks: [100, 101, 102, 103],
|
||||
@@ -380,10 +473,10 @@ describe("monitorConsole", () => {
|
||||
shard: "shard3",
|
||||
});
|
||||
expect(api.socket.subscribe).toHaveBeenCalledWith(
|
||||
"shard3/console",
|
||||
"console",
|
||||
expect.any(Function),
|
||||
);
|
||||
// Verify polling also uses shard3
|
||||
// Verify polling still uses shard3 for timing
|
||||
expect(api.time).toHaveBeenCalledWith("shard3");
|
||||
});
|
||||
|
||||
@@ -504,4 +597,37 @@ describe("monitorConsole", () => {
|
||||
expect(result.sawTraceback).toBe(true);
|
||||
expect(result.sawErrorLog).toBe(true);
|
||||
});
|
||||
|
||||
it("creates separate log files for different shards when logToFile=true", async () => {
|
||||
const api = buildMockApi({ ticks: [100, 101, 102, 103] });
|
||||
|
||||
setTimeout(() => {
|
||||
api._fireConsole({
|
||||
shard: "shard0",
|
||||
messages: { log: ["msg0"], results: [] },
|
||||
error: null,
|
||||
});
|
||||
api._fireConsole({
|
||||
shard: "shard1",
|
||||
messages: { log: ["msg1"], results: [] },
|
||||
error: null,
|
||||
});
|
||||
}, 50);
|
||||
|
||||
// Verify uploadArtifact was called with two files
|
||||
await monitorConsole(api, {
|
||||
...BASE_OPTS,
|
||||
logToFile: true,
|
||||
});
|
||||
|
||||
expect(artifact.create().uploadArtifact).toHaveBeenCalledWith(
|
||||
"screeps-console-log",
|
||||
expect.arrayContaining([
|
||||
expect.stringContaining("shard0_console_log.txt"),
|
||||
expect.stringContaining("shard1_console_log.txt"),
|
||||
]),
|
||||
expect.any(String),
|
||||
{ continueOnError: true },
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user