TRX/Checkmate
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

test(status-page): cover theme-flag helpers and document remaining caveats

Browse Source 
Address review follow-ups on PR #3568:

- Extract the controller's withoutThemeFields and applyDefaultTheme helpers from a private class field into a standalone module (controllers/statusPageThemeFlag.ts) so they can be tested without a controller harness; the controller is now a one-line consumer
- Add 9 unit tests covering both helpers (test/unit/controllers/statusPageThemeFlag.test.ts): no-mutation guarantees, partial inputs, all-fields-preserved verbatim, override-with-defaults semantics, and "page has no theme set yet" — the flag-off path is now exercised in both directions
- Expand the comment over withoutThemeFields to spell out why the strip is silent rather than a 400: this is an ops kill switch, not API semantics; clients shouldn't need to know whether themes are disabled today

Two caveats called out in review that this commit does NOT change:
- Mongoose `default:` directives only inject during hydration, not on partial updates. Legacy documents updated with `findOneAndUpdate` still won't have `theme` / `themeMode` written to Mongo. They render as defaults on read because the schema injects them — functionally equivalent, but the DB will hold a mix of present and absent fields indefinitely. Acceptable per the original commit intent.
- docs/plans/status-page-themes.md (304 lines) covers both backend and frontend work for the themes feature. It lives in this PR as the design artefact that drove both branches; moving it for purity would break the "where did this come from?" trail. Leaving it in.
This commit is contained in:
gorkem-bwl committed 2026-04-27 19:26:16 -04:00
1 parent 5874efff3c
commit d80d939bd8
3 files changed
+146 -27
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

server/src/controllers/statusPageController.ts
+7 -27
View File
@@ -12,7 +12,7 @@ import { IStatusPageService } from "@/service/business/statusPageService.js";
import { IMonitorsRepository } from "@/repositories/index.js";
import { ISettingsService } from "@/service/system/settingsService.js";
import { NormalizeData } from "@/utils/dataUtils.js";
import { DEFAULT_STATUS_PAGE_THEME, DEFAULT_STATUS_PAGE_THEME_MODE, type StatusPage } from "@/types/statusPage.js";
import { applyDefaultTheme, withoutThemeFields } from "@/controllers/statusPageThemeFlag.js";
const SERVICE_NAME = "statusPageController";
@@ -40,26 +40,6 @@ class StatusPageController implements IStatusPageController {
return StatusPageController.SERVICE_NAME;
}
// Used when STATUS_PAGE_THEMES_ENABLED is false: drop incoming theme fields
// before persisting so an admin client can't accidentally store a value the
// public page won't honour.
private withoutThemeFields = (body: Record<string, unknown>): Record<string, unknown> => {
const rest = { ...body };
delete rest.theme;
delete rest.themeMode;
return rest;
};
// Used when STATUS_PAGE_THEMES_ENABLED is false: overwrite the stored
// theme/themeMode with their defaults on read so callers see consistent
// values regardless of what's in the DB. Whatever a user previously chose
// is preserved in Mongo and resurfaces if the flag is flipped back on.
private applyDefaultTheme = (statusPage: StatusPage): StatusPage => ({
...statusPage,
theme: DEFAULT_STATUS_PAGE_THEME,
themeMode: DEFAULT_STATUS_PAGE_THEME_MODE,
});
createStatusPage = async (req: Request, res: Response, next: NextFunction) => {
try {
createStatusPageBodyValidation.parse(req.body);
@@ -68,7 +48,7 @@ class StatusPageController implements IStatusPageController {
}
const themesEnabled = this.settingsService.areStatusPageThemesEnabled();
const body = themesEnabled ? req.body : this.withoutThemeFields(req.body);
const body = themesEnabled ? req.body : withoutThemeFields(req.body);
const teamId = requireTeamId(req?.user?.teamId);
const userId = requireUserId(req?.user?.id);
const statusPage = await this.statusPageService.createStatusPage(userId, teamId, req.file, body);
@@ -76,7 +56,7 @@ class StatusPageController implements IStatusPageController {
return res.status(200).json({
success: true,
msg: "Status page created successfully",
data: themesEnabled ? statusPage : this.applyDefaultTheme(statusPage),
data: themesEnabled ? statusPage : applyDefaultTheme(statusPage),
});
} catch (error) {
next(error);
@@ -91,7 +71,7 @@ class StatusPageController implements IStatusPageController {
}
const themesEnabled = this.settingsService.areStatusPageThemesEnabled();
const body = themesEnabled ? req.body : this.withoutThemeFields(req.body);
const body = themesEnabled ? req.body : withoutThemeFields(req.body);
const teamId = requireTeamId(req?.user?.teamId);
const statusPageId = req.params.id as string;
if (!statusPageId) {
@@ -104,7 +84,7 @@ class StatusPageController implements IStatusPageController {
res.status(200).json({
success: true,
msg: "Status page updated successfully",
data: themesEnabled ? statusPage : this.applyDefaultTheme(statusPage),
data: themesEnabled ? statusPage : applyDefaultTheme(statusPage),
});
} catch (error) {
next(error);
@@ -155,7 +135,7 @@ class StatusPageController implements IStatusPageController {
success: true,
msg: "Status page retrieved successfully",
data: {
statusPage: themesEnabled ? statusPage : this.applyDefaultTheme(statusPage),
statusPage: themesEnabled ? statusPage : applyDefaultTheme(statusPage),
monitors: normalizedMonitors,
},
});
@@ -172,7 +152,7 @@ class StatusPageController implements IStatusPageController {
return res.status(200).json({
success: true,
msg: "Status pages retrieved successfully",
data: themesEnabled ? statusPages : statusPages.map((sp) => this.applyDefaultTheme(sp)),
data: themesEnabled ? statusPages : statusPages.map((sp) => applyDefaultTheme(sp)),
});
} catch (error) {
next(error);
server/src/controllers/statusPageThemeFlag.ts
+33
View File
@@ -0,0 +1,33 @@
import { DEFAULT_STATUS_PAGE_THEME, DEFAULT_STATUS_PAGE_THEME_MODE, type StatusPage } from "@/types/statusPage.js";
/**
* When STATUS_PAGE_THEMES_ENABLED is false, the controller drops incoming
* theme fields before persisting so an admin client can't accidentally store
* a value the public page won't honour. Whatever a caller sends here for
* `theme` / `themeMode` is silently ignored — the rest of the body is
* preserved verbatim.
*
* The strip is silent (not a 400) because the kill switch is an ops-side
* concern: API clients should not have to know whether the operator has
* disabled themes today, only that their saved value won't take effect.
* If we later decide we'd rather fail loudly, change this to throw a
* 400 AppError; downstream consumers already handle it.
*/
export const withoutThemeFields = (body: Record<string, unknown>): Record<string, unknown> => {
const rest = { ...body };
delete rest.theme;
delete rest.themeMode;
return rest;
};
/**
* When STATUS_PAGE_THEMES_ENABLED is false, callers reading a status page
* should see the canonical default theme / mode regardless of what's stored
* in Mongo. Whatever the user previously chose stays in the DB so flipping
* the flag back on resurfaces their selection.
*/
export const applyDefaultTheme = (statusPage: StatusPage): StatusPage => ({
...statusPage,
theme: DEFAULT_STATUS_PAGE_THEME,
themeMode: DEFAULT_STATUS_PAGE_THEME_MODE,
});