Skip to content

chore: api status-page locale #2003

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mxkaske merged 6 commits into from
Mar 23, 2026
Merged

chore: api status-page locale #2003

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3f22671
chore: api status-page locale
mxkaske Mar 22, 2026
b507e7b
fix: review
mxkaske Mar 22, 2026
acc461a
fix: review
mxkaske Mar 23, 2026
f994a96
fix: review
mxkaske Mar 23, 2026
488c61d
fix: test
mxkaske Mar 23, 2026
d75fd32
fix: review
mxkaske Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
285 changes: 285 additions & 0 deletions apps/server/src/routes/rpc/services/status-page/__tests__/status-page.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,18 @@ afterAll(async () => {
await db.delete(page).where(eq(page.slug, `${TEST_PREFIX}-slug-to-delete`));
await db.delete(page).where(eq(page.slug, `${TEST_PREFIX}-slug-to-update`));
await db.delete(page).where(eq(page.slug, `${TEST_PREFIX}-created-slug`));
await db
.delete(page)
.where(eq(page.slug, `${TEST_PREFIX}-locale-create-slug`));
await db
.delete(page)
.where(eq(page.slug, `${TEST_PREFIX}-locale-default-slug`));
await db
.delete(page)
.where(eq(page.slug, `${TEST_PREFIX}-locale-invalid-slug`));
await db
.delete(page)
.where(eq(page.slug, `${TEST_PREFIX}-locale-dedup-slug`));

await db.delete(monitor).where(eq(monitor.name, `${TEST_PREFIX}-monitor`));
});
Expand Down Expand Up @@ -542,6 +554,279 @@ describe("StatusPageService.UpdateStatusPage", () => {

expect(res.status).toBe(409);
});

test("updates locale settings", async () => {
const res = await connectRequest(
"UpdateStatusPage",
{
id: String(testPageToUpdateId),
defaultLocale: "LOCALE_FR",
locales: ["LOCALE_EN", "LOCALE_FR", "LOCALE_DE"],
},
{ "x-openstatus-key": "1" },
);

expect(res.status).toBe(200);

const data = await res.json();
expect(data.statusPage.defaultLocale).toBe("LOCALE_FR");
expect(data.statusPage.locales).toEqual([
"LOCALE_EN",
"LOCALE_FR",
"LOCALE_DE",
]);

// Restore defaults
await db
.update(page)
.set({ defaultLocale: "en", locales: null })
.where(eq(page.id, testPageToUpdateId));
});

test("clears locales when field is omitted", async () => {
// Set some locales
await db
.update(page)
.set({ defaultLocale: "en", locales: ["en", "fr"] })
.where(eq(page.id, testPageToUpdateId));

// Omitting locales clears them (same as sending [])
const res = await connectRequest(
"UpdateStatusPage",
{
id: String(testPageToUpdateId),
title: `${TEST_PREFIX}-no-locale-change`,
},
{ "x-openstatus-key": "1" },
);

expect(res.status).toBe(200);

const data = await res.json();
expect(data.statusPage.locales ?? []).toEqual([]);

// Restore defaults
await db
.update(page)
.set({
title: `${TEST_PREFIX}-page-to-update`,
defaultLocale: "en",
locales: null,
})
.where(eq(page.id, testPageToUpdateId));
});

test("resets locales to null when empty list is sent", async () => {
// First set some locales
await db
.update(page)
.set({ defaultLocale: "en", locales: ["en", "fr"] })
.where(eq(page.id, testPageToUpdateId));

// Send empty locales to clear them
const res = await connectRequest(
"UpdateStatusPage",
{
id: String(testPageToUpdateId),
locales: [],
},
{ "x-openstatus-key": "1" },
);

expect(res.status).toBe(200);

const data = await res.json();
expect(data.statusPage.locales ?? []).toEqual([]);

// Restore defaults
await db
.update(page)
.set({ defaultLocale: "en", locales: null })
.where(eq(page.id, testPageToUpdateId));
});
});

// ==========================================================================
// Locale Support
// ==========================================================================

describe("StatusPageService locale fields", () => {
test("creates a page with locale settings", async () => {
const res = await connectRequest(
"CreateStatusPage",
{
title: `${TEST_PREFIX}-locale-create`,
slug: `${TEST_PREFIX}-locale-create-slug`,
defaultLocale: "LOCALE_DE",
locales: ["LOCALE_EN", "LOCALE_DE"],
},
{ "x-openstatus-key": "1" },
);

expect(res.status).toBe(200);

const data = await res.json();
expect(data.statusPage.defaultLocale).toBe("LOCALE_DE");
expect(data.statusPage.locales).toEqual(["LOCALE_EN", "LOCALE_DE"]);

// Clean up
await db.delete(page).where(eq(page.id, Number(data.statusPage.id)));
});

test("creates a page with default locale when none specified", async () => {
const res = await connectRequest(
"CreateStatusPage",
{
title: `${TEST_PREFIX}-locale-default`,
slug: `${TEST_PREFIX}-locale-default-slug`,
},
{ "x-openstatus-key": "1" },
);

expect(res.status).toBe(200);

const data = await res.json();
expect(data.statusPage.defaultLocale).toBe("LOCALE_EN");
// ConnectRPC omits empty repeated fields in JSON
expect(data.statusPage.locales ?? []).toEqual([]);

// Clean up
await db.delete(page).where(eq(page.id, Number(data.statusPage.id)));
});

test("returns locale fields in GetStatusPage", async () => {
// Set locale on test page
await db
.update(page)
.set({ defaultLocale: "fr", locales: ["en", "fr"] })
.where(eq(page.id, testPageId));

const res = await connectRequest(
"GetStatusPage",
{ id: String(testPageId) },
{ "x-openstatus-key": "1" },
);

expect(res.status).toBe(200);

const data = await res.json();
expect(data.statusPage.defaultLocale).toBe("LOCALE_FR");
expect(data.statusPage.locales).toEqual(["LOCALE_EN", "LOCALE_FR"]);

// Restore defaults
await db
.update(page)
.set({ defaultLocale: "en", locales: null })
.where(eq(page.id, testPageId));
});

test("returns locale fields in GetStatusPageContent", async () => {
await db
.update(page)
.set({ defaultLocale: "de", locales: ["en", "de"] })
.where(eq(page.id, testPageId));

const res = await connectRequest(
"GetStatusPageContent",
{ slug: testPageSlug },
{ "x-openstatus-key": "1" },
);

expect(res.status).toBe(200);

const data = await res.json();
expect(data.statusPage.defaultLocale).toBe("LOCALE_DE");
expect(data.statusPage.locales).toEqual(["LOCALE_EN", "LOCALE_DE"]);

// Restore defaults
await db
.update(page)
.set({ defaultLocale: "en", locales: null })
.where(eq(page.id, testPageId));
});

test("create returns 400 when defaultLocale is not in locales", async () => {
const res = await connectRequest(
"CreateStatusPage",
{
title: `${TEST_PREFIX}-locale-invalid`,
slug: `${TEST_PREFIX}-locale-invalid-slug`,
defaultLocale: "LOCALE_FR",
locales: ["LOCALE_EN", "LOCALE_DE"],
},
{ "x-openstatus-key": "1" },
);

expect(res.status).toBe(400);

const data = await res.json();
expect(data.message).toContain(
"Default locale must be included in the locales list",
);
});

test("update returns 400 when defaultLocale is not in locales", async () => {
const res = await connectRequest(
"UpdateStatusPage",
{
id: String(testPageToUpdateId),
defaultLocale: "LOCALE_FR",
locales: ["LOCALE_EN", "LOCALE_DE"],
},
{ "x-openstatus-key": "1" },
);

expect(res.status).toBe(400);

const data = await res.json();
expect(data.message).toContain(
"Default locale must be included in the locales list",
);
});

test("create deduplicates locales", async () => {
const res = await connectRequest(
"CreateStatusPage",
{
title: `${TEST_PREFIX}-locale-dedup`,
slug: `${TEST_PREFIX}-locale-dedup-slug`,
defaultLocale: "LOCALE_EN",
locales: ["LOCALE_EN", "LOCALE_EN", "LOCALE_DE"],
},
{ "x-openstatus-key": "1" },
);

expect(res.status).toBe(200);

const data = await res.json();
expect(data.statusPage.locales).toEqual(["LOCALE_EN", "LOCALE_DE"]);

// Clean up
await db.delete(page).where(eq(page.id, Number(data.statusPage.id)));
});

test("update deduplicates locales", async () => {
const res = await connectRequest(
"UpdateStatusPage",
{
id: String(testPageToUpdateId),
defaultLocale: "LOCALE_EN",
locales: ["LOCALE_EN", "LOCALE_EN", "LOCALE_DE", "LOCALE_DE"],
},
{ "x-openstatus-key": "1" },
);

expect(res.status).toBe(200);

const data = await res.json();
expect(data.statusPage.locales).toEqual(["LOCALE_EN", "LOCALE_DE"]);

// Restore defaults
await db
.update(page)
.set({ defaultLocale: "en", locales: null })
.where(eq(page.id, testPageToUpdateId));
});
});

describe("StatusPageService.DeleteStatusPage", () => {
Expand Down
38 changes: 38 additions & 0 deletions apps/server/src/routes/rpc/services/status-page/converters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type { Locale } from "@openstatus/locales";
import type {
PageComponent,
PageComponentGroup,
Expand All @@ -10,6 +11,7 @@ import {
PageAccessType,
PageComponentType,
PageTheme,
Locale as ProtoLocale,
} from "@openstatus/proto/status_page/v1";

/**
Expand All @@ -27,6 +29,8 @@ type DBPage = {
homepageUrl: string | null;
contactUrl: string | null;
icon: string | null;
defaultLocale: Locale;
locales: Locale[] | null;
createdAt: Date | null;
updatedAt: Date | null;
};
Expand Down Expand Up @@ -163,6 +167,38 @@ export function protoComponentTypeToDb(
}
}

/**
* Convert DB locale string to proto enum.
*/
export function dbLocaleToProto(locale: Locale): ProtoLocale {
switch (locale) {
case "en":
return ProtoLocale.EN;
case "fr":
return ProtoLocale.FR;
case "de":
return ProtoLocale.DE;
default:
return ProtoLocale.EN;
}
}

/**
* Convert proto locale enum to DB string.
*/
export function protoLocaleToDb(locale: ProtoLocale): Locale {
switch (locale) {
case ProtoLocale.EN:
return "en";
case ProtoLocale.FR:
return "fr";
case ProtoLocale.DE:
return "de";
default:
return "en";
}
}

/**
* Convert a DB status page to full proto format.
*/
Expand All @@ -182,6 +218,8 @@ export function dbPageToProto(page: DBPage): StatusPage {
icon: page.icon ?? "",
createdAt: page.createdAt?.toISOString() ?? "",
updatedAt: page.updatedAt?.toISOString() ?? "",
defaultLocale: dbLocaleToProto(page.defaultLocale),
locales: page.locales?.map(dbLocaleToProto) ?? [],
};
}

Expand Down
Loading
Loading