Merge branch 'main' of https://github.com/zulip/zulip-desktop into test

Author: tarun8718

app/common/config-util.ts

@@ -4,9 +4,40 @@ import path from "path";
 
 import {JsonDB} from "node-json-db";
 
+import type {DNDSettings} from "./dnd-util";
 import * as EnterpriseUtil from "./enterprise-util";
 import Logger from "./logger-util";
 
+export interface Config extends DNDSettings {
+  appLanguage: string | null;
+  autoHideMenubar: boolean;
+  autoUpdate: boolean;
+  badgeOption: boolean;
+  betaUpdate: boolean;
+  customCSS: string | false | null;
+  dnd: boolean;
+  dndPreviousSettings: Partial<DNDSettings>;
+  dockBouncing: boolean;
+  downloadsPath: string;
+  enableSpellchecker: boolean;
+  errorReporting: boolean;
+  lastActiveTab: number;
+  promptDownload: boolean;
+  proxyBypass: string;
+  proxyPAC: string;
+  proxyRules: string;
+  quitOnClose: boolean;
+  showSidebar: boolean;
+  spellcheckerLanguages: string[] | null;
+  startAtLogin: boolean;
+  startMinimized: boolean;
+  systemProxyRules: string;
+  trayIcon: boolean;
+  useManualProxy: boolean;
+  useProxy: boolean;
+  useSystemProxy: boolean;
+}
+
 /* To make the util runnable in both main and renderer process */
 const {app, dialog} = process.type === "renderer" ? electron.remote : electron;
 
@@ -18,7 +49,10 @@ let db: JsonDB;
 
 reloadDB();
 
-export function getConfigItem(key: string, defaultValue: unknown = null): any {
+export function getConfigItem<Key extends keyof Config>(
+  key: Key,
+  defaultValue: Config[Key],
+): Config[Key] {
   try {
     db.reload();
   } catch (error: unknown) {
@@ -35,16 +69,6 @@ export function getConfigItem(key: string, defaultValue: unknown = null): any {
   return value;
 }
 
-export function getConfigString(key: string, defaultValue: string): string {
-  const value = getConfigItem(key, defaultValue);
-  if (typeof value === "string") {
-    return value;
-  }
-
-  setConfigItem(key, defaultValue);
-  return defaultValue;
-}
-
 // This function returns whether a key exists in the configuration file (settings.json)
 export function isConfigItemExists(key: string): boolean {
   try {
@@ -58,9 +82,9 @@ export function isConfigItemExists(key: string): boolean {
   return value !== undefined;
 }
 
-export function setConfigItem(
-  key: string,
-  value: unknown,
+export function setConfigItem<Key extends keyof Config>(
+  key: Key,
+  value: Config[Key],
   override?: boolean,
 ): void {
   if (EnterpriseUtil.configItemExists(key) && !override) {

app/common/dnd-util.ts

@@ -1,16 +1,16 @@
 import * as ConfigUtil from "./config-util";
 
-type SettingName = "showNotification" | "silent" | "flashTaskbarOnMessage";
+type SettingName = keyof DNDSettings;
 
 export interface DNDSettings {
-  showNotification?: boolean;
-  silent?: boolean;
-  flashTaskbarOnMessage?: boolean;
+  showNotification: boolean;
+  silent: boolean;
+  flashTaskbarOnMessage: boolean;
 }
 
 interface Toggle {
   dnd: boolean;
-  newSettings: DNDSettings;
+  newSettings: Partial<DNDSettings>;
 }
 
 export function toggle(): Toggle {
@@ -20,27 +20,34 @@ export function toggle(): Toggle {
     dndSettingList.push("flashTaskbarOnMessage");
   }
 
-  let newSettings: DNDSettings;
+  let newSettings: Partial<DNDSettings>;
   if (dnd) {
-    const oldSettings: DNDSettings = {};
+    const oldSettings: Partial<DNDSettings> = {};
     newSettings = {};
 
     // Iterate through the dndSettingList.
     for (const settingName of dndSettingList) {
       // Store the current value of setting.
-      oldSettings[settingName] = ConfigUtil.getConfigItem(settingName);
+      oldSettings[settingName] = ConfigUtil.getConfigItem(
+        settingName,
+        settingName !== "silent",
+      );
       // New value of setting.
       newSettings[settingName] = settingName === "silent";
     }
 
     // Store old value in oldSettings.
     ConfigUtil.setConfigItem("dndPreviousSettings", oldSettings);
   } else {
-    newSettings = ConfigUtil.getConfigItem("dndPreviousSettings");
+    newSettings = ConfigUtil.getConfigItem("dndPreviousSettings", {
+      showNotification: true,
+      silent: false,
+      ...(process.platform === "win32" && {flashTaskbarOnMessage: true}),
+    });
   }
 
   for (const settingName of dndSettingList) {
-    ConfigUtil.setConfigItem(settingName, newSettings[settingName]);
+    ConfigUtil.setConfigItem(settingName, newSettings[settingName]!);
   }
 
   ConfigUtil.setConfigItem("dnd", dnd);

app/common/enterprise-util.ts

@@ -1,14 +1,18 @@
 import fs from "fs";
 import path from "path";
 
+import type {Config} from "./config-util";
 import Logger from "./logger-util";
 
+interface EnterpriseConfig extends Config {
+  presetOrganizations: string[];
+}
+
 const logger = new Logger({
   file: "enterprise-util.log",
 });
 
-// TODO: replace enterpriseSettings type with an interface once settings are final
-let enterpriseSettings: Record<string, unknown>;
+let enterpriseSettings: Partial<EnterpriseConfig>;
 let configFile: boolean;
 
 reloadDB();
@@ -39,20 +43,20 @@ export function hasConfigFile(): boolean {
   return configFile;
 }
 
-export function getConfigItem(key: string, defaultValue?: unknown): any {
+export function getConfigItem<Key extends keyof EnterpriseConfig>(
+  key: Key,
+  defaultValue: EnterpriseConfig[Key],
+): EnterpriseConfig[Key] {
   reloadDB();
   if (!configFile) {
     return defaultValue;
   }
 
-  if (defaultValue === undefined) {
-    defaultValue = null;
-  }
-
-  return configItemExists(key) ? enterpriseSettings[key] : defaultValue;
+  const value = enterpriseSettings[key];
+  return value === undefined ? defaultValue : (value as EnterpriseConfig[Key]);
 }
 
-export function configItemExists(key: string): boolean {
+export function configItemExists(key: keyof EnterpriseConfig): boolean {
   reloadDB();
   if (!configFile) {
     return false;

app/common/translation-util.ts

@@ -10,7 +10,7 @@ i18n.configure({
 });
 
 /* Fetches the current appLocale from settings.json */
-const appLocale = ConfigUtil.getConfigItem("appLanguage");
+const appLocale = ConfigUtil.getConfigItem("appLanguage", "en");
 
 /* If no locale present in the json, en is set default */
 export function __(phrase: string): string {

app/common/typed-ipc.ts

@@ -73,7 +73,7 @@ export interface RendererMessage {
     autoHideMenubar: boolean,
     updateMenu: boolean,
   ) => void;
-  "toggle-dnd": (state: boolean, newSettings: DNDSettings) => void;
+  "toggle-dnd": (state: boolean, newSettings: Partial<DNDSettings>) => void;
   "toggle-menubar-setting": (state: boolean) => void;
   "toggle-sidebar": (show: boolean) => void;
   "toggle-sidebar-setting": (state: boolean) => void;

app/main/autoupdater.ts

@@ -34,9 +34,9 @@ export async function appUpdater(updateFromMenu = false): Promise<void> {
   autoUpdater.logger = log;
 
   // Handle auto updates for beta/pre releases
-  const isBetaUpdate = ConfigUtil.getConfigItem("betaUpdate");
+  const isBetaUpdate = ConfigUtil.getConfigItem("betaUpdate", false);
 
-  autoUpdater.allowPrerelease = isBetaUpdate || false;
+  autoUpdater.allowPrerelease = isBetaUpdate;
 
   const eventsListenerRemove = ["update-available", "update-not-available"];
   autoUpdater.on("update-available", async (info: UpdateInfo) => {

app/main/badge-settings.ts

@@ -39,7 +39,9 @@ function updateOverlayIcon(
   mainWindow: electron.BrowserWindow,
 ): void {
   if (!mainWindow.isFocused()) {
-    mainWindow.flashFrame(ConfigUtil.getConfigItem("flashTaskbarOnMessage"));
+    mainWindow.flashFrame(
+      ConfigUtil.getConfigItem("flashTaskbarOnMessage", true),
+    );
   }
 
   if (messageCount === 0) {

app/main/index.ts

@@ -84,7 +84,7 @@ function createMainWindow(): Electron.BrowserWindow {
 
   // Keep the app running in background on close event
   win.on("close", (event) => {
-    if (ConfigUtil.getConfigItem("quitOnClose")) {
+    if (ConfigUtil.getConfigItem("quitOnClose", false)) {
       app.quit();
     }
 
@@ -180,7 +180,7 @@ app.commandLine.appendSwitch("force-color-profile", "srgb");
 
   ipcMain.on("set-spellcheck-langs", () => {
     ses.setSpellCheckerLanguages(
-      ConfigUtil.getConfigItem("spellcheckerLanguages"),
+      ConfigUtil.getConfigItem("spellcheckerLanguages", null) ?? [],
     );
   });
   AppMenu.setMenu({
@@ -190,18 +190,18 @@ app.commandLine.appendSwitch("force-color-profile", "srgb");
 
   // Auto-hide menu bar on Windows + Linux
   if (process.platform !== "darwin") {
-    const shouldHideMenu = ConfigUtil.getConfigItem("autoHideMenubar") || false;
+    const shouldHideMenu = ConfigUtil.getConfigItem("autoHideMenubar", false);
     mainWindow.autoHideMenuBar = shouldHideMenu;
     mainWindow.setMenuBarVisibility(!shouldHideMenu);
   }
 
   // Initialize sentry for main process
-  const errorReporting = ConfigUtil.getConfigItem("errorReporting");
+  const errorReporting = ConfigUtil.getConfigItem("errorReporting", true);
   if (errorReporting) {
     sentryInit();
   }
 
-  const isSystemProxy = ConfigUtil.getConfigItem("useSystemProxy");
+  const isSystemProxy = ConfigUtil.getConfigItem("useSystemProxy", false);
 
   if (isSystemProxy) {
     (async () => ProxyUtil.resolveSystemProxy(mainWindow))();
@@ -210,7 +210,7 @@ app.commandLine.appendSwitch("force-color-profile", "srgb");
   const page = mainWindow.webContents;
 
   page.on("dom-ready", () => {
-    if (ConfigUtil.getConfigItem("startMinimized")) {
+    if (ConfigUtil.getConfigItem("startMinimized", false)) {
       mainWindow.hide();
     } else {
       mainWindow.show();
@@ -237,7 +237,7 @@ app.commandLine.appendSwitch("force-color-profile", "srgb");
 
   page.once("did-frame-finish-load", async () => {
     // Initiate auto-updates on MacOS and Windows
-    if (ConfigUtil.getConfigItem("autoUpdate")) {
+    if (ConfigUtil.getConfigItem("autoUpdate", true)) {
       await appUpdater();
     }
   });

app/main/linuxupdater.ts

@@ -17,7 +17,7 @@ export async function linuxUpdateNotification(
   session: Electron.session,
 ): Promise<void> {
   let url = "https://api.github.com/repos/zulip/zulip-desktop/releases";
-  url = ConfigUtil.getConfigItem("betaUpdate") ? url : url + "/latest";
+  url = ConfigUtil.getConfigItem("betaUpdate", false) ? url : url + "/latest";
 
   try {
     const response = await fetchResponse(net.request({url, session}));
@@ -27,7 +27,7 @@ export async function linuxUpdateNotification(
     }
 
     const data = JSON.parse(await getStream(response));
-    const latestVersion = ConfigUtil.getConfigItem("betaUpdate")
+    const latestVersion = ConfigUtil.getConfigItem("betaUpdate", false)
       ? data[0].tag_name
       : data.tag_name;
     if (typeof latestVersion !== "string") {

app/main/menu.ts

@@ -227,7 +227,7 @@ function getViewSubmenu(): Electron.MenuItemConstructorOptions[] {
       accelerator: "CommandOrControl+Shift+S",
       click(_item, focusedWindow) {
         if (focusedWindow) {
-          const newValue = !ConfigUtil.getConfigItem("showSidebar");
+          const newValue = !ConfigUtil.getConfigItem("showSidebar", true);
           send(focusedWindow.webContents, "toggle-sidebar", newValue);
           ConfigUtil.setConfigItem("showSidebar", newValue);
         }
@@ -239,7 +239,7 @@ function getViewSubmenu(): Electron.MenuItemConstructorOptions[] {
       visible: process.platform !== "darwin",
       click(_item, focusedWindow) {
         if (focusedWindow) {
-          const newValue = !ConfigUtil.getConfigItem("autoHideMenubar");
+          const newValue = !ConfigUtil.getConfigItem("autoHideMenubar", false);
           focusedWindow.autoHideMenuBar = newValue;
           focusedWindow.setMenuBarVisibility(!newValue);
           send(