apitally 0.11.5 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (101) hide show
  1. package/README.md +43 -2
  2. package/dist/adonisjs/index.cjs +41 -0
  3. package/dist/adonisjs/index.cjs.map +1 -0
  4. package/dist/adonisjs/index.d.cts +14 -0
  5. package/dist/adonisjs/index.d.ts +14 -0
  6. package/dist/adonisjs/index.js +17 -0
  7. package/dist/adonisjs/index.js.map +1 -0
  8. package/dist/adonisjs/middleware.cjs +214 -0
  9. package/dist/adonisjs/middleware.cjs.map +1 -0
  10. package/dist/adonisjs/middleware.d.cts +21 -0
  11. package/dist/adonisjs/middleware.d.ts +21 -0
  12. package/dist/adonisjs/middleware.js +185 -0
  13. package/dist/adonisjs/middleware.js.map +1 -0
  14. package/dist/adonisjs/provider.cjs +1083 -0
  15. package/dist/adonisjs/provider.cjs.map +1 -0
  16. package/dist/adonisjs/provider.d.cts +28 -0
  17. package/dist/adonisjs/provider.d.ts +28 -0
  18. package/dist/adonisjs/provider.js +1057 -0
  19. package/dist/adonisjs/provider.js.map +1 -0
  20. package/dist/common/client.cjs +117 -106
  21. package/dist/common/client.cjs.map +1 -1
  22. package/dist/common/client.js +112 -101
  23. package/dist/common/client.js.map +1 -1
  24. package/dist/common/consumerRegistry.cjs.map +1 -1
  25. package/dist/common/consumerRegistry.js.map +1 -1
  26. package/dist/common/logging.cjs.map +1 -1
  27. package/dist/common/logging.js.map +1 -1
  28. package/dist/common/packageVersions.cjs.map +1 -1
  29. package/dist/common/packageVersions.js.map +1 -1
  30. package/dist/common/paramValidation.cjs.map +1 -1
  31. package/dist/common/paramValidation.js.map +1 -1
  32. package/dist/common/requestCounter.cjs.map +1 -1
  33. package/dist/common/requestCounter.js.map +1 -1
  34. package/dist/common/requestLogger.cjs +55 -2
  35. package/dist/common/requestLogger.cjs.map +1 -1
  36. package/dist/common/requestLogger.d.cts +2 -1
  37. package/dist/common/requestLogger.d.ts +2 -1
  38. package/dist/common/requestLogger.js +55 -2
  39. package/dist/common/requestLogger.js.map +1 -1
  40. package/dist/common/sentry.cjs +55 -0
  41. package/dist/common/sentry.cjs.map +1 -0
  42. package/dist/common/sentry.d.cts +6 -0
  43. package/dist/common/sentry.d.ts +6 -0
  44. package/dist/common/sentry.js +22 -0
  45. package/dist/common/sentry.js.map +1 -0
  46. package/dist/common/serverErrorCounter.cjs +58 -45
  47. package/dist/common/serverErrorCounter.cjs.map +1 -1
  48. package/dist/common/serverErrorCounter.d.cts +3 -6
  49. package/dist/common/serverErrorCounter.d.ts +3 -6
  50. package/dist/common/serverErrorCounter.js +53 -45
  51. package/dist/common/serverErrorCounter.js.map +1 -1
  52. package/dist/common/tempGzipFile.cjs.map +1 -1
  53. package/dist/common/tempGzipFile.js.map +1 -1
  54. package/dist/common/types.cjs.map +1 -1
  55. package/dist/common/utils.cjs +48 -0
  56. package/dist/common/utils.cjs.map +1 -0
  57. package/dist/common/utils.d.cts +5 -0
  58. package/dist/common/utils.d.ts +5 -0
  59. package/dist/common/utils.js +25 -0
  60. package/dist/common/utils.js.map +1 -0
  61. package/dist/common/validationErrorCounter.cjs.map +1 -1
  62. package/dist/common/validationErrorCounter.js.map +1 -1
  63. package/dist/express/index.cjs +143 -111
  64. package/dist/express/index.cjs.map +1 -1
  65. package/dist/express/index.js +138 -106
  66. package/dist/express/index.js.map +1 -1
  67. package/dist/express/middleware.cjs +143 -111
  68. package/dist/express/middleware.cjs.map +1 -1
  69. package/dist/express/middleware.js +138 -106
  70. package/dist/express/middleware.js.map +1 -1
  71. package/dist/express/utils.cjs.map +1 -1
  72. package/dist/express/utils.js.map +1 -1
  73. package/dist/fastify/index.cjs +139 -112
  74. package/dist/fastify/index.cjs.map +1 -1
  75. package/dist/fastify/index.js +134 -107
  76. package/dist/fastify/index.js.map +1 -1
  77. package/dist/fastify/plugin.cjs +139 -112
  78. package/dist/fastify/plugin.cjs.map +1 -1
  79. package/dist/fastify/plugin.js +134 -107
  80. package/dist/fastify/plugin.js.map +1 -1
  81. package/dist/hono/index.cjs +138 -108
  82. package/dist/hono/index.cjs.map +1 -1
  83. package/dist/hono/index.js +133 -103
  84. package/dist/hono/index.js.map +1 -1
  85. package/dist/hono/middleware.cjs +138 -108
  86. package/dist/hono/middleware.cjs.map +1 -1
  87. package/dist/hono/middleware.js +133 -103
  88. package/dist/hono/middleware.js.map +1 -1
  89. package/dist/koa/index.cjs +122 -109
  90. package/dist/koa/index.cjs.map +1 -1
  91. package/dist/koa/index.js +117 -104
  92. package/dist/koa/index.js.map +1 -1
  93. package/dist/koa/middleware.cjs +122 -109
  94. package/dist/koa/middleware.cjs.map +1 -1
  95. package/dist/koa/middleware.js +117 -104
  96. package/dist/koa/middleware.js.map +1 -1
  97. package/dist/nestjs/index.cjs +143 -111
  98. package/dist/nestjs/index.cjs.map +1 -1
  99. package/dist/nestjs/index.js +138 -106
  100. package/dist/nestjs/index.js.map +1 -1
  101. package/package.json +46 -1
@@ -213,14 +213,116 @@ var RequestCounter = _RequestCounter;
213
213
  // src/common/requestLogger.ts
214
214
  var import_async_lock = __toESM(require("async-lock"), 1);
215
215
  var import_buffer2 = require("buffer");
216
- var import_crypto2 = require("crypto");
216
+ var import_crypto3 = require("crypto");
217
217
  var import_fs2 = require("fs");
218
218
  var import_os2 = require("os");
219
219
  var import_path2 = require("path");
220
220
 
221
+ // src/common/sentry.ts
222
+ var sentry;
223
+ (async () => {
224
+ try {
225
+ sentry = await import("@sentry/node");
226
+ } catch (e) {
227
+ }
228
+ })();
229
+ function getSentryEventId() {
230
+ if (sentry && sentry.lastEventId) {
231
+ return sentry.lastEventId();
232
+ }
233
+ return void 0;
234
+ }
235
+ __name(getSentryEventId, "getSentryEventId");
236
+
237
+ // src/common/serverErrorCounter.ts
238
+ var import_crypto = require("crypto");
239
+ var MAX_MSG_LENGTH = 2048;
240
+ var MAX_STACKTRACE_LENGTH = 65536;
241
+ var _ServerErrorCounter = class _ServerErrorCounter {
242
+ errorCounts;
243
+ errorDetails;
244
+ sentryEventIds;
245
+ constructor() {
246
+ this.errorCounts = /* @__PURE__ */ new Map();
247
+ this.errorDetails = /* @__PURE__ */ new Map();
248
+ this.sentryEventIds = /* @__PURE__ */ new Map();
249
+ }
250
+ addServerError(serverError) {
251
+ const key = this.getKey(serverError);
252
+ if (!this.errorDetails.has(key)) {
253
+ this.errorDetails.set(key, serverError);
254
+ }
255
+ this.errorCounts.set(key, (this.errorCounts.get(key) || 0) + 1);
256
+ const sentryEventId = getSentryEventId();
257
+ if (sentryEventId) {
258
+ this.sentryEventIds.set(key, sentryEventId);
259
+ }
260
+ }
261
+ getAndResetServerErrors() {
262
+ const data = [];
263
+ this.errorCounts.forEach((count, key) => {
264
+ const serverError = this.errorDetails.get(key);
265
+ if (serverError) {
266
+ data.push({
267
+ consumer: serverError.consumer || null,
268
+ method: serverError.method,
269
+ path: serverError.path,
270
+ type: serverError.type,
271
+ msg: truncateExceptionMessage(serverError.msg),
272
+ traceback: truncateExceptionStackTrace(serverError.traceback),
273
+ sentry_event_id: this.sentryEventIds.get(key) || null,
274
+ error_count: count
275
+ });
276
+ }
277
+ });
278
+ this.errorCounts.clear();
279
+ this.errorDetails.clear();
280
+ return data;
281
+ }
282
+ getKey(serverError) {
283
+ const hashInput = [
284
+ serverError.consumer || "",
285
+ serverError.method.toUpperCase(),
286
+ serverError.path,
287
+ serverError.type,
288
+ serverError.msg.trim(),
289
+ serverError.traceback.trim()
290
+ ].join("|");
291
+ return (0, import_crypto.createHash)("md5").update(hashInput).digest("hex");
292
+ }
293
+ };
294
+ __name(_ServerErrorCounter, "ServerErrorCounter");
295
+ var ServerErrorCounter = _ServerErrorCounter;
296
+ function truncateExceptionMessage(msg) {
297
+ if (msg.length <= MAX_MSG_LENGTH) {
298
+ return msg;
299
+ }
300
+ const suffix = "... (truncated)";
301
+ const cutoff = MAX_MSG_LENGTH - suffix.length;
302
+ return msg.substring(0, cutoff) + suffix;
303
+ }
304
+ __name(truncateExceptionMessage, "truncateExceptionMessage");
305
+ function truncateExceptionStackTrace(stack) {
306
+ const suffix = "... (truncated) ...";
307
+ const cutoff = MAX_STACKTRACE_LENGTH - suffix.length;
308
+ const lines = stack.trim().split("\n");
309
+ const truncatedLines = [];
310
+ let length = 0;
311
+ for (const line of lines) {
312
+ if (length + line.length + 1 > cutoff) {
313
+ truncatedLines.push(suffix);
314
+ break;
315
+ }
316
+ truncatedLines.push(line);
317
+ length += line.length + 1;
318
+ }
319
+ return truncatedLines.join("\n");
320
+ }
321
+ __name(truncateExceptionStackTrace, "truncateExceptionStackTrace");
322
+
221
323
  // src/common/tempGzipFile.ts
222
324
  var import_buffer = require("buffer");
223
- var import_crypto = require("crypto");
325
+ var import_crypto2 = require("crypto");
224
326
  var import_fs = require("fs");
225
327
  var import_os = require("os");
226
328
  var import_path = require("path");
@@ -233,7 +335,7 @@ var _TempGzipFile = class _TempGzipFile {
233
335
  readyPromise;
234
336
  closedPromise;
235
337
  constructor() {
236
- this.uuid = (0, import_crypto.randomUUID)();
338
+ this.uuid = (0, import_crypto2.randomUUID)();
237
339
  this.filePath = (0, import_path.join)((0, import_os.tmpdir)(), `apitally-${this.uuid}.gz`);
238
340
  this.writeStream = (0, import_fs.createWriteStream)(this.filePath);
239
341
  this.readyPromise = new Promise((resolve, reject) => {
@@ -340,6 +442,7 @@ var DEFAULT_CONFIG = {
340
442
  logRequestBody: false,
341
443
  logResponseHeaders: true,
342
444
  logResponseBody: false,
445
+ logException: true,
343
446
  maskQueryParams: [],
344
447
  maskHeaders: [],
345
448
  excludePaths: []
@@ -412,7 +515,7 @@ var _RequestLogger = class _RequestLogger {
412
515
  this.shouldMaskHeader(k) ? MASKED : v
413
516
  ]);
414
517
  }
415
- logRequest(request, response) {
518
+ logRequest(request, response, error) {
416
519
  var _a2, _b, _c;
417
520
  if (!this.enabled || this.suspendUntil !== null) return;
418
521
  const url = new URL(request.url);
@@ -458,9 +561,15 @@ var _RequestLogger = class _RequestLogger {
458
561
  request.headers = this.config.logRequestHeaders ? this.maskHeaders(request.headers) : [];
459
562
  response.headers = this.config.logResponseHeaders ? this.maskHeaders(response.headers) : [];
460
563
  const item = {
461
- uuid: (0, import_crypto2.randomUUID)(),
564
+ uuid: (0, import_crypto3.randomUUID)(),
462
565
  request: skipEmptyValues(request),
463
- response: skipEmptyValues(response)
566
+ response: skipEmptyValues(response),
567
+ exception: error && this.config.logException ? {
568
+ type: error.name,
569
+ message: truncateExceptionMessage(error.message),
570
+ stacktrace: truncateExceptionStackTrace(error.stack || ""),
571
+ sentryEventId: getSentryEventId()
572
+ } : null
464
573
  };
465
574
  [
466
575
  item.request.body,
@@ -612,7 +721,7 @@ function skipEmptyValues(data) {
612
721
  __name(skipEmptyValues, "skipEmptyValues");
613
722
  function checkWritableFs() {
614
723
  try {
615
- const testPath = (0, import_path2.join)((0, import_os2.tmpdir)(), `apitally-${(0, import_crypto2.randomUUID)()}`);
724
+ const testPath = (0, import_path2.join)((0, import_os2.tmpdir)(), `apitally-${(0, import_crypto3.randomUUID)()}`);
616
725
  (0, import_fs2.writeFileSync)(testPath, "test");
617
726
  (0, import_fs2.unlinkSync)(testPath);
618
727
  return true;
@@ -622,104 +731,6 @@ function checkWritableFs() {
622
731
  }
623
732
  __name(checkWritableFs, "checkWritableFs");
624
733
 
625
- // src/common/serverErrorCounter.ts
626
- var import_crypto3 = require("crypto");
627
- var MAX_MSG_LENGTH = 2048;
628
- var MAX_STACKTRACE_LENGTH = 65536;
629
- var _ServerErrorCounter = class _ServerErrorCounter {
630
- errorCounts;
631
- errorDetails;
632
- sentryEventIds;
633
- sentry;
634
- constructor() {
635
- this.errorCounts = /* @__PURE__ */ new Map();
636
- this.errorDetails = /* @__PURE__ */ new Map();
637
- this.sentryEventIds = /* @__PURE__ */ new Map();
638
- this.tryImportSentry();
639
- }
640
- addServerError(serverError) {
641
- const key = this.getKey(serverError);
642
- if (!this.errorDetails.has(key)) {
643
- this.errorDetails.set(key, serverError);
644
- }
645
- this.errorCounts.set(key, (this.errorCounts.get(key) || 0) + 1);
646
- this.captureSentryEventId(key);
647
- }
648
- getAndResetServerErrors() {
649
- const data = [];
650
- this.errorCounts.forEach((count, key) => {
651
- const serverError = this.errorDetails.get(key);
652
- if (serverError) {
653
- data.push({
654
- consumer: serverError.consumer || null,
655
- method: serverError.method,
656
- path: serverError.path,
657
- type: serverError.type,
658
- msg: this.getTruncatedMessage(serverError.msg),
659
- traceback: this.getTruncatedStack(serverError.traceback),
660
- sentry_event_id: this.sentryEventIds.get(key) || null,
661
- error_count: count
662
- });
663
- }
664
- });
665
- this.errorCounts.clear();
666
- this.errorDetails.clear();
667
- return data;
668
- }
669
- getKey(serverError) {
670
- const hashInput = [
671
- serverError.consumer || "",
672
- serverError.method.toUpperCase(),
673
- serverError.path,
674
- serverError.type,
675
- serverError.msg.trim(),
676
- serverError.traceback.trim()
677
- ].join("|");
678
- return (0, import_crypto3.createHash)("md5").update(hashInput).digest("hex");
679
- }
680
- getTruncatedMessage(msg) {
681
- msg = msg.trim();
682
- if (msg.length <= MAX_MSG_LENGTH) {
683
- return msg;
684
- }
685
- const suffix = "... (truncated)";
686
- const cutoff = MAX_MSG_LENGTH - suffix.length;
687
- return msg.substring(0, cutoff) + suffix;
688
- }
689
- getTruncatedStack(stack) {
690
- const suffix = "... (truncated) ...";
691
- const cutoff = MAX_STACKTRACE_LENGTH - suffix.length;
692
- const lines = stack.trim().split("\n");
693
- const truncatedLines = [];
694
- let length = 0;
695
- for (const line of lines) {
696
- if (length + line.length + 1 > cutoff) {
697
- truncatedLines.push(suffix);
698
- break;
699
- }
700
- truncatedLines.push(line);
701
- length += line.length + 1;
702
- }
703
- return truncatedLines.join("\n");
704
- }
705
- captureSentryEventId(serverErrorKey) {
706
- if (this.sentry && this.sentry.lastEventId) {
707
- const eventId = this.sentry.lastEventId();
708
- if (eventId) {
709
- this.sentryEventIds.set(serverErrorKey, eventId);
710
- }
711
- }
712
- }
713
- async tryImportSentry() {
714
- try {
715
- this.sentry = await import("@sentry/node");
716
- } catch (e) {
717
- }
718
- }
719
- };
720
- __name(_ServerErrorCounter, "ServerErrorCounter");
721
- var ServerErrorCounter = _ServerErrorCounter;
722
-
723
734
  // src/common/validationErrorCounter.ts
724
735
  var import_crypto4 = require("crypto");
725
736
  var _ValidationErrorCounter = class _ValidationErrorCounter {
@@ -805,7 +816,7 @@ var _ApitallyClient = class _ApitallyClient {
805
816
  throw new Error("Apitally client is already initialized");
806
817
  }
807
818
  if (!isValidClientId(clientId)) {
808
- throw new Error(`Invalid client ID '${clientId}' (expecting hexadeciaml UUID format)`);
819
+ throw new Error(`Invalid Apitally client ID '${clientId}' (expecting hexadecimal UUID format)`);
809
820
  }
810
821
  if (!isValidEnv(env)) {
811
822
  throw new Error(`Invalid env '${env}' (expecting 1-32 alphanumeric lowercase characters and hyphens only)`);
@@ -1061,6 +1072,25 @@ function getPackageVersion(name) {
1061
1072
  }
1062
1073
  __name(getPackageVersion, "getPackageVersion");
1063
1074
 
1075
+ // src/common/utils.ts
1076
+ function parseContentLength(contentLength) {
1077
+ if (contentLength === void 0 || contentLength === null) {
1078
+ return void 0;
1079
+ }
1080
+ if (typeof contentLength === "number") {
1081
+ return contentLength;
1082
+ }
1083
+ if (typeof contentLength === "string") {
1084
+ const parsed = parseInt(contentLength);
1085
+ return isNaN(parsed) ? void 0 : parsed;
1086
+ }
1087
+ if (Array.isArray(contentLength)) {
1088
+ return parseContentLength(contentLength[0]);
1089
+ }
1090
+ return void 0;
1091
+ }
1092
+ __name(parseContentLength, "parseContentLength");
1093
+
1064
1094
  // src/express/utils.js
1065
1095
  var regExpToParseExpressPathRegExp = /^\/\^\\?\/?(?:(:?[\w\\.-]*(?:\\\/:?[\w\\.-]*)*)|(\(\?:\\?\/?\([^)]+\)\)))\\\/.*/;
1066
1096
  var regExpToReplaceExpressPathRegExpParams = /\(\?:\\?\/?\([^)]+\)\)/;
@@ -1226,6 +1256,8 @@ var getMiddleware = /* @__PURE__ */ __name((app, client) => {
1226
1256
  const path = getRoutePath(req);
1227
1257
  const consumer = getConsumer(req);
1228
1258
  client.consumerRegistry.addOrUpdateConsumer(consumer);
1259
+ const requestSize = parseContentLength(req.get("content-length"));
1260
+ const responseSize = parseContentLength(res.get("content-length"));
1229
1261
  if (path) {
1230
1262
  client.requestCounter.addRequest({
1231
1263
  consumer: consumer == null ? void 0 : consumer.identifier,
@@ -1233,8 +1265,8 @@ var getMiddleware = /* @__PURE__ */ __name((app, client) => {
1233
1265
  path,
1234
1266
  statusCode: res.statusCode,
1235
1267
  responseTime,
1236
- requestSize: req.get("content-length"),
1237
- responseSize: res.get("content-length")
1268
+ requestSize,
1269
+ responseSize
1238
1270
  });
1239
1271
  if ((res.statusCode === 400 || res.statusCode === 422) && res.locals.body) {
1240
1272
  let jsonBody;
@@ -1282,16 +1314,16 @@ var getMiddleware = /* @__PURE__ */ __name((app, client) => {
1282
1314
  path,
1283
1315
  url: `${req.protocol}://${req.host}${req.originalUrl}`,
1284
1316
  headers: convertHeaders(req.headers),
1285
- size: Number(req.get("content-length")),
1317
+ size: requestSize,
1286
1318
  consumer: consumer == null ? void 0 : consumer.identifier,
1287
1319
  body: convertBody(req.body, req.get("content-type"))
1288
1320
  }, {
1289
1321
  statusCode: res.statusCode,
1290
1322
  responseTime: responseTime / 1e3,
1291
1323
  headers: convertHeaders(res.getHeaders()),
1292
- size: Number(res.get("content-length")),
1324
+ size: responseSize,
1293
1325
  body: convertBody(res.locals.body, res.get("content-type"))
1294
- });
1326
+ }, res.locals.serverError);
1295
1327
  }
1296
1328
  } catch (error) {
1297
1329
  client.logger.error("Error while logging request in Apitally middleware.", {