1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/*
* Copyright (C) 2021-2022 Kristóf Marussy <kristof@marussy.com>
*
* This file is part of Sophie.
*
* Sophie is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* SPDX-License-Identifier: AGPL-3.0-only
*/
import { watch } from 'fs';
import { readFile, stat, writeFile } from 'fs/promises';
import JSON5 from 'json5';
import { throttle } from 'lodash-es';
import { join } from 'path';
import type { ConfigPersistenceService, ReadConfigResult } from '../ConfigPersistenceService.js';
import type { ConfigSnapshotOut } from '../../stores/Config.js';
import { Disposer } from '../../utils/disposer';
import { getLogger } from '../../utils/logging';
const log = getLogger('configPersistence');
export class ConfigPersistenceServiceImpl implements ConfigPersistenceService {
private readonly configFilePath: string;
private writingConfig = false;
private timeLastWritten: Date | null = null;
constructor(
private readonly userDataDir: string,
private readonly configFileName: string = 'config.json5',
) {
this.configFileName = configFileName;
this.configFilePath = join(this.userDataDir, this.configFileName);
}
async readConfig(): Promise<ReadConfigResult> {
let configStr;
try {
configStr = await readFile(this.configFilePath, 'utf8');
} catch (err) {
if ((err as NodeJS.ErrnoException).code === 'ENOENT') {
log.debug('Config file', this.configFilePath, 'was not found');
return { found: false };
}
throw err;
}
log.info('Read config file', this.configFilePath);
return {
found: true,
data: JSON5.parse(configStr),
};
}
async writeConfig(configSnapshot: ConfigSnapshotOut): Promise<void> {
const configJson = JSON5.stringify(configSnapshot, {
space: 2,
});
this.writingConfig = true;
try {
await writeFile(this.configFilePath, configJson, 'utf8');
const { mtime } = await stat(this.configFilePath);
log.trace('Config file', this.configFilePath, 'last written at', mtime);
this.timeLastWritten = mtime;
} finally {
this.writingConfig = false;
}
log.info('Wrote config file', this.configFilePath);
}
watchConfig(callback: () => Promise<void>, throttleMs: number): Disposer {
log.debug('Installing watcher for', this.userDataDir);
const configChanged = throttle(async () => {
let mtime: Date;
try {
const stats = await stat(this.configFilePath);
mtime = stats.mtime;
log.trace('Config file last modified at', mtime);
} catch (err) {
if ((err as NodeJS.ErrnoException).code === 'ENOENT') {
log.debug('Config file', this.configFilePath, 'was deleted after being changed');
return;
}
throw err;
}
if (!this.writingConfig
&& (this.timeLastWritten === null || mtime > this.timeLastWritten)) {
log.debug(
'Found a config file modified at',
mtime,
'whish is newer than last written',
this.timeLastWritten,
);
return callback();
}
}, throttleMs);
const watcher = watch(this.userDataDir, {
persistent: false,
});
watcher.on('change', (eventType, filename) => {
if (eventType === 'change'
&& (filename === this.configFileName || filename === null)) {
configChanged()?.catch((err) => {
console.log('Unhandled error while listening for config changes', err);
});
}
});
return () => {
log.trace('Removing watcher for', this.configFilePath);
watcher.close();
};
}
}
|
