@eggjs/watcher 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +147 -0
- package/dist/commonjs/agent.d.ts +2 -0
- package/dist/commonjs/agent.js +5 -0
- package/dist/commonjs/app.d.ts +2 -0
- package/dist/commonjs/app.js +5 -0
- package/dist/commonjs/config/config.default.d.ts +15 -0
- package/dist/commonjs/config/config.default.js +22 -0
- package/dist/commonjs/config/config.local.d.ts +6 -0
- package/dist/commonjs/config/config.local.js +8 -0
- package/dist/commonjs/config/config.unittest.d.ts +6 -0
- package/dist/commonjs/config/config.unittest.js +8 -0
- package/dist/commonjs/index.d.ts +3 -0
- package/dist/commonjs/index.js +20 -0
- package/dist/commonjs/lib/boot.d.ts +6 -0
- package/dist/commonjs/lib/boot.js +23 -0
- package/dist/commonjs/lib/event-sources/base.d.ts +5 -0
- package/dist/commonjs/lib/event-sources/base.js +8 -0
- package/dist/commonjs/lib/event-sources/default.d.ts +6 -0
- package/dist/commonjs/lib/event-sources/default.js +19 -0
- package/dist/commonjs/lib/event-sources/development.d.ts +7 -0
- package/dist/commonjs/lib/event-sources/development.js +101 -0
- package/dist/commonjs/lib/event-sources/index.d.ts +3 -0
- package/dist/commonjs/lib/event-sources/index.js +20 -0
- package/dist/commonjs/lib/types.d.ts +33 -0
- package/dist/commonjs/lib/types.js +3 -0
- package/dist/commonjs/lib/utils.d.ts +2 -0
- package/dist/commonjs/lib/utils.js +25 -0
- package/dist/commonjs/lib/watcher.d.ts +9 -0
- package/dist/commonjs/lib/watcher.js +111 -0
- package/dist/commonjs/package.json +3 -0
- package/dist/esm/agent.d.ts +2 -0
- package/dist/esm/agent.js +3 -0
- package/dist/esm/app.d.ts +2 -0
- package/dist/esm/app.js +3 -0
- package/dist/esm/config/config.default.d.ts +15 -0
- package/dist/esm/config/config.default.js +17 -0
- package/dist/esm/config/config.local.d.ts +6 -0
- package/dist/esm/config/config.local.js +6 -0
- package/dist/esm/config/config.unittest.d.ts +6 -0
- package/dist/esm/config/config.unittest.js +6 -0
- package/dist/esm/index.d.ts +3 -0
- package/dist/esm/index.js +4 -0
- package/dist/esm/lib/boot.d.ts +6 -0
- package/dist/esm/lib/boot.js +19 -0
- package/dist/esm/lib/event-sources/base.d.ts +5 -0
- package/dist/esm/lib/event-sources/base.js +4 -0
- package/dist/esm/lib/event-sources/default.d.ts +6 -0
- package/dist/esm/lib/event-sources/default.js +16 -0
- package/dist/esm/lib/event-sources/development.d.ts +7 -0
- package/dist/esm/lib/event-sources/development.js +95 -0
- package/dist/esm/lib/event-sources/index.d.ts +3 -0
- package/dist/esm/lib/event-sources/index.js +4 -0
- package/dist/esm/lib/types.d.ts +33 -0
- package/dist/esm/lib/types.js +2 -0
- package/dist/esm/lib/utils.d.ts +2 -0
- package/dist/esm/lib/utils.js +18 -0
- package/dist/esm/lib/watcher.d.ts +9 -0
- package/dist/esm/lib/watcher.js +104 -0
- package/dist/esm/package.json +3 -0
- package/dist/package.json +4 -0
- package/package.json +83 -0
- package/src/agent.ts +3 -0
- package/src/app.ts +3 -0
- package/src/config/config.default.ts +17 -0
- package/src/config/config.local.ts +5 -0
- package/src/config/config.unittest.ts +5 -0
- package/src/index.ts +3 -0
- package/src/lib/boot.ts +22 -0
- package/src/lib/event-sources/base.ts +6 -0
- package/src/lib/event-sources/default.ts +18 -0
- package/src/lib/event-sources/development.ts +99 -0
- package/src/lib/event-sources/index.ts +3 -0
- package/src/lib/types.ts +35 -0
- package/src/lib/utils.ts +20 -0
- package/src/lib/watcher.ts +117 -0
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.Watcher = void 0;
|
|
7
|
+
const node_util_1 = require("node:util");
|
|
8
|
+
const sdk_base_1 = require("sdk-base");
|
|
9
|
+
const camelcase_1 = __importDefault(require("camelcase"));
|
|
10
|
+
const utils_1 = require("@eggjs/utils");
|
|
11
|
+
const utils_js_1 = require("./utils.js");
|
|
12
|
+
const debug = (0, node_util_1.debuglog)('@eggjs/watcher/lib/watcher');
|
|
13
|
+
class Watcher extends sdk_base_1.Base {
|
|
14
|
+
#config;
|
|
15
|
+
#eventSource;
|
|
16
|
+
constructor(config) {
|
|
17
|
+
super({
|
|
18
|
+
initMethod: '_init',
|
|
19
|
+
});
|
|
20
|
+
this.#config = config;
|
|
21
|
+
}
|
|
22
|
+
async _init() {
|
|
23
|
+
const watcherType = this.#config.watcher.type;
|
|
24
|
+
let EventSource = this.#config.watcher.eventSources[watcherType];
|
|
25
|
+
if (typeof EventSource === 'string') {
|
|
26
|
+
EventSource = await (0, utils_1.importModule)(EventSource);
|
|
27
|
+
}
|
|
28
|
+
// chokidar => watcherChokidar
|
|
29
|
+
// custom => watcherCustom
|
|
30
|
+
//
|
|
31
|
+
// e.g:
|
|
32
|
+
// config => { watcher: { type: 'custom' }, watcherCustom: { ... } }
|
|
33
|
+
const key = (0, camelcase_1.default)(['watcher', watcherType]);
|
|
34
|
+
const eventSourceOptions = this.#config[key] ?? {};
|
|
35
|
+
this.#eventSource = Reflect.construct(EventSource, [eventSourceOptions]);
|
|
36
|
+
this.#eventSource.on('change', this.#onChange.bind(this))
|
|
37
|
+
.on('fuzzy-change', this.#onFuzzyChange.bind(this))
|
|
38
|
+
.on('info', (...args) => this.emit('info', ...args))
|
|
39
|
+
.on('warn', (...args) => this.emit('warn', ...args))
|
|
40
|
+
.on('error', (...args) => this.emit('error', ...args));
|
|
41
|
+
await this.#eventSource.ready();
|
|
42
|
+
}
|
|
43
|
+
watch(path, listener) {
|
|
44
|
+
this.emit('info', '[@eggjs/watcher] Start watching: %j', path);
|
|
45
|
+
if (!path)
|
|
46
|
+
return;
|
|
47
|
+
// support array
|
|
48
|
+
if (Array.isArray(path)) {
|
|
49
|
+
path.forEach(p => this.watch(p, listener));
|
|
50
|
+
return;
|
|
51
|
+
}
|
|
52
|
+
// one file only watch once
|
|
53
|
+
if (!this.listenerCount(path)) {
|
|
54
|
+
this.#eventSource.watch(path);
|
|
55
|
+
}
|
|
56
|
+
this.on(path, listener);
|
|
57
|
+
}
|
|
58
|
+
/*
|
|
59
|
+
// TODO wait unsubscribe implementation of cluster-client
|
|
60
|
+
unwatch(path, callback) {
|
|
61
|
+
if (!path) return;
|
|
62
|
+
|
|
63
|
+
// support array
|
|
64
|
+
if (Array.isArray(path)) {
|
|
65
|
+
path.forEach(p => this.unwatch(p, callback));
|
|
66
|
+
return;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
if (callback) {
|
|
70
|
+
this.removeListener(path, callback);
|
|
71
|
+
// stop watching when no listener bound to the path
|
|
72
|
+
if (this.listenerCount(path) === 0) {
|
|
73
|
+
this._eventSource.unwatch(path);
|
|
74
|
+
}
|
|
75
|
+
return;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
this.removeAllListeners(path);
|
|
79
|
+
this._eventSource.unwatch(path);
|
|
80
|
+
}
|
|
81
|
+
*/
|
|
82
|
+
#onChange(info) {
|
|
83
|
+
debug('onChange %o', info);
|
|
84
|
+
this.emit('info', '[@eggjs/watcher] Received a change event from eventSource: %j', info);
|
|
85
|
+
const path = info.path;
|
|
86
|
+
for (const p of this.eventNames()) {
|
|
87
|
+
if (typeof p !== 'string')
|
|
88
|
+
continue;
|
|
89
|
+
// if it is a sub path, emit a `change` event
|
|
90
|
+
if ((0, utils_js_1.isEqualOrParentPath)(p, path)) {
|
|
91
|
+
this.emit(p, info);
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
#onFuzzyChange(info) {
|
|
96
|
+
debug('onFuzzyChange %o', info);
|
|
97
|
+
this.emit('info', '[@eggjs/watcher] Received a fuzzy-change event from eventSource: %j', info);
|
|
98
|
+
const path = info.path;
|
|
99
|
+
for (const p of this.eventNames()) {
|
|
100
|
+
if (typeof p !== 'string')
|
|
101
|
+
continue;
|
|
102
|
+
// if it is a parent path, emit a `change` event
|
|
103
|
+
// just the opposite to `_onChange`
|
|
104
|
+
if ((0, utils_js_1.isEqualOrParentPath)(path, p)) {
|
|
105
|
+
this.emit(p, info);
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
exports.Watcher = Watcher;
|
|
111
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2F0Y2hlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvd2F0Y2hlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFBQSx5Q0FBcUM7QUFDckMsdUNBQWdDO0FBQ2hDLDBEQUFrQztBQUNsQyx3Q0FBNEM7QUFFNUMseUNBQWlEO0FBR2pELE1BQU0sS0FBSyxHQUFHLElBQUEsb0JBQVEsRUFBQyw0QkFBNEIsQ0FBQyxDQUFDO0FBSXJELE1BQWEsT0FBUSxTQUFRLGVBQUk7SUFDL0IsT0FBTyxDQUFnQjtJQUN2QixZQUFZLENBQWtCO0lBRTlCLFlBQVksTUFBcUI7UUFDL0IsS0FBSyxDQUFDO1lBQ0osVUFBVSxFQUFFLE9BQU87U0FDcEIsQ0FBQyxDQUFDO1FBQ0gsSUFBSSxDQUFDLE9BQU8sR0FBRyxNQUFNLENBQUM7SUFDeEIsQ0FBQztJQUVTLEtBQUssQ0FBQyxLQUFLO1FBQ25CLE1BQU0sV0FBVyxHQUFHLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQztRQUM5QyxJQUFJLFdBQVcsR0FBMkIsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsWUFBWSxDQUFDLFdBQVcsQ0FBUSxDQUFDO1FBQ2hHLElBQUksT0FBTyxXQUFXLEtBQUssUUFBUSxFQUFFLENBQUM7WUFDcEMsV0FBVyxHQUFHLE1BQU0sSUFBQSxvQkFBWSxFQUFDLFdBQVcsQ0FBQyxDQUFDO1FBQ2hELENBQUM7UUFFRCw4QkFBOEI7UUFDOUIsMEJBQTBCO1FBQzFCLEVBQUU7UUFDRixPQUFPO1FBQ1AscUVBQXFFO1FBQ3JFLE1BQU0sR0FBRyxHQUFHLElBQUEsbUJBQVMsRUFBQyxDQUFFLFNBQVMsRUFBRSxXQUFXLENBQUUsQ0FBQyxDQUFDO1FBQ2xELE1BQU0sa0JBQWtCLEdBQUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLENBQUM7UUFDbkQsSUFBSSxDQUFDLFlBQVksR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLFdBQVcsRUFBRSxDQUFFLGtCQUFrQixDQUFFLENBQUMsQ0FBQztRQUMzRSxJQUFJLENBQUMsWUFBWSxDQUFDLEVBQUUsQ0FBQyxRQUFRLEVBQUUsSUFBSSxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7YUFDdEQsRUFBRSxDQUFDLGNBQWMsRUFBRSxJQUFJLENBQUMsY0FBYyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQzthQUNsRCxFQUFFLENBQUMsTUFBTSxFQUFFLENBQUMsR0FBRyxJQUFJLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLEdBQUcsSUFBSSxDQUFDLENBQUM7YUFDbkQsRUFBRSxDQUFDLE1BQU0sRUFBRSxDQUFDLEdBQUcsSUFBSSxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxHQUFHLElBQUksQ0FBQyxDQUFDO2FBQ25ELEVBQUUsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxHQUFHLElBQUksRUFBRSxFQUFFLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUUsR0FBRyxJQUFJLENBQUMsQ0FBQyxDQUFDO1FBQ3pELE1BQU0sSUFBSSxDQUFDLFlBQVksQ0FBQyxLQUFLLEVBQUUsQ0FBQztJQUNsQyxDQUFDO0lBRUQsS0FBSyxDQUFDLElBQXVCLEVBQUUsUUFBdUI7UUFDcEQsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUscUNBQXFDLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDL0QsSUFBSSxDQUFDLElBQUk7WUFBRSxPQUFPO1FBRWxCLGdCQUFnQjtRQUNoQixJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQztZQUN4QixJQUFJLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsUUFBUSxDQUFDLENBQUMsQ0FBQztZQUMzQyxPQUFPO1FBQ1QsQ0FBQztRQUVELDJCQUEyQjtRQUMzQixJQUFJLENBQUMsSUFBSSxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDO1lBQzlCLElBQUksQ0FBQyxZQUFZLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ2hDLENBQUM7UUFDRCxJQUFJLENBQUMsRUFBRSxDQUFDLElBQUksRUFBRSxRQUFRLENBQUMsQ0FBQztJQUMxQixDQUFDO0lBRUQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O01BdUJFO0lBRUYsU0FBUyxDQUFDLElBQWdCO1FBQ3hCLEtBQUssQ0FBQyxhQUFhLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDM0IsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsK0RBQStELEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDekYsTUFBTSxJQUFJLEdBQUcsSUFBSSxDQUFDLElBQUksQ0FBQztRQUV2QixLQUFLLE1BQU0sQ0FBQyxJQUFJLElBQUksQ0FBQyxVQUFVLEVBQUUsRUFBRSxDQUFDO1lBQ2xDLElBQUksT0FBTyxDQUFDLEtBQUssUUFBUTtnQkFBRSxTQUFTO1lBQ3BDLDZDQUE2QztZQUM3QyxJQUFJLElBQUEsOEJBQW1CLEVBQUMsQ0FBQyxFQUFFLElBQUksQ0FBQyxFQUFFLENBQUM7Z0JBQ2pDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxFQUFFLElBQUksQ0FBQyxDQUFDO1lBQ3JCLENBQUM7UUFDSCxDQUFDO0lBQ0gsQ0FBQztJQUVELGNBQWMsQ0FBQyxJQUFnQjtRQUM3QixLQUFLLENBQUMsa0JBQWtCLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDaEMsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUscUVBQXFFLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDL0YsTUFBTSxJQUFJLEdBQUcsSUFBSSxDQUFDLElBQUksQ0FBQztRQUV2QixLQUFLLE1BQU0sQ0FBQyxJQUFJLElBQUksQ0FBQyxVQUFVLEVBQUUsRUFBRSxDQUFDO1lBQ2xDLElBQUksT0FBTyxDQUFDLEtBQUssUUFBUTtnQkFBRSxTQUFTO1lBQ3BDLGdEQUFnRDtZQUNoRCxtQ0FBbUM7WUFDbkMsSUFBSSxJQUFBLDhCQUFtQixFQUFDLElBQUksRUFBRSxDQUFDLENBQUMsRUFBRSxDQUFDO2dCQUNqQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsRUFBRSxJQUFJLENBQUMsQ0FBQztZQUNyQixDQUFDO1FBQ0gsQ0FBQztJQUNILENBQUM7Q0FDRjtBQXhHRCwwQkF3R0MifQ==
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { Boot } from './lib/boot.js';
|
|
2
|
+
export default Boot;
|
|
3
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYWdlbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLElBQUksRUFBRSxNQUFNLGVBQWUsQ0FBQztBQUVyQyxlQUFlLElBQUksQ0FBQyJ9
|
package/dist/esm/app.js
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { Boot } from './lib/boot.js';
|
|
2
|
+
export default Boot;
|
|
3
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2FwcC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsSUFBSSxFQUFFLE1BQU0sZUFBZSxDQUFDO0FBRXJDLGVBQWUsSUFBSSxDQUFDIn0=
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
declare const _default: {
|
|
2
|
+
/**
|
|
3
|
+
* watcher options
|
|
4
|
+
* @member Config#watcher
|
|
5
|
+
* @property {string} type - event source type
|
|
6
|
+
*/
|
|
7
|
+
watcher: {
|
|
8
|
+
type: string;
|
|
9
|
+
eventSources: {
|
|
10
|
+
default: string;
|
|
11
|
+
development: string;
|
|
12
|
+
};
|
|
13
|
+
};
|
|
14
|
+
};
|
|
15
|
+
export default _default;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import path from 'node:path';
|
|
2
|
+
import { getSourceDirname } from '../lib/utils.js';
|
|
3
|
+
export default {
|
|
4
|
+
/**
|
|
5
|
+
* watcher options
|
|
6
|
+
* @member Config#watcher
|
|
7
|
+
* @property {string} type - event source type
|
|
8
|
+
*/
|
|
9
|
+
watcher: {
|
|
10
|
+
type: 'default', // default event source
|
|
11
|
+
eventSources: {
|
|
12
|
+
default: path.join(getSourceDirname(), 'lib', 'event-sources', 'default'),
|
|
13
|
+
development: path.join(getSourceDirname(), 'lib', 'event-sources', 'development'),
|
|
14
|
+
},
|
|
15
|
+
},
|
|
16
|
+
};
|
|
17
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sSUFBSSxNQUFNLFdBQVcsQ0FBQztBQUM3QixPQUFPLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQztBQUVuRCxlQUFlO0lBQ2I7Ozs7T0FJRztJQUNILE9BQU8sRUFBRTtRQUNQLElBQUksRUFBRSxTQUFTLEVBQUUsdUJBQXVCO1FBQ3hDLFlBQVksRUFBRTtZQUNaLE9BQU8sRUFBRSxJQUFJLENBQUMsSUFBSSxDQUFDLGdCQUFnQixFQUFFLEVBQUUsS0FBSyxFQUFFLGVBQWUsRUFBRSxTQUFTLENBQUM7WUFDekUsV0FBVyxFQUFFLElBQUksQ0FBQyxJQUFJLENBQUMsZ0JBQWdCLEVBQUUsRUFBRSxLQUFLLEVBQUUsZUFBZSxFQUFFLGFBQWEsQ0FBQztTQUNsRjtLQUNGO0NBQ0YsQ0FBQyJ9
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export default {
|
|
2
|
+
watcher: {
|
|
3
|
+
type: 'development',
|
|
4
|
+
},
|
|
5
|
+
};
|
|
6
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmxvY2FsLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2NvbmZpZy9jb25maWcubG9jYWwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsZUFBZTtJQUNiLE9BQU8sRUFBRTtRQUNQLElBQUksRUFBRSxhQUFhO0tBQ3BCO0NBQ0YsQ0FBQyJ9
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export default {
|
|
2
|
+
watcher: {
|
|
3
|
+
type: 'development',
|
|
4
|
+
},
|
|
5
|
+
};
|
|
6
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLnVuaXR0ZXN0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2NvbmZpZy9jb25maWcudW5pdHRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsZUFBZTtJQUNiLE9BQU8sRUFBRTtRQUNQLElBQUksRUFBRSxhQUFhO0tBQ3BCO0NBQ0YsQ0FBQyJ9
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export * from './lib/types.js';
|
|
2
|
+
export * from './lib/watcher.js';
|
|
3
|
+
export * from './lib/event-sources/index.js';
|
|
4
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxnQkFBZ0IsQ0FBQztBQUMvQixjQUFjLGtCQUFrQixDQUFDO0FBQ2pDLGNBQWMsOEJBQThCLENBQUMifQ==
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { Watcher } from './watcher.js';
|
|
2
|
+
export class Boot {
|
|
3
|
+
#app;
|
|
4
|
+
#watcher;
|
|
5
|
+
constructor(appOrAgent) {
|
|
6
|
+
this.#app = appOrAgent;
|
|
7
|
+
this.#watcher = this.#app.watcher = this.#app.cluster(Watcher, {})
|
|
8
|
+
.delegate('watch', 'subscribe')
|
|
9
|
+
.create(appOrAgent.config)
|
|
10
|
+
.on('info', (msg, ...args) => this.#app.coreLogger.info(msg, ...args))
|
|
11
|
+
.on('warn', (msg, ...args) => this.#app.coreLogger.warn(msg, ...args))
|
|
12
|
+
.on('error', (msg, ...args) => this.#app.coreLogger.error(msg, ...args));
|
|
13
|
+
}
|
|
14
|
+
async didLoad() {
|
|
15
|
+
await this.#watcher.ready();
|
|
16
|
+
this.#app.coreLogger.info('[@eggjs/watcher:%s] watcher start success', this.#app.type);
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYm9vdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvYm9vdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLEVBQUUsT0FBTyxFQUFFLE1BQU0sY0FBYyxDQUFDO0FBRXZDLE1BQU0sT0FBTyxJQUFJO0lBQ2YsSUFBSSxDQUFzQjtJQUMxQixRQUFRLENBQVU7SUFFbEIsWUFBWSxVQUErQjtRQUN6QyxJQUFJLENBQUMsSUFBSSxHQUFHLFVBQVUsQ0FBQztRQUN2QixJQUFJLENBQUMsUUFBUSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLE9BQU8sRUFBRSxFQUFFLENBQUM7YUFDL0QsUUFBUSxDQUFDLE9BQU8sRUFBRSxXQUFXLENBQUM7YUFDOUIsTUFBTSxDQUFDLFVBQVUsQ0FBQyxNQUFNLENBQUM7YUFDekIsRUFBRSxDQUFDLE1BQU0sRUFBRSxDQUFDLEdBQVcsRUFBRSxHQUFHLElBQVcsRUFBRSxFQUFFLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxHQUFHLElBQUksQ0FBQyxDQUFDO2FBQ3BGLEVBQUUsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxHQUFXLEVBQUUsR0FBRyxJQUFXLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxJQUFJLENBQUMsQ0FBQzthQUNwRixFQUFFLENBQUMsT0FBTyxFQUFFLENBQUMsR0FBVyxFQUFFLEdBQUcsSUFBVyxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxLQUFLLENBQUMsR0FBRyxFQUFFLEdBQUcsSUFBSSxDQUFDLENBQUMsQ0FBQztJQUM1RixDQUFDO0lBRUQsS0FBSyxDQUFDLE9BQU87UUFDWCxNQUFNLElBQUksQ0FBQyxRQUFRLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDNUIsSUFBSSxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLDJDQUEyQyxFQUFFLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDekYsQ0FBQztDQUNGIn0=
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Base } from 'sdk-base';
|
|
2
|
+
export class BaseEventSource extends Base {
|
|
3
|
+
}
|
|
4
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYmFzZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvZXZlbnQtc291cmNlcy9iYXNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxJQUFJLEVBQUUsTUFBTSxVQUFVLENBQUM7QUFFaEMsTUFBTSxPQUFnQixlQUFnQixTQUFRLElBQUk7Q0FHakQifQ==
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { BaseEventSource } from './base.js';
|
|
2
|
+
export default class DefaultEventSource extends BaseEventSource {
|
|
3
|
+
constructor() {
|
|
4
|
+
super();
|
|
5
|
+
// delay emit so that can be listened
|
|
6
|
+
setImmediate(() => this.emit('info', '[@eggjs/watcher] defaultEventSource watcher will NOT take effect'));
|
|
7
|
+
this.ready(true);
|
|
8
|
+
}
|
|
9
|
+
watch() {
|
|
10
|
+
this.emit('info', '[@eggjs/watcher] using defaultEventSource watcher.watch() does NOTHING');
|
|
11
|
+
}
|
|
12
|
+
unwatch() {
|
|
13
|
+
this.emit('info', '[@eggjs/watcher] using defaultEventSource watcher.unwatch() does NOTHING');
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVmYXVsdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvZXZlbnQtc291cmNlcy9kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxlQUFlLEVBQUUsTUFBTSxXQUFXLENBQUM7QUFFNUMsTUFBTSxDQUFDLE9BQU8sT0FBTyxrQkFBbUIsU0FBUSxlQUFlO0lBQzdEO1FBQ0UsS0FBSyxFQUFFLENBQUM7UUFDUixxQ0FBcUM7UUFDckMsWUFBWSxDQUFDLEdBQUcsRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLGtFQUFrRSxDQUFDLENBQUMsQ0FBQztRQUMxRyxJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ25CLENBQUM7SUFFRCxLQUFLO1FBQ0gsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsd0VBQXdFLENBQUMsQ0FBQztJQUM5RixDQUFDO0lBRUQsT0FBTztRQUNMLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLDBFQUEwRSxDQUFDLENBQUM7SUFDaEcsQ0FBQztDQUNGIn0=
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { debuglog } from 'node:util';
|
|
2
|
+
import path from 'node:path';
|
|
3
|
+
import fs from 'node:fs';
|
|
4
|
+
import { BaseEventSource } from './base.js';
|
|
5
|
+
const debug = debuglog('@eggjs/watcher/lib/event-sources/development');
|
|
6
|
+
// only used by local dev environment
|
|
7
|
+
export default class DevelopmentEventSource extends BaseEventSource {
|
|
8
|
+
#fileWatching = new Map();
|
|
9
|
+
constructor() {
|
|
10
|
+
super();
|
|
11
|
+
this.ready(true);
|
|
12
|
+
}
|
|
13
|
+
watch(file) {
|
|
14
|
+
try {
|
|
15
|
+
const stat = fs.statSync(file, { throwIfNoEntry: false });
|
|
16
|
+
if (!stat) {
|
|
17
|
+
debug('watch %o ignore, file not exists', file);
|
|
18
|
+
return;
|
|
19
|
+
}
|
|
20
|
+
debug('watch %o, isFile: %o', file, stat.isFile());
|
|
21
|
+
// https://nodejs.org/docs/latest/api/fs.html#fswatchfilename-options-listener
|
|
22
|
+
let recursive = true;
|
|
23
|
+
if (process.platform === 'linux' && process.version.startsWith('v18.')) {
|
|
24
|
+
// https://github.com/fgnass/filewatcher/pull/6
|
|
25
|
+
// disable recursive on linux + Node.js <= 18
|
|
26
|
+
recursive = false;
|
|
27
|
+
}
|
|
28
|
+
const handler = fs.watch(file, {
|
|
29
|
+
persistent: true,
|
|
30
|
+
recursive,
|
|
31
|
+
}, (event, filename) => {
|
|
32
|
+
debug('watch %o => event: %o, filename: %o', file, event, filename);
|
|
33
|
+
let changePath = file;
|
|
34
|
+
if (stat.isFile()) {
|
|
35
|
+
this.#onFsWatchChange(event, changePath);
|
|
36
|
+
}
|
|
37
|
+
else {
|
|
38
|
+
// dir
|
|
39
|
+
if (filename) {
|
|
40
|
+
changePath = path.join(file, filename);
|
|
41
|
+
}
|
|
42
|
+
this.#onFsWatchChange(event, changePath);
|
|
43
|
+
}
|
|
44
|
+
});
|
|
45
|
+
// 保存 handler,用于解除监听
|
|
46
|
+
this.#fileWatching.set(file, handler);
|
|
47
|
+
}
|
|
48
|
+
catch (e) {
|
|
49
|
+
// file not exist, do nothing
|
|
50
|
+
// do not emit error, in case of too many logs
|
|
51
|
+
this.emit('warn', '[@eggjs/watcher:DevelopmentEventSource] watch %o error: %s', file, e);
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
unwatch(file) {
|
|
55
|
+
if (!file)
|
|
56
|
+
return;
|
|
57
|
+
const h = this.#fileWatching.get(file);
|
|
58
|
+
if (!h)
|
|
59
|
+
return;
|
|
60
|
+
// fs.watch 文件监听
|
|
61
|
+
h.removeAllListeners();
|
|
62
|
+
h.close();
|
|
63
|
+
this.#fileWatching.delete(file);
|
|
64
|
+
}
|
|
65
|
+
#onFsWatchChange(event, file) {
|
|
66
|
+
if (!file) {
|
|
67
|
+
this.emit('warn', '[@eggjs/watcher:DevelopmentEventSource] event: %o', event);
|
|
68
|
+
return;
|
|
69
|
+
}
|
|
70
|
+
// { event: 'change',
|
|
71
|
+
// path: '/Users/mk2/git/changing/test/fixtures/foo.js',
|
|
72
|
+
// stat:
|
|
73
|
+
// { dev: 16777220,
|
|
74
|
+
// mode: 33188,
|
|
75
|
+
// nlink: 1,
|
|
76
|
+
// uid: 501,
|
|
77
|
+
// gid: 20,
|
|
78
|
+
// rdev: 0,
|
|
79
|
+
// blksize: 4096,
|
|
80
|
+
// ino: 72656587,
|
|
81
|
+
// size: 11,
|
|
82
|
+
// blocks: 8,
|
|
83
|
+
// atime: Wed Jun 17 2015 00:08:11 GMT+0800 (CST),
|
|
84
|
+
// mtime: Wed Jun 17 2015 00:08:38 GMT+0800 (CST),
|
|
85
|
+
// ctime: Wed Jun 17 2015 00:08:38 GMT+0800 (CST),
|
|
86
|
+
// birthtime: Tue Jun 16 2015 23:19:13 GMT+0800 (CST) } }
|
|
87
|
+
const info = {
|
|
88
|
+
path: file,
|
|
89
|
+
event,
|
|
90
|
+
stat: fs.statSync(file, { throwIfNoEntry: false }),
|
|
91
|
+
};
|
|
92
|
+
this.emit('change', info);
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGV2ZWxvcG1lbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL2V2ZW50LXNvdXJjZXMvZGV2ZWxvcG1lbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFFBQVEsRUFBRSxNQUFNLFdBQVcsQ0FBQztBQUNyQyxPQUFPLElBQUksTUFBTSxXQUFXLENBQUM7QUFDN0IsT0FBTyxFQUFpQyxNQUFNLFNBQVMsQ0FBQztBQUN4RCxPQUFPLEVBQUUsZUFBZSxFQUFFLE1BQU0sV0FBVyxDQUFDO0FBRzVDLE1BQU0sS0FBSyxHQUFHLFFBQVEsQ0FBQyw4Q0FBOEMsQ0FBQyxDQUFDO0FBRXZFLHFDQUFxQztBQUNyQyxNQUFNLENBQUMsT0FBTyxPQUFPLHNCQUF1QixTQUFRLGVBQWU7SUFDakUsYUFBYSxHQUFHLElBQUksR0FBRyxFQUFxQixDQUFDO0lBRTdDO1FBQ0UsS0FBSyxFQUFFLENBQUM7UUFDUixJQUFJLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBQ25CLENBQUM7SUFFRCxLQUFLLENBQUMsSUFBWTtRQUNoQixJQUFJLENBQUM7WUFDSCxNQUFNLElBQUksR0FBRyxFQUFFLENBQUMsUUFBUSxDQUFDLElBQUksRUFBRSxFQUFFLGNBQWMsRUFBRSxLQUFLLEVBQUUsQ0FBQyxDQUFDO1lBQzFELElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQztnQkFDVixLQUFLLENBQUMsa0NBQWtDLEVBQUUsSUFBSSxDQUFDLENBQUM7Z0JBQ2hELE9BQU87WUFDVCxDQUFDO1lBQ0QsS0FBSyxDQUFDLHNCQUFzQixFQUFFLElBQUksRUFBRSxJQUFJLENBQUMsTUFBTSxFQUFFLENBQUMsQ0FBQztZQUNuRCw4RUFBOEU7WUFDOUUsSUFBSSxTQUFTLEdBQUcsSUFBSSxDQUFDO1lBQ3JCLElBQUksT0FBTyxDQUFDLFFBQVEsS0FBSyxPQUFPLElBQUksT0FBTyxDQUFDLE9BQU8sQ0FBQyxVQUFVLENBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQztnQkFDdkUsK0NBQStDO2dCQUMvQyw2Q0FBNkM7Z0JBQzdDLFNBQVMsR0FBRyxLQUFLLENBQUM7WUFDcEIsQ0FBQztZQUNELE1BQU0sT0FBTyxHQUFHLEVBQUUsQ0FBQyxLQUFLLENBQUMsSUFBSSxFQUFFO2dCQUM3QixVQUFVLEVBQUUsSUFBSTtnQkFDaEIsU0FBUzthQUNWLEVBQUUsQ0FBQyxLQUFLLEVBQUUsUUFBUSxFQUFFLEVBQUU7Z0JBQ3JCLEtBQUssQ0FBQyxxQ0FBcUMsRUFBRSxJQUFJLEVBQUUsS0FBSyxFQUFFLFFBQVEsQ0FBQyxDQUFDO2dCQUNwRSxJQUFJLFVBQVUsR0FBRyxJQUFJLENBQUM7Z0JBQ3RCLElBQUksSUFBSSxDQUFDLE1BQU0sRUFBRSxFQUFFLENBQUM7b0JBQ2xCLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFLLEVBQUUsVUFBVSxDQUFDLENBQUM7Z0JBQzNDLENBQUM7cUJBQU0sQ0FBQztvQkFDTixNQUFNO29CQUNOLElBQUksUUFBUSxFQUFFLENBQUM7d0JBQ2IsVUFBVSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxFQUFFLFFBQVEsQ0FBQyxDQUFDO29CQUN6QyxDQUFDO29CQUNELElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxLQUFLLEVBQUUsVUFBVSxDQUFDLENBQUM7Z0JBQzNDLENBQUM7WUFDSCxDQUFDLENBQUMsQ0FBQztZQUNILG9CQUFvQjtZQUNwQixJQUFJLENBQUMsYUFBYSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFDeEMsQ0FBQztRQUFDLE9BQU8sQ0FBQyxFQUFFLENBQUM7WUFDWCw2QkFBNkI7WUFDN0IsOENBQThDO1lBQzlDLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLDREQUE0RCxFQUFFLElBQUksRUFBRSxDQUFDLENBQUMsQ0FBQztRQUMzRixDQUFDO0lBQ0gsQ0FBQztJQUVELE9BQU8sQ0FBQyxJQUFZO1FBQ2xCLElBQUksQ0FBQyxJQUFJO1lBQUUsT0FBTztRQUVsQixNQUFNLENBQUMsR0FBRyxJQUFJLENBQUMsYUFBYSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUN2QyxJQUFJLENBQUMsQ0FBQztZQUFFLE9BQU87UUFFZixnQkFBZ0I7UUFDaEIsQ0FBQyxDQUFDLGtCQUFrQixFQUFFLENBQUM7UUFDdkIsQ0FBQyxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQ1YsSUFBSSxDQUFDLGFBQWEsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDbEMsQ0FBQztJQUVELGdCQUFnQixDQUFDLEtBQXFCLEVBQUUsSUFBWTtRQUNsRCxJQUFJLENBQUMsSUFBSSxFQUFFLENBQUM7WUFDVixJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxtREFBbUQsRUFBRSxLQUFLLENBQUMsQ0FBQztZQUM5RSxPQUFPO1FBQ1QsQ0FBQztRQUNELHFCQUFxQjtRQUNyQix3REFBd0Q7UUFDeEQsUUFBUTtRQUNSLG9CQUFvQjtRQUNwQixrQkFBa0I7UUFDbEIsZUFBZTtRQUNmLGVBQWU7UUFDZixjQUFjO1FBQ2QsY0FBYztRQUNkLG9CQUFvQjtRQUNwQixvQkFBb0I7UUFDcEIsZUFBZTtRQUNmLGdCQUFnQjtRQUNoQixxREFBcUQ7UUFDckQscURBQXFEO1FBQ3JELHFEQUFxRDtRQUNyRCw0REFBNEQ7UUFDNUQsTUFBTSxJQUFJLEdBQUc7WUFDWCxJQUFJLEVBQUUsSUFBSTtZQUNWLEtBQUs7WUFDTCxJQUFJLEVBQUUsRUFBRSxDQUFDLFFBQVEsQ0FBQyxJQUFJLEVBQUUsRUFBRSxjQUFjLEVBQUUsS0FBSyxFQUFFLENBQUM7U0FDckMsQ0FBQztRQUNoQixJQUFJLENBQUMsSUFBSSxDQUFDLFFBQVEsRUFBRSxJQUFJLENBQUMsQ0FBQztJQUM1QixDQUFDO0NBQ0YifQ==
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export * from './base.js';
|
|
2
|
+
export * from './default.js';
|
|
3
|
+
export * from './development.js';
|
|
4
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL2V2ZW50LXNvdXJjZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxXQUFXLENBQUM7QUFDMUIsY0FBYyxjQUFjLENBQUM7QUFDN0IsY0FBYyxrQkFBa0IsQ0FBQyJ9
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import type { WatchEventType, Stats } from 'node:fs';
|
|
2
|
+
import type { Watcher } from './watcher.js';
|
|
3
|
+
export interface WatcherConfig {
|
|
4
|
+
watcher: {
|
|
5
|
+
type: string;
|
|
6
|
+
eventSources: Record<string, string>;
|
|
7
|
+
};
|
|
8
|
+
[key: string]: Record<string, any>;
|
|
9
|
+
}
|
|
10
|
+
export interface ChangeInfo {
|
|
11
|
+
event: WatchEventType;
|
|
12
|
+
/**
|
|
13
|
+
* file stat if path exists
|
|
14
|
+
*/
|
|
15
|
+
stat?: Stats;
|
|
16
|
+
path: string;
|
|
17
|
+
}
|
|
18
|
+
declare module 'egg' {
|
|
19
|
+
interface EggWatcherAgent {
|
|
20
|
+
watcher: Watcher;
|
|
21
|
+
}
|
|
22
|
+
interface Agent extends EggWatcherAgent {
|
|
23
|
+
}
|
|
24
|
+
interface EggWatcherApplication {
|
|
25
|
+
watcher: Watcher;
|
|
26
|
+
}
|
|
27
|
+
interface Application extends EggWatcherApplication {
|
|
28
|
+
}
|
|
29
|
+
interface EggWatcherAppConfig extends WatcherConfig {
|
|
30
|
+
}
|
|
31
|
+
interface EggAppConfig extends EggWatcherAppConfig {
|
|
32
|
+
}
|
|
33
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import path from 'node:path';
|
|
2
|
+
import { fileURLToPath } from 'node:url';
|
|
3
|
+
// judge if parent is child's parent path
|
|
4
|
+
// isEqualOrParentPath('/foo', '/foo/bar') => true
|
|
5
|
+
// isEqualOrParentPath('/foo/bar', '/foo') => false
|
|
6
|
+
export function isEqualOrParentPath(parent, child) {
|
|
7
|
+
return !path.relative(parent, child).startsWith('..');
|
|
8
|
+
}
|
|
9
|
+
export function getSourceDirname() {
|
|
10
|
+
if (typeof __dirname === 'string') {
|
|
11
|
+
return path.dirname(__dirname);
|
|
12
|
+
}
|
|
13
|
+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
14
|
+
// @ts-ignore
|
|
15
|
+
const __filename = fileURLToPath(import.meta.url);
|
|
16
|
+
return path.dirname(path.dirname(__filename));
|
|
17
|
+
}
|
|
18
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXRpbHMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbGliL3V0aWxzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sSUFBSSxNQUFNLFdBQVcsQ0FBQztBQUM3QixPQUFPLEVBQUUsYUFBYSxFQUFFLE1BQU0sVUFBVSxDQUFDO0FBRXpDLHlDQUF5QztBQUN6QyxrREFBa0Q7QUFDbEQsbURBQW1EO0FBQ25ELE1BQU0sVUFBVSxtQkFBbUIsQ0FBQyxNQUFjLEVBQUUsS0FBYTtJQUMvRCxPQUFPLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxNQUFNLEVBQUUsS0FBSyxDQUFDLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxDQUFDO0FBQ3hELENBQUM7QUFFRCxNQUFNLFVBQVUsZ0JBQWdCO0lBQzlCLElBQUksT0FBTyxTQUFTLEtBQUssUUFBUSxFQUFFLENBQUM7UUFDbEMsT0FBTyxJQUFJLENBQUMsT0FBTyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQ2pDLENBQUM7SUFFRCw2REFBNkQ7SUFDN0QsYUFBYTtJQUNiLE1BQU0sVUFBVSxHQUFHLGFBQWEsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQ2xELE9BQU8sSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxDQUFDLENBQUM7QUFDaEQsQ0FBQyJ9
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { Base } from 'sdk-base';
|
|
2
|
+
import type { ChangeInfo, WatcherConfig } from './types.js';
|
|
3
|
+
export type WatchListener = (info: ChangeInfo) => void;
|
|
4
|
+
export declare class Watcher extends Base {
|
|
5
|
+
#private;
|
|
6
|
+
constructor(config: WatcherConfig);
|
|
7
|
+
protected _init(): Promise<void>;
|
|
8
|
+
watch(path: string | string[], listener: WatchListener): void;
|
|
9
|
+
}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { debuglog } from 'node:util';
|
|
2
|
+
import { Base } from 'sdk-base';
|
|
3
|
+
import camelcase from 'camelcase';
|
|
4
|
+
import { importModule } from '@eggjs/utils';
|
|
5
|
+
import { isEqualOrParentPath } from './utils.js';
|
|
6
|
+
const debug = debuglog('@eggjs/watcher/lib/watcher');
|
|
7
|
+
export class Watcher extends Base {
|
|
8
|
+
#config;
|
|
9
|
+
#eventSource;
|
|
10
|
+
constructor(config) {
|
|
11
|
+
super({
|
|
12
|
+
initMethod: '_init',
|
|
13
|
+
});
|
|
14
|
+
this.#config = config;
|
|
15
|
+
}
|
|
16
|
+
async _init() {
|
|
17
|
+
const watcherType = this.#config.watcher.type;
|
|
18
|
+
let EventSource = this.#config.watcher.eventSources[watcherType];
|
|
19
|
+
if (typeof EventSource === 'string') {
|
|
20
|
+
EventSource = await importModule(EventSource);
|
|
21
|
+
}
|
|
22
|
+
// chokidar => watcherChokidar
|
|
23
|
+
// custom => watcherCustom
|
|
24
|
+
//
|
|
25
|
+
// e.g:
|
|
26
|
+
// config => { watcher: { type: 'custom' }, watcherCustom: { ... } }
|
|
27
|
+
const key = camelcase(['watcher', watcherType]);
|
|
28
|
+
const eventSourceOptions = this.#config[key] ?? {};
|
|
29
|
+
this.#eventSource = Reflect.construct(EventSource, [eventSourceOptions]);
|
|
30
|
+
this.#eventSource.on('change', this.#onChange.bind(this))
|
|
31
|
+
.on('fuzzy-change', this.#onFuzzyChange.bind(this))
|
|
32
|
+
.on('info', (...args) => this.emit('info', ...args))
|
|
33
|
+
.on('warn', (...args) => this.emit('warn', ...args))
|
|
34
|
+
.on('error', (...args) => this.emit('error', ...args));
|
|
35
|
+
await this.#eventSource.ready();
|
|
36
|
+
}
|
|
37
|
+
watch(path, listener) {
|
|
38
|
+
this.emit('info', '[@eggjs/watcher] Start watching: %j', path);
|
|
39
|
+
if (!path)
|
|
40
|
+
return;
|
|
41
|
+
// support array
|
|
42
|
+
if (Array.isArray(path)) {
|
|
43
|
+
path.forEach(p => this.watch(p, listener));
|
|
44
|
+
return;
|
|
45
|
+
}
|
|
46
|
+
// one file only watch once
|
|
47
|
+
if (!this.listenerCount(path)) {
|
|
48
|
+
this.#eventSource.watch(path);
|
|
49
|
+
}
|
|
50
|
+
this.on(path, listener);
|
|
51
|
+
}
|
|
52
|
+
/*
|
|
53
|
+
// TODO wait unsubscribe implementation of cluster-client
|
|
54
|
+
unwatch(path, callback) {
|
|
55
|
+
if (!path) return;
|
|
56
|
+
|
|
57
|
+
// support array
|
|
58
|
+
if (Array.isArray(path)) {
|
|
59
|
+
path.forEach(p => this.unwatch(p, callback));
|
|
60
|
+
return;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
if (callback) {
|
|
64
|
+
this.removeListener(path, callback);
|
|
65
|
+
// stop watching when no listener bound to the path
|
|
66
|
+
if (this.listenerCount(path) === 0) {
|
|
67
|
+
this._eventSource.unwatch(path);
|
|
68
|
+
}
|
|
69
|
+
return;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
this.removeAllListeners(path);
|
|
73
|
+
this._eventSource.unwatch(path);
|
|
74
|
+
}
|
|
75
|
+
*/
|
|
76
|
+
#onChange(info) {
|
|
77
|
+
debug('onChange %o', info);
|
|
78
|
+
this.emit('info', '[@eggjs/watcher] Received a change event from eventSource: %j', info);
|
|
79
|
+
const path = info.path;
|
|
80
|
+
for (const p of this.eventNames()) {
|
|
81
|
+
if (typeof p !== 'string')
|
|
82
|
+
continue;
|
|
83
|
+
// if it is a sub path, emit a `change` event
|
|
84
|
+
if (isEqualOrParentPath(p, path)) {
|
|
85
|
+
this.emit(p, info);
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
#onFuzzyChange(info) {
|
|
90
|
+
debug('onFuzzyChange %o', info);
|
|
91
|
+
this.emit('info', '[@eggjs/watcher] Received a fuzzy-change event from eventSource: %j', info);
|
|
92
|
+
const path = info.path;
|
|
93
|
+
for (const p of this.eventNames()) {
|
|
94
|
+
if (typeof p !== 'string')
|
|
95
|
+
continue;
|
|
96
|
+
// if it is a parent path, emit a `change` event
|
|
97
|
+
// just the opposite to `_onChange`
|
|
98
|
+
if (isEqualOrParentPath(path, p)) {
|
|
99
|
+
this.emit(p, info);
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2F0Y2hlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvd2F0Y2hlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsUUFBUSxFQUFFLE1BQU0sV0FBVyxDQUFDO0FBQ3JDLE9BQU8sRUFBRSxJQUFJLEVBQUUsTUFBTSxVQUFVLENBQUM7QUFDaEMsT0FBTyxTQUFTLE1BQU0sV0FBVyxDQUFDO0FBQ2xDLE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSxjQUFjLENBQUM7QUFFNUMsT0FBTyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sWUFBWSxDQUFDO0FBR2pELE1BQU0sS0FBSyxHQUFHLFFBQVEsQ0FBQyw0QkFBNEIsQ0FBQyxDQUFDO0FBSXJELE1BQU0sT0FBTyxPQUFRLFNBQVEsSUFBSTtJQUMvQixPQUFPLENBQWdCO0lBQ3ZCLFlBQVksQ0FBa0I7SUFFOUIsWUFBWSxNQUFxQjtRQUMvQixLQUFLLENBQUM7WUFDSixVQUFVLEVBQUUsT0FBTztTQUNwQixDQUFDLENBQUM7UUFDSCxJQUFJLENBQUMsT0FBTyxHQUFHLE1BQU0sQ0FBQztJQUN4QixDQUFDO0lBRVMsS0FBSyxDQUFDLEtBQUs7UUFDbkIsTUFBTSxXQUFXLEdBQUcsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDO1FBQzlDLElBQUksV0FBVyxHQUEyQixJQUFJLENBQUMsT0FBTyxDQUFDLE9BQU8sQ0FBQyxZQUFZLENBQUMsV0FBVyxDQUFRLENBQUM7UUFDaEcsSUFBSSxPQUFPLFdBQVcsS0FBSyxRQUFRLEVBQUUsQ0FBQztZQUNwQyxXQUFXLEdBQUcsTUFBTSxZQUFZLENBQUMsV0FBVyxDQUFDLENBQUM7UUFDaEQsQ0FBQztRQUVELDhCQUE4QjtRQUM5QiwwQkFBMEI7UUFDMUIsRUFBRTtRQUNGLE9BQU87UUFDUCxxRUFBcUU7UUFDckUsTUFBTSxHQUFHLEdBQUcsU0FBUyxDQUFDLENBQUUsU0FBUyxFQUFFLFdBQVcsQ0FBRSxDQUFDLENBQUM7UUFDbEQsTUFBTSxrQkFBa0IsR0FBRyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsQ0FBQztRQUNuRCxJQUFJLENBQUMsWUFBWSxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsV0FBVyxFQUFFLENBQUUsa0JBQWtCLENBQUUsQ0FBQyxDQUFDO1FBQzNFLElBQUksQ0FBQyxZQUFZLENBQUMsRUFBRSxDQUFDLFFBQVEsRUFBRSxJQUFJLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQzthQUN0RCxFQUFFLENBQUMsY0FBYyxFQUFFLElBQUksQ0FBQyxjQUFjLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO2FBQ2xELEVBQUUsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxHQUFHLElBQUksRUFBRSxFQUFFLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUsR0FBRyxJQUFJLENBQUMsQ0FBQzthQUNuRCxFQUFFLENBQUMsTUFBTSxFQUFFLENBQUMsR0FBRyxJQUFJLEVBQUUsRUFBRSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFLEdBQUcsSUFBSSxDQUFDLENBQUM7YUFDbkQsRUFBRSxDQUFDLE9BQU8sRUFBRSxDQUFDLEdBQUcsSUFBSSxFQUFFLEVBQUUsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBRSxHQUFHLElBQUksQ0FBQyxDQUFDLENBQUM7UUFDekQsTUFBTSxJQUFJLENBQUMsWUFBWSxDQUFDLEtBQUssRUFBRSxDQUFDO0lBQ2xDLENBQUM7SUFFRCxLQUFLLENBQUMsSUFBdUIsRUFBRSxRQUF1QjtRQUNwRCxJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSxxQ0FBcUMsRUFBRSxJQUFJLENBQUMsQ0FBQztRQUMvRCxJQUFJLENBQUMsSUFBSTtZQUFFLE9BQU87UUFFbEIsZ0JBQWdCO1FBQ2hCLElBQUksS0FBSyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDO1lBQ3hCLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUMsRUFBRSxRQUFRLENBQUMsQ0FBQyxDQUFDO1lBQzNDLE9BQU87UUFDVCxDQUFDO1FBRUQsMkJBQTJCO1FBQzNCLElBQUksQ0FBQyxJQUFJLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUM7WUFDOUIsSUFBSSxDQUFDLFlBQVksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDaEMsQ0FBQztRQUNELElBQUksQ0FBQyxFQUFFLENBQUMsSUFBSSxFQUFFLFFBQVEsQ0FBQyxDQUFDO0lBQzFCLENBQUM7SUFFRDs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7TUF1QkU7SUFFRixTQUFTLENBQUMsSUFBZ0I7UUFDeEIsS0FBSyxDQUFDLGFBQWEsRUFBRSxJQUFJLENBQUMsQ0FBQztRQUMzQixJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sRUFBRSwrREFBK0QsRUFBRSxJQUFJLENBQUMsQ0FBQztRQUN6RixNQUFNLElBQUksR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDO1FBRXZCLEtBQUssTUFBTSxDQUFDLElBQUksSUFBSSxDQUFDLFVBQVUsRUFBRSxFQUFFLENBQUM7WUFDbEMsSUFBSSxPQUFPLENBQUMsS0FBSyxRQUFRO2dCQUFFLFNBQVM7WUFDcEMsNkNBQTZDO1lBQzdDLElBQUksbUJBQW1CLENBQUMsQ0FBQyxFQUFFLElBQUksQ0FBQyxFQUFFLENBQUM7Z0JBQ2pDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxFQUFFLElBQUksQ0FBQyxDQUFDO1lBQ3JCLENBQUM7UUFDSCxDQUFDO0lBQ0gsQ0FBQztJQUVELGNBQWMsQ0FBQyxJQUFnQjtRQUM3QixLQUFLLENBQUMsa0JBQWtCLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDaEMsSUFBSSxDQUFDLElBQUksQ0FBQyxNQUFNLEVBQUUscUVBQXFFLEVBQUUsSUFBSSxDQUFDLENBQUM7UUFDL0YsTUFBTSxJQUFJLEdBQUcsSUFBSSxDQUFDLElBQUksQ0FBQztRQUV2QixLQUFLLE1BQU0sQ0FBQyxJQUFJLElBQUksQ0FBQyxVQUFVLEVBQUUsRUFBRSxDQUFDO1lBQ2xDLElBQUksT0FBTyxDQUFDLEtBQUssUUFBUTtnQkFBRSxTQUFTO1lBQ3BDLGdEQUFnRDtZQUNoRCxtQ0FBbUM7WUFDbkMsSUFBSSxtQkFBbUIsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFDLEVBQUUsQ0FBQztnQkFDakMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLEVBQUUsSUFBSSxDQUFDLENBQUM7WUFDckIsQ0FBQztRQUNILENBQUM7SUFDSCxDQUFDO0NBQ0YifQ==
|