underpost 2.7.1 → 2.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 (213) hide show
  1. package/.dockerignore +13 -13
  2. package/.env.development +7 -7
  3. package/.env.production +7 -7
  4. package/.env.test +7 -7
  5. package/.github/workflows/publish.yml +26 -0
  6. package/.nycrc +9 -9
  7. package/.prettierignore +12 -12
  8. package/.prettierrc +9 -9
  9. package/.vscode/extensions.json +72 -72
  10. package/.vscode/settings.json +100 -99
  11. package/Dockerfile +89 -89
  12. package/LICENSE +21 -21
  13. package/README.md +96 -96
  14. package/bin/db.js +172 -119
  15. package/bin/deploy.js +582 -661
  16. package/bin/dns.js +1 -1
  17. package/bin/file.js +92 -92
  18. package/bin/index.js +53 -53
  19. package/bin/install.js +398 -357
  20. package/bin/shortcut.js +44 -44
  21. package/bin/ssl.js +65 -64
  22. package/bin/util.js +182 -182
  23. package/bin/vs.js +35 -35
  24. package/conf.js +251 -249
  25. package/docker-compose.yml +67 -67
  26. package/jsconfig.json +7 -7
  27. package/jsdoc.json +32 -32
  28. package/nodemon.json +6 -6
  29. package/package.json +137 -132
  30. package/prometheus.yml +36 -36
  31. package/setup.sh +24 -24
  32. package/src/api/core/core.controller.js +69 -69
  33. package/src/api/core/core.model.js +11 -11
  34. package/src/api/core/core.router.js +23 -23
  35. package/src/api/core/core.service.js +29 -29
  36. package/src/api/crypto/crypto.controller.js +51 -51
  37. package/src/api/crypto/crypto.model.js +23 -23
  38. package/src/api/crypto/crypto.router.js +20 -20
  39. package/src/api/crypto/crypto.service.js +64 -64
  40. package/src/api/default/default.controller.js +69 -69
  41. package/src/api/default/default.model.js +20 -20
  42. package/src/api/default/default.router.js +23 -23
  43. package/src/api/default/default.service.js +31 -31
  44. package/src/api/file/file.controller.js +53 -51
  45. package/src/api/file/file.model.js +19 -19
  46. package/src/api/file/file.router.js +21 -20
  47. package/src/api/file/file.service.js +76 -70
  48. package/src/api/instance/instance.controller.js +69 -69
  49. package/src/api/instance/instance.model.js +36 -36
  50. package/src/api/instance/instance.router.js +33 -33
  51. package/src/api/instance/instance.service.js +48 -48
  52. package/src/api/test/test.controller.js +59 -59
  53. package/src/api/test/test.model.js +14 -14
  54. package/src/api/test/test.router.js +21 -21
  55. package/src/api/test/test.service.js +35 -35
  56. package/src/api/user/user.build.js +16 -0
  57. package/src/api/user/user.controller.js +70 -70
  58. package/src/api/user/user.model.js +65 -65
  59. package/src/api/user/user.router.js +345 -345
  60. package/src/api/user/user.service.js +479 -479
  61. package/src/api.js +23 -23
  62. package/src/client/Default.index.js +40 -40
  63. package/src/client/components/core/Account.js +290 -290
  64. package/src/client/components/core/AgGrid.js +160 -160
  65. package/src/client/components/core/Auth.js +19 -19
  66. package/src/client/components/core/Badge.js +32 -32
  67. package/src/client/components/core/BlockChain.js +41 -41
  68. package/src/client/components/core/Blog.js +9 -9
  69. package/src/client/components/core/BtnIcon.js +101 -94
  70. package/src/client/components/core/CalendarCore.js +458 -319
  71. package/src/client/components/core/Chat.js +64 -64
  72. package/src/client/components/core/ColorPalette.js +5267 -5267
  73. package/src/client/components/core/CommonJs.js +735 -732
  74. package/src/client/components/core/Content.js +193 -49
  75. package/src/client/components/core/Css.js +1064 -1027
  76. package/src/client/components/core/CssCore.js +817 -796
  77. package/src/client/components/core/D3Chart.js +44 -44
  78. package/src/client/components/core/Docs.js +229 -229
  79. package/src/client/components/core/DropDown.js +164 -164
  80. package/src/client/components/core/EventsUI.js +46 -54
  81. package/src/client/components/core/FileExplorer.js +699 -624
  82. package/src/client/components/core/FullScreen.js +45 -45
  83. package/src/client/components/core/Input.js +346 -259
  84. package/src/client/components/core/JoyStick.js +77 -77
  85. package/src/client/components/core/Keyboard.js +73 -73
  86. package/src/client/components/core/LoadingAnimation.js +179 -157
  87. package/src/client/components/core/LogIn.js +187 -181
  88. package/src/client/components/core/LogOut.js +58 -52
  89. package/src/client/components/core/Logger.js +26 -26
  90. package/src/client/components/core/Modal.js +1612 -1596
  91. package/src/client/components/core/NotificationManager.js +84 -84
  92. package/src/client/components/core/Panel.js +613 -413
  93. package/src/client/components/core/PanelForm.js +468 -0
  94. package/src/client/components/core/Polyhedron.js +162 -162
  95. package/src/client/components/core/Recover.js +204 -204
  96. package/src/client/components/core/Responsive.js +53 -53
  97. package/src/client/components/core/RichText.js +51 -27
  98. package/src/client/components/core/Router.js +76 -77
  99. package/src/client/components/core/Scroll.js +34 -0
  100. package/src/client/components/core/SignUp.js +125 -125
  101. package/src/client/components/core/SocketIo.js +72 -72
  102. package/src/client/components/core/Stream.js +113 -113
  103. package/src/client/components/core/ToggleSwitch.js +87 -87
  104. package/src/client/components/core/ToolTip.js +26 -26
  105. package/src/client/components/core/Translate.js +437 -408
  106. package/src/client/components/core/Validator.js +100 -100
  107. package/src/client/components/core/VanillaJs.js +460 -457
  108. package/src/client/components/core/Wallet.js +106 -106
  109. package/src/client/components/core/Webhook.js +25 -25
  110. package/src/client/components/core/Worker.js +272 -272
  111. package/src/client/components/default/CommonDefault.js +29 -29
  112. package/src/client/components/default/CssDefault.js +13 -13
  113. package/src/client/components/default/ElementsDefault.js +38 -38
  114. package/src/client/components/default/LogInDefault.js +41 -41
  115. package/src/client/components/default/LogOutDefault.js +28 -28
  116. package/src/client/components/default/MenuDefault.js +389 -389
  117. package/src/client/components/default/RoutesDefault.js +48 -48
  118. package/src/client/components/default/SettingsDefault.js +16 -16
  119. package/src/client/components/default/SignUpDefault.js +9 -9
  120. package/src/client/components/default/SocketIoDefault.js +54 -54
  121. package/src/client/components/default/TranslateDefault.js +7 -7
  122. package/src/client/public/default/assets/mailer/api-user-check.png +0 -0
  123. package/src/client/public/default/assets/mailer/api-user-invalid-token.png +0 -0
  124. package/src/client/public/default/assets/mailer/api-user-recover.png +0 -0
  125. package/src/client/public/default/browserconfig.xml +11 -11
  126. package/src/client/public/default/manifest.webmanifest +68 -68
  127. package/src/client/public/default/plantuml/client-conf.svg +1 -0
  128. package/src/client/public/default/plantuml/client-schema.svg +1 -0
  129. package/src/client/public/default/plantuml/cron-conf.svg +1 -0
  130. package/src/client/public/default/plantuml/cron-schema.svg +1 -0
  131. package/src/client/public/default/plantuml/server-conf.svg +1 -0
  132. package/src/client/public/default/plantuml/server-schema.svg +1 -0
  133. package/src/client/public/default/plantuml/ssr-conf.svg +1 -0
  134. package/src/client/public/default/plantuml/ssr-schema.svg +1 -0
  135. package/src/client/public/default/sitemap +147 -147
  136. package/src/client/public/default/yandex-browser-manifest.json +8 -8
  137. package/src/client/public/doc/sitemap +147 -147
  138. package/src/client/public/test/sitemap +147 -147
  139. package/src/client/services/core/core.service.js +170 -152
  140. package/src/client/services/crypto/crypto.service.js +70 -70
  141. package/src/client/services/default/default.management.js +345 -345
  142. package/src/client/services/default/default.service.js +89 -89
  143. package/src/client/services/file/file.service.js +70 -70
  144. package/src/client/services/instance/instance.management.js +74 -74
  145. package/src/client/services/instance/instance.service.js +89 -89
  146. package/src/client/services/test/test.service.js +70 -70
  147. package/src/client/services/user/user.management.js +50 -50
  148. package/src/client/services/user/user.service.js +89 -89
  149. package/src/client/ssr/Render.js +16 -16
  150. package/src/client/ssr/body-components/CacheControl.js +114 -113
  151. package/src/client/ssr/body-components/DefaultSplashScreen.js +79 -79
  152. package/src/client/ssr/email-components/DefaultRecoverEmail.js +21 -21
  153. package/src/client/ssr/email-components/DefaultVerifyEmail.js +17 -17
  154. package/src/client/ssr/head-components/Css.js +241 -241
  155. package/src/client/ssr/head-components/DefaultScripts.js +3 -3
  156. package/src/client/ssr/head-components/Microdata.js +11 -11
  157. package/src/client/ssr/head-components/Production.js +1 -1
  158. package/src/client/ssr/head-components/PwaDefault.js +59 -59
  159. package/src/client/ssr/head-components/Seo.js +14 -14
  160. package/src/client/sw/default.sw.js +201 -201
  161. package/src/client/sw/template.sw.js +84 -84
  162. package/src/client.build.js +22 -22
  163. package/src/client.dev.js +21 -21
  164. package/src/cron.js +25 -25
  165. package/src/db/DataBaseProvider.js +34 -34
  166. package/src/db/mariadb/MariaDB.js +33 -33
  167. package/src/db/mongo/MongooseDB.js +46 -46
  168. package/src/dns.js +22 -22
  169. package/src/index.js +42 -29
  170. package/src/mailer/EmailRender.js +69 -69
  171. package/src/mailer/MailerProvider.js +96 -96
  172. package/src/proxy.js +22 -22
  173. package/src/runtime/lampp/Lampp.js +69 -44
  174. package/src/runtime/nginx/Nginx.js +3 -3
  175. package/src/runtime/xampp/Xampp.js +49 -49
  176. package/src/server/auth.js +235 -204
  177. package/src/server/backup.js +101 -94
  178. package/src/server/client-build-live.js +72 -72
  179. package/src/server/client-build.js +705 -699
  180. package/src/server/client-dev-server.js +60 -58
  181. package/src/server/client-formatted.js +48 -48
  182. package/src/server/client-icons.js +149 -150
  183. package/src/server/conf.js +860 -611
  184. package/src/server/dns.js +98 -98
  185. package/src/server/downloader.js +42 -42
  186. package/src/server/logger.js +180 -180
  187. package/src/server/network.js +122 -122
  188. package/src/server/peer.js +33 -33
  189. package/src/server/process.js +66 -66
  190. package/src/server/prompt-optimizer.js +28 -28
  191. package/src/server/proxy.js +118 -118
  192. package/src/server/runtime.js +444 -393
  193. package/src/server/ssl.js +109 -107
  194. package/src/server.js +25 -25
  195. package/src/ws/IoInterface.js +45 -45
  196. package/src/ws/IoServer.js +39 -39
  197. package/src/ws/core/channels/core.ws.chat.js +23 -23
  198. package/src/ws/core/channels/core.ws.mailer.js +35 -35
  199. package/src/ws/core/channels/core.ws.stream.js +31 -31
  200. package/src/ws/core/core.ws.connection.js +28 -28
  201. package/src/ws/core/core.ws.emit.js +14 -14
  202. package/src/ws/core/core.ws.server.js +24 -24
  203. package/src/ws/core/management/core.ws.chat.js +8 -8
  204. package/src/ws/core/management/core.ws.mailer.js +16 -16
  205. package/src/ws/core/management/core.ws.stream.js +8 -8
  206. package/src/ws/default/channels/default.ws.main.js +16 -16
  207. package/src/ws/default/default.ws.connection.js +22 -22
  208. package/src/ws/default/default.ws.emit.js +14 -14
  209. package/src/ws/default/default.ws.server.js +20 -20
  210. package/src/ws/default/management/default.ws.main.js +8 -8
  211. package/startup.js +11 -11
  212. package/supervisord-openssh-server.conf +4 -4
  213. package/test/api.test.js +60 -60
package/src/server/dns.js CHANGED
@@ -1,98 +1,98 @@
1
- import axios from 'axios';
2
- import dotenv from 'dotenv';
3
- import fs from 'fs';
4
- import cron from 'node-cron';
5
-
6
- import { ip } from './network.js';
7
- import { loggerFactory } from './logger.js';
8
- import { isIPv4 } from 'is-ip';
9
-
10
- dotenv.config();
11
-
12
- const logger = loggerFactory(import.meta);
13
-
14
- const Dns = {
15
- ip: null,
16
- ipDaemon: null,
17
- InitIpDaemon: async function () {
18
- // WAN | NAT-VPS | LAN
19
- // enabled DMZ Host to proxy IP 80-443 (79-444) sometimes router block first port
20
- // LAN server or device's local servers port -> 3000-3100 (2999-3101)
21
- // DNS Records: [ANAME](Address Dynamic) -> [A](ipv4) host | [AAAA](ipv6) host -> [ip]
22
- // DHCP (Dynamic Host Configuration Protocol) LAN reserver IP -> MAC ID
23
- // Forward the router's TCP/UDP ports to the LAN device's IP address
24
-
25
- const privateCronConfPath = `./engine-private/conf/${process.argv[2]}/conf.cron.json`;
26
-
27
- const confCronPath = fs.existsSync(privateCronConfPath) ? privateCronConfPath : './conf/conf.cron.json';
28
-
29
- let confCronData = JSON.parse(fs.readFileSync(confCronPath, 'utf8'));
30
- if (confCronData.ipDaemon.disabled) return;
31
- this.ip = confCronData.ipDaemon.ip;
32
- logger.info(`Current ip`, this.ip);
33
- if (this.ipDaemon) clearInterval(this.ipDaemon);
34
- const callback = async () => {
35
- let testIp;
36
- try {
37
- testIp = await ip.public.ipv4();
38
- } catch (error) {
39
- logger.error(error, { testIp, stack: error.stack });
40
- }
41
- if (testIp && typeof testIp === 'string' && isIPv4(testIp) && this.ip !== testIp) {
42
- logger.info(`New ip`, testIp);
43
- this.ip = testIp;
44
- confCronData.ipDaemon.ip = this.ip;
45
- fs.writeFileSync(confCronPath, JSON.stringify(confCronData, null, 4), 'utf8');
46
- for (const recordType of Object.keys(confCronData.records)) {
47
- switch (recordType) {
48
- case 'A':
49
- for (const dnsProvider of confCronData.records[recordType]) {
50
- if (typeof this.services.updateIp[dnsProvider.dns] === 'function')
51
- await this.services.updateIp[dnsProvider.dns](dnsProvider);
52
- }
53
- break;
54
-
55
- default:
56
- break;
57
- }
58
- }
59
- }
60
- };
61
- await callback();
62
- // every minute
63
- cron.schedule(
64
- '* * * * *',
65
- async () => {
66
- await callback();
67
- },
68
- {
69
- scheduled: true,
70
- timezone: process.env.TIME_ZONE || 'America/New_York',
71
- },
72
- );
73
- },
74
- services: {
75
- updateIp: {
76
- dondominio: (options) => {
77
- const { user, api_key, host, dns } = options;
78
- const url = `https://dondns.dondominio.com/json/?user=${user}&password=${api_key}&host=${host}&ip=${Dns.ip}`;
79
- logger.info(`${dns} update ip url`, url);
80
- if (process.env.NODE_ENV !== 'production') return false;
81
- return new Promise((resolve) => {
82
- axios
83
- .get(url)
84
- .then((response) => {
85
- logger.info(`${dns} update ip success`, response.data);
86
- return resolve(true);
87
- })
88
- .catch((error) => {
89
- logger.error(error, `${dns} update ip error`);
90
- return resolve(false);
91
- });
92
- });
93
- },
94
- },
95
- },
96
- };
97
-
98
- export { Dns };
1
+ import axios from 'axios';
2
+ import dotenv from 'dotenv';
3
+ import fs from 'fs';
4
+ import cron from 'node-cron';
5
+
6
+ import { ip } from './network.js';
7
+ import { loggerFactory } from './logger.js';
8
+ import { isIPv4 } from 'is-ip';
9
+
10
+ dotenv.config();
11
+
12
+ const logger = loggerFactory(import.meta);
13
+
14
+ const Dns = {
15
+ ip: null,
16
+ ipDaemon: null,
17
+ InitIpDaemon: async function () {
18
+ // WAN | NAT-VPS | LAN
19
+ // enabled DMZ Host to proxy IP 80-443 (79-444) sometimes router block first port
20
+ // LAN server or device's local servers port -> 3000-3100 (2999-3101)
21
+ // DNS Records: [ANAME](Address Dynamic) -> [A](ipv4) host | [AAAA](ipv6) host -> [ip]
22
+ // DHCP (Dynamic Host Configuration Protocol) LAN reserver IP -> MAC ID
23
+ // Forward the router's TCP/UDP ports to the LAN device's IP address
24
+
25
+ const privateCronConfPath = `./engine-private/conf/${process.argv[2]}/conf.cron.json`;
26
+
27
+ const confCronPath = fs.existsSync(privateCronConfPath) ? privateCronConfPath : './conf/conf.cron.json';
28
+
29
+ let confCronData = JSON.parse(fs.readFileSync(confCronPath, 'utf8'));
30
+ if (confCronData.ipDaemon.disabled) return;
31
+ Dns.ip = confCronData.ipDaemon.ip;
32
+ logger.info(`Current ip`, Dns.ip);
33
+ if (Dns.ipDaemon) clearInterval(Dns.ipDaemon);
34
+ const callback = async () => {
35
+ let testIp;
36
+ try {
37
+ testIp = await ip.public.ipv4();
38
+ } catch (error) {
39
+ logger.error(error, { testIp, stack: error.stack });
40
+ }
41
+ if (testIp && typeof testIp === 'string' && isIPv4(testIp) && Dns.ip !== testIp) {
42
+ logger.info(`New ip`, testIp);
43
+ Dns.ip = testIp;
44
+ confCronData.ipDaemon.ip = Dns.ip;
45
+ fs.writeFileSync(confCronPath, JSON.stringify(confCronData, null, 4), 'utf8');
46
+ for (const recordType of Object.keys(confCronData.records)) {
47
+ switch (recordType) {
48
+ case 'A':
49
+ for (const dnsProvider of confCronData.records[recordType]) {
50
+ if (typeof Dns.services.updateIp[dnsProvider.dns] === 'function')
51
+ await Dns.services.updateIp[dnsProvider.dns](dnsProvider);
52
+ }
53
+ break;
54
+
55
+ default:
56
+ break;
57
+ }
58
+ }
59
+ }
60
+ };
61
+ await callback();
62
+ // every minute
63
+ cron.schedule(
64
+ '* * * * *',
65
+ async () => {
66
+ await callback();
67
+ },
68
+ {
69
+ scheduled: true,
70
+ timezone: process.env.TIME_ZONE || 'America/New_York',
71
+ },
72
+ );
73
+ },
74
+ services: {
75
+ updateIp: {
76
+ dondominio: (options) => {
77
+ const { user, api_key, host, dns } = options;
78
+ const url = `https://dondns.dondominio.com/json/?user=${user}&password=${api_key}&host=${host}&ip=${Dns.ip}`;
79
+ logger.info(`${dns} update ip url`, url);
80
+ if (process.env.NODE_ENV !== 'production') return false;
81
+ return new Promise((resolve) => {
82
+ axios
83
+ .get(url)
84
+ .then((response) => {
85
+ logger.info(`${dns} update ip success`, response.data);
86
+ return resolve(true);
87
+ })
88
+ .catch((error) => {
89
+ logger.error(error, `${dns} update ip error`);
90
+ return resolve(false);
91
+ });
92
+ });
93
+ },
94
+ },
95
+ },
96
+ };
97
+
98
+ export { Dns };
@@ -1,42 +1,42 @@
1
- import axios from 'axios';
2
- import fs from 'fs';
3
- import { loggerFactory } from './logger.js';
4
- import dotenv from 'dotenv';
5
- import https from 'https';
6
-
7
- dotenv.config();
8
-
9
- const httpsAgent = new https.Agent({
10
- rejectUnauthorized: false,
11
- });
12
-
13
- axios.defaults.httpsAgent = httpsAgent;
14
-
15
- const logger = loggerFactory(import.meta);
16
-
17
- const Downloader = (url, fullPath, options = { method: 'get', responseType: 'stream' }) =>
18
- new Promise((resolve, reject) =>
19
- axios({
20
- url,
21
- ...options,
22
- })
23
- .then((response) => {
24
- // Create a write stream to save the file to the specified path
25
- const writer = fs.createWriteStream(fullPath);
26
- response.data.pipe(writer);
27
- writer.on('finish', () => {
28
- logger.info('Download complete. File saved at', fullPath);
29
- return resolve(fullPath);
30
- });
31
- writer.on('error', (error) => {
32
- logger.error(error, 'Error downloading the file');
33
- return reject(error);
34
- });
35
- })
36
- .catch((error) => {
37
- logger.error(error, 'Error in the request');
38
- return reject(error);
39
- }),
40
- );
41
-
42
- export { Downloader };
1
+ import axios from 'axios';
2
+ import fs from 'fs';
3
+ import { loggerFactory } from './logger.js';
4
+ import dotenv from 'dotenv';
5
+ import https from 'https';
6
+
7
+ dotenv.config();
8
+
9
+ const httpsAgent = new https.Agent({
10
+ rejectUnauthorized: false,
11
+ });
12
+
13
+ axios.defaults.httpsAgent = httpsAgent;
14
+
15
+ const logger = loggerFactory(import.meta);
16
+
17
+ const Downloader = (url, fullPath, options = { method: 'get', responseType: 'stream' }) =>
18
+ new Promise((resolve, reject) =>
19
+ axios({
20
+ url,
21
+ ...options,
22
+ })
23
+ .then((response) => {
24
+ // Create a write stream to save the file to the specified path
25
+ const writer = fs.createWriteStream(fullPath);
26
+ response.data.pipe(writer);
27
+ writer.on('finish', () => {
28
+ logger.info('Download complete. File saved at', fullPath);
29
+ return resolve(fullPath);
30
+ });
31
+ writer.on('error', (error) => {
32
+ logger.error(error, 'Error downloading the file');
33
+ return reject(error);
34
+ });
35
+ })
36
+ .catch((error) => {
37
+ logger.error(error, 'Error in the request');
38
+ return reject(error);
39
+ }),
40
+ );
41
+
42
+ export { Downloader };
@@ -1,180 +1,180 @@
1
- /**
2
- * Module for managing logger control and configuration
3
- * @module src/server/logger.js
4
- * @namespace Logger
5
- */
6
-
7
- 'use strict';
8
-
9
- import dotenv from 'dotenv';
10
- import winston from 'winston';
11
- import morgan from 'morgan';
12
- import colorize from 'json-colorizer';
13
- import colors from 'colors';
14
- import v8 from 'v8';
15
- import isAdmin from 'is-admin';
16
- import { clearTerminalStringColor, formatBytes } from '../client/components/core/CommonJs.js';
17
-
18
- colors.enable();
19
- dotenv.config();
20
-
21
- // Define your severity levels.
22
- // With them, You can create log files,
23
- // see or hide levels based on the running ENV.
24
- const levels = {
25
- error: 0,
26
- warn: 1,
27
- info: 2,
28
- http: 3,
29
- debug: 4,
30
- };
31
-
32
- // This method set the current severity based on
33
- // the current NODE_ENV: show all the log levels
34
- // if the server was run in development mode; otherwise,
35
- // if it was run in production, show only warn and error messages.
36
- const level = () => 'info'; // (process.env.NODE_ENV || 'development' ? 'debug' : 'warn');
37
-
38
- // Define different colors for each level.
39
- // Colors make the log message more visible,
40
- // adding the ability to focus or ignore messages.
41
-
42
- // Tell winston that you want to link the colors
43
- // defined above to the severity levels.
44
- winston.addColors({
45
- error: 'red',
46
- warn: 'yellow',
47
- info: 'green',
48
- http: 'magenta',
49
- debug: 'white',
50
- });
51
-
52
- // Chose the aspect of your log customizing the log format.
53
- const format = (meta) =>
54
- winston.format.combine(
55
- // winston.format.errors({ stack: true }),
56
- // Add the message timestamp with the preferred format
57
- winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss:ms' }),
58
- // Tell Winston that the logs must be colored
59
- winston.format.colorize({ all: true }),
60
- // Define the format of the message showing the timestamp, the level and the message
61
- winston.format.printf((info) => {
62
- const symbols = Object.getOwnPropertySymbols(info);
63
- return `${`[${meta}]`.green} ${info.timestamp} ${info.level} ${
64
- symbols[1]
65
- ? `${clearTerminalStringColor(info.message)}: ${colorize(JSON.stringify(info[symbols[1]][0], null, 4), {
66
- colors: {
67
- STRING_KEY: 'green',
68
- STRING_LITERAL: 'magenta.bold',
69
- NUMBER_LITERAL: '#FF0000',
70
- },
71
- })}`
72
- : info.message
73
- }`;
74
- }),
75
- );
76
-
77
- /**
78
- * Logs information about the current process environment to the console.
79
- *
80
- * This function is used to log details about
81
- * the execution context, such as command-line arguments,
82
- * environment variables, the process's administrative privileges,
83
- * and the maximum available heap space size.
84
- *
85
- * @param {winston.Logger} logger - A pre-configured Winston logger object.
86
- * @memberof Logger
87
- */
88
- const setUpInfo = async (logger = new winston.Logger()) => {
89
- logger.info('argv', process.argv);
90
- logger.info('env', process.env.NODE_ENV);
91
- logger.info('admin', await isAdmin());
92
- logger.info('--max-old-space-size', {
93
- total_available_size: formatBytes(v8.getHeapStatistics().total_available_size),
94
- });
95
- };
96
-
97
- /**
98
- * The function `loggerFactory` creates a logger instance with specified transports for printing out
99
- * messages.
100
- * @param meta - The `meta` parameter in the `loggerFactory` function is used to extract the last part
101
- * of a URL and use it to create log files in a specific directory.
102
- * @returns {winston.Logger} The `loggerFactory` function returns a logger instance created using Winston logger
103
- * library. The logger instance is configured with various transports for printing out messages to
104
- * different destinations such as the terminal, error.log file, and all.log file. The logger instance
105
- * also has a method `setUpInfo` attached to it for setting up additional information.
106
- * @memberof Logger
107
- */
108
- const loggerFactory = (meta = { url: '' }) => {
109
- meta = meta.url.split('/').pop();
110
- // Define which transports the logger must use to print out messages.
111
- // In this example, we are using three different transports
112
- const transports = [
113
- // Allow the use the terminal to print the messages
114
- new winston.transports.Console(),
115
- // Allow to print all the error level messages inside the error.log file
116
- new winston.transports.File({
117
- filename: `logs/${meta}/error.log`,
118
- level: 'error',
119
- }),
120
- // Allow to print all the error message inside the all.log file
121
- // (also the error log that are also printed inside the error.log(
122
- new winston.transports.File({ filename: `logs/${meta}/all.log` }),
123
- ];
124
-
125
- // Create the logger instance that has to be exported
126
- // and used to log messages.
127
- const logger = winston.createLogger({
128
- defaultMeta: meta,
129
- level: level(),
130
- levels,
131
- format: format(meta),
132
- transports,
133
- // exceptionHandlers: [new winston.transports.File({ filename: 'exceptions.log' })],
134
- // rejectionHandlers: [new winston.transports.File({ filename: 'rejections.log' })],
135
- // exitOnError: false,
136
- });
137
- logger.setUpInfo = async () => {
138
- await setUpInfo(logger);
139
- };
140
- return logger;
141
- };
142
-
143
- /**
144
- * The `loggerMiddleware` function creates a middleware for logging HTTP requests using Morgan with
145
- * custom message format and options.
146
- * @param meta - The `meta` parameter in the `loggerMiddleware` function is an object that contains
147
- * information about the request URL. It has a default value of an empty object `{ url: '' }`. This
148
- * object is used to provide additional metadata for logging purposes.
149
- * @returns {Handler<any, any>} The `loggerMiddleware` function returns a middleware function that uses the Morgan library
150
- * to log HTTP request information. The middleware function formats the log message using predefined
151
- * tokens provided by Morgan and custom tokens like `:host` to include specific request details. The
152
- * log message format includes information such as remote address, HTTP method, host, URL, status code,
153
- * content length, and response time in milliseconds. The middleware
154
- * @memberof Logger
155
- */
156
- const loggerMiddleware = (meta = { url: '' }) => {
157
- const stream = {
158
- // Use the http severity
159
- write: (message) => loggerFactory(meta).http(message),
160
- };
161
-
162
- const skip = (req, res) => process.env.NODE_ENV === 'production';
163
-
164
- morgan.token('host', function (req, res) {
165
- return req.headers['host'];
166
- });
167
-
168
- return morgan(
169
- // Define message format string (this is the default one).
170
- // The message format is made from tokens, and each token is
171
- // defined inside the Morgan library.
172
- // You can create your custom token to show what do you want from a request.
173
- `:remote-addr :method :host:url :status :res[content-length] - :response-time ms`,
174
- // Options: in this case, I overwrote the stream and the skip logic.
175
- // See the methods above.
176
- { stream, skip },
177
- );
178
- };
179
-
180
- export { loggerFactory, loggerMiddleware, setUpInfo };
1
+ /**
2
+ * Module for managing logger control and configuration
3
+ * @module src/server/logger.js
4
+ * @namespace Logger
5
+ */
6
+
7
+ 'use strict';
8
+
9
+ import dotenv from 'dotenv';
10
+ import winston from 'winston';
11
+ import morgan from 'morgan';
12
+ import colorize from 'json-colorizer';
13
+ import colors from 'colors';
14
+ import v8 from 'v8';
15
+ import isAdmin from 'is-admin';
16
+ import { clearTerminalStringColor, formatBytes } from '../client/components/core/CommonJs.js';
17
+
18
+ colors.enable();
19
+ dotenv.config();
20
+
21
+ // Define your severity levels.
22
+ // With them, You can create log files,
23
+ // see or hide levels based on the running ENV.
24
+ const levels = {
25
+ error: 0,
26
+ warn: 1,
27
+ info: 2,
28
+ http: 3,
29
+ debug: 4,
30
+ };
31
+
32
+ // This method set the current severity based on
33
+ // the current NODE_ENV: show all the log levels
34
+ // if the server was run in development mode; otherwise,
35
+ // if it was run in production, show only warn and error messages.
36
+ const level = () => 'info'; // (process.env.NODE_ENV || 'development' ? 'debug' : 'warn');
37
+
38
+ // Define different colors for each level.
39
+ // Colors make the log message more visible,
40
+ // adding the ability to focus or ignore messages.
41
+
42
+ // Tell winston that you want to link the colors
43
+ // defined above to the severity levels.
44
+ winston.addColors({
45
+ error: 'red',
46
+ warn: 'yellow',
47
+ info: 'green',
48
+ http: 'magenta',
49
+ debug: 'white',
50
+ });
51
+
52
+ // Chose the aspect of your log customizing the log format.
53
+ const format = (meta) =>
54
+ winston.format.combine(
55
+ // winston.format.errors({ stack: true }),
56
+ // Add the message timestamp with the preferred format
57
+ winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss:ms' }),
58
+ // Tell Winston that the logs must be colored
59
+ winston.format.colorize({ all: true }),
60
+ // Define the format of the message showing the timestamp, the level and the message
61
+ winston.format.printf((info) => {
62
+ const symbols = Object.getOwnPropertySymbols(info);
63
+ return `${`[${meta}]`.green} ${info.timestamp} ${info.level} ${
64
+ symbols[1]
65
+ ? `${clearTerminalStringColor(info.message)}: ${colorize(JSON.stringify(info[symbols[1]][0], null, 4), {
66
+ colors: {
67
+ STRING_KEY: 'green',
68
+ STRING_LITERAL: 'magenta.bold',
69
+ NUMBER_LITERAL: '#FF0000',
70
+ },
71
+ })}`
72
+ : info.message
73
+ }`;
74
+ }),
75
+ );
76
+
77
+ /**
78
+ * Logs information about the current process environment to the console.
79
+ *
80
+ * This function is used to log details about
81
+ * the execution context, such as command-line arguments,
82
+ * environment variables, the process's administrative privileges,
83
+ * and the maximum available heap space size.
84
+ *
85
+ * @param {winston.Logger} logger - A pre-configured Winston logger object.
86
+ * @memberof Logger
87
+ */
88
+ const setUpInfo = async (logger = new winston.Logger()) => {
89
+ logger.info('argv', process.argv);
90
+ logger.info('env', process.env.NODE_ENV);
91
+ logger.info('admin', await isAdmin());
92
+ logger.info('--max-old-space-size', {
93
+ total_available_size: formatBytes(v8.getHeapStatistics().total_available_size),
94
+ });
95
+ };
96
+
97
+ /**
98
+ * The function `loggerFactory` creates a logger instance with specified transports for printing out
99
+ * messages.
100
+ * @param meta - The `meta` parameter in the `loggerFactory` function is used to extract the last part
101
+ * of a URL and use it to create log files in a specific directory.
102
+ * @returns {winston.Logger} The `loggerFactory` function returns a logger instance created using Winston logger
103
+ * library. The logger instance is configured with various transports for printing out messages to
104
+ * different destinations such as the terminal, error.log file, and all.log file. The logger instance
105
+ * also has a method `setUpInfo` attached to it for setting up additional information.
106
+ * @memberof Logger
107
+ */
108
+ const loggerFactory = (meta = { url: '' }) => {
109
+ meta = meta.url.split('/').pop();
110
+ // Define which transports the logger must use to print out messages.
111
+ // In this example, we are using three different transports
112
+ const transports = [
113
+ // Allow the use the terminal to print the messages
114
+ new winston.transports.Console(),
115
+ // Allow to print all the error level messages inside the error.log file
116
+ new winston.transports.File({
117
+ filename: `logs/${meta}/error.log`,
118
+ level: 'error',
119
+ }),
120
+ // Allow to print all the error message inside the all.log file
121
+ // (also the error log that are also printed inside the error.log(
122
+ new winston.transports.File({ filename: `logs/${meta}/all.log` }),
123
+ ];
124
+
125
+ // Create the logger instance that has to be exported
126
+ // and used to log messages.
127
+ const logger = winston.createLogger({
128
+ defaultMeta: meta,
129
+ level: level(),
130
+ levels,
131
+ format: format(meta),
132
+ transports,
133
+ // exceptionHandlers: [new winston.transports.File({ filename: 'exceptions.log' })],
134
+ // rejectionHandlers: [new winston.transports.File({ filename: 'rejections.log' })],
135
+ // exitOnError: false,
136
+ });
137
+ logger.setUpInfo = async () => {
138
+ await setUpInfo(logger);
139
+ };
140
+ return logger;
141
+ };
142
+
143
+ /**
144
+ * The `loggerMiddleware` function creates a middleware for logging HTTP requests using Morgan with
145
+ * custom message format and options.
146
+ * @param meta - The `meta` parameter in the `loggerMiddleware` function is an object that contains
147
+ * information about the request URL. It has a default value of an empty object `{ url: '' }`. This
148
+ * object is used to provide additional metadata for logging purposes.
149
+ * @returns {Handler<any, any>} The `loggerMiddleware` function returns a middleware function that uses the Morgan library
150
+ * to log HTTP request information. The middleware function formats the log message using predefined
151
+ * tokens provided by Morgan and custom tokens like `:host` to include specific request details. The
152
+ * log message format includes information such as remote address, HTTP method, host, URL, status code,
153
+ * content length, and response time in milliseconds. The middleware
154
+ * @memberof Logger
155
+ */
156
+ const loggerMiddleware = (meta = { url: '' }) => {
157
+ const stream = {
158
+ // Use the http severity
159
+ write: (message) => loggerFactory(meta).http(message),
160
+ };
161
+
162
+ const skip = (req, res) => process.env.NODE_ENV === 'production';
163
+
164
+ morgan.token('host', function (req, res) {
165
+ return req.headers['host'];
166
+ });
167
+
168
+ return morgan(
169
+ // Define message format string (this is the default one).
170
+ // The message format is made from tokens, and each token is
171
+ // defined inside the Morgan library.
172
+ // You can create your custom token to show what do you want from a request.
173
+ `:remote-addr :method :host:url :status :res[content-length] - :response-time ms`,
174
+ // Options: in this case, I overwrote the stream and the skip logic.
175
+ // See the methods above.
176
+ { stream, skip },
177
+ );
178
+ };
179
+
180
+ export { loggerFactory, loggerMiddleware, setUpInfo };