navi-hey 1.2.0 → 1.3.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/lib/common/server/HandlerConfig.js +30 -0
- package/lib/common/server/RequestHandler.js +13 -0
- package/lib/common/utils/EnvResolver.js +26 -0
- package/lib/common/utils/env_resolver/EnvStringResolver.js +52 -0
- package/lib/common/utils/logging/BaseLogger.js +98 -0
- package/lib/common/utils/logging/BufferedLogger.js +100 -0
- package/lib/common/utils/logging/ConsoleLogger.js +20 -0
- package/lib/common/utils/logging/Log.js +82 -0
- package/lib/common/utils/logging/LogBuffer.js +122 -0
- package/lib/common/utils/logging/LogBufferCollection.js +56 -0
- package/lib/common/utils/logging/LogContext.js +51 -0
- package/lib/common/utils/logging/LogFactory.js +33 -0
- package/lib/common/utils/logging/LogFilter.js +34 -0
- package/lib/common/utils/logging/Logger.js +138 -0
- package/lib/common/utils/logging/LoggerGroup.js +104 -0
- package/lib/models/configs/Link.js +36 -0
- package/lib/models/configs/WebConfig.js +5 -1
- package/lib/serializers/LinksSerializer.js +19 -0
- package/lib/server/Router.js +39 -35
- package/lib/server/handlers/AssetsHandler.js +51 -0
- package/lib/server/handlers/IndexHandler.js +33 -0
- package/lib/server/handlers/LinksHandler.js +50 -0
- package/lib/server/handlers/LogsHandler.js +57 -0
- package/lib/server/handlers/SettingsHandler.js +34 -0
- package/lib/server/handlers/StatsHandler.js +33 -0
- package/lib/server/handlers/engine/EngineContinueHandler.js +32 -0
- package/lib/server/handlers/engine/EnginePauseHandler.js +32 -0
- package/lib/server/handlers/engine/EngineRestartHandler.js +32 -0
- package/lib/server/handlers/engine/EngineShutdownHandler.js +30 -0
- package/lib/server/handlers/engine/EngineStartHandler.js +32 -0
- package/lib/server/handlers/engine/EngineStatusHandler.js +29 -0
- package/lib/server/handlers/engine/EngineStopHandler.js +32 -0
- package/lib/server/handlers/jobs/JobHandler.js +35 -0
- package/lib/server/handlers/jobs/JobLogsHandler.js +38 -0
- package/lib/server/handlers/jobs/{JobRetryRequestHandler.js → JobRetryHandler.js} +15 -13
- package/lib/server/handlers/jobs/JobsHandler.js +37 -0
- package/lib/services/ApplicationInstance.js +28 -4
- package/lib/services/Client.js +6 -2
- package/lib/services/ConfigLoader.js +3 -3
- package/lib/services/RunSummary.js +70 -0
- package/lib/utils/logging/BaseLogger.js +1 -98
- package/lib/utils/logging/BufferedLogger.js +1 -100
- package/lib/utils/logging/ConsoleLogger.js +1 -20
- package/lib/utils/logging/Log.js +1 -82
- package/lib/utils/logging/LogBuffer.js +1 -122
- package/lib/utils/logging/LogBufferCollection.js +1 -56
- package/lib/utils/logging/LogContext.js +1 -51
- package/lib/utils/logging/LogFactory.js +1 -33
- package/lib/utils/logging/LogFilter.js +1 -34
- package/lib/utils/logging/Logger.js +1 -138
- package/lib/utils/logging/LoggerGroup.js +1 -104
- package/package.json +1 -1
- package/static/assets/{index-D5tOOLpl.js → index-BnMGdHFP.js} +7 -7
- package/static/favicon.png +0 -0
- package/static/index.html +2 -1
- package/lib/serializers/BaseUrlsSerializer.js +0 -18
- package/lib/server/RequestHandler.js +0 -15
- package/lib/server/handlers/AssetsRequestHandler.js +0 -50
- package/lib/server/handlers/BaseUrlsRequestHandler.js +0 -33
- package/lib/server/handlers/IndexRequestHandler.js +0 -31
- package/lib/server/handlers/LogsRequestHandler.js +0 -55
- package/lib/server/handlers/SettingsRequestHandler.js +0 -35
- package/lib/server/handlers/StatsRequestHandler.js +0 -31
- package/lib/server/handlers/engine/EngineContinueRequestHandler.js +0 -34
- package/lib/server/handlers/engine/EnginePauseRequestHandler.js +0 -34
- package/lib/server/handlers/engine/EngineRestartRequestHandler.js +0 -34
- package/lib/server/handlers/engine/EngineShutdownRequestHandler.js +0 -29
- package/lib/server/handlers/engine/EngineStartRequestHandler.js +0 -34
- package/lib/server/handlers/engine/EngineStatusRequestHandler.js +0 -27
- package/lib/server/handlers/engine/EngineStopRequestHandler.js +0 -34
- package/lib/server/handlers/jobs/JobLogsRequestHandler.js +0 -39
- package/lib/server/handlers/jobs/JobRequestHandler.js +0 -33
- package/lib/server/handlers/jobs/JobsRequestHandler.js +0 -33
- package/lib/utils/EnvResolver.js +0 -75
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Filters a list of log entries based on query options.
|
|
3
|
+
* @author darthjee
|
|
4
|
+
*/
|
|
5
|
+
class LogFilter {
|
|
6
|
+
#logs;
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* @param {Array<import('./Log.js').Log>} logs - The full list of logs to filter (oldest first).
|
|
10
|
+
*/
|
|
11
|
+
constructor(logs) {
|
|
12
|
+
this.#logs = logs;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Returns the filtered log list.
|
|
17
|
+
* @param {object} [options={}] - Filter options.
|
|
18
|
+
* @param {number|string} [options.lastId] - When provided, returns only logs newer than this ID.
|
|
19
|
+
* Returns an empty array if the ID is not found.
|
|
20
|
+
* @returns {Array<import('./Log.js').Log>} Filtered array of log entries.
|
|
21
|
+
*/
|
|
22
|
+
filter({ lastId } = {}) {
|
|
23
|
+
if (lastId === undefined) return this.#logs;
|
|
24
|
+
|
|
25
|
+
const id = parseInt(lastId, 10);
|
|
26
|
+
const index = this.#logs.findIndex(log => log.id === id);
|
|
27
|
+
|
|
28
|
+
if (index === -1) return [];
|
|
29
|
+
|
|
30
|
+
return this.#logs.slice(index + 1);
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
export { LogFilter };
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
import { ConsoleLogger } from './ConsoleLogger.js';
|
|
2
|
+
import { LoggerGroup } from './LoggerGroup.js';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Static facade for the default LoggerGroup singleton.
|
|
6
|
+
* All instance-level log logic lives in BaseLogger / ConsoleLogger / LoggerGroup.
|
|
7
|
+
*
|
|
8
|
+
* @example <caption>Basic logging (default ConsoleLogger)</caption>
|
|
9
|
+
* Logger.info('Server started');
|
|
10
|
+
* Logger.warn('Low memory');
|
|
11
|
+
* Logger.error('Request failed');
|
|
12
|
+
*
|
|
13
|
+
* @example <caption>Swap to a custom logger</caption>
|
|
14
|
+
* Logger.setLogger(myCustomLogger);
|
|
15
|
+
* Logger.info('Now routed through myCustomLogger');
|
|
16
|
+
*
|
|
17
|
+
* @example <caption>Add an extra log destination</caption>
|
|
18
|
+
* const buffered = new BufferedLogger();
|
|
19
|
+
* Logger.addLogger(buffered);
|
|
20
|
+
* Logger.info('Goes to console and buffered logger');
|
|
21
|
+
*
|
|
22
|
+
* @example <caption>Suppress all output</caption>
|
|
23
|
+
* Logger.suppress();
|
|
24
|
+
* Logger.info('This will not be printed');
|
|
25
|
+
* Logger.suppress(false); // restore output
|
|
26
|
+
*
|
|
27
|
+
* @author darthjee
|
|
28
|
+
*/
|
|
29
|
+
class Logger {
|
|
30
|
+
static #loggerGroup;
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Returns the default LoggerGroup instance (singleton).
|
|
34
|
+
* Initialized with a ConsoleLogger on first access.
|
|
35
|
+
* @returns {LoggerGroup} The default logger group instance.
|
|
36
|
+
*/
|
|
37
|
+
static default() {
|
|
38
|
+
this.#ensureLoggerGroup();
|
|
39
|
+
return this.#loggerGroup;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* Logs a debug message using the default logger instance.
|
|
44
|
+
* @param {string} message - The message to log.
|
|
45
|
+
* @param {object} [attributes={}] - Optional structured metadata.
|
|
46
|
+
* @returns {void}
|
|
47
|
+
*/
|
|
48
|
+
static debug(message, attributes = {}) {
|
|
49
|
+
this.default().debug(message, attributes);
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* Logs an info message using the default logger instance.
|
|
54
|
+
* @param {string} message - The message to log.
|
|
55
|
+
* @param {object} [attributes={}] - Optional structured metadata.
|
|
56
|
+
* @returns {void}
|
|
57
|
+
*/
|
|
58
|
+
static info(message, attributes = {}) {
|
|
59
|
+
this.default().info(message, attributes);
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* Logs a warn message using the default logger instance.
|
|
64
|
+
* @param {string} message - The message to log.
|
|
65
|
+
* @param {object} [attributes={}] - Optional structured metadata.
|
|
66
|
+
* @returns {void}
|
|
67
|
+
*/
|
|
68
|
+
static warn(message, attributes = {}) {
|
|
69
|
+
this.default().warn(message, attributes);
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* Logs an error message using the default logger instance.
|
|
74
|
+
* @param {string} message - The message to log.
|
|
75
|
+
* @param {object} [attributes={}] - Optional structured metadata.
|
|
76
|
+
* @returns {void}
|
|
77
|
+
*/
|
|
78
|
+
static error(message, attributes = {}) {
|
|
79
|
+
this.default().error(message, attributes);
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* Suppresses or restores log output on the default logger instance.
|
|
84
|
+
* @param {boolean} [value=true] - When true, all log output is suppressed.
|
|
85
|
+
* @returns {void}
|
|
86
|
+
*/
|
|
87
|
+
static suppress(value = true) {
|
|
88
|
+
this.default().suppress(value);
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* Sets the log level threshold on the default logger instance.
|
|
93
|
+
* @param {string} level - The new log level ('debug', 'info', 'warn', 'error', 'silent').
|
|
94
|
+
* @returns {void}
|
|
95
|
+
*/
|
|
96
|
+
static setLevel(level) {
|
|
97
|
+
this.default().setLevel(level);
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* Resets the default logger group so a new one is created on the next call to default().
|
|
102
|
+
* Useful in tests to ensure a clean singleton state.
|
|
103
|
+
* @returns {void}
|
|
104
|
+
*/
|
|
105
|
+
static reset() {
|
|
106
|
+
this.#loggerGroup = null;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* Replaces the default logger group with a new LoggerGroup containing the provided logger.
|
|
111
|
+
* @param {BaseLogger} logger - The logger instance to use in the new group.
|
|
112
|
+
* @returns {void}
|
|
113
|
+
*/
|
|
114
|
+
static setLogger(logger) {
|
|
115
|
+
this.#loggerGroup = new LoggerGroup([logger]);
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
/**
|
|
119
|
+
* Adds a logger to the default logger group.
|
|
120
|
+
* @param {BaseLogger} logger - The logger instance to add.
|
|
121
|
+
* @returns {void}
|
|
122
|
+
*/
|
|
123
|
+
static addLogger(logger) {
|
|
124
|
+
this.default().addLogger(logger);
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* Ensures the default LoggerGroup instance exists, creating one with a ConsoleLogger if needed.
|
|
129
|
+
* @returns {void}
|
|
130
|
+
*/
|
|
131
|
+
static #ensureLoggerGroup() {
|
|
132
|
+
if (!this.#loggerGroup) {
|
|
133
|
+
this.#loggerGroup = new LoggerGroup([new ConsoleLogger()]);
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
export { Logger };
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* LoggerGroup broadcasts log messages to multiple Logger instances.
|
|
3
|
+
* Useful for sending the same log output to multiple destinations (console, web, file, etc.).
|
|
4
|
+
* @author darthjee
|
|
5
|
+
*/
|
|
6
|
+
class LoggerGroup {
|
|
7
|
+
#loggers;
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Creates a new LoggerGroup instance.
|
|
11
|
+
* @param {Array<Logger>} [loggers=[]] - Array of Logger instances to broadcast to.
|
|
12
|
+
*/
|
|
13
|
+
constructor(loggers = []) {
|
|
14
|
+
this.#loggers = loggers;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Adds a logger to the group.
|
|
19
|
+
* @param {Logger} logger - The Logger instance to add.
|
|
20
|
+
* @returns {LoggerGroup} This instance for method chaining.
|
|
21
|
+
*/
|
|
22
|
+
addLogger(logger) {
|
|
23
|
+
this.#loggers.push(logger);
|
|
24
|
+
return this;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Removes a logger from the group.
|
|
29
|
+
* @param {Logger} logger - The Logger instance to remove.
|
|
30
|
+
* @returns {LoggerGroup} This instance for method chaining.
|
|
31
|
+
*/
|
|
32
|
+
removeLogger(logger) {
|
|
33
|
+
this.#loggers = this.#loggers.filter(l => l !== logger);
|
|
34
|
+
return this;
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* Returns all loggers in the group.
|
|
39
|
+
* @returns {Array<Logger>} Array of Logger instances.
|
|
40
|
+
*/
|
|
41
|
+
getLoggers() {
|
|
42
|
+
return [...this.#loggers];
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Broadcasts a debug message to all loggers in the group.
|
|
47
|
+
* @param {string} message - The message to log.
|
|
48
|
+
* @param {object} [attributes={}] - Optional structured metadata.
|
|
49
|
+
* @returns {void}
|
|
50
|
+
*/
|
|
51
|
+
debug(message, attributes = {}) {
|
|
52
|
+
this.#loggers.forEach(logger => logger.debug(message, attributes));
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Broadcasts an info message to all loggers in the group.
|
|
57
|
+
* @param {string} message - The message to log.
|
|
58
|
+
* @param {object} [attributes={}] - Optional structured metadata.
|
|
59
|
+
* @returns {void}
|
|
60
|
+
*/
|
|
61
|
+
info(message, attributes = {}) {
|
|
62
|
+
this.#loggers.forEach(logger => logger.info(message, attributes));
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Broadcasts a warn message to all loggers in the group.
|
|
67
|
+
* @param {string} message - The message to log.
|
|
68
|
+
* @param {object} [attributes={}] - Optional structured metadata.
|
|
69
|
+
* @returns {void}
|
|
70
|
+
*/
|
|
71
|
+
warn(message, attributes = {}) {
|
|
72
|
+
this.#loggers.forEach(logger => logger.warn(message, attributes));
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Broadcasts an error message to all loggers in the group.
|
|
77
|
+
* @param {string} message - The message to log.
|
|
78
|
+
* @param {object} [attributes={}] - Optional structured metadata.
|
|
79
|
+
* @returns {void}
|
|
80
|
+
*/
|
|
81
|
+
error(message, attributes = {}) {
|
|
82
|
+
this.#loggers.forEach(logger => logger.error(message, attributes));
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* Suppresses or restores log output on all loggers in the group.
|
|
87
|
+
* @param {boolean} [value=true] - When true, all log output is suppressed.
|
|
88
|
+
* @returns {void}
|
|
89
|
+
*/
|
|
90
|
+
suppress(value = true) {
|
|
91
|
+
this.#loggers.forEach(logger => logger.suppress(value));
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Sets the log level threshold on all loggers in the group.
|
|
96
|
+
* @param {string} level - The new log level ('debug', 'info', 'warn', 'error', 'silent').
|
|
97
|
+
* @returns {void}
|
|
98
|
+
*/
|
|
99
|
+
setLevel(level) {
|
|
100
|
+
this.#loggers.forEach(logger => logger.setLevel(level));
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
export { LoggerGroup };
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Represents a web link item configured for the UI.
|
|
3
|
+
* @author darthjee
|
|
4
|
+
*/
|
|
5
|
+
class Link {
|
|
6
|
+
/**
|
|
7
|
+
* Creates a Link instance.
|
|
8
|
+
* @param {object} params - Constructor params.
|
|
9
|
+
* @param {string} params.url - Link URL.
|
|
10
|
+
* @param {string} [params.text] - Link display text.
|
|
11
|
+
*/
|
|
12
|
+
constructor({ url, text }) {
|
|
13
|
+
this.url = url;
|
|
14
|
+
this.text = text ?? url;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Creates a Link instance from a YAML entry.
|
|
19
|
+
* @param {string|object} entry - A URL string or an object with text/url fields.
|
|
20
|
+
* @returns {Link} The parsed Link instance.
|
|
21
|
+
*/
|
|
22
|
+
static fromObject(entry) {
|
|
23
|
+
if (typeof entry === 'string') return new Link({ url: entry, text: entry });
|
|
24
|
+
return new Link({ url: entry.url, text: entry.text });
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Serializes this link for JSON responses.
|
|
29
|
+
* @returns {{url: string, text: string}} The serialized link.
|
|
30
|
+
*/
|
|
31
|
+
toJSON() {
|
|
32
|
+
return { url: this.url, text: this.text };
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
export { Link };
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { Link } from './Link.js';
|
|
2
|
+
|
|
1
3
|
/**
|
|
2
4
|
* Represents the web server configuration.
|
|
3
5
|
* @author darthjee
|
|
@@ -8,11 +10,13 @@ class WebConfig {
|
|
|
8
10
|
* @param {number} config.port - The port number to listen on.
|
|
9
11
|
* @param {number} [config.logs_page_size=20] - Maximum number of log entries per page.
|
|
10
12
|
* @param {boolean} [config.enable_shutdown=true] - Whether the shutdown button is enabled.
|
|
13
|
+
* @param {Array<string|object>} [config.links=[]] - Links shown in the web UI.
|
|
11
14
|
*/
|
|
12
|
-
constructor({ port, logs_page_size: logsPageSize = 20, enable_shutdown: enableShutdown = true }) {
|
|
15
|
+
constructor({ port, logs_page_size: logsPageSize = 20, enable_shutdown: enableShutdown = true, links = [] }) {
|
|
13
16
|
this.port = port;
|
|
14
17
|
this.logsPageSize = logsPageSize;
|
|
15
18
|
this.enableShutdown = enableShutdown;
|
|
19
|
+
this.links = links.map((link) => Link.fromObject(link));
|
|
16
20
|
}
|
|
17
21
|
}
|
|
18
22
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { Serializer } from './Serializer.js';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Serializes Link instances into plain link objects.
|
|
5
|
+
* @augments Serializer
|
|
6
|
+
* @author darthjee
|
|
7
|
+
*/
|
|
8
|
+
class LinksSerializer extends Serializer {
|
|
9
|
+
/**
|
|
10
|
+
* Serializes a single Link instance.
|
|
11
|
+
* @param {import('../models/configs/Link.js').Link} link - The link to serialize.
|
|
12
|
+
* @returns {{url: string, text: string}} Plain object representation of the link.
|
|
13
|
+
*/
|
|
14
|
+
static _serializeObject(link) {
|
|
15
|
+
return link.toJSON();
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export { LinksSerializer };
|
package/lib/server/Router.js
CHANGED
|
@@ -1,28 +1,32 @@
|
|
|
1
1
|
import path from 'path';
|
|
2
2
|
import { fileURLToPath } from 'url';
|
|
3
3
|
import express from 'express';
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
8
|
-
import {
|
|
9
|
-
import {
|
|
10
|
-
import {
|
|
11
|
-
import {
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
16
|
-
import {
|
|
17
|
-
import {
|
|
18
|
-
import {
|
|
19
|
-
import {
|
|
20
|
-
import {
|
|
4
|
+
import { AssetsHandler } from './handlers/AssetsHandler.js';
|
|
5
|
+
import { HandlerConfig } from '../common/server/HandlerConfig.js';
|
|
6
|
+
import { EngineContinueHandler } from './handlers/engine/EngineContinueHandler.js';
|
|
7
|
+
import { EnginePauseHandler } from './handlers/engine/EnginePauseHandler.js';
|
|
8
|
+
import { EngineRestartHandler } from './handlers/engine/EngineRestartHandler.js';
|
|
9
|
+
import { EngineShutdownHandler } from './handlers/engine/EngineShutdownHandler.js';
|
|
10
|
+
import { EngineStartHandler } from './handlers/engine/EngineStartHandler.js';
|
|
11
|
+
import { EngineStatusHandler } from './handlers/engine/EngineStatusHandler.js';
|
|
12
|
+
import { EngineStopHandler } from './handlers/engine/EngineStopHandler.js';
|
|
13
|
+
import { IndexHandler } from './handlers/IndexHandler.js';
|
|
14
|
+
import { JobHandler } from './handlers/jobs/JobHandler.js';
|
|
15
|
+
import { JobLogsHandler } from './handlers/jobs/JobLogsHandler.js';
|
|
16
|
+
import { JobRetryHandler } from './handlers/jobs/JobRetryHandler.js';
|
|
17
|
+
import { JobsHandler } from './handlers/jobs/JobsHandler.js';
|
|
18
|
+
import { LinksHandler } from './handlers/LinksHandler.js';
|
|
19
|
+
import { LogsHandler } from './handlers/LogsHandler.js';
|
|
20
|
+
import { SettingsHandler } from './handlers/SettingsHandler.js';
|
|
21
|
+
import { StatsHandler } from './handlers/StatsHandler.js';
|
|
22
|
+
import { PathValidator } from './PathValidator.js';
|
|
21
23
|
import { RouteRegister } from './RouteRegister.js';
|
|
22
24
|
|
|
23
25
|
const { Router: ExpressRouter } = express;
|
|
24
26
|
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
25
27
|
const staticDir = path.join(__dirname, '../../static');
|
|
28
|
+
const assetsDir = path.join(staticDir, 'assets');
|
|
29
|
+
const assetsValidator = new PathValidator(assetsDir);
|
|
26
30
|
|
|
27
31
|
/**
|
|
28
32
|
* Builds the Express router with all application routes.
|
|
@@ -49,26 +53,26 @@ class Router {
|
|
|
49
53
|
const register = new RouteRegister(router);
|
|
50
54
|
|
|
51
55
|
const GET_ROUTES = {
|
|
52
|
-
'/settings.json': new
|
|
53
|
-
'/stats.json': new
|
|
54
|
-
'/
|
|
55
|
-
'/jobs/:
|
|
56
|
-
'/
|
|
57
|
-
'/
|
|
58
|
-
'/
|
|
59
|
-
'/
|
|
60
|
-
'/': new
|
|
61
|
-
'/assets/*path': new
|
|
56
|
+
'/settings.json': new HandlerConfig(SettingsHandler, this.#webConfig.enableShutdown),
|
|
57
|
+
'/stats.json': new HandlerConfig(StatsHandler),
|
|
58
|
+
'/jobs/:status.json': new HandlerConfig(JobsHandler),
|
|
59
|
+
'/jobs/:job_id/logs.json': new HandlerConfig(JobLogsHandler, this.#webConfig.logsPageSize),
|
|
60
|
+
'/job/:id.json': new HandlerConfig(JobHandler),
|
|
61
|
+
'/engine/status': new HandlerConfig(EngineStatusHandler),
|
|
62
|
+
'/logs.json': new HandlerConfig(LogsHandler, this.#webConfig.logsPageSize),
|
|
63
|
+
'/links.json': new HandlerConfig(LinksHandler, this.#webConfig.links),
|
|
64
|
+
'/': new HandlerConfig(IndexHandler),
|
|
65
|
+
'/assets/*path': new HandlerConfig(AssetsHandler, [assetsDir, assetsValidator]),
|
|
62
66
|
};
|
|
63
67
|
|
|
64
68
|
const PATCH_ROUTES = {
|
|
65
|
-
'/jobs/:id/retry': new
|
|
66
|
-
'/engine/pause': new
|
|
67
|
-
'/engine/stop': new
|
|
68
|
-
'/engine/continue': new
|
|
69
|
-
'/engine/start': new
|
|
70
|
-
'/engine/restart': new
|
|
71
|
-
'/engine/shutdown': new
|
|
69
|
+
'/jobs/:id/retry': new HandlerConfig(JobRetryHandler),
|
|
70
|
+
'/engine/pause': new HandlerConfig(EnginePauseHandler),
|
|
71
|
+
'/engine/stop': new HandlerConfig(EngineStopHandler),
|
|
72
|
+
'/engine/continue': new HandlerConfig(EngineContinueHandler),
|
|
73
|
+
'/engine/start': new HandlerConfig(EngineStartHandler),
|
|
74
|
+
'/engine/restart': new HandlerConfig(EngineRestartHandler),
|
|
75
|
+
'/engine/shutdown': new HandlerConfig(EngineShutdownHandler),
|
|
72
76
|
};
|
|
73
77
|
|
|
74
78
|
Object.entries(GET_ROUTES).forEach(([route, handler]) => {
|
|
@@ -82,7 +86,7 @@ class Router {
|
|
|
82
86
|
router.use(express.static(staticDir));
|
|
83
87
|
|
|
84
88
|
router.use((_req, res) => {
|
|
85
|
-
new
|
|
89
|
+
new HandlerConfig(IndexHandler).handle(_req, res);
|
|
86
90
|
});
|
|
87
91
|
|
|
88
92
|
return router;
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import path from 'path';
|
|
2
|
+
import { RequestHandler } from '../../common/server/RequestHandler.js';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Executes request-handling behaviour for static asset routes.
|
|
6
|
+
* Rejects path traversal attempts with 403 Forbidden.
|
|
7
|
+
* @author darthjee
|
|
8
|
+
*/
|
|
9
|
+
class AssetsHandler extends RequestHandler {
|
|
10
|
+
#request;
|
|
11
|
+
#response;
|
|
12
|
+
#assetsDir;
|
|
13
|
+
#validator;
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* @param {object} request - The Express request object.
|
|
17
|
+
* @param {object} response - The Express response object.
|
|
18
|
+
* @param {string} assetsDir - Absolute path to the assets directory.
|
|
19
|
+
* @param {import('../PathValidator.js').PathValidator} validator - Path validator instance.
|
|
20
|
+
*/
|
|
21
|
+
constructor(request, response, assetsDir, validator) {
|
|
22
|
+
super();
|
|
23
|
+
this.#request = request;
|
|
24
|
+
this.#response = response;
|
|
25
|
+
this.#assetsDir = assetsDir;
|
|
26
|
+
this.#validator = validator;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Serves the requested asset file, rejecting any path traversal attempt.
|
|
31
|
+
* @returns {void}
|
|
32
|
+
*/
|
|
33
|
+
handle() {
|
|
34
|
+
const assetPath = [].concat(this.#request.params.path).join(path.sep);
|
|
35
|
+
const resolved = this.#resolveAssetPath(assetPath);
|
|
36
|
+
this.#response.sendFile(resolved);
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* Resolves and validates the asset path.
|
|
41
|
+
* @param {string} assetPath
|
|
42
|
+
* @returns {string}
|
|
43
|
+
*/
|
|
44
|
+
#resolveAssetPath(assetPath) {
|
|
45
|
+
const resolved = path.resolve(this.#assetsDir, assetPath);
|
|
46
|
+
this.#validator.validate(resolved);
|
|
47
|
+
return resolved;
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export { AssetsHandler };
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import path from 'path';
|
|
2
|
+
import { fileURLToPath } from 'url';
|
|
3
|
+
import { RequestHandler } from '../../common/server/RequestHandler.js';
|
|
4
|
+
|
|
5
|
+
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
6
|
+
const staticDir = path.resolve(__dirname, '../../../static');
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Executes request-handling behaviour for the SPA index route.
|
|
10
|
+
* @author darthjee
|
|
11
|
+
*/
|
|
12
|
+
class IndexHandler extends RequestHandler {
|
|
13
|
+
#response;
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* @param {object} _request - The Express request object.
|
|
17
|
+
* @param {object} response - The Express response object.
|
|
18
|
+
*/
|
|
19
|
+
constructor(_request, response) {
|
|
20
|
+
super();
|
|
21
|
+
this.#response = response;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* Serves source/static/index.html.
|
|
26
|
+
* @returns {void}
|
|
27
|
+
*/
|
|
28
|
+
handle() {
|
|
29
|
+
this.#response.sendFile(path.join(staticDir, 'index.html'));
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
export { IndexHandler };
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { RequestHandler } from '../../common/server/RequestHandler.js';
|
|
2
|
+
import { Link } from '../../models/configs/Link.js';
|
|
3
|
+
import { ClientRegistry } from '../../registry/ClientRegistry.js';
|
|
4
|
+
import { LinksSerializer } from '../../serializers/LinksSerializer.js';
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Executes request-handling behaviour for GET /links.json.
|
|
8
|
+
* @author darthjee
|
|
9
|
+
*/
|
|
10
|
+
class LinksHandler extends RequestHandler {
|
|
11
|
+
#response;
|
|
12
|
+
#links;
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* @param {object} _request - The Express request object.
|
|
16
|
+
* @param {object} response - The Express response object.
|
|
17
|
+
* @param {Array<object>} links - Configured web links.
|
|
18
|
+
*/
|
|
19
|
+
constructor(_request, response, links) {
|
|
20
|
+
super();
|
|
21
|
+
this.#response = response;
|
|
22
|
+
this.#links = links;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
/**
|
|
26
|
+
* Responds with the combined configured and client-derived links.
|
|
27
|
+
* @returns {void}
|
|
28
|
+
*/
|
|
29
|
+
handle() {
|
|
30
|
+
this.#response.json({ links: LinksSerializer.serialize(this.#allLinks()) });
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* @returns {Array<Link>}
|
|
35
|
+
*/
|
|
36
|
+
#allLinks() {
|
|
37
|
+
return [...this.#links, ...this.#clientLinks()];
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* @returns {Array<Link>}
|
|
42
|
+
*/
|
|
43
|
+
#clientLinks() {
|
|
44
|
+
return ClientRegistry.all().map((client) => (
|
|
45
|
+
new Link({ url: client.baseUrl, text: client.linkText ?? client.name })
|
|
46
|
+
));
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
export { LinksHandler };
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { RequestHandler } from '../../common/server/RequestHandler.js';
|
|
2
|
+
import { LogRegistry } from '../../registry/LogRegistry.js';
|
|
3
|
+
import { LogSerializer } from '../../serializers/LogSerializer.js';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Executes request-handling behaviour for GET /logs.json.
|
|
7
|
+
* Routes to per-job or per-worker buffers via optional query params.
|
|
8
|
+
* Returns 400 when both jobId and workerId are present simultaneously.
|
|
9
|
+
* @author darthjee
|
|
10
|
+
*/
|
|
11
|
+
class LogsHandler extends RequestHandler {
|
|
12
|
+
#request;
|
|
13
|
+
#response;
|
|
14
|
+
#pageSize;
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* @param {object} request - The Express request object.
|
|
18
|
+
* @param {object} response - The Express response object.
|
|
19
|
+
* @param {number} pageSize - Maximum number of log entries to return.
|
|
20
|
+
*/
|
|
21
|
+
constructor(request, response, pageSize) {
|
|
22
|
+
super();
|
|
23
|
+
this.#request = request;
|
|
24
|
+
this.#response = response;
|
|
25
|
+
this.#pageSize = pageSize;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* Responds with a paginated JSON array of log entries.
|
|
30
|
+
* @returns {void}
|
|
31
|
+
*/
|
|
32
|
+
handle() {
|
|
33
|
+
const { last_id: lastId, jobId, workerId } = this.#request.query;
|
|
34
|
+
|
|
35
|
+
if (jobId && workerId) {
|
|
36
|
+
this.#response.status(400).json({ error: 'Cannot specify both jobId and workerId' });
|
|
37
|
+
return;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
if (jobId) {
|
|
41
|
+
const logs = LogRegistry.getLogsByJobId(jobId);
|
|
42
|
+
this.#response.json(LogSerializer.serialize(logs.slice(0, this.#pageSize)));
|
|
43
|
+
return;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
if (workerId) {
|
|
47
|
+
const logs = LogRegistry.getLogsByWorkerId(workerId);
|
|
48
|
+
this.#response.json(LogSerializer.serialize(logs.slice(0, this.#pageSize)));
|
|
49
|
+
return;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
const logs = LogRegistry.getLogs({ lastId });
|
|
53
|
+
this.#response.json(LogSerializer.serialize(logs.slice(0, this.#pageSize)));
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
export { LogsHandler };
|