admin/bodyshop-desktop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add watcher polling settings.

Browse Source
This commit is contained in:
Patrick Fic
2025-03-26 11:32:41 -07:00
parent 791c518920
commit e2ccbf7007
11 changed files with 247 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/main/ipc/ipcMainConfig.ts
View File

@@ -8,6 +8,8 @@ import {
SettingsWatchedFilePathsAdd,
SettingsWatchedFilePathsGet,
SettingsWatchedFilePathsRemove,
SettingsWatcherPollingGet,
SettingsWatcherPollingSet,
} from "./ipcMainHandler.settings";
import { ipcMainHandleAuthStateChanged } from "./ipcMainHandler.user";
import { autoUpdater } from "electron-updater";
@@ -78,6 +80,14 @@ ipcMain.handle(
ipcTypes.toMain.settings.filepaths.remove,
SettingsWatchedFilePathsRemove,
);
ipcMain.handle(
ipcTypes.toMain.settings.watcher.getpolling,
SettingsWatcherPollingGet,
);
ipcMain.handle(
ipcTypes.toMain.settings.watcher.setpolling,
SettingsWatcherPollingSet,
);
//Watcher Handlers
ipcMain.on(ipcTypes.toMain.watcher.start, () => {

39
src/main/ipc/ipcMainHandler.settings.ts
View File

@@ -2,7 +2,13 @@ import { BrowserWindow, dialog, IpcMainInvokeEvent } from "electron";
import log from "electron-log/main";
import _ from "lodash";
import Store from "../store/store";
import { addWatcherPath, removeWatcherPath, watcher } from "../watcher/watcher";
import {
addWatcherPath,
removeWatcherPath,
StartWatcher,
StopWatcher,
watcher,
} from "../watcher/watcher";
const SettingsWatchedFilePathsAdd = async (): Promise<string[]> => {
const mainWindow = BrowserWindow.getAllWindows()[0]; //TODO: Filter to only main window once a proper key has been set.
@@ -41,8 +47,39 @@ const SettingsWatchedFilePathsGet = async (): Promise<string[]> => {
return filepaths;
};
const SettingsWatcherPollingGet = async (): Promise<{
enabled: boolean;
interval: number;
}> => {
const pollingEnabled: { enabled: boolean; interval: number } =
Store.get("settings.polling");
return { enabled: pollingEnabled.enabled, interval: pollingEnabled.interval };
};
const SettingsWatcherPollingSet = async (
event: IpcMainInvokeEvent,
pollingSettings: {
enabled: boolean;
interval: number;
},
): Promise<{
enabled: boolean;
interval: number;
}> => {
log.info("Polling set", pollingSettings);
const { enabled, interval } = pollingSettings;
Store.set("settings.polling", { enabled, interval });
//Restart the watcher with these new settings.
await StopWatcher();
StartWatcher();
return { enabled, interval };
};
export {
SettingsWatchedFilePathsAdd,
SettingsWatchedFilePathsGet,
SettingsWatchedFilePathsRemove,
SettingsWatcherPollingGet,
SettingsWatcherPollingSet,
};

9
src/main/store/store.ts
View File

@@ -1,4 +1,5 @@
import Store from "electron-store";
const store = new Store({
defaults: {
settings: {
@@ -6,7 +7,7 @@ const store = new Store({
runWatcherOnStartup: true,
polling: {
enabled: false,
pollingInterval: 30000,
interval: 30000,
},
},
app: {
@@ -25,4 +26,10 @@ const store = new Store({
},
});
// store.onDidAnyChange((newValue, oldValue) => {
// console.log("Settings changed", newValue, oldValue);
// const mainWindow = BrowserWindow.getAllWindows()[0];
// mainWindow?.webContents.send(ipcTypes.toRenderer.store.didChange, newValue);
// });
export default store;

29
src/main/watcher/watcher.ts
View File

@@ -7,7 +7,7 @@ import ipcTypes from "../../util/ipcTypes.json";
import ImportJob from "../decoder/decoder";
import store from "../store/store";
let watcher: FSWatcher;
let watcher: FSWatcher | null;
async function StartWatcher(): Promise<boolean> {
const filePaths: string[] = store.get("settings.filepaths") || [];
@@ -33,13 +33,19 @@ async function StartWatcher(): Promise<boolean> {
}
}
const pollingSettings =
(store.get("settings.polling") as {
enabled?: boolean;
interval?: number;
}) || {};
watcher = chokidar.watch(filePaths, {
ignored: (filepath, stats) => {
const p = path.parse(filepath);
return !stats?.isFile() && p.ext !== "" && p.ext.toUpperCase() !== ".ENV"; //Only watch for .ENV files.
},
usePolling: store.get("settings.polling").enabled || false,
interval: store.get("settings.polling").pollingInterval || 1000,
usePolling: pollingSettings.enabled || false,
interval: pollingSettings.interval || 30000,
persistent: true,
ignoreInitial: true,
awaitWriteFinish: {
@@ -73,34 +79,39 @@ async function StartWatcher(): Promise<boolean> {
// errorTypeCheck(error)
// );
})
.on("ready", onWatcherReady)
.on("raw", function (event, path, details) {
// This event should be triggered everytime something happens.
// console.log("Raw event info:", event, path, details);
});
.on("ready", onWatcherReady);
// .on("raw", function (event, path, details) {
// // This event should be triggered everytime something happens.
// // console.log("Raw event info:", event, path, details);
// });
return true;
}
function removeWatcherPath(path: string): void {
if (watcher) {
watcher.unwatch(path);
log.debug(`Stopped watching path: ${path}`);
}
}
function addWatcherPath(path: string | string[]): void {
if (watcher) {
watcher.add(path);
log.debug(`Started watching path: ${path}`);
}
}
function onWatcherReady(): void {
if (watcher) {
const mainWindow = BrowserWindow.getAllWindows()[0]; //TODO: Filter to only main window once a proper key has been set.
new Notification({
title: "Watcher Started",
body: "Newly exported estimates will be automatically uploaded.",
}).show();
log.info("Confirmed watched paths:", watcher.getWatched());
mainWindow.webContents.send(ipcTypes.toRenderer.watcher.started);
}
}
async function StopWatcher(): Promise<boolean> {

64
src/renderer/src/components/Settings/Settings.Watcher.tsx
View File

@@ -7,15 +7,39 @@ import {
selectWatcherStatus,
} from "@renderer/redux/app.slice";
import { useAppSelector } from "@renderer/redux/reduxHooks";
import { Alert, Button, Card, Space, Typography } from "antd";
import { Alert, Button, Card, InputNumber, Space, Switch } from "antd";
import { useTranslation } from "react-i18next";
import ipcTypes from "../../../../util/ipcTypes.json";
import { useEffect, useState } from "react";
const SettingsWatcher: React.FC = () => {
const { t } = useTranslation();
const isWatcherStarted = useAppSelector(selectWatcherStatus);
const watcherError = useAppSelector(selectWatcherError);
const [pollingState, setPollingState] = useState<{
enabled: boolean;
interval: number;
}>({
enabled: false,
interval: 0,
});
console.log("*** ~ pollingState:", pollingState);
const getPollingStateFromStore = (): void => {
window.electron.ipcRenderer
.invoke(ipcTypes.toMain.settings.watcher.getpolling)
.then((storePollingState: { enabled: boolean; interval: number }) => {
console.log("*** ~ .then ~ storePollingState:", storePollingState);
setPollingState(storePollingState);
});
};
//Get state first time it renders.
useEffect(() => {
getPollingStateFromStore();
}, []);
const handleStart = (): void => {
window.electron.ipcRenderer.send(ipcTypes.toMain.watcher.start);
};
@@ -24,6 +48,31 @@ const SettingsWatcher: React.FC = () => {
window.electron.ipcRenderer.send(ipcTypes.toMain.watcher.stop);
};
const toggleWatcherMode = (checked: boolean): void => {
window.electron.ipcRenderer
.invoke(ipcTypes.toMain.settings.watcher.setpolling, {
enabled: !checked,
interval: pollingState.interval,
})
.then((storePollingState: { enabled: boolean; interval: number }) => {
setPollingState(storePollingState);
});
};
const handlePollingIntervalChange = (value: number | null): void => {
if (value) {
window.electron.ipcRenderer
.invoke(ipcTypes.toMain.settings.watcher.setpolling, {
enabled: pollingState.enabled,
interval: value,
})
.then((storePollingState: { enabled: boolean; interval: number }) => {
setPollingState(storePollingState);
});
}
getPollingStateFromStore();
};
return (
<Card title={t("settings.labels.watcherstatus")}>
<Space>
@@ -47,6 +96,19 @@ const SettingsWatcher: React.FC = () => {
{t("settings.labels.stopped")}
</Space>
)}
<Switch
checked={!pollingState.enabled}
onChange={toggleWatcherMode}
checkedChildren={t("settings.labels.watchermoderealtime")}
unCheckedChildren={t("settings.labels.watchermodepolling")}
/>
<InputNumber
title={t("settings.labels.pollinginterval")}
disabled={!pollingState.enabled}
min={1000}
value={pollingState.interval}
onChange={handlePollingIntervalChange}
/>
{watcherError && <Alert message={watcherError} />}
</Space>
</Card>

42
src/renderer/src/redux/app.slice.ts
View File

@@ -1,13 +1,15 @@
import { createSlice, PayloadAction } from "@reduxjs/toolkit";
import log from "electron-log/renderer";
import type { RootState } from "./redux-store";
import { update } from "lodash";
import { notification } from "antd";
interface AppState {
value: number;
watcher: {
started: boolean;
error: string | null;
polling: {
enabled: boolean;
interval: number;
};
};
updates: {
available: boolean;
@@ -24,6 +26,10 @@ const initialState: AppState = {
watcher: {
started: false,
error: null,
polling: {
enabled: false,
interval: 30000,
},
},
updates: {
available: false,
@@ -58,16 +64,26 @@ export const appSlice = createSlice({
state.updates.available = true;
state.updates.checking = false;
},
updateProgress: (state, action) => {
updateProgress: (
state,
action: PayloadAction<{ progress: number; speed: number }>,
) => {
state.updates.available = true;
state.updates.progress = action?.progress;
state.updates.speed = action?.speed;
state.updates.progress = action.payload.progress;
state.updates.speed = action.payload.speed;
},
updateDownloaded: (state) => {
state.updates.completed = true;
state.updates.progress = 100;
state.updates.speed = 0;
},
setWatcherPolling: (
state,
action: PayloadAction<{ enabled: boolean; interval: number }>,
) => {
state.watcher.polling.enabled = action.payload.enabled;
state.watcher.polling.interval = action.payload.interval;
},
},
});
@@ -79,6 +95,7 @@ export const {
updateChecking,
updateDownloaded,
updateProgress,
setWatcherPolling,
} = appSlice.actions;
// Other code such as selectors can use the imported `RootState` type
@@ -100,6 +117,13 @@ export const selectAppUpdateSpeed = (state: RootState): number =>
export const selectAppUpdateCompleted = (state: RootState): boolean =>
state.app.updates.completed;
export const selectWatcherPolling = (
state: RootState,
): {
enabled: boolean;
interval: number;
} => state.app.watcher.polling;
//Async Functions - Thunks
// Define a thunk that dispatches those action creators
// const fetchUsers = () => async (dispatch) => {
@@ -108,12 +132,4 @@ export const selectAppUpdateCompleted = (state: RootState): boolean =>
// // dispatch(incrementByAmount(100));
// };
const updateAvailableThunk = () => async (dispatch) => {
notification.info({
message: "Update Available",
key: "app-update",
description: "An update is available for download.",
});
};
export default appSlice.reducer;

6
src/renderer/src/util/ipcRendererHandler.ts
View File

@@ -1,5 +1,7 @@
//Set up all of the IPC handlers.
import {
selectWatcherPolling,
setWatcherPolling,
updateAvailable,
updateChecking,
updateDownloaded,
@@ -84,3 +86,7 @@ ipcRenderer.on(
dispatch(updateDownloaded());
},
);
ipcRenderer.on(ipcTypes.toRenderer.watcher.polling, (event, arg) => {
dispatch(setWatcherPolling({ enabled: arg.enabled, interval: arg.interval }));
});

7
src/util/ipcTypes.json
View File

@@ -19,6 +19,10 @@
"get": "toMain_settings_filepaths_get",
"add": "toMain_settings_filepaths_add",
"remove": "toMain_settings_filepaths_remove"
},
"watcher": {
"getpolling": "toMain_settings_watcher_getpolling",
"setpolling": "toMain_settings_watcher_setpolling"
}
},
"user": {
@@ -30,7 +34,8 @@
"watcher": {
"started": "toRenderer_watcher_started",
"stopped": "toRenderer_watcher_stopped",
"error": "toRenderer_watcher_error"
"error": "toRenderer_watcher_error",
"polling": "toRenderer_watcher_polling"
},
"updates": {
"checking": "toRenderer_updates_checking",

2
src/util/translations/en-US/renderer.json
View File

@@ -14,6 +14,8 @@
"started": "Started",
"stopped": "Stopped",
"watchedpaths": "Watched Paths",
"watchermodepolling": "Polling",
"watchermoderealtime": "Real Time",
"watcherstatus": "Watcher Status"
}
},

26
translations.babel
View File

@@ -165,6 +165,32 @@
</translation>
</translations>
</concept_node>
<concept_node>
<name>watchermodepolling</name>
<definition_loaded>false</definition_loaded>
<description></description>
<comment></comment>
<default_text></default_text>
<translations>
<translation>
<language>en-US</language>
<approved>false</approved>
</translation>
</translations>
</concept_node>
<concept_node>
<name>watchermoderealtime</name>
<definition_loaded>false</definition_loaded>
<description></description>
<comment></comment>
<default_text></default_text>
<translations>
<translation>
<language>en-US</language>
<approved>false</approved>
</translation>
</translations>
</concept_node>
<concept_node>
<name>watcherstatus</name>
<definition_loaded>false</definition_loaded>