@miqro/core 1.6.1 → 1.7.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.
Files changed (175) hide show
  1. package/README.md +101 -41
  2. package/dist/api-router.d.ts +1 -1
  3. package/dist/api-router.js +0 -1
  4. package/dist/app-utils.js +0 -1
  5. package/dist/app.js +2 -3
  6. package/dist/common/api-router-utils.d.ts +1 -1
  7. package/dist/common/api-router-utils.js +6 -22
  8. package/dist/common/api-router.d.ts +3 -16
  9. package/dist/common/api-router.js +0 -1
  10. package/dist/common/config/config.js +0 -1
  11. package/dist/common/config/featuretoggle.js +0 -1
  12. package/dist/common/config/index.js +0 -1
  13. package/dist/common/config/loader.js +0 -1
  14. package/dist/common/context.d.ts +1 -1
  15. package/dist/common/context.js +0 -1
  16. package/dist/common/error/badrequesterror.js +0 -1
  17. package/dist/common/error/configfilenotfound.js +0 -1
  18. package/dist/common/error/forbiddenerror.js +0 -1
  19. package/dist/common/error/index.js +0 -1
  20. package/dist/common/error/notfound.js +0 -1
  21. package/dist/common/error/notimplemented.js +0 -1
  22. package/dist/common/error/unauthorizederror.js +0 -1
  23. package/dist/common/helpers.js +0 -1
  24. package/dist/common/index.js +0 -1
  25. package/dist/common/logger/constants.d.ts +13 -0
  26. package/dist/common/logger/constants.js +25 -0
  27. package/dist/common/logger/factory.d.ts +2 -4
  28. package/dist/common/logger/factory.js +7 -4
  29. package/dist/common/logger/index.d.ts +5 -5
  30. package/dist/common/logger/index.js +5 -5
  31. package/dist/common/logger/{transport.d.ts → interfaces.d.ts} +6 -3
  32. package/dist/common/logger/interfaces.js +2 -0
  33. package/dist/common/logger/logger.d.ts +15 -7
  34. package/dist/common/logger/logger.js +35 -28
  35. package/dist/common/logger/transport/console.d.ts +5 -0
  36. package/dist/common/logger/transport/console.js +38 -0
  37. package/dist/common/logger/transport/file.d.ts +2 -0
  38. package/dist/common/logger/transport/file.js +28 -0
  39. package/dist/common/router-handler.js +0 -1
  40. package/dist/common/router-helpers.d.ts +1 -1
  41. package/dist/common/router-helpers.js +3 -4
  42. package/dist/common/router-utils.js +0 -1
  43. package/dist/common/session/common.js +0 -1
  44. package/dist/common/session/index.js +0 -1
  45. package/dist/common/session/service.js +0 -1
  46. package/dist/common/tokenize-match.js +0 -1
  47. package/dist/index.js +0 -1
  48. package/dist/middleware/buffer.js +0 -1
  49. package/dist/middleware/cookie.js +0 -1
  50. package/dist/middleware/cors.js +0 -1
  51. package/dist/middleware/form.js +0 -1
  52. package/dist/middleware/group.js +0 -1
  53. package/dist/middleware/index.js +0 -1
  54. package/dist/middleware/json.js +0 -1
  55. package/dist/middleware/logger.js +0 -1
  56. package/dist/middleware/parse.js +0 -1
  57. package/dist/middleware/result.js +0 -1
  58. package/dist/middleware/session.js +0 -1
  59. package/dist/middleware/tag.js +0 -1
  60. package/dist/middleware/text.js +0 -1
  61. package/dist/proxy.js +0 -1
  62. package/dist/router.d.ts +1 -1
  63. package/dist/router.js +2 -3
  64. package/dist/static.js +0 -1
  65. package/package.json +8 -10
  66. package/dist/api-router.js.map +0 -1
  67. package/dist/app-utils.js.map +0 -1
  68. package/dist/app.js.map +0 -1
  69. package/dist/common/api-router-utils.js.map +0 -1
  70. package/dist/common/api-router.js.map +0 -1
  71. package/dist/common/config/config.js.map +0 -1
  72. package/dist/common/config/featuretoggle.js.map +0 -1
  73. package/dist/common/config/index.js.map +0 -1
  74. package/dist/common/config/loader.js.map +0 -1
  75. package/dist/common/context.js.map +0 -1
  76. package/dist/common/error/badrequesterror.js.map +0 -1
  77. package/dist/common/error/configfilenotfound.js.map +0 -1
  78. package/dist/common/error/forbiddenerror.js.map +0 -1
  79. package/dist/common/error/index.js.map +0 -1
  80. package/dist/common/error/notfound.js.map +0 -1
  81. package/dist/common/error/notimplemented.js.map +0 -1
  82. package/dist/common/error/unauthorizederror.js.map +0 -1
  83. package/dist/common/helpers.js.map +0 -1
  84. package/dist/common/index.js.map +0 -1
  85. package/dist/common/logger/common.d.ts +0 -4
  86. package/dist/common/logger/common.js +0 -7
  87. package/dist/common/logger/common.js.map +0 -1
  88. package/dist/common/logger/factory.js.map +0 -1
  89. package/dist/common/logger/formatter.d.ts +0 -7
  90. package/dist/common/logger/formatter.js +0 -9
  91. package/dist/common/logger/formatter.js.map +0 -1
  92. package/dist/common/logger/index.js.map +0 -1
  93. package/dist/common/logger/logger.js.map +0 -1
  94. package/dist/common/logger/transport.js +0 -59
  95. package/dist/common/logger/transport.js.map +0 -1
  96. package/dist/common/router-handler.js.map +0 -1
  97. package/dist/common/router-helpers.js.map +0 -1
  98. package/dist/common/router-utils.js.map +0 -1
  99. package/dist/common/session/common.js.map +0 -1
  100. package/dist/common/session/index.js.map +0 -1
  101. package/dist/common/session/service.js.map +0 -1
  102. package/dist/common/tokenize-match.js.map +0 -1
  103. package/dist/index.js.map +0 -1
  104. package/dist/middleware/buffer.js.map +0 -1
  105. package/dist/middleware/cookie.js.map +0 -1
  106. package/dist/middleware/cors.js.map +0 -1
  107. package/dist/middleware/form.js.map +0 -1
  108. package/dist/middleware/group.js.map +0 -1
  109. package/dist/middleware/index.js.map +0 -1
  110. package/dist/middleware/json.js.map +0 -1
  111. package/dist/middleware/logger.js.map +0 -1
  112. package/dist/middleware/parse.js.map +0 -1
  113. package/dist/middleware/result.js.map +0 -1
  114. package/dist/middleware/session.js.map +0 -1
  115. package/dist/middleware/tag.js.map +0 -1
  116. package/dist/middleware/text.js.map +0 -1
  117. package/dist/proxy.js.map +0 -1
  118. package/dist/router.js.map +0 -1
  119. package/dist/static.js.map +0 -1
  120. package/src/api-router.ts +0 -60
  121. package/src/api-router.unit.test.js +0 -273
  122. package/src/app-utils.ts +0 -82
  123. package/src/app-utils.unit.test.js +0 -100
  124. package/src/app.ts +0 -51
  125. package/src/app.unit.test.js +0 -334
  126. package/src/common/api-router-utils.ts +0 -209
  127. package/src/common/api-router.ts +0 -32
  128. package/src/common/config/config.ts +0 -111
  129. package/src/common/config/featuretoggle.ts +0 -6
  130. package/src/common/config/index.ts +0 -3
  131. package/src/common/config/loader.ts +0 -80
  132. package/src/common/context.ts +0 -167
  133. package/src/common/context.unit.test.js +0 -288
  134. package/src/common/error/badrequesterror.ts +0 -6
  135. package/src/common/error/configfilenotfound.ts +0 -6
  136. package/src/common/error/forbiddenerror.ts +0 -6
  137. package/src/common/error/index.ts +0 -6
  138. package/src/common/error/notfound.ts +0 -6
  139. package/src/common/error/notimplemented.ts +0 -6
  140. package/src/common/error/unauthorizederror.ts +0 -6
  141. package/src/common/helpers.ts +0 -11
  142. package/src/common/index.ts +0 -7
  143. package/src/common/logger/common.ts +0 -6
  144. package/src/common/logger/factory.ts +0 -51
  145. package/src/common/logger/formatter.ts +0 -9
  146. package/src/common/logger/index.ts +0 -6
  147. package/src/common/logger/logger.ts +0 -114
  148. package/src/common/logger/transport.ts +0 -71
  149. package/src/common/router-handler.ts +0 -159
  150. package/src/common/router-helpers.ts +0 -20
  151. package/src/common/router-utils.ts +0 -95
  152. package/src/common/session/common.ts +0 -40
  153. package/src/common/session/index.ts +0 -2
  154. package/src/common/session/service.ts +0 -160
  155. package/src/common/tokenize-match.ts +0 -130
  156. package/src/index.ts +0 -7
  157. package/src/middleware/buffer.ts +0 -80
  158. package/src/middleware/cookie.ts +0 -20
  159. package/src/middleware/cors.ts +0 -96
  160. package/src/middleware/form.ts +0 -59
  161. package/src/middleware/group.ts +0 -70
  162. package/src/middleware/index.ts +0 -48
  163. package/src/middleware/json.ts +0 -55
  164. package/src/middleware/logger.ts +0 -18
  165. package/src/middleware/parse.ts +0 -93
  166. package/src/middleware/result.ts +0 -43
  167. package/src/middleware/session.ts +0 -136
  168. package/src/middleware/tag.ts +0 -15
  169. package/src/middleware/text.ts +0 -45
  170. package/src/proxy.ts +0 -77
  171. package/src/proxy.unit.test.js +0 -159
  172. package/src/router.ts +0 -112
  173. package/src/router.unit.test.js +0 -397
  174. package/src/setup-test.js +0 -5
  175. 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,6 +0,0 @@
1
- export type LogLevel = "error" | "warn" | "info" | "debug" | "trace";
2
-
3
-
4
- export const LoggerEvents = {
5
- error: "error"
6
- };
@@ -1,51 +0,0 @@
1
- import {Logger} from "./logger";
2
- import {LoggerFormatter} from "./formatter";
3
- import {LoggerTransport} from "./transport";
4
- import {LogLevel} from "./common";
5
- import {ConfigStore} from "../config";
6
-
7
- const loggerContainer: Map<string, Logger> = new Map<string, Logger>();
8
- const DEFAULT_ENV_NAME = "LOG_LEVEL";
9
-
10
- export const getLogger = (identifier: string, options?: { formatter?: LoggerFormatter, transports?: LoggerTransport[] }, useCache = true): Logger => {
11
- if (typeof identifier !== "string" && typeof identifier !== "undefined") {
12
- throw new Error("Bad log identifier");
13
- }
14
- if (useCache && loggerContainer.has(identifier)) {
15
- return loggerContainer.get(identifier) as Logger;
16
- } else {
17
- const envVarName = `LOG_LEVEL_${identifier}`;
18
- const level = ConfigStore.getConfig(envVarName) ? ConfigStore.getConfig(envVarName) as LogLevel : ConfigStore.getConfig(DEFAULT_ENV_NAME, "info") as LogLevel;
19
- const factory = getLoggerFactory();
20
- const logger = factory({identifier, level, options});
21
- if (useCache) {
22
- loggerContainer.set(identifier, logger);
23
- }
24
- return logger;
25
- }
26
- };
27
-
28
- export type LoggerFactory = (args: { identifier: string, level: LogLevel; options?: { transports?: LoggerTransport[]; formatter?: LoggerFormatter; } }) => Logger;
29
-
30
- const defaultLoggerFactory: LoggerFactory = ({identifier, options, level}): Logger => {
31
- return new Logger(identifier, level, options);
32
- };
33
-
34
- let customLoggerFactory: LoggerFactory | undefined = undefined;
35
-
36
- export const setLoggerFactory = (factory: LoggerFactory): LoggerFactory => {
37
- if (customLoggerFactory !== undefined) {
38
- throw new Error("cannot change logger factory. it has been used already.");
39
- }
40
- customLoggerFactory = factory;
41
- return customLoggerFactory;
42
- };
43
-
44
- export const getLoggerFactory = (): LoggerFactory => {
45
- if (customLoggerFactory) {
46
- return customLoggerFactory;
47
- } else {
48
- customLoggerFactory = defaultLoggerFactory;
49
- return defaultLoggerFactory;
50
- }
51
- };
@@ -1,9 +0,0 @@
1
- import {LogLevel} from "./common";
2
-
3
- export type LoggerFormatter = (args: { identifier: string, level: LogLevel, message: string }) => string;
4
-
5
- export const defaultLoggerFormatter: LoggerFormatter =
6
- ({identifier, level, message}) => `${new Date().toISOString()} ${process.pid} ` +
7
- `${identifier ? `[${identifier}] ` : ""}` +
8
- `${level !== "info" ? (level === "error" || level === "warn" ? `[${level.toUpperCase()}] ` : `[${level}] `) : ""}` +
9
- `${message}`;
@@ -1,6 +0,0 @@
1
- export {LogLevel} from "./common";
2
- export * from "./factory";
3
- export * from "./formatter";
4
- export * from "./logger";
5
- export * from "./transport";
6
-
@@ -1,114 +0,0 @@
1
- import {format} from "util";
2
- import {EventEmitter} from "events";
3
- import {ConsoleTransport, FileTransport, LoggerTransport, LoggerTransportWriteArgs, WriteArgs} from "./transport";
4
- import {defaultLoggerFormatter, LoggerFormatter} from "./formatter";
5
- import {LoggerEvents, LogLevel} from "./common";
6
-
7
- const defaultLoggerTransports: () => LoggerTransport[] = () => [
8
- ConsoleTransport(),
9
- FileTransport()
10
- ];
11
-
12
- const LOG_LEVEL_MAP =
13
- {
14
- "error": 1,
15
- "warn": 2,
16
- "info": 3,
17
- "debug": 4,
18
- "trace": 5,
19
- };
20
-
21
- export interface Logger {
22
- log(message?: any, ...optionalParams: any[]): void;
23
-
24
- info(message?: any, ...optionalParams: any[]): void;
25
-
26
- trace(message?: any, ...optionalParams: any[]): void;
27
-
28
- debug(message?: any, ...optionalParams: any[]): void;
29
-
30
- warn(message?: any, ...optionalParams: any[]): void;
31
-
32
- error(message?: any, ...optionalParams: any[]): void;
33
- }
34
-
35
- export class Logger extends EventEmitter implements Logger {
36
-
37
- protected readonly options: { transports: LoggerTransport[]; formatter: LoggerFormatter; };
38
-
39
- constructor(protected readonly identifier: string, protected readonly level: LogLevel = "info", options?: { transports?: LoggerTransport[]; formatter?: LoggerFormatter; }) {
40
- super();
41
- if (!LOG_LEVEL_MAP[level]) {
42
- throw new Error(`Unknown level [${level}]`);
43
- }
44
- this.on(LoggerEvents.error, (e) => {
45
- console.error(e);
46
- });
47
- this.options = {
48
- transports: options && options.transports !== undefined ? options.transports : defaultLoggerTransports(),
49
- formatter: options && options.formatter !== undefined ? options.formatter : defaultLoggerFormatter,
50
- };
51
- }
52
-
53
- protected write(args: WriteArgs): void {
54
- try {
55
- let eventArgs: LoggerTransportWriteArgs | undefined = undefined;
56
- const tR = [];
57
- for (const transport of this.options.transports) {
58
- if (LOG_LEVEL_MAP[transport.level ? transport.level : this.level] >= LOG_LEVEL_MAP[args.level]) {
59
- try {
60
- eventArgs = eventArgs ? eventArgs : {
61
- out: this.options.formatter({
62
- identifier: this.identifier,
63
- level: args.level,
64
- message: format(args.message, ...args.optionalParams)
65
- }),
66
- ...args
67
- };
68
- tR.push(transport.write(eventArgs));
69
- } catch (e2) {
70
- this.emit(LoggerEvents.error, e2);
71
- }
72
- }
73
- }
74
- Promise.all(tR).catch((e) => {
75
- this.emit(LoggerEvents.error, e);
76
- });
77
- } catch (e) {
78
- this.emit(LoggerEvents.error, e);
79
- }
80
- }
81
-
82
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
83
- public debug(message?: any, ...optionalParams: any[]): void {
84
- return this.write({level: "debug", message, optionalParams});
85
- }
86
-
87
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
88
- public error(message?: any, ...optionalParams: any[]): void {
89
- return this.write({level: "error", message, optionalParams});
90
- }
91
-
92
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
93
- public info(message?: any, ...optionalParams: any[]): void {
94
- return this.write({level: "info", message, optionalParams});
95
- }
96
-
97
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
98
- public log(message?: any, ...optionalParams: any[]): void {
99
- return this.write({level: "info", message, optionalParams});
100
- }
101
-
102
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
103
- public trace(message?: any, ...optionalParams: any[]): void {
104
- return this.write({level: "trace", message, optionalParams});
105
- }
106
-
107
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
108
- public warn(message?: any, ...optionalParams: any[]): void {
109
- return this.write({level: "warn", message, optionalParams});
110
- }
111
- }
112
-
113
-
114
-
@@ -1,71 +0,0 @@
1
- import {createWriteStream} from "fs";
2
- import {resolve} from "path";
3
- import {LogLevel} from "./common";
4
-
5
- export interface WriteArgs {
6
- level: LogLevel;
7
- message?: any;
8
- optionalParams: any[]
9
- }
10
-
11
- export interface LoggerTransportWriteArgs extends WriteArgs {
12
- out: string;
13
- }
14
-
15
- export interface LoggerTransport {
16
- level?: LogLevel;
17
-
18
- write(args: LoggerTransportWriteArgs): Promise<void> | void;
19
- }
20
-
21
- export const ConsoleTransport: (color?: boolean, level?: LogLevel) => LoggerTransport = (color = true, level?: LogLevel) => {
22
- return {
23
- level,
24
- write: async ({level, out}: LoggerTransportWriteArgs): Promise<void> => {
25
- if (color) {
26
- switch (level) {
27
- case "warn":
28
- console.warn("\x1b[33m%s\x1b[0m", out);
29
- break;
30
- case "error":
31
- console.error("\x1b[31m%s\x1b[0m", out);
32
- break;
33
- case "trace":
34
- console.log("\x1b[34m%s\x1b[0m", out);
35
- break;
36
- case "debug":
37
- console.log("\x1b[36m%s\x1b[0m", out);
38
- break;
39
- default:
40
- console[level](out);
41
- break;
42
- }
43
- } else {
44
- console[level](out);
45
- }
46
- }
47
- };
48
- };
49
-
50
- const FILE_TRANSPORT_ENVVAR = "LOG_FILE";
51
-
52
- export const FileTransport: (filePath?: string | null, level?: LogLevel) => LoggerTransport = (filePath = process.env[FILE_TRANSPORT_ENVVAR] ? process.env[FILE_TRANSPORT_ENVVAR] : null, level?: LogLevel) => {
53
- const fileHandler = filePath ? createWriteStream(resolve(filePath), {flags: "a"}) : null;
54
- return {
55
- level,
56
- write: async ({out}: LoggerTransportWriteArgs): Promise<void> => {
57
- if (fileHandler) {
58
- return new Promise((resolve, reject) => {
59
- fileHandler.write(`${out}\n`, (err) => {
60
- if (err) {
61
- reject(err);
62
- } else {
63
- resolve();
64
- }
65
- });
66
- });
67
- }
68
- return;
69
- }
70
- };
71
- };