Merge pull request #286 from argonism/ku/notification-settings

Add notify setting

Author: morishin

src/lib/Setting.ts

@@ -16,6 +16,7 @@ export type SettingType = {
   readonly bdashServer: BdashServerSettingType;
   readonly experimentalFeature: ExperimentalFeatureSettingType;
   readonly defaultDataSourceId: number | null;
+  readonly notification: NotificationSettingType;
 };
 
 export type FormatterSettingType = {
@@ -39,6 +40,14 @@ export type ExperimentalFeatureSettingType = {
   autoCompleteEnabled: boolean;
 };
 
+export const notificationWhenOptions = ["focusing", "not_focusing", "always"] as const;
+export type NotificationWhenType = typeof notificationWhenOptions[number];
+
+export type NotificationSettingType = {
+  enabled: boolean;
+  when: NotificationWhenType;
+};
+
 // type for partial updating parameter.
 export type PartialSettingType = { [P in keyof SettingType]?: Partial<SettingType[P]> };
 
@@ -66,6 +75,10 @@ export default class Setting {
         autoCompleteEnabled: false,
       },
       defaultDataSourceId: null,
+      notification: {
+        enabled: true,
+        when: "not_focusing",
+      },
     };
   }
 

src/main/window.ts

@@ -2,9 +2,19 @@ import electron, { BrowserWindow, dialog, ipcMain, shell, Notification } from "e
 import path from "path";
 import logger from "./logger";
 import Config from "./Config";
+import { SettingType } from "src/lib/Setting";
 
 const windows: BrowserWindow[] = [];
 
+const shouldNotify = (setting: SettingType, isFocused: boolean) => {
+  return (
+    setting.notification.enabled &&
+    (setting.notification.when === "always" ||
+      (setting.notification.when === "focusing" && isFocused) ||
+      (setting.notification.when === "not_focusing" && !isFocused))
+  );
+};
+
 export async function createWindow(): Promise<void> {
   const win = new electron.BrowserWindow({
     width: 1280,
@@ -21,9 +31,9 @@ export async function createWindow(): Promise<void> {
   ipcMain.handle("getConfig", async () => Config);
 
   ipcMain.on("queryCompleted", (_event, data) => {
-    const { success, title, runtime, rowCount, errorMessage } = data;
+    const { success, title, runtime, rowCount, errorMessage, _setting } = data;
 
-    if (!win.isFocused()) {
+    if (shouldNotify(_setting, win.isFocused())) {
       const notificationTitle = success ? "✅️ Query completed" : "❌️ Query failed";
       let notificationBody;
 

src/renderer/pages/Query/QueryAction.ts

@@ -86,6 +86,7 @@ const QueryAction = {
     const { query: queryBody, startLine } = await Util.findQueryByLine(query.body, dataSource.mimeType, line);
     const executor = DataSource.create(dataSource);
     const id = query.id;
+    const _setting = setting.load();
     dispatch("updateQuery", { id, params: { status: "working", executor } });
 
     const start = Date.now();
@@ -110,6 +111,7 @@ const QueryAction = {
         success: false,
         title: query.title,
         errorMessage: err.message,
+        _setting,
       });
 
       return;
@@ -141,6 +143,7 @@ const QueryAction = {
       title: query.title,
       runtime: params.runtime,
       rowCount: result.rows?.length || 0,
+      _setting,
     });
   },
 

src/renderer/pages/Setting/Setting.tsx

@@ -6,7 +6,7 @@ import Action from "./SettingAction";
 import Button from "../../components/Button";
 import ProgressIcon from "../../components/ProgressIcon";
 import { selectStyles } from "../../components/Select";
-import { indentValues } from "../../../lib/Setting";
+import { indentValues, notificationWhenOptions } from "../../../lib/Setting";
 
 class Setting extends React.Component<unknown, SettingState> {
   override componentDidMount(): void {
@@ -174,6 +174,28 @@ class Setting extends React.Component<unknown, SettingState> {
             />
           </div>
         </div>
+        <div className="page-Setting-section1">
+          <h1>Notification</h1>
+          <div className="page-Setting-section2">
+            <h2>Enable</h2>
+            <input
+              type="checkbox"
+              onChange={(e): void => Action.update({ notification: { enabled: e.target.checked } })}
+              checked={setting.notification.enabled}
+            />
+          </div>
+          <div className="page-Setting-section2">
+            <h2>Notify when</h2>
+            <Select
+              value={{ value: setting.notification.when, label: setting.notification.when }}
+              options={notificationWhenOptions.map((v) => ({ value: v, label: v }))}
+              onChange={(e): void => Action.update({ notification: { when: (e as OptionTypeBase).value } })}
+              isClearable={false}
+              isSearchable={false}
+              styles={selectStyles}
+            />
+          </div>
+        </div>
         <div className="page-Setting-section1">
           <h1>Experimental Features</h1>
           <div className="page-Setting-section2">