fix: review

Author: mxkaske

apps/server/src/routes/rpc/services/status-page/__tests__/status-page.test.ts

@@ -267,6 +267,9 @@ afterAll(async () => {
   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(monitor).where(eq(monitor.name, `${TEST_PREFIX}-monitor`));
 });
@@ -552,7 +555,7 @@ describe("StatusPageService.UpdateStatusPage", () => {
       {
         id: String(testPageToUpdateId),
         defaultLocale: "LOCALE_FR",
-        locales: ["LOCALE_EN", "LOCALE_FR", "LOCALE_DE"],
+        locales: { locales: ["LOCALE_EN", "LOCALE_FR", "LOCALE_DE"] },
       },
       { "x-openstatus-key": "1" },
     );
@@ -573,6 +576,70 @@ describe("StatusPageService.UpdateStatusPage", () => {
       .set({ defaultLocale: "en", locales: null })
       .where(eq(page.id, testPageToUpdateId));
   });
+
+  test("clears locale settings when empty LocaleList is sent", async () => {
+    // First set some locales
+    await db
+      .update(page)
+      .set({ defaultLocale: "en", locales: ["en", "fr"] })
+      .where(eq(page.id, testPageToUpdateId));
+
+    // Send empty LocaleList to clear
+    const res = await connectRequest(
+      "UpdateStatusPage",
+      {
+        id: String(testPageToUpdateId),
+        locales: { locales: [] },
+      },
+      { "x-openstatus-key": "1" },
+    );
+
+    expect(res.status).toBe(200);
+
+    const data = await res.json();
+    // Locales should be cleared (empty array or omitted)
+    expect(data.statusPage.locales ?? []).toEqual([]);
+
+    // Restore defaults
+    await db
+      .update(page)
+      .set({ defaultLocale: "en", locales: null })
+      .where(eq(page.id, testPageToUpdateId));
+  });
+
+  test("does not change locales when field is omitted", async () => {
+    // Set some locales
+    await db
+      .update(page)
+      .set({ defaultLocale: "en", locales: ["en", "fr"] })
+      .where(eq(page.id, testPageToUpdateId));
+
+    // Update only the title, omit locales entirely
+    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();
+    // Locales should remain unchanged
+    expect(data.statusPage.locales).toEqual(["LOCALE_EN", "LOCALE_FR"]);
+
+    // Restore defaults
+    await db
+      .update(page)
+      .set({
+        title: `${TEST_PREFIX}-page-to-update`,
+        defaultLocale: "en",
+        locales: null,
+      })
+      .where(eq(page.id, testPageToUpdateId));
+  });
 });
 
 // ==========================================================================
@@ -607,7 +674,7 @@ describe("StatusPageService locale fields", () => {
       "CreateStatusPage",
       {
         title: `${TEST_PREFIX}-locale-default`,
-        slug: `${TEST_PREFIX}-locale-create-slug`,
+        slug: `${TEST_PREFIX}-locale-default-slug`,
       },
       { "x-openstatus-key": "1" },
     );

apps/server/src/routes/rpc/services/status-page/index.ts

@@ -1,4 +1,4 @@
-import type { ServiceImpl } from "@connectrpc/connect";
+import { Code, ConnectError, type ServiceImpl } from "@connectrpc/connect";
 import {
   and,
   count,
@@ -158,6 +158,23 @@ export const statusPageServiceImpl: ServiceImpl<typeof StatusPageService> = {
       throw slugAlreadyExistsError(req.slug);
     }
 
+    // Resolve locale values
+    const defaultLocale =
+      req.defaultLocale !== undefined && req.defaultLocale !== 0
+        ? protoLocaleToDb(req.defaultLocale)
+        : "en";
+    const validLocales = req.locales.filter((l) => l !== 0);
+    const locales =
+      validLocales.length > 0 ? validLocales.map(protoLocaleToDb) : null;
+
+    // Validate defaultLocale is included in locales when locales are provided
+    if (locales && !locales.includes(defaultLocale)) {
+      throw new ConnectError(
+        "Default locale must be included in the locales list",
+        Code.InvalidArgument,
+      );
+    }
+
     // Create the status page
     const newPage = await db
       .insert(page)
@@ -170,11 +187,8 @@ export const statusPageServiceImpl: ServiceImpl<typeof StatusPageService> = {
         published: false,
         homepageUrl: req.homepageUrl ?? null,
         contactUrl: req.contactUrl ?? null,
-        defaultLocale: req.defaultLocale
-          ? protoLocaleToDb(req.defaultLocale)
-          : "en",
-        locales:
-          req.locales.length > 0 ? req.locales.map(protoLocaleToDb) : null,
+        defaultLocale,
+        locales,
       })
       .returning()
       .get();
@@ -284,8 +298,24 @@ export const statusPageServiceImpl: ServiceImpl<typeof StatusPageService> = {
     if (req.defaultLocale !== undefined) {
       updateValues.defaultLocale = protoLocaleToDb(req.defaultLocale);
     }
-    if (req.locales.length > 0) {
-      updateValues.locales = req.locales.map(protoLocaleToDb);
+    if (req.locales !== undefined) {
+      const validLocales = req.locales.locales.filter((l) => l !== 0);
+      updateValues.locales =
+        validLocales.length > 0 ? validLocales.map(protoLocaleToDb) : null;
+    }
+
+    // Validate defaultLocale is included in locales
+    const finalDefaultLocale =
+      (updateValues.defaultLocale as string) ?? pageData.defaultLocale;
+    const finalLocales =
+      "locales" in updateValues
+        ? (updateValues.locales as string[] | null)
+        : (pageData.locales as string[] | null);
+    if (finalLocales && !finalLocales.includes(finalDefaultLocale)) {
+      throw new ConnectError(
+        "Default locale must be included in the locales list",
+        Code.InvalidArgument,
+      );
     }
 
     const updatedPage = await db

packages/proto/api/openstatus/status_page/v1/service.proto

@@ -196,7 +196,8 @@ message UpdateStatusPageRequest {
   optional Locale default_locale = 7;
 
   // New enabled locales for the status page (optional).
-  repeated Locale locales = 8;
+  // When absent: don't change. When present but empty: clear locales. When present with values: set locales.
+  optional LocaleList locales = 8;
 }
 
 // UpdateStatusPageResponse is the response after updating a status page.

packages/proto/api/openstatus/status_page/v1/status_page.proto

@@ -30,6 +30,12 @@ enum Locale {
   LOCALE_DE = 3;
 }
 
+// LocaleList is a wrapper message for a list of locales.
+// Used with `optional` to distinguish "not set" from "set to empty".
+message LocaleList {
+  repeated Locale locales = 1;
+}
+
 // OverallStatus represents the aggregated status of all components on a page.
 enum OverallStatus {
   OVERALL_STATUS_UNSPECIFIED = 0;

packages/proto/gen/ts/openstatus/status_page/v1/service_pb.ts

@@ -11,7 +11,27 @@ import type { Message } from "@bufbuild/protobuf";
  * Describes the file openstatus/status_page/v1/status_page.proto.
  */
 export const file_openstatus_status_page_v1_status_page: GenFile = /*@__PURE__*/
-  fileDesc("CitvcGVuc3RhdHVzL3N0YXR1c19wYWdlL3YxL3N0YXR1c19wYWdlLnByb3RvEhlvcGVuc3RhdHVzLnN0YXR1c19wYWdlLnYxIqAECgpTdGF0dXNQYWdlEgoKAmlkGAEgASgJEg0KBXRpdGxlGAIgASgJEhMKC2Rlc2NyaXB0aW9uGAMgASgJEh4KBHNsdWcYBCABKAlCELpHDToLEglhY21lLWNvcnASMAoNY3VzdG9tX2RvbWFpbhgFIAEoCUIZukcWOhQSEnN0YXR1cy5leGFtcGxlLmNvbRIRCglwdWJsaXNoZWQYBiABKAgSPgoLYWNjZXNzX3R5cGUYByABKA4yKS5vcGVuc3RhdHVzLnN0YXR1c19wYWdlLnYxLlBhZ2VBY2Nlc3NUeXBlEjMKBXRoZW1lGAggASgOMiQub3BlbnN0YXR1cy5zdGF0dXNfcGFnZS52MS5QYWdlVGhlbWUSFAoMaG9tZXBhZ2VfdXJsGAkgASgJEhMKC2NvbnRhY3RfdXJsGAogASgJEgwKBGljb24YCyABKAkSLwoKY3JlYXRlZF9hdBgMIAEoCUIbukcYOhYSFDIwMjQtMDEtMTVUMDk6MDA6MDBaEi8KCnVwZGF0ZWRfYXQYDSABKAlCG7pHGDoWEhQyMDI0LTA2LTIwVDE0OjMwOjAwWhI5Cg5kZWZhdWx0X2xvY2FsZRgOIAEoDjIhLm9wZW5zdGF0dXMuc3RhdHVzX3BhZ2UudjEuTG9jYWxlEjIKB2xvY2FsZXMYDyADKA4yIS5vcGVuc3RhdHVzLnN0YXR1c19wYWdlLnYxLkxvY2FsZSJ3ChFTdGF0dXNQYWdlU3VtbWFyeRIKCgJpZBgBIAEoCRINCgV0aXRsZRgCIAEoCRIMCgRzbHVnGAMgASgJEhEKCXB1Ymxpc2hlZBgEIAEoCBISCgpjcmVhdGVkX2F0GAUgASgJEhIKCnVwZGF0ZWRfYXQYBiABKAkqnAEKDlBhZ2VBY2Nlc3NUeXBlEiAKHFBBR0VfQUNDRVNTX1RZUEVfVU5TUEVDSUZJRUQQABIbChdQQUdFX0FDQ0VTU19UWVBFX1BVQkxJQxABEicKI1BBR0VfQUNDRVNTX1RZUEVfUEFTU1dPUkRfUFJPVEVDVEVEEAISIgoeUEFHRV9BQ0NFU1NfVFlQRV9BVVRIRU5USUNBVEVEEAMqaQoJUGFnZVRoZW1lEhoKFlBBR0VfVEhFTUVfVU5TUEVDSUZJRUQQABIVChFQQUdFX1RIRU1FX1NZU1RFTRABEhQKEFBBR0VfVEhFTUVfTElHSFQQAhITCg9QQUdFX1RIRU1FX0RBUksQAypNCgZMb2NhbGUSFgoSTE9DQUxFX1VOU1BFQ0lGSUVEEAASDQoJTE9DQUxFX0VOEAESDQoJTE9DQUxFX0ZSEAISDQoJTE9DQUxFX0RFEAMq7AEKDU92ZXJhbGxTdGF0dXMSHgoaT1ZFUkFMTF9TVEFUVVNfVU5TUEVDSUZJRUQQABIeChpPVkVSQUxMX1NUQVRVU19PUEVSQVRJT05BTBABEhsKF09WRVJBTExfU1RBVFVTX0RFR1JBREVEEAISIQodT1ZFUkFMTF9TVEFUVVNfUEFSVElBTF9PVVRBR0UQAxIfChtPVkVSQUxMX1NUQVRVU19NQUpPUl9PVVRBR0UQBBIeChpPVkVSQUxMX1NUQVRVU19NQUlOVEVOQU5DRRAFEhoKFk9WRVJBTExfU1RBVFVTX1VOS05PV04QBkJaWlhnaXRodWIuY29tL29wZW5zdGF0dXNocS9vcGVuc3RhdHVzL3BhY2thZ2VzL3Byb3RvL29wZW5zdGF0dXMvc3RhdHVzX3BhZ2UvdjE7c3RhdHVzcGFnZXYxYgZwcm90bzM", [file_gnostic_openapi_v3_annotations]);
+  fileDesc("CitvcGVuc3RhdHVzL3N0YXR1c19wYWdlL3YxL3N0YXR1c19wYWdlLnByb3RvEhlvcGVuc3RhdHVzLnN0YXR1c19wYWdlLnYxIkAKCkxvY2FsZUxpc3QSMgoHbG9jYWxlcxgBIAMoDjIhLm9wZW5zdGF0dXMuc3RhdHVzX3BhZ2UudjEuTG9jYWxlIqAECgpTdGF0dXNQYWdlEgoKAmlkGAEgASgJEg0KBXRpdGxlGAIgASgJEhMKC2Rlc2NyaXB0aW9uGAMgASgJEh4KBHNsdWcYBCABKAlCELpHDToLEglhY21lLWNvcnASMAoNY3VzdG9tX2RvbWFpbhgFIAEoCUIZukcWOhQSEnN0YXR1cy5leGFtcGxlLmNvbRIRCglwdWJsaXNoZWQYBiABKAgSPgoLYWNjZXNzX3R5cGUYByABKA4yKS5vcGVuc3RhdHVzLnN0YXR1c19wYWdlLnYxLlBhZ2VBY2Nlc3NUeXBlEjMKBXRoZW1lGAggASgOMiQub3BlbnN0YXR1cy5zdGF0dXNfcGFnZS52MS5QYWdlVGhlbWUSFAoMaG9tZXBhZ2VfdXJsGAkgASgJEhMKC2NvbnRhY3RfdXJsGAogASgJEgwKBGljb24YCyABKAkSLwoKY3JlYXRlZF9hdBgMIAEoCUIbukcYOhYSFDIwMjQtMDEtMTVUMDk6MDA6MDBaEi8KCnVwZGF0ZWRfYXQYDSABKAlCG7pHGDoWEhQyMDI0LTA2LTIwVDE0OjMwOjAwWhI5Cg5kZWZhdWx0X2xvY2FsZRgOIAEoDjIhLm9wZW5zdGF0dXMuc3RhdHVzX3BhZ2UudjEuTG9jYWxlEjIKB2xvY2FsZXMYDyADKA4yIS5vcGVuc3RhdHVzLnN0YXR1c19wYWdlLnYxLkxvY2FsZSJ3ChFTdGF0dXNQYWdlU3VtbWFyeRIKCgJpZBgBIAEoCRINCgV0aXRsZRgCIAEoCRIMCgRzbHVnGAMgASgJEhEKCXB1Ymxpc2hlZBgEIAEoCBISCgpjcmVhdGVkX2F0GAUgASgJEhIKCnVwZGF0ZWRfYXQYBiABKAkqnAEKDlBhZ2VBY2Nlc3NUeXBlEiAKHFBBR0VfQUNDRVNTX1RZUEVfVU5TUEVDSUZJRUQQABIbChdQQUdFX0FDQ0VTU19UWVBFX1BVQkxJQxABEicKI1BBR0VfQUNDRVNTX1RZUEVfUEFTU1dPUkRfUFJPVEVDVEVEEAISIgoeUEFHRV9BQ0NFU1NfVFlQRV9BVVRIRU5USUNBVEVEEAMqaQoJUGFnZVRoZW1lEhoKFlBBR0VfVEhFTUVfVU5TUEVDSUZJRUQQABIVChFQQUdFX1RIRU1FX1NZU1RFTRABEhQKEFBBR0VfVEhFTUVfTElHSFQQAhITCg9QQUdFX1RIRU1FX0RBUksQAypNCgZMb2NhbGUSFgoSTE9DQUxFX1VOU1BFQ0lGSUVEEAASDQoJTE9DQUxFX0VOEAESDQoJTE9DQUxFX0ZSEAISDQoJTE9DQUxFX0RFEAMq7AEKDU92ZXJhbGxTdGF0dXMSHgoaT1ZFUkFMTF9TVEFUVVNfVU5TUEVDSUZJRUQQABIeChpPVkVSQUxMX1NUQVRVU19PUEVSQVRJT05BTBABEhsKF09WRVJBTExfU1RBVFVTX0RFR1JBREVEEAISIQodT1ZFUkFMTF9TVEFUVVNfUEFSVElBTF9PVVRBR0UQAxIfChtPVkVSQUxMX1NUQVRVU19NQUpPUl9PVVRBR0UQBBIeChpPVkVSQUxMX1NUQVRVU19NQUlOVEVOQU5DRRAFEhoKFk9WRVJBTExfU1RBVFVTX1VOS05PV04QBkJaWlhnaXRodWIuY29tL29wZW5zdGF0dXNocS9vcGVuc3RhdHVzL3BhY2thZ2VzL3Byb3RvL29wZW5zdGF0dXMvc3RhdHVzX3BhZ2UvdjE7c3RhdHVzcGFnZXYxYgZwcm90bzM", [file_gnostic_openapi_v3_annotations]);
+
+/**
+ * LocaleList is a wrapper message for a list of locales.
+ * Used with `optional` to distinguish "not set" from "set to empty".
+ *
+ * @generated from message openstatus.status_page.v1.LocaleList
+ */
+export type LocaleList = Message<"openstatus.status_page.v1.LocaleList"> & {
+  /**
+   * @generated from field: repeated openstatus.status_page.v1.Locale locales = 1;
+   */
+  locales: Locale[];
+};
+
+/**
+ * Describes the message openstatus.status_page.v1.LocaleList.
+ * Use `create(LocaleListSchema)` to create a new message.
+ */
+export const LocaleListSchema: GenMessage<LocaleList> = /*@__PURE__*/
+  messageDesc(file_openstatus_status_page_v1_status_page, 0);
 
 /**
  * StatusPage represents a full status page with all details.
@@ -130,7 +150,7 @@ export type StatusPage = Message<"openstatus.status_page.v1.StatusPage"> & {
  * Use `create(StatusPageSchema)` to create a new message.
  */
 export const StatusPageSchema: GenMessage<StatusPage> = /*@__PURE__*/
-  messageDesc(file_openstatus_status_page_v1_status_page, 0);
+  messageDesc(file_openstatus_status_page_v1_status_page, 1);
 
 /**
  * StatusPageSummary represents metadata for a status page (used in list responses).
@@ -186,7 +206,7 @@ export type StatusPageSummary = Message<"openstatus.status_page.v1.StatusPageSum
  * Use `create(StatusPageSummarySchema)` to create a new message.
  */
 export const StatusPageSummarySchema: GenMessage<StatusPageSummary> = /*@__PURE__*/
-  messageDesc(file_openstatus_status_page_v1_status_page, 1);
+  messageDesc(file_openstatus_status_page_v1_status_page, 2);
 
 /**
  * PageAccessType defines who can access the status page.