diff options
author | 2021-12-26 19:17:23 +0100 | |
---|---|---|
committer | 2021-12-26 19:17:23 +0100 | |
commit | e56cdad02c00adf3b779d9de62d460e78be204a6 (patch) | |
tree | 638d8ac94380b3d675f13c6eabc1e5ee51126342 /packages/main/src/services/impl/ConfigPersistenceImpl.ts | |
parent | refactor: Config persistence architecture (diff) | |
download | sophie-e56cdad02c00adf3b779d9de62d460e78be204a6.tar.gz sophie-e56cdad02c00adf3b779d9de62d460e78be204a6.tar.zst sophie-e56cdad02c00adf3b779d9de62d460e78be204a6.zip |
refactor: Clarify main process architecture
* stores: reactive data structures to hold application state
* controllers: subscribe to store changes and call store actions in
response to external events from services
* services: integrate with the nodejs and electron environment (should
be mocked for unit testing)
Diffstat (limited to 'packages/main/src/services/impl/ConfigPersistenceImpl.ts')
-rw-r--r-- | packages/main/src/services/impl/ConfigPersistenceImpl.ts | 102 |
1 files changed, 0 insertions, 102 deletions
diff --git a/packages/main/src/services/impl/ConfigPersistenceImpl.ts b/packages/main/src/services/impl/ConfigPersistenceImpl.ts deleted file mode 100644 index 097ab74..0000000 --- a/packages/main/src/services/impl/ConfigPersistenceImpl.ts +++ /dev/null | |||
@@ -1,102 +0,0 @@ | |||
1 | /* | ||
2 | * Copyright (C) 2021-2022 Kristóf Marussy <kristof@marussy.com> | ||
3 | * | ||
4 | * This file is part of Sophie. | ||
5 | * | ||
6 | * Sophie is free software: you can redistribute it and/or modify | ||
7 | * it under the terms of the GNU Affero General Public License as | ||
8 | * published by the Free Software Foundation, version 3. | ||
9 | * | ||
10 | * This program is distributed in the hope that it will be useful, | ||
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
13 | * GNU Affero General Public License for more details. | ||
14 | * | ||
15 | * You should have received a copy of the GNU Affero General Public License | ||
16 | * along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
17 | * | ||
18 | * SPDX-License-Identifier: AGPL-3.0-only | ||
19 | */ | ||
20 | |||
21 | import { watch } from 'fs'; | ||
22 | import { readFile, stat, writeFile } from 'fs/promises'; | ||
23 | import JSON5 from 'json5'; | ||
24 | import { throttle } from 'lodash'; | ||
25 | import { IDisposer } from 'mobx-state-tree'; | ||
26 | import { join } from 'path'; | ||
27 | |||
28 | import { CONFIG_DEBOUNCE_TIME, ConfigPersistence, ReadConfigResult } from '../ConfigPersistence'; | ||
29 | import type { ConfigSnapshotOut } from '../../stores/Config'; | ||
30 | |||
31 | export class ConfigPersistenceImpl implements ConfigPersistence { | ||
32 | readonly #userDataDir: string; | ||
33 | |||
34 | readonly #configFileName: string; | ||
35 | |||
36 | readonly #configFilePath: string; | ||
37 | |||
38 | constructor( | ||
39 | userDataDir: string, | ||
40 | configFileName: string, | ||
41 | ) { | ||
42 | this.#userDataDir = userDataDir; | ||
43 | this.#configFileName = configFileName; | ||
44 | this.#configFilePath = join(this.#userDataDir, this.#configFileName); | ||
45 | } | ||
46 | |||
47 | async readConfig(): Promise<ReadConfigResult> { | ||
48 | let configStr; | ||
49 | try { | ||
50 | configStr = await readFile(this.#configFilePath, 'utf8'); | ||
51 | } catch (err) { | ||
52 | if ((err as NodeJS.ErrnoException).code === 'ENOENT') { | ||
53 | return { found: false }; | ||
54 | } | ||
55 | throw err; | ||
56 | } | ||
57 | return { | ||
58 | found: true, | ||
59 | data: JSON5.parse(configStr), | ||
60 | }; | ||
61 | } | ||
62 | |||
63 | async writeConfig(configSnapshot: ConfigSnapshotOut): Promise<Date> { | ||
64 | const configJson = JSON5.stringify(configSnapshot, { | ||
65 | space: 2, | ||
66 | }); | ||
67 | await writeFile(this.#configFilePath, configJson, 'utf8'); | ||
68 | const { mtime } = await stat(this.#configFilePath); | ||
69 | return mtime; | ||
70 | } | ||
71 | |||
72 | watchConfig(callback: (mtime: Date) => Promise<void>): IDisposer { | ||
73 | const configChanged = throttle(async () => { | ||
74 | let mtime: Date; | ||
75 | try { | ||
76 | const stats = await stat(this.#configFilePath); | ||
77 | mtime = stats.mtime; | ||
78 | } catch (err) { | ||
79 | if ((err as NodeJS.ErrnoException).code === 'ENOENT') { | ||
80 | return; | ||
81 | } | ||
82 | throw err; | ||
83 | } | ||
84 | return callback(mtime); | ||
85 | }, CONFIG_DEBOUNCE_TIME); | ||
86 | |||
87 | const watcher = watch(this.#userDataDir, { | ||
88 | persistent: false, | ||
89 | }); | ||
90 | |||
91 | watcher.on('change', (eventType, filename) => { | ||
92 | if (eventType === 'change' | ||
93 | && (filename === this.#configFileName || filename === null)) { | ||
94 | configChanged()?.catch((err) => { | ||
95 | console.log('Unhandled error while listening for config changes', err); | ||
96 | }); | ||
97 | } | ||
98 | }); | ||
99 | |||
100 | return () => watcher.close(); | ||
101 | } | ||
102 | } | ||