@miqro/core 4.0.1 → 5.0.2
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/build/app.d.ts +15 -11
- package/build/app.js +22 -20
- package/build/app.js.map +1 -1
- package/build/common.d.ts +106 -0
- package/build/common.js +477 -0
- package/build/common.js.map +1 -0
- package/build/lib.d.ts +7 -38
- package/build/lib.js +6 -33
- package/build/lib.js.map +1 -1
- package/build/middleware/body-parser.d.ts +78 -0
- package/build/middleware/body-parser.js +552 -0
- package/build/middleware/body-parser.js.map +1 -0
- package/build/middleware/router.d.ts +114 -0
- package/build/middleware/router.js +704 -0
- package/build/middleware/router.js.map +1 -0
- package/build/middleware/session.d.ts +27 -3
- package/build/middleware/session.js +238 -18
- package/build/middleware/session.js.map +1 -1
- package/build/types.d.ts +309 -0
- package/build/types.js +455 -0
- package/build/types.js.map +1 -0
- package/build/{websocket/cluster.d.ts → websocket.d.ts} +13 -2
- package/build/websocket.js +316 -0
- package/build/websocket.js.map +1 -0
- package/package.json +7 -7
- package/src/app.ts +36 -32
- package/src/common.ts +528 -0
- package/src/lib.ts +63 -101
- package/src/middleware/body-parser.ts +597 -0
- package/src/middleware/router.ts +840 -0
- package/src/middleware/session.ts +249 -19
- package/src/types.ts +785 -0
- package/src/websocket.ts +356 -0
- package/build/api-router.d.ts +0 -34
- package/build/api-router.js +0 -48
- package/build/api-router.js.map +0 -1
- package/build/app-utils.d.ts +0 -13
- package/build/app-utils.js +0 -78
- package/build/app-utils.js.map +0 -1
- package/build/common/api-router-types.d.ts +0 -28
- package/build/common/api-router-types.js +0 -24
- package/build/common/api-router-types.js.map +0 -1
- package/build/common/api-router-utils.d.ts +0 -3
- package/build/common/api-router-utils.js +0 -118
- package/build/common/api-router-utils.js.map +0 -1
- package/build/common/config/config.d.ts +0 -15
- package/build/common/config/config.js +0 -38
- package/build/common/config/config.js.map +0 -1
- package/build/common/config/featuretoggle.d.ts +0 -1
- package/build/common/config/featuretoggle.js +0 -6
- package/build/common/config/featuretoggle.js.map +0 -1
- package/build/common/config/loader.d.ts +0 -13
- package/build/common/config/loader.js +0 -64
- package/build/common/config/loader.js.map +0 -1
- package/build/common/context.d.ts +0 -57
- package/build/common/context.js +0 -137
- package/build/common/context.js.map +0 -1
- package/build/common/error/badrequesterror.d.ts +0 -3
- package/build/common/error/badrequesterror.js +0 -7
- package/build/common/error/badrequesterror.js.map +0 -1
- package/build/common/error/configfilenotfound.d.ts +0 -3
- package/build/common/error/configfilenotfound.js +0 -7
- package/build/common/error/configfilenotfound.js.map +0 -1
- package/build/common/error/forbiddenerror.d.ts +0 -3
- package/build/common/error/forbiddenerror.js +0 -7
- package/build/common/error/forbiddenerror.js.map +0 -1
- package/build/common/error/notfound.d.ts +0 -3
- package/build/common/error/notfound.js +0 -7
- package/build/common/error/notfound.js.map +0 -1
- package/build/common/error/notimplemented.d.ts +0 -3
- package/build/common/error/notimplemented.js +0 -7
- package/build/common/error/notimplemented.js.map +0 -1
- package/build/common/error/unauthorizederror.d.ts +0 -3
- package/build/common/error/unauthorizederror.js +0 -7
- package/build/common/error/unauthorizederror.js.map +0 -1
- package/build/common/logger/constants.d.ts +0 -14
- package/build/common/logger/constants.js +0 -22
- package/build/common/logger/constants.js.map +0 -1
- package/build/common/logger/factory.d.ts +0 -16
- package/build/common/logger/factory.js +0 -47
- package/build/common/logger/factory.js.map +0 -1
- package/build/common/logger/interfaces.d.ts +0 -18
- package/build/common/logger/interfaces.js +0 -2
- package/build/common/logger/interfaces.js.map +0 -1
- package/build/common/logger/logger.d.ts +0 -35
- package/build/common/logger/logger.js +0 -95
- package/build/common/logger/logger.js.map +0 -1
- package/build/common/logger/transport/console.d.ts +0 -5
- package/build/common/logger/transport/console.js +0 -37
- package/build/common/logger/transport/console.js.map +0 -1
- package/build/common/logger/transport/file.d.ts +0 -2
- package/build/common/logger/transport/file.js +0 -25
- package/build/common/logger/transport/file.js.map +0 -1
- package/build/common/parser.d.ts +0 -7
- package/build/common/parser.js +0 -44
- package/build/common/parser.js.map +0 -1
- package/build/common/router-default-logger-factory.d.ts +0 -4
- package/build/common/router-default-logger-factory.js +0 -38
- package/build/common/router-default-logger-factory.js.map +0 -1
- package/build/common/router-handler.d.ts +0 -20
- package/build/common/router-handler.js +0 -154
- package/build/common/router-handler.js.map +0 -1
- package/build/common/router-types.d.ts +0 -63
- package/build/common/router-types.js +0 -86
- package/build/common/router-types.js.map +0 -1
- package/build/common/router-utils.d.ts +0 -3
- package/build/common/router-utils.js +0 -46
- package/build/common/router-utils.js.map +0 -1
- package/build/common/session/common.d.ts +0 -37
- package/build/common/session/common.js +0 -2
- package/build/common/session/common.js.map +0 -1
- package/build/common/session/service.d.ts +0 -26
- package/build/common/session/service.js +0 -154
- package/build/common/session/service.js.map +0 -1
- package/build/common/tokenize-match.d.ts +0 -19
- package/build/common/tokenize-match.js +0 -73
- package/build/common/tokenize-match.js.map +0 -1
- package/build/common/url-utils.d.ts +0 -6
- package/build/common/url-utils.js +0 -48
- package/build/common/url-utils.js.map +0 -1
- package/build/middleware/buffer.d.ts +0 -6
- package/build/middleware/buffer.js +0 -78
- package/build/middleware/buffer.js.map +0 -1
- package/build/middleware/cookie.d.ts +0 -4
- package/build/middleware/cookie.js +0 -15
- package/build/middleware/cookie.js.map +0 -1
- package/build/middleware/cors.d.ts +0 -8
- package/build/middleware/cors.js +0 -89
- package/build/middleware/cors.js.map +0 -1
- package/build/middleware/form.d.ts +0 -6
- package/build/middleware/form.js +0 -58
- package/build/middleware/form.js.map +0 -1
- package/build/middleware/group.d.ts +0 -3
- package/build/middleware/group.js +0 -77
- package/build/middleware/group.js.map +0 -1
- package/build/middleware/json.d.ts +0 -6
- package/build/middleware/json.js +0 -55
- package/build/middleware/json.js.map +0 -1
- package/build/middleware/logger.d.ts +0 -4
- package/build/middleware/logger.js +0 -16
- package/build/middleware/logger.js.map +0 -1
- package/build/middleware/parse.d.ts +0 -14
- package/build/middleware/parse.js +0 -88
- package/build/middleware/parse.js.map +0 -1
- package/build/middleware/result.d.ts +0 -9
- package/build/middleware/result.js +0 -62
- package/build/middleware/result.js.map +0 -1
- package/build/middleware/tag.d.ts +0 -4
- package/build/middleware/tag.js +0 -10
- package/build/middleware/tag.js.map +0 -1
- package/build/middleware/text.d.ts +0 -5
- package/build/middleware/text.js +0 -46
- package/build/middleware/text.js.map +0 -1
- package/build/proxy.d.ts +0 -19
- package/build/proxy.js +0 -74
- package/build/proxy.js.map +0 -1
- package/build/router.d.ts +0 -26
- package/build/router.js +0 -116
- package/build/router.js.map +0 -1
- package/build/static.d.ts +0 -14
- package/build/static.js +0 -211
- package/build/static.js.map +0 -1
- package/build/websocket/cluster.js +0 -114
- package/build/websocket/cluster.js.map +0 -1
- package/build/websocket/server.d.ts +0 -15
- package/build/websocket/server.js +0 -127
- package/build/websocket/server.js.map +0 -1
- package/build/websocket/types.d.ts +0 -39
- package/build/websocket/types.js +0 -2
- package/build/websocket/types.js.map +0 -1
- package/build/websocket/utils.d.ts +0 -8
- package/build/websocket/utils.js +0 -77
- package/build/websocket/utils.js.map +0 -1
- package/src/api-router.ts +0 -50
- package/src/app-utils.ts +0 -82
- package/src/common/api-router-types.ts +0 -52
- package/src/common/api-router-utils.ts +0 -126
- package/src/common/config/config.ts +0 -49
- package/src/common/config/featuretoggle.ts +0 -6
- package/src/common/config/loader.ts +0 -81
- package/src/common/context.ts +0 -192
- package/src/common/error/badrequesterror.ts +0 -6
- package/src/common/error/configfilenotfound.ts +0 -6
- package/src/common/error/forbiddenerror.ts +0 -6
- package/src/common/error/notfound.ts +0 -6
- package/src/common/error/notimplemented.ts +0 -6
- package/src/common/error/unauthorizederror.ts +0 -6
- package/src/common/logger/constants.ts +0 -28
- package/src/common/logger/factory.ts +0 -53
- package/src/common/logger/interfaces.ts +0 -19
- package/src/common/logger/logger.ts +0 -136
- package/src/common/logger/transport/console.ts +0 -36
- package/src/common/logger/transport/file.ts +0 -26
- package/src/common/parser.ts +0 -50
- package/src/common/router-default-logger-factory.ts +0 -44
- package/src/common/router-handler.ts +0 -186
- package/src/common/router-types.ts +0 -153
- package/src/common/router-utils.ts +0 -47
- package/src/common/session/common.ts +0 -40
- package/src/common/session/service.ts +0 -175
- package/src/common/tokenize-match.ts +0 -98
- package/src/common/url-utils.ts +0 -46
- package/src/middleware/buffer.ts +0 -82
- package/src/middleware/cookie.ts +0 -20
- package/src/middleware/cors.ts +0 -98
- package/src/middleware/form.ts +0 -61
- package/src/middleware/group.ts +0 -74
- package/src/middleware/json.ts +0 -57
- package/src/middleware/logger.ts +0 -18
- package/src/middleware/parse.ts +0 -105
- package/src/middleware/result.ts +0 -73
- package/src/middleware/tag.ts +0 -15
- package/src/middleware/text.ts +0 -47
- package/src/proxy.ts +0 -99
- package/src/router.ts +0 -140
- package/src/static.ts +0 -242
- package/src/websocket/cluster.ts +0 -128
- package/src/websocket/server.ts +0 -135
- package/src/websocket/types.ts +0 -41
- package/src/websocket/utils.ts +0 -95
package/src/common.ts
ADDED
|
@@ -0,0 +1,528 @@
|
|
|
1
|
+
import { format } from "util";
|
|
2
|
+
import { createWriteStream, existsSync, readFileSync, readdirSync } from "fs";
|
|
3
|
+
import { extname, resolve } from "path";
|
|
4
|
+
import { IncomingMessage } from "http";
|
|
5
|
+
import { ConfigOutput, ErrorHandler, Handler, LoadConfigOut, LogLevel, LoggerErrorEvent, LoggerFactory, LoggerFactoryArgs, LoggerFormatter, LoggerTransport, LoggerTransportWriteArgs, MinimalLogger, Request, Response, WriteArgs, newURL, normalizePath } from "./types.js";
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Logger
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
export function LoggerHandler(options?: {
|
|
12
|
+
formatter: (req: Request) => string;
|
|
13
|
+
}): Handler<void> {
|
|
14
|
+
return function LoggerHandler(req, res): void {
|
|
15
|
+
res.on("close", () => {
|
|
16
|
+
const took = Date.now() - req.startMS;
|
|
17
|
+
const entry = options ? options.formatter(req) : `status[${res.statusCode}] content-length[${(res as any)._contentLength}] [${took}]ms`;
|
|
18
|
+
if (res.statusCode < 400) {
|
|
19
|
+
req.logger.info(entry);
|
|
20
|
+
} else if (res.statusCode >= 400 && res.statusCode < 500) {
|
|
21
|
+
req.logger.warn(entry);
|
|
22
|
+
} else {
|
|
23
|
+
req.logger.error(entry);
|
|
24
|
+
}
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
export interface Logger extends MinimalLogger {
|
|
30
|
+
|
|
31
|
+
addTransport(transport: LoggerTransport): void;
|
|
32
|
+
|
|
33
|
+
setLevel(level: LogLevel): void;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
export class Logger extends EventTarget implements Logger {
|
|
37
|
+
|
|
38
|
+
protected readonly options: { transports: LoggerTransport[]; formatter: LoggerFormatter; };
|
|
39
|
+
|
|
40
|
+
constructor(protected readonly identifier: string, protected level: LogLevel = "info", options?: { transports?: LoggerTransport[]; formatter?: LoggerFormatter; }) {
|
|
41
|
+
super();
|
|
42
|
+
if (LOG_LEVEL_MAP[level] === undefined) {
|
|
43
|
+
throw new Error(`Unknown level [${level}]`);
|
|
44
|
+
}
|
|
45
|
+
this.addEventListener(LoggerEvents.error, (ev: any) => {
|
|
46
|
+
console.error((ev as LoggerErrorEvent).error);
|
|
47
|
+
});
|
|
48
|
+
this.options = {
|
|
49
|
+
transports: options && options.transports !== undefined ? options.transports : DEFAULT_LOGGER_TRANSPORTS(),
|
|
50
|
+
formatter: options && options.formatter !== undefined ? options.formatter : DEFAULT_LOGGER_FORMATTER,
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
public setLevel(level: LogLevel): void {
|
|
55
|
+
if (!LOG_LEVEL_MAP[level]) {
|
|
56
|
+
throw new Error(`Unknown level [${level}]`);
|
|
57
|
+
}
|
|
58
|
+
this.level = level;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
public addTransport(transport: LoggerTransport): void {
|
|
62
|
+
this.options.transports.push(transport);
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
protected write(args: WriteArgs): void {
|
|
66
|
+
try {
|
|
67
|
+
let eventArgs: LoggerTransportWriteArgs | undefined = undefined;
|
|
68
|
+
const tR = [];
|
|
69
|
+
for (const transport of this.options.transports) {
|
|
70
|
+
if (LOG_LEVEL_MAP[transport.level ? transport.level : this.level] >= LOG_LEVEL_MAP[args.level]) {
|
|
71
|
+
try {
|
|
72
|
+
eventArgs = eventArgs ? eventArgs : {
|
|
73
|
+
out: this.options.formatter({
|
|
74
|
+
identifier: this.identifier,
|
|
75
|
+
level: args.level,
|
|
76
|
+
message: format(args.message, ...args.optionalParams)
|
|
77
|
+
}),
|
|
78
|
+
...args
|
|
79
|
+
};
|
|
80
|
+
tR.push(transport.write(eventArgs));
|
|
81
|
+
} catch (e2: any) {
|
|
82
|
+
this.dispatchEvent(new LoggerErrorEvent(LoggerEvents.error, {
|
|
83
|
+
error: e2
|
|
84
|
+
}));
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
Promise.allSettled(tR).catch((e) => {
|
|
89
|
+
this.dispatchEvent(new LoggerErrorEvent(LoggerEvents.error, {
|
|
90
|
+
error: e
|
|
91
|
+
}));
|
|
92
|
+
});
|
|
93
|
+
} catch (e: any) {
|
|
94
|
+
this.dispatchEvent(new LoggerErrorEvent(LoggerEvents.error, {
|
|
95
|
+
error: e
|
|
96
|
+
}));
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
|
|
101
|
+
public debug(message?: any, ...optionalParams: any[]): void {
|
|
102
|
+
return this.write({ level: "debug", message, optionalParams });
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
|
|
106
|
+
public error(message?: any, ...optionalParams: any[]): void {
|
|
107
|
+
return this.write({ level: "error", message, optionalParams });
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
|
|
111
|
+
public info(message?: any, ...optionalParams: any[]): void {
|
|
112
|
+
return this.write({ level: "info", message, optionalParams });
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
|
|
116
|
+
public log(message?: any, ...optionalParams: any[]): void {
|
|
117
|
+
return this.write({ level: "info", message, optionalParams });
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
|
|
121
|
+
public trace(message?: any, ...optionalParams: any[]): void {
|
|
122
|
+
return this.write({ level: "trace", message, optionalParams });
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
|
|
126
|
+
public warn(message?: any, ...optionalParams: any[]): void {
|
|
127
|
+
return this.write({ level: "warn", message, optionalParams });
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
const FILE_TRANSPORT_ENV_VARIABLE = "LOG_FILE";
|
|
132
|
+
|
|
133
|
+
export const FileTransport: (filePath?: string | null, level?: LogLevel) => LoggerTransport = (filePath = process.env[FILE_TRANSPORT_ENV_VARIABLE] ? process.env[FILE_TRANSPORT_ENV_VARIABLE] : null, level?: LogLevel) => {
|
|
134
|
+
const fileHandler = filePath ? createWriteStream(resolve(filePath), { flags: "a" }) : null;
|
|
135
|
+
return {
|
|
136
|
+
level,
|
|
137
|
+
write: async ({ out }: LoggerTransportWriteArgs): Promise<void> => {
|
|
138
|
+
if (fileHandler) {
|
|
139
|
+
return new Promise((resolve, reject) => {
|
|
140
|
+
fileHandler.write(`${out}\n`, (err) => {
|
|
141
|
+
if (err) {
|
|
142
|
+
reject(err);
|
|
143
|
+
} else {
|
|
144
|
+
resolve();
|
|
145
|
+
}
|
|
146
|
+
});
|
|
147
|
+
});
|
|
148
|
+
}
|
|
149
|
+
return;
|
|
150
|
+
}
|
|
151
|
+
};
|
|
152
|
+
};
|
|
153
|
+
|
|
154
|
+
export function ConsoleTransport(color: boolean = true, level?: LogLevel) {
|
|
155
|
+
return {
|
|
156
|
+
level,
|
|
157
|
+
write: async ({ level, out }: LoggerTransportWriteArgs): Promise<void> => {
|
|
158
|
+
if (color) {
|
|
159
|
+
switch (level) {
|
|
160
|
+
case "warn":
|
|
161
|
+
console.warn("\x1b[33m%s\x1b[0m", out);
|
|
162
|
+
break;
|
|
163
|
+
case "error":
|
|
164
|
+
console.error("\x1b[31m%s\x1b[0m", out);
|
|
165
|
+
break;
|
|
166
|
+
case "trace":
|
|
167
|
+
console.log("\x1b[34m%s\x1b[0m", out);
|
|
168
|
+
break;
|
|
169
|
+
case "debug":
|
|
170
|
+
console.log("\x1b[36m%s\x1b[0m", out);
|
|
171
|
+
break;
|
|
172
|
+
case "none":
|
|
173
|
+
break;
|
|
174
|
+
default:
|
|
175
|
+
console[level](out);
|
|
176
|
+
break;
|
|
177
|
+
}
|
|
178
|
+
} else {
|
|
179
|
+
if (level === "trace" || level === "debug") {
|
|
180
|
+
console.log(out);
|
|
181
|
+
} else if (level !== "none") {
|
|
182
|
+
console[level](out);
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
};
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
export const DEFAULT_LOGGER_TRANSPORTS: () => LoggerTransport[] = () => [
|
|
191
|
+
ConsoleTransport(),
|
|
192
|
+
FileTransport()
|
|
193
|
+
];
|
|
194
|
+
|
|
195
|
+
export const DEFAULT_LOGGER_FORMATTER: LoggerFormatter =
|
|
196
|
+
({ identifier, level, message }) => `${new Date().toISOString()} ${process.pid} ` +
|
|
197
|
+
`${identifier ? `[${identifier}] ` : ""}` +
|
|
198
|
+
`${level !== "info" ? (level === "error" || level === "warn" ? `[${level.toUpperCase()}] ` : `[${level}] `) : ""}` +
|
|
199
|
+
`${message}`;
|
|
200
|
+
|
|
201
|
+
export const LOG_LEVEL_MAP =
|
|
202
|
+
{
|
|
203
|
+
"none": 0,
|
|
204
|
+
"error": 1,
|
|
205
|
+
"warn": 2,
|
|
206
|
+
"info": 3,
|
|
207
|
+
"debug": 4,
|
|
208
|
+
"trace": 5,
|
|
209
|
+
};
|
|
210
|
+
|
|
211
|
+
export const LoggerEvents = {
|
|
212
|
+
error: "error"
|
|
213
|
+
};
|
|
214
|
+
|
|
215
|
+
const loggerContainer: Map<string, MinimalLogger> = new Map<string, MinimalLogger>();
|
|
216
|
+
const DEFAULT_ENV_NAME = "LOG_LEVEL";
|
|
217
|
+
|
|
218
|
+
export function getLogger(identifier: string, options?: { formatter?: LoggerFormatter, transports?: LoggerTransport[] }, useCache = true): MinimalLogger {
|
|
219
|
+
if (typeof identifier !== "string" && typeof identifier !== "undefined") {
|
|
220
|
+
throw new Error("Bad log identifier");
|
|
221
|
+
}
|
|
222
|
+
if (useCache && loggerContainer.has(identifier)) {
|
|
223
|
+
return loggerContainer.get(identifier) as Logger;
|
|
224
|
+
} else {
|
|
225
|
+
const envVarName = `LOG_LEVEL_${identifier}`;
|
|
226
|
+
const level = getEnvVariable(envVarName) ? getEnvVariable(envVarName) as LogLevel : getEnvVariable(DEFAULT_ENV_NAME, "info") as LogLevel
|
|
227
|
+
const factory = getLoggerFactory();
|
|
228
|
+
const logger = factory({ identifier, level, options });
|
|
229
|
+
if (useCache) {
|
|
230
|
+
loggerContainer.set(identifier, logger);
|
|
231
|
+
}
|
|
232
|
+
return logger;
|
|
233
|
+
}
|
|
234
|
+
};
|
|
235
|
+
|
|
236
|
+
function defaultLoggerFactory({ identifier, options, level }: LoggerFactoryArgs): Logger {
|
|
237
|
+
return new Logger(identifier, level, {
|
|
238
|
+
formatter: options && options.formatter ? options.formatter : DEFAULT_LOGGER_FORMATTER,
|
|
239
|
+
transports: options && options.transports ? options.transports : DEFAULT_LOGGER_TRANSPORTS()
|
|
240
|
+
});
|
|
241
|
+
};
|
|
242
|
+
|
|
243
|
+
let customLoggerFactory: LoggerFactory | undefined = undefined;
|
|
244
|
+
|
|
245
|
+
export function setLoggerFactory(factory: LoggerFactory): LoggerFactory {
|
|
246
|
+
if (customLoggerFactory !== undefined) {
|
|
247
|
+
throw new Error("cannot change logger factory after it has been used.");
|
|
248
|
+
}
|
|
249
|
+
customLoggerFactory = factory;
|
|
250
|
+
return customLoggerFactory;
|
|
251
|
+
};
|
|
252
|
+
|
|
253
|
+
export function getLoggerFactory(): LoggerFactory {
|
|
254
|
+
if (customLoggerFactory) {
|
|
255
|
+
return customLoggerFactory;
|
|
256
|
+
} else {
|
|
257
|
+
customLoggerFactory = defaultLoggerFactory;
|
|
258
|
+
return defaultLoggerFactory;
|
|
259
|
+
}
|
|
260
|
+
};
|
|
261
|
+
|
|
262
|
+
export function routerDefaultLoggerFactory(uuid: string, req: IncomingMessage): MinimalLogger {
|
|
263
|
+
let path = "";
|
|
264
|
+
let query = "";
|
|
265
|
+
let urlParsingError;
|
|
266
|
+
let method = "GET";
|
|
267
|
+
let remoteAddress: string | undefined = "";
|
|
268
|
+
try {
|
|
269
|
+
const url = newURL(req.url ? req.url : "/") as URL;
|
|
270
|
+
query = url.searchParams.toString();
|
|
271
|
+
path = normalizePath(url.pathname); // normalized path
|
|
272
|
+
method = req.method ? req.method.toUpperCase() as string : "GET";
|
|
273
|
+
remoteAddress = req.socket.remoteAddress;
|
|
274
|
+
} catch (e) {
|
|
275
|
+
urlParsingError = e;
|
|
276
|
+
}
|
|
277
|
+
const pathToEnv = path.replace(/\//ig, "_").toUpperCase();
|
|
278
|
+
const identifier = `${pathToEnv === "_" ? "" : pathToEnv.substring(1)}${method.toUpperCase()}`;
|
|
279
|
+
|
|
280
|
+
const logger = getLogger(identifier, {
|
|
281
|
+
formatter: (args) => {
|
|
282
|
+
args.message = `${method} ${path}${query ? `?${query}` : ""}${uuid ? ` [${uuid}]` : ""}${remoteAddress ? ` (${remoteAddress})` : ""} ${args.message}`;
|
|
283
|
+
return DEFAULT_LOGGER_FORMATTER(args);
|
|
284
|
+
}
|
|
285
|
+
}, false);
|
|
286
|
+
|
|
287
|
+
if (urlParsingError) {
|
|
288
|
+
logger.error(urlParsingError);
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
return logger;
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
/**
|
|
295
|
+
* Error
|
|
296
|
+
*/
|
|
297
|
+
|
|
298
|
+
export class BadRequestError extends Error {
|
|
299
|
+
constructor(message = "BAD REQUEST") {
|
|
300
|
+
super(message);
|
|
301
|
+
this.name = "BadRequestError";
|
|
302
|
+
}
|
|
303
|
+
}
|
|
304
|
+
|
|
305
|
+
export class ConfigFileNotFoundError extends Error {
|
|
306
|
+
constructor(message = "NOT FOUND") {
|
|
307
|
+
super(message);
|
|
308
|
+
this.name = "ConfigFileNotFoundError";
|
|
309
|
+
}
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
export class ForbiddenError extends Error {
|
|
313
|
+
constructor(message = "FORBIDDEN") {
|
|
314
|
+
super(message);
|
|
315
|
+
this.name = "ForbiddenError";
|
|
316
|
+
}
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
export class NotFoundError extends Error {
|
|
320
|
+
constructor(message = "NOT FOUND") {
|
|
321
|
+
super(message);
|
|
322
|
+
this.name = "NotFoundError";
|
|
323
|
+
}
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
export class MethodNotImplementedError extends Error {
|
|
327
|
+
constructor(message = "NOT IMPLEMENTED") {
|
|
328
|
+
super(message);
|
|
329
|
+
this.name = "MethodNotImplementedError";
|
|
330
|
+
}
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
export class UnAuthorizedError extends Error {
|
|
334
|
+
constructor(message = "UNAUTHORIZED") {
|
|
335
|
+
super(message);
|
|
336
|
+
this.name = "UnAuthorizedError";
|
|
337
|
+
}
|
|
338
|
+
}
|
|
339
|
+
|
|
340
|
+
export const HTML_HEADERS = {
|
|
341
|
+
["Content-Type"]: "text/html; charset=utf-8"
|
|
342
|
+
}
|
|
343
|
+
|
|
344
|
+
export const STATUS = {
|
|
345
|
+
ERROR: 503,
|
|
346
|
+
BAD_REQUEST: 400,
|
|
347
|
+
NOT_FOUND: 404,
|
|
348
|
+
NOT_IMPLEMENTED: 501,
|
|
349
|
+
FORBIDDEN: 403,
|
|
350
|
+
UNAUTHORIZED: 401,
|
|
351
|
+
};
|
|
352
|
+
|
|
353
|
+
export function defaultAppErrorHandler(): ErrorHandler<void> {
|
|
354
|
+
const isTestEnv = (process.env.NODE_ENV === "development" || process.env.NODE_ENV === "test");
|
|
355
|
+
return async function DefaultErrorHandler(e: any, req: Request, res: Response): Promise<void> {
|
|
356
|
+
if (
|
|
357
|
+
isTestEnv &&
|
|
358
|
+
(!e || !e.name || e.name === "Error")
|
|
359
|
+
) {
|
|
360
|
+
req.logger.error(e);
|
|
361
|
+
await res.asyncEnd({
|
|
362
|
+
headers: HTML_HEADERS,
|
|
363
|
+
status: STATUS.ERROR,
|
|
364
|
+
body: `${e && e.message ? e.message : String(e)}. You are seeing this message because NODE_ENV === "development" || NODE_ENV === "test"${e && e.stack ? ` ${e.stack}` : ""}`
|
|
365
|
+
});
|
|
366
|
+
} else {
|
|
367
|
+
req.logger.error(e);
|
|
368
|
+
const name = e && e.name ? e.name : undefined;
|
|
369
|
+
switch (name) {
|
|
370
|
+
case "NotFoundError":
|
|
371
|
+
await res.asyncEnd({
|
|
372
|
+
headers: HTML_HEADERS,
|
|
373
|
+
status: STATUS.NOT_FOUND,
|
|
374
|
+
body: e.message ? e.message : "NOT FOUND"
|
|
375
|
+
});
|
|
376
|
+
break;
|
|
377
|
+
case "MethodNotImplementedError":
|
|
378
|
+
await res.asyncEnd({
|
|
379
|
+
headers: HTML_HEADERS,
|
|
380
|
+
status: STATUS.NOT_IMPLEMENTED,
|
|
381
|
+
body: e.message ? e.message : "NOT IMPLEMENTED"
|
|
382
|
+
});
|
|
383
|
+
break;
|
|
384
|
+
case "ForbiddenError":
|
|
385
|
+
await res.asyncEnd({
|
|
386
|
+
headers: HTML_HEADERS,
|
|
387
|
+
status: STATUS.FORBIDDEN,
|
|
388
|
+
body: e.message ? e.message : "FORBIDDEN"
|
|
389
|
+
});
|
|
390
|
+
break;
|
|
391
|
+
case "UnAuthorizedError":
|
|
392
|
+
await res.asyncEnd({
|
|
393
|
+
headers: HTML_HEADERS,
|
|
394
|
+
status: STATUS.UNAUTHORIZED,
|
|
395
|
+
body: e.message ? e.message : "UNAUTHORIZED"
|
|
396
|
+
});
|
|
397
|
+
break;
|
|
398
|
+
case "ParseOptionsError":
|
|
399
|
+
case "BadRequestError":
|
|
400
|
+
case "SequelizeValidationError":
|
|
401
|
+
case "SequelizeEagerLoadingError":
|
|
402
|
+
case "SequelizeUniqueConstraintError":
|
|
403
|
+
await res.asyncEnd({
|
|
404
|
+
headers: HTML_HEADERS,
|
|
405
|
+
status: STATUS.BAD_REQUEST,
|
|
406
|
+
body: e.message ? e.message : "BAD REQUEST"
|
|
407
|
+
});
|
|
408
|
+
break;
|
|
409
|
+
case "ConfigFileNotFoundError":
|
|
410
|
+
await res.asyncEnd({
|
|
411
|
+
headers: HTML_HEADERS,
|
|
412
|
+
status: STATUS.ERROR,
|
|
413
|
+
body: e.message ? e.message : "SERVER ERROR"
|
|
414
|
+
});
|
|
415
|
+
break;
|
|
416
|
+
}
|
|
417
|
+
}
|
|
418
|
+
};
|
|
419
|
+
}
|
|
420
|
+
|
|
421
|
+
/**
|
|
422
|
+
* config loading
|
|
423
|
+
*/
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
export abstract class ConfigPathResolver {
|
|
428
|
+
|
|
429
|
+
public static getSequelizeRCFilePath(): string {
|
|
430
|
+
return resolve(ConfigPathResolver.getBaseDirname(), `.sequelizerc`);
|
|
431
|
+
}
|
|
432
|
+
|
|
433
|
+
public static getConfigDirname(): string {
|
|
434
|
+
return resolve(ConfigPathResolver.getBaseDirname(), `config`, checkEnvVariable("NODE_ENV", "development"));
|
|
435
|
+
}
|
|
436
|
+
|
|
437
|
+
public static getBaseDirname(): string {
|
|
438
|
+
const appBaseDirname = getEnvVariable("APP_BASE_DIRNAME");
|
|
439
|
+
if (appBaseDirname) {
|
|
440
|
+
return appBaseDirname;
|
|
441
|
+
} else if (typeof process !== "undefined") {
|
|
442
|
+
return process.cwd();
|
|
443
|
+
} else {
|
|
444
|
+
return "";
|
|
445
|
+
}
|
|
446
|
+
}
|
|
447
|
+
}
|
|
448
|
+
|
|
449
|
+
export const checkEnvVariables = (requiredEnvVariables: string[], defaults?: string[]): string[] => {
|
|
450
|
+
if (defaults && defaults.length !== requiredEnvVariables.length) {
|
|
451
|
+
throw new Error(`defaults cannot be a different length of requiredEnvVariables`);
|
|
452
|
+
}
|
|
453
|
+
return requiredEnvVariables.map((envName, index) => checkEnvVariable(envName, defaults && defaults[index] ? defaults[index] : undefined));
|
|
454
|
+
};
|
|
455
|
+
|
|
456
|
+
export const checkEnvVariable = (envName: string, defaults?: string): string => {
|
|
457
|
+
const value = getEnvVariable(envName, defaults);
|
|
458
|
+
if (!value) {
|
|
459
|
+
throw new Error(`Env variable [${envName}!] not defined.`);
|
|
460
|
+
}
|
|
461
|
+
return value;
|
|
462
|
+
};
|
|
463
|
+
|
|
464
|
+
export const getEnvVariable = (envName: string, defaults?: string): string | undefined => {
|
|
465
|
+
return process.env[envName] ? process.env[envName] : defaults ? defaults as string : undefined;
|
|
466
|
+
};
|
|
467
|
+
|
|
468
|
+
export const isFeatureEnabled = (feature: string, defaults = true): boolean => {
|
|
469
|
+
const featureToggleName = `${feature.toUpperCase()}`;
|
|
470
|
+
return checkEnvVariable(featureToggleName, String(defaults)) === "true";
|
|
471
|
+
};
|
|
472
|
+
|
|
473
|
+
export const loadConfigString = (envFileContent: string, combined?: ConfigOutput): ConfigOutput => {
|
|
474
|
+
const ret: ConfigOutput = Object.create(null);
|
|
475
|
+
envFileContent.split("\n")
|
|
476
|
+
.filter(value => value && value.length > 0 && value.substring(0, 1) !== "#")
|
|
477
|
+
.forEach((line) => {
|
|
478
|
+
const separator = line.indexOf("=");
|
|
479
|
+
if (separator === -1) {
|
|
480
|
+
throw new Error(`cannot read ${line}`);
|
|
481
|
+
}
|
|
482
|
+
ret[line.substring(0, separator)] = line.substring(separator + 1);
|
|
483
|
+
});
|
|
484
|
+
const keys = Object.keys(ret);
|
|
485
|
+
for (const key of keys) {
|
|
486
|
+
if (combined) {
|
|
487
|
+
combined[key] = ret[key];
|
|
488
|
+
}
|
|
489
|
+
process.env[key] = ret[key];
|
|
490
|
+
}
|
|
491
|
+
return ret;
|
|
492
|
+
}
|
|
493
|
+
|
|
494
|
+
export const loadConfigFile = (envFilePath: string, combined?: ConfigOutput, logger?: Logger): ConfigOutput => {
|
|
495
|
+
if (!existsSync(envFilePath)) {
|
|
496
|
+
throw new ConfigFileNotFoundError(`config file [${envFilePath}] doesnt exists!`);
|
|
497
|
+
} else {
|
|
498
|
+
if (logger) {
|
|
499
|
+
logger.trace(`loading config from [${envFilePath}].`);
|
|
500
|
+
}
|
|
501
|
+
return loadConfigString(readFileSync(envFilePath).toString(), combined);
|
|
502
|
+
}
|
|
503
|
+
};
|
|
504
|
+
|
|
505
|
+
const MISSED_TO_RUNMIQRO_INIT = (configDirname: string): string => `no config loaded. env files in [${configDirname}] doesnt exist!.`;
|
|
506
|
+
|
|
507
|
+
export const loadConfig = (configDirname: string = ConfigPathResolver.getConfigDirname(), logger?: Logger): LoadConfigOut => {
|
|
508
|
+
const outputs: ConfigOutput[] = [];
|
|
509
|
+
const combined = Object.create(null);
|
|
510
|
+
//console.log(configDirname);
|
|
511
|
+
if (existsSync(configDirname)) {
|
|
512
|
+
const configFiles = readdirSync(configDirname);
|
|
513
|
+
for (const configFile of configFiles) {
|
|
514
|
+
const configFilePath = resolve(configDirname, configFile);
|
|
515
|
+
const ext = extname(configFilePath);
|
|
516
|
+
if (ext === ".env") {
|
|
517
|
+
outputs.push(loadConfigFile(configFilePath, combined, logger));
|
|
518
|
+
}
|
|
519
|
+
}
|
|
520
|
+
if (logger && configFiles.length === 0) {
|
|
521
|
+
logger.debug(MISSED_TO_RUNMIQRO_INIT(configDirname));
|
|
522
|
+
}
|
|
523
|
+
} else if (logger) {
|
|
524
|
+
logger.debug(MISSED_TO_RUNMIQRO_INIT(configDirname));
|
|
525
|
+
}
|
|
526
|
+
return { combined, outputs };
|
|
527
|
+
};
|
|
528
|
+
|
package/src/lib.ts
CHANGED
|
@@ -1,120 +1,82 @@
|
|
|
1
|
-
export { Context, Handler, HandlerResponse, ErrorHandler } from "./common/context.js";
|
|
2
1
|
|
|
3
|
-
export {
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
export { getLogger } from "./common/logger/factory.js";
|
|
14
|
-
export { Logger, LoggerErrorEvent, LoggerErrorEventInit } from "./common/logger/logger.js";
|
|
2
|
+
export {
|
|
3
|
+
UnAuthorizedError,
|
|
4
|
+
BadRequestError,
|
|
5
|
+
ConfigFileNotFoundError,
|
|
6
|
+
ForbiddenError,
|
|
7
|
+
NotFoundError,
|
|
8
|
+
MethodNotImplementedError,
|
|
9
|
+
getLogger, Logger, LoggerHandler,
|
|
10
|
+
loadConfig, loadConfigFile, ConfigPathResolver, checkEnvVariables, checkEnvVariable, getEnvVariable, isFeatureEnabled,
|
|
11
|
+
} from "./common.js";
|
|
15
12
|
|
|
16
|
-
export {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
13
|
+
export {
|
|
14
|
+
LoggerErrorEvent,
|
|
15
|
+
LoggerErrorEventInit,
|
|
16
|
+
Request,
|
|
17
|
+
Response,
|
|
18
|
+
normalizePath,
|
|
19
|
+
WebSocketComplexValidateResult,
|
|
20
|
+
WebSocketClient,
|
|
21
|
+
WebSocketServerOptions,
|
|
22
|
+
GroupPolicy,
|
|
23
|
+
GroupPolicyGroups,
|
|
24
|
+
GroupPolicyType,
|
|
25
|
+
NoTokenSession,
|
|
26
|
+
Session,
|
|
27
|
+
SessionHandlerOptions,
|
|
28
|
+
HandlerWithOptions,
|
|
29
|
+
MinimalRouter,
|
|
30
|
+
RouterHandlerOptions,
|
|
31
|
+
RouterJSONDoc,
|
|
32
|
+
RouterOptions,
|
|
33
|
+
RouteJSONDoc,
|
|
34
|
+
RouteOptions,
|
|
35
|
+
ParserMode,
|
|
36
|
+
SchemaProperties,
|
|
37
|
+
APIRoute,
|
|
38
|
+
APIRouterOptions,
|
|
39
|
+
Handler,
|
|
40
|
+
HandlerResponse,
|
|
41
|
+
ErrorHandler
|
|
42
|
+
} from "./types.js";
|
|
22
43
|
|
|
23
44
|
export {
|
|
24
45
|
App,
|
|
25
46
|
Server,
|
|
26
|
-
|
|
47
|
+
AppOptions
|
|
27
48
|
} from "./app.js";
|
|
28
49
|
|
|
29
50
|
export {
|
|
30
|
-
WebSocketServer
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
ComplexValidateResult,
|
|
34
|
-
OnUpgrade as UpgradableConnection,
|
|
35
|
-
WebSocketClient,
|
|
36
|
-
WebSocketServerOptions
|
|
37
|
-
} from "./websocket/types.js";
|
|
38
|
-
export {
|
|
39
|
-
ClusterWebSocketServer,
|
|
40
|
-
} from "./websocket/cluster.js";
|
|
41
|
-
export {
|
|
42
|
-
Router
|
|
43
|
-
} from "./router.js";
|
|
51
|
+
WebSocketServer,
|
|
52
|
+
ClusterWebSocketServer
|
|
53
|
+
} from "./websocket.js";
|
|
44
54
|
|
|
45
55
|
export {
|
|
56
|
+
Router,
|
|
46
57
|
Static,
|
|
47
|
-
StaticRouterOptions
|
|
48
|
-
|
|
49
|
-
|
|
58
|
+
StaticRouterOptions,
|
|
59
|
+
Proxy,
|
|
60
|
+
ProxyRouterOptions,
|
|
50
61
|
APIRouter
|
|
51
|
-
} from "./
|
|
62
|
+
} from "./middleware/router.js";
|
|
52
63
|
|
|
53
64
|
export {
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
} from "./middleware/cookie.js";
|
|
63
|
-
export {
|
|
65
|
+
ReadBuffer,
|
|
66
|
+
URLEncodedParser,
|
|
67
|
+
JSONParser,
|
|
68
|
+
TextParser,
|
|
69
|
+
ParseRequest,
|
|
70
|
+
ParseRequestOptions,
|
|
71
|
+
ResponseHandler,
|
|
72
|
+
ResultParser,
|
|
64
73
|
CORS,
|
|
65
74
|
CORSOptions
|
|
66
|
-
} from "./middleware/
|
|
67
|
-
export {
|
|
68
|
-
URLEncodedParser
|
|
69
|
-
} from "./middleware/form.js";
|
|
70
|
-
export {
|
|
71
|
-
GroupPolicyHandler
|
|
72
|
-
} from "./middleware/group.js";
|
|
73
|
-
export {
|
|
74
|
-
JSONParser
|
|
75
|
-
} from "./middleware/json.js";
|
|
76
|
-
export {
|
|
77
|
-
LoggerHandler
|
|
78
|
-
} from "./middleware/logger.js";
|
|
79
|
-
export {
|
|
80
|
-
ParseRequest,
|
|
81
|
-
ParseRequestOptions
|
|
82
|
-
} from "./middleware/parse.js";
|
|
83
|
-
export {
|
|
84
|
-
ResultParser
|
|
85
|
-
} from "./middleware/result.js";
|
|
75
|
+
} from "./middleware/body-parser.js";
|
|
86
76
|
export {
|
|
87
|
-
SessionHandler
|
|
77
|
+
SessionHandler,
|
|
78
|
+
GroupPolicyHandler,
|
|
79
|
+
VerifyEndpointServiceOptions,
|
|
80
|
+
VerifyEndpointService,
|
|
81
|
+
VerifyTokenService
|
|
88
82
|
} from "./middleware/session.js";
|
|
89
|
-
export {
|
|
90
|
-
TagResponse
|
|
91
|
-
} from "./middleware/tag.js";
|
|
92
|
-
export {
|
|
93
|
-
TextParser
|
|
94
|
-
} from "./middleware/text.js";
|
|
95
|
-
|
|
96
|
-
export {
|
|
97
|
-
HandlerWithOptions,
|
|
98
|
-
MinimalRouter,
|
|
99
|
-
RouterHandlerOptions,
|
|
100
|
-
RouterJSONDoc,
|
|
101
|
-
RouterOptions,
|
|
102
|
-
RouteJSONDoc,
|
|
103
|
-
RouteOptions,
|
|
104
|
-
ParserMode,
|
|
105
|
-
SchemaProperties,
|
|
106
|
-
} from "./common/router-types.js";
|
|
107
|
-
|
|
108
|
-
export {
|
|
109
|
-
APIRoute,
|
|
110
|
-
APIRouterOptions
|
|
111
|
-
} from "./common/api-router-types.js";
|
|
112
|
-
|
|
113
|
-
export {
|
|
114
|
-
GroupPolicy,
|
|
115
|
-
GroupPolicyGroups,
|
|
116
|
-
GroupPolicyType,
|
|
117
|
-
NoTokenSession,
|
|
118
|
-
Session,
|
|
119
|
-
SessionHandlerOptions
|
|
120
|
-
} from "./common/session/common.js";
|