feat: add server settings for default board, default color scheme and default locale (#1373)

* feat: add server settings for default board, default color scheme and default locale

* chore: address pull request feedback

* test: adjust unit tests to match requirements

* fix: deepsource issue

* chore: add deepsource as dependency to translation library

* refactor: restructure language-combobox, adjust default locale for next-intl

* chore: change cookie keys prefix from homarr- to homarr.

packages/db/migrations/seed.ts

@@ -1,5 +1,6 @@
 import SuperJSON from "superjson";
 
+import { objectKeys } from "@homarr/common";
 import { everyoneGroup } from "@homarr/definitions";
 import { defaultServerSettings, defaultServerSettingsKeys } from "@homarr/server-settings";
 
@@ -32,21 +33,33 @@ const seedEveryoneGroupAsync = async (db: Database) => {
 
 const seedServerSettingsAsync = async (db: Database) => {
   const serverSettingsData = await db.query.serverSettings.findMany();
-  let insertedSettingsCount = 0;
 
   for (const settingsKey of defaultServerSettingsKeys) {
-    if (serverSettingsData.some((setting) => setting.settingKey === settingsKey)) {
-      return;
+    const currentDbEntry = serverSettingsData.find((setting) => setting.settingKey === settingsKey);
+    if (!currentDbEntry) {
+      await db.insert(serverSettings).values({
+        settingKey: settingsKey,
+        value: SuperJSON.stringify(defaultServerSettings[settingsKey]),
+      });
+      console.log(`Created serverSetting through seed key=${settingsKey}`);
+      continue;
     }
 
-    await db.insert(serverSettings).values({
-      settingKey: settingsKey,
-      value: SuperJSON.stringify(defaultServerSettings[settingsKey]),
-    });
-    insertedSettingsCount++;
-  }
+    const currentSettings = SuperJSON.parse<Record<string, unknown>>(currentDbEntry.value);
+    const defaultSettings = defaultServerSettings[settingsKey];
+    const missingKeys = objectKeys(defaultSettings).filter((key) => !(key in currentSettings));
 
-  if (insertedSettingsCount > 0) {
-    console.info(`Inserted ${insertedSettingsCount} missing settings`);
+    if (missingKeys.length === 0) {
+      console.info(`Skipping seeding for serverSetting as it already exists key=${settingsKey}`);
+      continue;
+    }
+
+    await db
+      .update(serverSettings)
+      .set({
+        value: SuperJSON.stringify({ ...defaultSettings, ...currentSettings }), // Add missing keys
+      })
+      .where(eq(serverSettings.settingKey, settingsKey));
+    console.log(`Updated serverSetting through seed key=${settingsKey}`);
   }
 };

packages/db/queries/index.ts

@@ -1 +1,2 @@
 export * from "./item";
+export * from "./server-setting";

packages/db/queries/server-setting.ts

@@ -0,0 +1,52 @@
+import SuperJSON from "superjson";
+
+import type { ServerSettings } from "@homarr/server-settings";
+import { defaultServerSettings, defaultServerSettingsKeys } from "@homarr/server-settings";
+
+import type { Database } from "..";
+import { eq } from "..";
+import { serverSettings } from "../schema/sqlite";
+
+export const getServerSettingsAsync = async (db: Database) => {
+  const settings = await db.query.serverSettings.findMany();
+
+  return defaultServerSettingsKeys.reduce((acc, settingKey) => {
+    const setting = settings.find((setting) => setting.settingKey === settingKey);
+    if (!setting) {
+      // Typescript is not happy because the key is a union and it does not know that they are the same
+      acc[settingKey] = defaultServerSettings[settingKey] as never;
+      return acc;
+    }
+
+    acc[settingKey] = {
+      ...defaultServerSettings[settingKey],
+      ...SuperJSON.parse(setting.value),
+    };
+    return acc;
+  }, {} as ServerSettings);
+};
+
+export const getServerSettingByKeyAsync = async <TKey extends keyof ServerSettings>(db: Database, key: TKey) => {
+  const dbSettings = await db.query.serverSettings.findFirst({
+    where: eq(serverSettings.settingKey, key),
+  });
+
+  if (!dbSettings) {
+    return defaultServerSettings[key];
+  }
+
+  return SuperJSON.parse<ServerSettings[TKey]>(dbSettings.value);
+};
+
+export const updateServerSettingByKeyAsync = async <TKey extends keyof ServerSettings>(
+  db: Database,
+  key: TKey,
+  value: ServerSettings[TKey],
+) => {
+  await db
+    .update(serverSettings)
+    .set({
+      value: SuperJSON.stringify(value),
+    })
+    .where(eq(serverSettings.settingKey, key));
+};