refactor: apply PR feedback for rollback feature
Lint / pre-commit Linting (push) Successful in 46s
Test / Run Tests (push) Successful in 1m6s

This commit is contained in:
2026-05-16 23:28:35 +02:00
parent f9920db232
commit dce79ba192
3 changed files with 102 additions and 53 deletions
+73 -22
View File
@@ -20,6 +20,23 @@ vi.mock("../monitor.js", () => ({
}), }),
})); }));
// Mock screeps-api
vi.mock("screeps-api", () => {
const mockApi = {
auth: vi.fn().mockResolvedValue(),
code: {
get: vi.fn().mockResolvedValue({ ok: 1, modules: { main: "old_code" } }),
set: vi.fn().mockResolvedValue({ ok: 1 }),
},
};
// Use a regular function so it can be called with `new`
return {
ScreepsAPI: vi.fn(function () {
return mockApi;
}),
};
});
import * as core from "@actions/core"; import * as core from "@actions/core";
import { monitorConsole } from "../monitor.js"; import { monitorConsole } from "../monitor.js";
@@ -29,7 +46,9 @@ import {
readReplaceAndWriteFiles, readReplaceAndWriteFiles,
readFilesIntoDict, readFilesIntoDict,
applyOnAction, applyOnAction,
postCode,
} from "../index.js"; } from "../index.js";
import { ScreepsAPI } from "screeps-api";
import fs from "fs"; import fs from "fs";
import path from "path"; import path from "path";
import os from "os"; import os from "os";
@@ -231,31 +250,31 @@ describe("glob functionality", () => {
describe("applyOnAction", () => { describe("applyOnAction", () => {
beforeEach(() => vi.clearAllMocks()); beforeEach(() => vi.clearAllMocks());
it("'ignore' + true → no core call", () => { it("'ignore' + true → no core call, returns false", () => {
applyOnAction("ignore", true, "msg"); expect(applyOnAction("ignore", true, "msg")).toBe(false);
expect(core.warning).not.toHaveBeenCalled(); expect(core.warning).not.toHaveBeenCalled();
expect(core.setFailed).not.toHaveBeenCalled(); expect(core.setFailed).not.toHaveBeenCalled();
}); });
it("'warn' + true → core.warning() called with message", () => { it("'warn' + true → core.warning() called with message, returns false", () => {
applyOnAction("warn", true, "boom"); expect(applyOnAction("warn", true, "boom")).toBe(false);
expect(core.warning).toHaveBeenCalledWith("boom"); expect(core.warning).toHaveBeenCalledWith("boom");
expect(core.setFailed).not.toHaveBeenCalled(); expect(core.setFailed).not.toHaveBeenCalled();
}); });
it("'fail' + true → core.setFailed() called with message", () => { it("'fail' + true → core.setFailed() called with message, returns true", () => {
applyOnAction("fail", true, "boom"); expect(applyOnAction("fail", true, "boom")).toBe(true);
expect(core.setFailed).toHaveBeenCalledWith("boom"); expect(core.setFailed).toHaveBeenCalledWith("boom");
expect(core.warning).not.toHaveBeenCalled(); expect(core.warning).not.toHaveBeenCalled();
}); });
it("'fail' + false → no core call", () => { it("'fail' + false → no core call, returns false", () => {
applyOnAction("fail", false, "boom"); expect(applyOnAction("fail", false, "boom")).toBe(false);
expect(core.setFailed).not.toHaveBeenCalled(); expect(core.setFailed).not.toHaveBeenCalled();
}); });
it("'warn' + false → no core call", () => { it("'warn' + false → no core call, returns false", () => {
applyOnAction("warn", false, "msg"); expect(applyOnAction("warn", false, "msg")).toBe(false);
expect(core.warning).not.toHaveBeenCalled(); expect(core.warning).not.toHaveBeenCalled();
}); });
}); });
@@ -270,28 +289,60 @@ describe("postCode — monitor wiring", () => {
// Default core mocks // Default core mocks
core.getInput.mockImplementation((name) => { core.getInput.mockImplementation((name) => {
if (name === "monitor") return "0"; if (name === "monitor") return "0";
if (name === "token") return "test-token";
if (name === "branch") return "default";
if (name === "on_traceback") return "fail";
return ""; return "";
}); });
core.getBooleanInput.mockReturnValue(false); core.getBooleanInput.mockImplementation((name) => {
if (name === "rollback_on_failure") return false;
return false;
});
}); });
it("does not call monitorConsole when monitor=0 (default)", async () => { it("does not call monitorConsole when monitor=0 (default)", async () => {
// We need to mock the rest of postCode to not fail before it hits the monitor block // We just run postCode with monitor=0 and verify monitorConsole is not called.
// This is a bit complex as postCode is large, but we can mock the inputs to exit early or mock the API await postCode();
// Actually, I'll just check if monitorConsole is called. expect(monitorConsole).not.toHaveBeenCalled();
});
// For this test, I'll make validateAuthentication fail so it returns early but after input check it("rolls back to previous code when monitor detects a failure and rollback_on_failure is true", async () => {
// Setup inputs for monitor and rollback
core.getInput.mockImplementation((name) => { core.getInput.mockImplementation((name) => {
if (name === "monitor") return "0"; if (name === "monitor") return "10";
if (name === "token") return "test-token";
if (name === "branch") return "default";
if (name === "on_traceback") return "fail";
return ""; return "";
}); });
core.getBooleanInput.mockImplementation((name) => {
if (name === "rollback_on_failure") return true;
return false;
});
// We'll just run a partial check or rely on the monitor unit tests for depth // Simulate a failure in monitorConsole
// The wiring in index.js is: monitorConsole.mockResolvedValueOnce({
// const monitorTicks = parseInt(core.getInput("monitor") || "0", 10); sawTraceback: true, // Should trigger "fail" due to on_traceback=fail
// if (monitorTicks > 0) { ... } sawErrorLog: false,
sawWarningLog: false,
});
// Testing the logic inside index.js directly by calling postCode would require full environment mock. await postCode();
// I'll stick to the applyOnAction unit tests and rely on monitor.test.js for the heavy lifting.
// Verify rollback was performed
const mockApiInstance = new ScreepsAPI();
// `code.set` should be called twice:
// 1st time: uploading the new files
// 2nd time: rolling back to oldCode
expect(mockApiInstance.code.set).toHaveBeenCalledTimes(2);
expect(mockApiInstance.code.set).toHaveBeenNthCalledWith(2, "default", {
main: "old_code",
});
// Verify it called core.setFailed due to traceback
expect(core.setFailed).toHaveBeenCalledWith(
"Screeps console: traceback detected",
);
}); });
}); });
+1 -1
View File
File diff suppressed because one or more lines are too long
+28 -30
View File
@@ -118,17 +118,19 @@ export function validateAuthentication(token, username, password) {
* @param {'ignore'|'warn'|'fail'} action * @param {'ignore'|'warn'|'fail'} action
* @param {boolean} flag - Only acts when true * @param {boolean} flag - Only acts when true
* @param {string} message - Passed to core.warning / core.setFailed * @param {string} message - Passed to core.warning / core.setFailed
* @returns {boolean} - Returns true if the action was 'fail' and the flag was true.
*/ */
export function applyOnAction(action, flag, message) { export function applyOnAction(action, flag, message) {
if (!flag) return; if (!flag) return false;
if (action === "warn") { if (action === "warn") {
core.warning(message); core.warning(message);
return; return false;
} }
if (action === "fail") { if (action === "fail") {
core.setFailed(message); core.setFailed(message);
return true;
} }
// 'ignore' → no-op return false;
} }
/** /**
@@ -210,14 +212,16 @@ export async function postCode() {
`Successfully downloaded existing code (modules: ${Object.keys(oldCode).join(", ")})`, `Successfully downloaded existing code (modules: ${Object.keys(oldCode).join(", ")})`,
); );
} else { } else {
core.warning( core.setFailed(
`Failed to download existing code, rollback will not be possible.`, `Failed to download existing code, but rollback_on_failure is enabled. Aborting deployment.`,
); );
return;
} }
} catch (err) { } catch (err) {
core.warning( core.setFailed(
`Error downloading existing code: ${err.message}. Rollback will not be possible.`, `Error downloading existing code: ${err.message}. Aborting deployment.`,
); );
return;
} }
} }
@@ -248,13 +252,23 @@ export async function postCode() {
core.setOutput("saw_error_log", String(result.sawErrorLog)); core.setOutput("saw_error_log", String(result.sawErrorLog));
core.setOutput("saw_warning_log", String(result.sawWarningLog)); core.setOutput("saw_warning_log", String(result.sawWarningLog));
let shouldFail = false; const fail1 = applyOnAction(
if (core.getInput("on_traceback") === "fail" && result.sawTraceback) core.getInput("on_traceback") || "fail",
shouldFail = true; result.sawTraceback,
if (core.getInput("on_error_log") === "fail" && result.sawErrorLog) "Screeps console: traceback detected",
shouldFail = true; );
if (core.getInput("on_warning_log") === "fail" && result.sawWarningLog) const fail2 = applyOnAction(
shouldFail = true; core.getInput("on_error_log") || "warn",
result.sawErrorLog,
"Screeps console: error log output detected",
);
const fail3 = applyOnAction(
core.getInput("on_warning_log") || "ignore",
result.sawWarningLog,
"Screeps console: warning log output detected",
);
const shouldFail = fail1 || fail2 || fail3;
if (shouldFail && rollbackOnFailure && oldCode) { if (shouldFail && rollbackOnFailure && oldCode) {
core.info( core.info(
@@ -269,22 +283,6 @@ export async function postCode() {
core.error(`Rollback failed: ${err}`); core.error(`Rollback failed: ${err}`);
} }
} }
applyOnAction(
core.getInput("on_traceback"),
result.sawTraceback,
"Screeps console: traceback detected",
);
applyOnAction(
core.getInput("on_error_log"),
result.sawErrorLog,
"Screeps console: error log output detected",
);
applyOnAction(
core.getInput("on_warning_log"),
result.sawWarningLog,
"Screeps console: warning log output detected",
);
} }
} }