@miqro/core 1.7.0 → 1.7.3

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.
Files changed (159) hide show
  1. package/dist/api-router.js +0 -1
  2. package/dist/app-utils.js +0 -1
  3. package/dist/app.js +2 -3
  4. package/dist/common/api-router-utils.js +0 -1
  5. package/dist/common/api-router.js +0 -1
  6. package/dist/common/config/config.js +0 -1
  7. package/dist/common/config/featuretoggle.js +0 -1
  8. package/dist/common/config/index.js +0 -1
  9. package/dist/common/config/loader.js +0 -1
  10. package/dist/common/context.d.ts +2 -1
  11. package/dist/common/context.js +27 -12
  12. package/dist/common/error/badrequesterror.js +0 -1
  13. package/dist/common/error/configfilenotfound.js +0 -1
  14. package/dist/common/error/forbiddenerror.js +0 -1
  15. package/dist/common/error/index.js +0 -1
  16. package/dist/common/error/notfound.js +0 -1
  17. package/dist/common/error/notimplemented.js +0 -1
  18. package/dist/common/error/unauthorizederror.js +0 -1
  19. package/dist/common/helpers.js +0 -1
  20. package/dist/common/index.js +0 -1
  21. package/dist/common/logger/constants.js +0 -1
  22. package/dist/common/logger/factory.js +0 -1
  23. package/dist/common/logger/index.js +0 -1
  24. package/dist/common/logger/interfaces.js +0 -1
  25. package/dist/common/logger/logger.js +0 -1
  26. package/dist/common/logger/transport/console.js +0 -1
  27. package/dist/common/logger/transport/file.js +0 -1
  28. package/dist/common/router-handler.js +0 -1
  29. package/dist/common/router-helpers.js +0 -1
  30. package/dist/common/router-utils.js +0 -1
  31. package/dist/common/session/common.js +0 -1
  32. package/dist/common/session/index.js +0 -1
  33. package/dist/common/session/service.js +0 -1
  34. package/dist/common/tokenize-match.js +0 -1
  35. package/dist/index.js +0 -1
  36. package/dist/middleware/buffer.js +0 -1
  37. package/dist/middleware/cookie.js +0 -1
  38. package/dist/middleware/cors.js +0 -1
  39. package/dist/middleware/form.js +0 -1
  40. package/dist/middleware/group.js +0 -1
  41. package/dist/middleware/index.js +0 -1
  42. package/dist/middleware/json.js +0 -1
  43. package/dist/middleware/logger.js +0 -1
  44. package/dist/middleware/parse.js +0 -1
  45. package/dist/middleware/result.js +0 -1
  46. package/dist/middleware/session.js +0 -1
  47. package/dist/middleware/tag.js +0 -1
  48. package/dist/middleware/text.js +0 -1
  49. package/dist/proxy.js +28 -11
  50. package/dist/router.js +2 -3
  51. package/dist/static.js +0 -1
  52. package/package.json +7 -9
  53. package/dist/api-router.js.map +0 -1
  54. package/dist/app-utils.js.map +0 -1
  55. package/dist/app.js.map +0 -1
  56. package/dist/common/api-router-utils.js.map +0 -1
  57. package/dist/common/api-router.js.map +0 -1
  58. package/dist/common/config/config.js.map +0 -1
  59. package/dist/common/config/featuretoggle.js.map +0 -1
  60. package/dist/common/config/index.js.map +0 -1
  61. package/dist/common/config/loader.js.map +0 -1
  62. package/dist/common/context.js.map +0 -1
  63. package/dist/common/error/badrequesterror.js.map +0 -1
  64. package/dist/common/error/configfilenotfound.js.map +0 -1
  65. package/dist/common/error/forbiddenerror.js.map +0 -1
  66. package/dist/common/error/index.js.map +0 -1
  67. package/dist/common/error/notfound.js.map +0 -1
  68. package/dist/common/error/notimplemented.js.map +0 -1
  69. package/dist/common/error/unauthorizederror.js.map +0 -1
  70. package/dist/common/helpers.js.map +0 -1
  71. package/dist/common/index.js.map +0 -1
  72. package/dist/common/logger/constants.js.map +0 -1
  73. package/dist/common/logger/factory.js.map +0 -1
  74. package/dist/common/logger/index.js.map +0 -1
  75. package/dist/common/logger/interfaces.js.map +0 -1
  76. package/dist/common/logger/logger.js.map +0 -1
  77. package/dist/common/logger/transport/console.js.map +0 -1
  78. package/dist/common/logger/transport/file.js.map +0 -1
  79. package/dist/common/router-handler.js.map +0 -1
  80. package/dist/common/router-helpers.js.map +0 -1
  81. package/dist/common/router-utils.js.map +0 -1
  82. package/dist/common/session/common.js.map +0 -1
  83. package/dist/common/session/index.js.map +0 -1
  84. package/dist/common/session/service.js.map +0 -1
  85. package/dist/common/tokenize-match.js.map +0 -1
  86. package/dist/index.js.map +0 -1
  87. package/dist/middleware/buffer.js.map +0 -1
  88. package/dist/middleware/cookie.js.map +0 -1
  89. package/dist/middleware/cors.js.map +0 -1
  90. package/dist/middleware/form.js.map +0 -1
  91. package/dist/middleware/group.js.map +0 -1
  92. package/dist/middleware/index.js.map +0 -1
  93. package/dist/middleware/json.js.map +0 -1
  94. package/dist/middleware/logger.js.map +0 -1
  95. package/dist/middleware/parse.js.map +0 -1
  96. package/dist/middleware/result.js.map +0 -1
  97. package/dist/middleware/session.js.map +0 -1
  98. package/dist/middleware/tag.js.map +0 -1
  99. package/dist/middleware/text.js.map +0 -1
  100. package/dist/proxy.js.map +0 -1
  101. package/dist/router.js.map +0 -1
  102. package/dist/static.js.map +0 -1
  103. package/src/api-router.ts +0 -60
  104. package/src/api-router.unit.test.js +0 -273
  105. package/src/app-utils.ts +0 -82
  106. package/src/app-utils.unit.test.js +0 -100
  107. package/src/app.ts +0 -51
  108. package/src/app.unit.test.js +0 -334
  109. package/src/common/api-router-utils.ts +0 -193
  110. package/src/common/api-router.ts +0 -19
  111. package/src/common/config/config.ts +0 -111
  112. package/src/common/config/featuretoggle.ts +0 -6
  113. package/src/common/config/index.ts +0 -3
  114. package/src/common/config/loader.ts +0 -80
  115. package/src/common/context.ts +0 -167
  116. package/src/common/context.unit.test.js +0 -288
  117. package/src/common/error/badrequesterror.ts +0 -6
  118. package/src/common/error/configfilenotfound.ts +0 -6
  119. package/src/common/error/forbiddenerror.ts +0 -6
  120. package/src/common/error/index.ts +0 -6
  121. package/src/common/error/notfound.ts +0 -6
  122. package/src/common/error/notimplemented.ts +0 -6
  123. package/src/common/error/unauthorizederror.ts +0 -6
  124. package/src/common/helpers.ts +0 -11
  125. package/src/common/index.ts +0 -7
  126. package/src/common/logger/constants.ts +0 -27
  127. package/src/common/logger/factory.ts +0 -53
  128. package/src/common/logger/index.ts +0 -6
  129. package/src/common/logger/interfaces.ts +0 -19
  130. package/src/common/logger/logger.ts +0 -136
  131. package/src/common/logger/transport/console.ts +0 -34
  132. package/src/common/logger/transport/file.ts +0 -26
  133. package/src/common/router-handler.ts +0 -159
  134. package/src/common/router-helpers.ts +0 -20
  135. package/src/common/router-utils.ts +0 -95
  136. package/src/common/session/common.ts +0 -40
  137. package/src/common/session/index.ts +0 -2
  138. package/src/common/session/service.ts +0 -160
  139. package/src/common/tokenize-match.ts +0 -130
  140. package/src/index.ts +0 -7
  141. package/src/middleware/buffer.ts +0 -80
  142. package/src/middleware/cookie.ts +0 -20
  143. package/src/middleware/cors.ts +0 -96
  144. package/src/middleware/form.ts +0 -59
  145. package/src/middleware/group.ts +0 -70
  146. package/src/middleware/index.ts +0 -48
  147. package/src/middleware/json.ts +0 -55
  148. package/src/middleware/logger.ts +0 -18
  149. package/src/middleware/parse.ts +0 -93
  150. package/src/middleware/result.ts +0 -43
  151. package/src/middleware/session.ts +0 -136
  152. package/src/middleware/tag.ts +0 -15
  153. package/src/middleware/text.ts +0 -45
  154. package/src/proxy.ts +0 -77
  155. package/src/proxy.unit.test.js +0 -159
  156. package/src/router.ts +0 -112
  157. package/src/router.unit.test.js +0 -397
  158. package/src/setup-test.js +0 -5
  159. package/src/static.ts +0 -238
@@ -1,288 +0,0 @@
1
- const {fake, requireMock} = require("@miqro/test");
2
- const {resolve} = require("path");
3
- const {format} = require("util");
4
- const {strictEqual} = require("assert");
5
- const {distPath} = require("../setup-test.js");
6
- const {serialize} = require("cookie");
7
-
8
- const testFilePath = resolve(distPath, "common", "context.js");
9
-
10
- describe("context unit tests", () => {
11
-
12
- const res = {
13
- headersSent: false,
14
- end: fake((body, cb) => {
15
- res.headersSent = true
16
- cb();
17
- }),
18
- setHeader: fake(() => {
19
-
20
- }),
21
- removeHeader: fake(() => {
22
-
23
- })
24
- };
25
- const logger = "logger1";
26
- const newURLRet = {
27
- pathname: "pathname",
28
- searchParams: "searchParams"
29
- };
30
- const parseSearchParamsRet = "parseSearchParamsRet";
31
- const normalizePathRet = "normalizePathRet";
32
- const newURL = fake(() => {
33
- return newURLRet;
34
- });
35
- const normalizePath = fake(() => {
36
- return normalizePathRet;
37
- });
38
- const parseSearchParams = fake(() => {
39
- return parseSearchParamsRet;
40
- });
41
- const cookieSerializeRet = "cookieSerializeRet";
42
- const cookieSerialize = fake(() => {
43
- return cookieSerializeRet;
44
- });
45
-
46
- let Context;
47
-
48
- before(() => {
49
- res.headersSent = false;
50
- cookieSerialize.reset();
51
- res.end.reset();
52
- res.setHeader.reset();
53
- res.removeHeader.reset();
54
- newURL.reset();
55
- normalizePath.reset();
56
- parseSearchParams.reset();
57
- const lib = requireMock(testFilePath, {
58
- "./logger": {},
59
- "./session": {},
60
- "http": {},
61
- "./tokenize-match": {
62
- normalizePath,
63
- parseSearchParams
64
- },
65
- "url": {},
66
- "./helpers": {
67
- newURL
68
- },
69
- "cookie": {
70
- serialize: cookieSerialize
71
- },
72
- }, distPath);
73
- Context = lib.Context;
74
- });
75
-
76
- const uuid = "uuid1";
77
- [{
78
- req: {
79
- url: "/url",
80
- socket: {
81
- remoteAddress: "remoteAddress"
82
- },
83
- headers: {
84
- host: "fakeHost"
85
- }
86
- }
87
- }, {
88
- req: {
89
- url: "/url",
90
- method: "MeThoD",
91
- socket: {
92
- remoteAddress: "remoteAddress"
93
- },
94
- headers: {
95
- host: "fakeHost"
96
- }
97
- }
98
- }].forEach(({req}) => {
99
-
100
- it(format("ctor req %o", req), async () => {
101
- const context = new Context(uuid, req, res, logger);
102
- strictEqual(context.uuid, uuid);
103
- strictEqual(context.body, undefined);
104
- strictEqual(res.removeHeader.callCount, 1);
105
- strictEqual(res.removeHeader.callArgs[0][0], "Date");
106
- strictEqual(context.req, req);
107
- strictEqual(context.res, res);
108
- strictEqual(context.query, parseSearchParamsRet);
109
- strictEqual(cookieSerialize.callCount, 0);
110
- strictEqual(parseSearchParams.callCount, 1);
111
- strictEqual(parseSearchParams.callArgs[0][0], newURLRet.searchParams);
112
- strictEqual(normalizePath.callCount, 1);
113
- strictEqual(normalizePath.callArgs[0][0], newURLRet.pathname);
114
- strictEqual(context.path, normalizePathRet);
115
- strictEqual(context.method, req.method ? req.method.toUpperCase() : "GET");
116
- strictEqual(context.logger, logger);
117
- strictEqual(context.url, newURLRet);
118
- strictEqual(newURL.callCount, 1);
119
- strictEqual(newURL.callArgs[0][0], req.url);
120
- strictEqual(newURL.callArgs[0][1], `http://${req.headers.host}`);
121
- strictEqual(res.end.callCount, 0);
122
- strictEqual(res.setHeader.callCount, 0);
123
- });
124
- });
125
-
126
-
127
- it("this.setHeader alias for this.res.setHeader", () => {
128
- const context = new Context(uuid, {
129
- url: "/url",
130
- method: "MeThoD",
131
- socket: {
132
- remoteAddress: "remoteAddress"
133
- },
134
- headers: {
135
- host: "fakeHost"
136
- }
137
- }, res, logger);
138
- context.setHeader("key", "value");
139
- strictEqual(cookieSerialize.callCount, 0);
140
- strictEqual(res.end.callCount, 0);
141
- strictEqual(res.setHeader.callCount, 1);
142
- strictEqual(res.setHeader.callArgs[0][0], "key");
143
- strictEqual(res.setHeader.callArgs[0][1], "value");
144
- });
145
-
146
- it("this.close calls this.end", async () => {
147
- const context = new Context(uuid, {
148
- url: "/url",
149
- method: "MeThoD",
150
- socket: {
151
- remoteAddress: "remoteAddress"
152
- },
153
- headers: {
154
- host: "fakeHost"
155
- }
156
- }, res, logger);
157
- context.end = fake(async () => {
158
-
159
- });
160
- await context.close();
161
- strictEqual(cookieSerialize.callCount, 0);
162
- strictEqual(res.end.callCount, 0);
163
- strictEqual(res.setHeader.callCount, 0);
164
- strictEqual(context.end.callCount, 1);
165
- strictEqual(context.end.callArgs[0][0].status, 400);
166
- strictEqual(context.end.callArgs[0][0].headers.connection, "close");
167
- });
168
-
169
- it("this.addVaryHeader", () => {
170
- // TODO
171
- });
172
-
173
- it("this.setCookie alias for this.res.setHeader with cookie.serializer", async () => {
174
- const context = new Context(uuid, {
175
- url: "/url",
176
- method: "MeThoD",
177
- socket: {
178
- remoteAddress: "remoteAddress"
179
- },
180
- headers: {
181
- host: "fakeHost"
182
- }
183
- }, res, logger);
184
- await context.setCookie("name", "value");
185
- strictEqual(cookieSerialize.callCount, 1);
186
- strictEqual(cookieSerialize.callArgs[0][0], "name");
187
- strictEqual(cookieSerialize.callArgs[0][1], "value");
188
- strictEqual(res.end.callCount, 0);
189
- strictEqual(res.setHeader.callCount, 1);
190
- strictEqual(res.setHeader.callArgs[0][0], "Set-Cookie");
191
- strictEqual(res.setHeader.callArgs[0][1], cookieSerializeRet);
192
- });
193
-
194
- it("this.end with headers not sent", async () => {
195
- const context = new Context(uuid, {
196
- url: "/url",
197
- method: "MeThoD",
198
- socket: {
199
- remoteAddress: "remoteAddress"
200
- },
201
- headers: {
202
- host: "fakeHost"
203
- }
204
- }, res, logger);
205
- res.headersSent = true;
206
- try {
207
- await context.end("end1");
208
- strictEqual(false, true);
209
- } catch (e) {
210
- strictEqual(e.message, "already ended");
211
- }
212
- });
213
-
214
- it("this.end with headers sent", async () => {
215
- const context = new Context(uuid, {
216
- url: "/url",
217
- method: "MeThoD",
218
- socket: {
219
- remoteAddress: "remoteAddress"
220
- },
221
- headers: {
222
- host: "fakeHost"
223
- }
224
- }, res, logger
225
- );
226
- const headers = {
227
- key1: "value1",
228
- key2: "value2"
229
- };
230
- const body = "body";
231
- const status = "status";
232
- await context.end({
233
- headers,
234
- body,
235
- status
236
- });
237
- strictEqual(res.end.callCount, 1);
238
- strictEqual(res.end.callArgs[0][0], body);
239
- strictEqual(res.setHeader.callCount, 3);
240
- strictEqual(res.setHeader.callArgs[0][0], "key1");
241
- strictEqual(res.setHeader.callArgs[0][1], "value1");
242
- strictEqual(res.setHeader.callArgs[1][0], "key2");
243
- strictEqual(res.setHeader.callArgs[1][1], "value2");
244
- strictEqual(res.setHeader.callArgs[2][0], "connection");
245
- strictEqual(res.setHeader.callArgs[2][1], "close");
246
- });
247
-
248
- [{status: "status"}, {status: undefined}].forEach(({status}) => {
249
- [{headers: "headers"}, {status: undefined}].forEach(({headers}) => {
250
- [{body: {attr1: "value2"}}].forEach(({body}) => {
251
- it(format("this.json alias for this.end %o", {status, headers, body}), async () => {
252
- const context = new Context(uuid, {
253
- url: "/url",
254
- method: "MeThoD",
255
- socket: {
256
- remoteAddress: "remoteAddress"
257
- },
258
- headers: {
259
- host: "fakeHost"
260
- }
261
- }, res, logger);
262
- context.end = fake(async () => {
263
-
264
- });
265
- await context.json(body, headers, status);
266
- strictEqual(cookieSerialize.callCount, 0);
267
- strictEqual(res.end.callCount, 0);
268
- strictEqual(res.setHeader.callCount, 0);
269
- strictEqual(context.end.callCount, 1);
270
- strictEqual(context.end.callArgs[0][0].status, status ? status : 200);
271
- });
272
- });
273
- });
274
- });
275
-
276
-
277
- it("this.text", () => {
278
- // TODO
279
- });
280
-
281
- it("this.html", () => {
282
- // TODO
283
- });
284
-
285
- it("this.redirect", () => {
286
- // TODO
287
- });
288
- });
@@ -1,6 +0,0 @@
1
- export class BadRequestError extends Error {
2
- constructor(message = "BAD REQUEST") {
3
- super(message);
4
- this.name = "BadRequestError";
5
- }
6
- }
@@ -1,6 +0,0 @@
1
- export class ConfigFileNotFoundError extends Error {
2
- constructor(message = "NOT FOUND") {
3
- super(message);
4
- this.name = "ConfigFileNotFoundError";
5
- }
6
- }
@@ -1,6 +0,0 @@
1
- export class ForbiddenError extends Error {
2
- constructor(message = "FORBIDDEN") {
3
- super(message);
4
- this.name = "ForbiddenError";
5
- }
6
- }
@@ -1,6 +0,0 @@
1
- export * from "./badrequesterror";
2
- export * from "./unauthorizederror";
3
- export * from "./forbiddenerror";
4
- export * from "./notfound";
5
- export * from "./notimplemented";
6
- export * from "./configfilenotfound";
@@ -1,6 +0,0 @@
1
- export class NotFoundError extends Error {
2
- constructor(message = "NOT FOUND") {
3
- super(message);
4
- this.name = "NotFoundError";
5
- }
6
- }
@@ -1,6 +0,0 @@
1
- export class MethodNotImplementedError extends Error {
2
- constructor(message = "NOT IMPLEMENTED") {
3
- super(message);
4
- this.name = "MethodNotImplementedError";
5
- }
6
- }
@@ -1,6 +0,0 @@
1
- export class UnAuthorizedError extends Error {
2
- constructor(message = "UNAUTHORIZED") {
3
- super(message);
4
- this.name = "UnAuthorizedError";
5
- }
6
- }
@@ -1,11 +0,0 @@
1
- export const newURL = (input: string, base?: string | any): any => {
2
- /* eslint-disable @typescript-eslint/ban-ts-comment */
3
- // @ts-ignore
4
- return new URL(input, base)
5
- }
6
-
7
- export const newURLSearchParams = (arg?: string | any): any => {
8
- /* eslint-disable @typescript-eslint/ban-ts-comment */
9
- // @ts-ignore
10
- return new URLSearchParams(arg);
11
- }
@@ -1,7 +0,0 @@
1
- export * from "./context";
2
- export * from "./router-helpers";
3
- export * from "./api-router";
4
- export * from "./session";
5
- export * from "./error";
6
- export * from "./config";
7
- export * from "./logger";
@@ -1,27 +0,0 @@
1
- import {LoggerFormatter, LoggerTransport} from "./interfaces.js";
2
- import {File} from "./transport/file.js";
3
- import {Console} from "./transport/console.js";
4
-
5
- export const DEFAULT_LOGGER_TRANSPORTS: () => LoggerTransport[] = () => [
6
- Console(),
7
- File()
8
- ];
9
-
10
- export const DEFAULT_LOGGER_FORMATTER: LoggerFormatter =
11
- ({identifier, level, message}) => `${new Date().toISOString()} ${process.pid} ` +
12
- `${identifier ? `[${identifier}] ` : ""}` +
13
- `${level !== "info" ? (level === "error" || level === "warn" ? `[${level.toUpperCase()}] ` : `[${level}] `) : ""}` +
14
- `${message}`;
15
-
16
- export const LOG_LEVEL_MAP =
17
- {
18
- "error": 1,
19
- "warn": 2,
20
- "info": 3,
21
- "debug": 4,
22
- "trace": 5,
23
- };
24
-
25
- export const LoggerEvents = {
26
- error: "error"
27
- };
@@ -1,53 +0,0 @@
1
- import { LoggerFormatter, LoggerTransport, LogLevel } from "./interfaces";
2
- import { ConfigStore } from "../config";
3
- import {Logger} from "./logger.js";
4
- import {DEFAULT_LOGGER_FORMATTER, DEFAULT_LOGGER_TRANSPORTS} from "./constants.js";
5
-
6
- const loggerContainer: Map<string, Logger> = new Map<string, Logger>();
7
- const DEFAULT_ENV_NAME = "LOG_LEVEL";
8
-
9
- export const getLogger = (identifier: string, options?: { formatter?: LoggerFormatter, transports?: LoggerTransport[] }, useCache = true): Logger => {
10
- if (typeof identifier !== "string" && typeof identifier !== "undefined") {
11
- throw new Error("Bad log identifier");
12
- }
13
- if (useCache && loggerContainer.has(identifier)) {
14
- return loggerContainer.get(identifier) as Logger;
15
- } else {
16
- const envVarName = `LOG_LEVEL_${identifier}`;
17
- const level = ConfigStore.getConfig(envVarName) ? ConfigStore.getConfig(envVarName) as LogLevel : ConfigStore.getConfig(DEFAULT_ENV_NAME, "info") as LogLevel;
18
- const factory = getLoggerFactory();
19
- const logger = factory({ identifier, level, options });
20
- if (useCache) {
21
- loggerContainer.set(identifier, logger);
22
- }
23
- return logger;
24
- }
25
- };
26
-
27
- export type LoggerFactory = (args: { identifier: string, level: LogLevel; options?: { transports?: LoggerTransport[]; formatter?: LoggerFormatter; } }) => Logger;
28
-
29
- const defaultLoggerFactory: LoggerFactory = ({ identifier, options, level }): Logger => {
30
- return new Logger(identifier, level, {
31
- formatter: options && options.formatter ? options.formatter : DEFAULT_LOGGER_FORMATTER,
32
- transports: options && options.transports ? options.transports : DEFAULT_LOGGER_TRANSPORTS()
33
- });
34
- };
35
-
36
- let customLoggerFactory: LoggerFactory | undefined = undefined;
37
-
38
- export const setLoggerFactory = (factory: LoggerFactory): LoggerFactory => {
39
- if (customLoggerFactory !== undefined) {
40
- throw new Error("cannot change logger factory after it has been used.");
41
- }
42
- customLoggerFactory = factory;
43
- return customLoggerFactory;
44
- };
45
-
46
- export const getLoggerFactory = (): LoggerFactory => {
47
- if (customLoggerFactory) {
48
- return customLoggerFactory;
49
- } else {
50
- customLoggerFactory = defaultLoggerFactory;
51
- return defaultLoggerFactory;
52
- }
53
- };
@@ -1,6 +0,0 @@
1
- export * from "./constants.js";
2
- export * from "./logger.js";
3
- export * from "./factory.js";
4
- export * from "./interfaces.js";
5
- export * from "./transport/console.js";
6
-
@@ -1,19 +0,0 @@
1
- export type LogLevel = "error" | "warn" | "info" | "debug" | "trace";
2
-
3
- export interface WriteArgs {
4
- level: LogLevel;
5
- message?: any;
6
- optionalParams: any[]
7
- }
8
-
9
- export interface LoggerTransportWriteArgs extends WriteArgs {
10
- out: string;
11
- }
12
-
13
- export interface LoggerTransport {
14
- level?: LogLevel;
15
-
16
- write(args: LoggerTransportWriteArgs): Promise<void> | void;
17
- }
18
-
19
- export type LoggerFormatter = (args: { identifier: string, level: LogLevel, message: string }) => string;
@@ -1,136 +0,0 @@
1
- import {format} from "util";
2
- import {LoggerFormatter, LoggerTransport, LoggerTransportWriteArgs, LogLevel, WriteArgs} from "./interfaces.js";
3
- import {LoggerEvents, DEFAULT_LOGGER_FORMATTER, DEFAULT_LOGGER_TRANSPORTS, LOG_LEVEL_MAP} from "./constants.js";
4
-
5
- export interface LoggerErrorEventInit {
6
- error: any;
7
- }
8
-
9
- // @types/node doesnt include Event and EventTarget
10
- declare var Event: any;
11
- declare var EventTarget: any;
12
-
13
- export class LoggerErrorEvent extends Event {
14
- public error: any;
15
-
16
- constructor(event: string, init: LoggerErrorEventInit) {
17
- super(event, init);
18
- this.error = init.error;
19
- }
20
- }
21
-
22
- export interface Logger {
23
- log(message?: any, ...optionalParams: any[]): void;
24
-
25
- info(message?: any, ...optionalParams: any[]): void;
26
-
27
- trace(message?: any, ...optionalParams: any[]): void;
28
-
29
- debug(message?: any, ...optionalParams: any[]): void;
30
-
31
- warn(message?: any, ...optionalParams: any[]): void;
32
-
33
- error(message?: any, ...optionalParams: any[]): void;
34
-
35
- addTransport(transport: LoggerTransport): void;
36
-
37
- setLevel(level: LogLevel): void;
38
- }
39
-
40
- export class Logger extends EventTarget implements Logger {
41
-
42
- protected readonly options: { transports: LoggerTransport[]; formatter: LoggerFormatter; };
43
-
44
- constructor(protected readonly identifier: string, protected level: LogLevel = "info", options?: { transports?: LoggerTransport[]; formatter?: LoggerFormatter; }) {
45
- super();
46
- if (!LOG_LEVEL_MAP[level]) {
47
- throw new Error(`Unknown level [${level}]`);
48
- }
49
- this.addEventListener(LoggerEvents.error, (ev: any) => {
50
- console.error((ev as LoggerErrorEvent).error);
51
- });
52
- this.options = {
53
- transports: options && options.transports !== undefined ? options.transports : DEFAULT_LOGGER_TRANSPORTS(),
54
- formatter: options && options.formatter !== undefined ? options.formatter : DEFAULT_LOGGER_FORMATTER,
55
- };
56
- }
57
-
58
- public setLevel(level: LogLevel): void {
59
- if (!LOG_LEVEL_MAP[level]) {
60
- throw new Error(`Unknown level [${level}]`);
61
- }
62
- this.level = level;
63
- }
64
-
65
- public addTransport(transport: LoggerTransport): void {
66
- this.options.transports.push(transport);
67
- }
68
-
69
- protected write(args: WriteArgs): void {
70
- try {
71
- let eventArgs: LoggerTransportWriteArgs | undefined = undefined;
72
- const tR = [];
73
- for (const transport of this.options.transports) {
74
- if (LOG_LEVEL_MAP[transport.level ? transport.level : this.level] >= LOG_LEVEL_MAP[args.level]) {
75
- try {
76
- eventArgs = eventArgs ? eventArgs : {
77
- out: this.options.formatter({
78
- identifier: this.identifier,
79
- level: args.level,
80
- message: format(args.message, ...args.optionalParams)
81
- }),
82
- ...args
83
- };
84
- tR.push(transport.write(eventArgs));
85
- } catch (e2: any) {
86
- this.dispatchEvent(new LoggerErrorEvent(LoggerEvents.error, {
87
- error: e2
88
- }));
89
- }
90
- }
91
- }
92
- Promise.allSettled(tR).catch((e) => {
93
- this.dispatchEvent(new LoggerErrorEvent(LoggerEvents.error, {
94
- error: e
95
- }));
96
- });
97
- } catch (e: any) {
98
- this.dispatchEvent(new LoggerErrorEvent(LoggerEvents.error, {
99
- error: e
100
- }));
101
- }
102
- }
103
-
104
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
105
- public debug(message?: any, ...optionalParams: any[]): void {
106
- return this.write({level: "debug", message, optionalParams});
107
- }
108
-
109
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
110
- public error(message?: any, ...optionalParams: any[]): void {
111
- return this.write({level: "error", message, optionalParams});
112
- }
113
-
114
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
115
- public info(message?: any, ...optionalParams: any[]): void {
116
- return this.write({level: "info", message, optionalParams});
117
- }
118
-
119
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
120
- public log(message?: any, ...optionalParams: any[]): void {
121
- return this.write({level: "info", message, optionalParams});
122
- }
123
-
124
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
125
- public trace(message?: any, ...optionalParams: any[]): void {
126
- return this.write({level: "trace", message, optionalParams});
127
- }
128
-
129
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
130
- public warn(message?: any, ...optionalParams: any[]): void {
131
- return this.write({level: "warn", message, optionalParams});
132
- }
133
- }
134
-
135
-
136
-
@@ -1,34 +0,0 @@
1
- import {LoggerTransportWriteArgs, LogLevel} from "../interfaces.js";
2
-
3
- export function Console(color: boolean = true, level?: LogLevel) {
4
- return {
5
- level,
6
- write: async ({level, out}: LoggerTransportWriteArgs): Promise<void> => {
7
- if (color) {
8
- switch (level) {
9
- case "warn":
10
- console.warn("\x1b[33m%s\x1b[0m", out);
11
- break;
12
- case "error":
13
- console.error("\x1b[31m%s\x1b[0m", out);
14
- break;
15
- case "trace":
16
- console.log("\x1b[34m%s\x1b[0m", out);
17
- break;
18
- case "debug":
19
- console.log("\x1b[36m%s\x1b[0m", out);
20
- break;
21
- default:
22
- console[level](out);
23
- break;
24
- }
25
- } else {
26
- if(level === "trace" || level === "debug") {
27
- console.log(out);
28
- } else {
29
- console[level](out);
30
- }
31
- }
32
- }
33
- };
34
- }
@@ -1,26 +0,0 @@
1
- import {createWriteStream} from "fs";
2
- import {resolve} from "path";
3
- import {LoggerTransport, LoggerTransportWriteArgs, LogLevel} from "../interfaces.js";
4
-
5
- const FILE_TRANSPORT_ENVVAR = "LOG_FILE";
6
-
7
- export const File: (filePath?: string | null, level?: LogLevel) => LoggerTransport = (filePath = process.env[FILE_TRANSPORT_ENVVAR] ? process.env[FILE_TRANSPORT_ENVVAR] : null, level?: LogLevel) => {
8
- const fileHandler = filePath ? createWriteStream(resolve(filePath), {flags: "a"}) : null;
9
- return {
10
- level,
11
- write: async ({out}: LoggerTransportWriteArgs): Promise<void> => {
12
- if (fileHandler) {
13
- return new Promise((resolve, reject) => {
14
- fileHandler.write(`${out}\n`, (err) => {
15
- if (err) {
16
- reject(err);
17
- } else {
18
- resolve();
19
- }
20
- });
21
- });
22
- }
23
- return;
24
- }
25
- };
26
- };