apitally 0.25.7 → 1.0.0-alpha.1

package/dist/koa/middleware.cjs

@@ -3,7 +3,6 @@ var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -19,202 +18,94 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var middleware_exports = {};
 __export(middleware_exports, {
-  setConsumer: () => setConsumer,
-  useApitally: () => useApitally
+  installKoaMiddleware: () => installKoaMiddleware
 });
 module.exports = __toCommonJS(middleware_exports);
-var import_node_async_hooks = require("node:async_hooks");
-var import_client = require('../common/client.cjs');
-var import_consumerRegistry = require('../common/consumerRegistry.cjs');
-var import_packageVersions = require('../common/packageVersions.cjs');
-var import_requestLogger = require('../common/requestLogger.cjs');
-var import_loggers = require('../loggers/index.cjs');
-function useApitally(app, config) {
-  const client = new import_client.ApitallyClient(config);
-  const middleware = getMiddleware(client);
-  app.use(middleware);
-  const setStartupData = /* @__PURE__ */ __name((attempt = 1) => {
-    const appInfo = getAppInfo(app, config.appVersion);
-    if (appInfo.paths.length > 0 || attempt >= 10) {
-      client.setStartupData(appInfo);
-      client.startSync();
-    } else {
-      setTimeout(() => setStartupData(attempt + 1), 500);
-    }
-  }, "setStartupData");
-  setTimeout(() => setStartupData(), 500);
-}
-__name(useApitally, "useApitally");
-function getMiddleware(client) {
-  const logsContext = new import_node_async_hooks.AsyncLocalStorage();
-  if (client.requestLogger.config.captureLogs) {
-    (0, import_loggers.patchConsole)(logsContext);
-    (0, import_loggers.patchWinston)(logsContext);
+var import_api = require("@opentelemetry/api");
+var import_activation = require('../activation.cjs');
+var import_config = require('../config.cjs');
+var import_exceptions = require('../exceptions.cjs');
+var import_logger = require('../logger.cjs');
+var import_requestObservation = require('../requestObservation.cjs');
+var import_requestObservationNode = require('../requestObservationNode.cjs');
+var import_routes = require('./routes.cjs');
+const MIDDLEWARE_MARKER = /* @__PURE__ */ Symbol.for("apitally.koaMiddleware");
+const TRACER_NAME = "apitally.koa";
+function installKoaMiddleware(app) {
+  const markedApp = app;
+  if (markedApp[MIDDLEWARE_MARKER] === true) {
+    return;
   }
-  return async (ctx, next) => {
-    if (!client.isEnabled() || ctx.request.method.toUpperCase() === "OPTIONS") {
+  markedApp[MIDDLEWARE_MARKER] = true;
+  warnIfMiddlewareAlreadyRegistered(app);
+  app.use(async (ctx, next) => {
+    let started;
+    try {
+      started = observeRequest(ctx);
+    } catch (error) {
+      (0, import_logger.logWarning)(`Error in the Apitally middleware: ${String(error)}`);
+    }
+    if (!started) {
       await next();
       return;
     }
-    await logsContext.run([], async () => {
-      var _a;
-      let path;
-      let statusCode;
-      let serverError;
-      const startTime = performance.now();
-      const spanHandle = client.spanCollector.startSpan();
-      try {
-        await spanHandle.runInContext(next);
-      } catch (error) {
-        path = getPath(ctx);
-        statusCode = error.statusCode || error.status || 500;
-        if (path && statusCode === 500 && error instanceof Error) {
-          serverError = error;
-          client.serverErrorCounter.addServerError({
-            consumer: (_a = getConsumer(ctx)) == null ? void 0 : _a.identifier,
-            method: ctx.request.method,
-            path,
-            type: error.name,
-            msg: error.message,
-            traceback: error.stack || ""
-          });
-        }
-        throw error;
-      } finally {
-        const responseTime = performance.now() - startTime;
-        if (!path) {
-          path = getPath(ctx);
-        }
-        spanHandle.setName(`${ctx.request.method} ${path}`);
-        const spans = spanHandle.end();
-        const traceId = spanHandle.traceId;
-        const consumer = getConsumer(ctx);
-        client.consumerRegistry.addOrUpdateConsumer(consumer);
-        if (path) {
-          try {
-            client.requestCounter.addRequest({
-              consumer: consumer == null ? void 0 : consumer.identifier,
-              method: ctx.request.method,
-              path,
-              statusCode: statusCode || ctx.response.status,
-              responseTime,
-              requestSize: ctx.request.length,
-              responseSize: ctx.response.length
-            });
-          } catch (error) {
-            client.logger.error("Error while logging request in Apitally middleware.", {
-              context: ctx,
-              error
-            });
-          }
-        }
-        if (client.requestLogger.enabled) {
-          const logs = logsContext.getStore();
-          client.requestLogger.logRequest({
-            timestamp: Date.now() / 1e3,
-            method: ctx.request.method,
-            path,
-            url: ctx.request.href,
-            headers: (0, import_requestLogger.convertHeaders)(ctx.request.headers),
-            size: ctx.request.length,
-            consumer: consumer == null ? void 0 : consumer.identifier,
-            body: (0, import_requestLogger.convertBody)(ctx.request.body, ctx.request.get("content-type"))
-          }, {
-            statusCode: statusCode || ctx.response.status,
-            responseTime: responseTime / 1e3,
-            headers: (0, import_requestLogger.convertHeaders)(ctx.response.headers),
-            size: ctx.response.length,
-            body: (0, import_requestLogger.convertBody)(ctx.response.body, ctx.response.get("content-type"))
-          }, serverError, logs, spans, traceId);
-        }
+    try {
+      await import_api.context.with(started.requestContext, next);
+    } catch (error) {
+      const errorStatus = (0, import_exceptions.resolveErrorStatus)(error);
+      if (errorStatus === void 0 || errorStatus >= 500) {
+        import_api.context.with(started.requestContext, () => (0, import_exceptions.captureException)(error));
       }
-    });
-  };
-}
-__name(getMiddleware, "getMiddleware");
-function getPath(ctx) {
-  return ctx._matchedRoute || ctx.routePath;
-}
-__name(getPath, "getPath");
-function setConsumer(ctx, consumer) {
-  ctx.state.apitallyConsumer = consumer || void 0;
-}
-__name(setConsumer, "setConsumer");
-function getConsumer(ctx) {
-  if (ctx.state.apitallyConsumer) {
-    return (0, import_consumerRegistry.consumerFromStringOrObject)(ctx.state.apitallyConsumer);
-  } else if (ctx.state.consumerIdentifier) {
-    process.emitWarning("The consumerIdentifier property on the ctx.state object is deprecated. Use apitallyConsumer instead.", "DeprecationWarning");
-    return (0, import_consumerRegistry.consumerFromStringOrObject)(ctx.state.consumerIdentifier);
-  }
-  return null;
+      throw error;
+    } finally {
+      started.observation.route = (0, import_routes.resolveMatchedRoute)(ctx);
+    }
+  });
 }
-__name(getConsumer, "getConsumer");
-function getAppInfo(app, appVersion) {
-  const versions = [
-    [
-      "nodejs",
-      process.version.replace(/^v/, "")
-    ]
-  ];
-  const koaVersion = (0, import_packageVersions.getPackageVersion)("koa");
-  const apitallyVersion = (0, import_packageVersions.getPackageVersion)("../..");
-  if (koaVersion) {
-    versions.push([
-      "koa",
-      koaVersion
-    ]);
-  }
-  if (apitallyVersion) {
-    versions.push([
-      "apitally",
-      apitallyVersion
-    ]);
+function observeRequest(ctx) {
+  (0, import_activation.activate)();
+  if (!(0, import_activation.isActivated)()) {
+    return void 0;
   }
-  if (appVersion) {
-    versions.push([
-      "app",
-      appVersion
-    ]);
-  }
-  return {
-    paths: listEndpoints(app),
-    versions: Object.fromEntries(versions),
-    client: "js:koa"
-  };
-}
-__name(getAppInfo, "getAppInfo");
-function isKoaRouterMiddleware(middleware) {
-  return typeof middleware === "function" && middleware.router && Array.isArray(middleware.router.stack);
+  (0, import_requestObservationNode.registerServerCloseFlush)(ctx.req);
+  const started = (0, import_requestObservationNode.startNodeRequestObservation)({ request: ctx.req, tracerName: TRACER_NAME });
+  import_api.context.bind(started.requestContext, ctx.req);
+  import_api.context.bind(started.requestContext, ctx.res);
+  const observation = started.observation;
+  (0, import_requestObservationNode.captureNodeResponse)(
+    ctx.res,
+    (0, import_config.getConfig)().captureResponseBody && observation.requestRecord.dropReason === void 0,
+    observation.requestBodyCapture
+  ).then((completion) => {
+    (0, import_requestObservation.finalizeRequestObservation)({
+      observation,
+      completedAtMillis: completion.completedAtMillis,
+      statusCode: ctx.res.statusCode,
+      route: observation.route ?? (0, import_routes.resolveMatchedRoute)(ctx),
+      clientAddress: ctx.ip,
+      requestHeaders: ctx.req.headers,
+      responseHeaders: ctx.res.getHeaders(),
+      capturedRequestBody: completion.requestBody,
+      capturedResponseBody: completion
+    });
+  }).catch((error) => {
+    (0, import_logger.logWarning)(`Error in the Apitally middleware: ${String(error)}`);
+  });
+  return { observation, requestContext: started.requestContext };
 }
-__name(isKoaRouterMiddleware, "isKoaRouterMiddleware");
-function listEndpoints(app) {
-  const endpoints = [];
-  app.middleware.forEach((middleware) => {
-    if (isKoaRouterMiddleware(middleware)) {
-      middleware.router.stack.forEach((layer) => {
-        if (layer.methods && layer.methods.length > 0) {
-          layer.methods.forEach((method) => {
-            if (![
-              "HEAD",
-              "OPTIONS"
-            ].includes(method.toUpperCase())) {
-              endpoints.push({
-                method: method.toUpperCase(),
-                path: layer.path
-              });
-            }
-          });
-        }
-      });
+function warnIfMiddlewareAlreadyRegistered(app) {
+  try {
+    if (app.middleware.length > 0) {
+      (0, import_logger.logWarning)(
+        "useApitally() was called after middleware was registered on the Koa app, so earlier middleware may handle or consume requests before Apitally observes them. To resolve this, call useApitally() immediately after creating the app, before registering middleware and routes."
+      );
     }
-  });
-  return endpoints;
+  } catch (error) {
+    (0, import_logger.logDebug)(`Error inspecting the koa app's middleware: ${String(error)}`);
+  }
 }
-__name(listEndpoints, "listEndpoints");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  setConsumer,
-  useApitally
+  installKoaMiddleware
 });
 //# sourceMappingURL=middleware.cjs.map

package/dist/koa/middleware.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/koa/middleware.ts"],"sourcesContent":["import Koa from \"koa\";\nimport { AsyncLocalStorage } from \"node:async_hooks\";\n\nimport { ApitallyClient } from \"../common/client.js\";\nimport { consumerFromStringOrObject } from \"../common/consumerRegistry.js\";\nimport { getPackageVersion } from \"../common/packageVersions.js\";\nimport type { LogRecord } from \"../common/requestLogger.js\";\nimport { convertBody, convertHeaders } from \"../common/requestLogger.js\";\nimport {\n  ApitallyConfig,\n  ApitallyConsumer,\n  PathInfo,\n  StartupData,\n} from \"../common/types.js\";\nimport { patchConsole, patchWinston } from \"../loggers/index.js\";\n\nexport function useApitally(app: Koa, config: ApitallyConfig) {\n  const client = new ApitallyClient(config);\n  const middleware = getMiddleware(client);\n  app.use(middleware);\n\n  const setStartupData = (attempt: number = 1) => {\n    const appInfo = getAppInfo(app, config.appVersion);\n    if (appInfo.paths.length > 0 || attempt >= 10) {\n      client.setStartupData(appInfo);\n      client.startSync();\n    } else {\n      setTimeout(() => setStartupData(attempt + 1), 500);\n    }\n  };\n  setTimeout(() => setStartupData(), 500);\n}\n\nfunction getMiddleware(client: ApitallyClient) {\n  const logsContext = new AsyncLocalStorage<LogRecord[]>();\n\n  if (client.requestLogger.config.captureLogs) {\n    patchConsole(logsContext);\n    patchWinston(logsContext);\n  }\n\n  return async (ctx: Koa.Context, next: Koa.Next) => {\n    if (!client.isEnabled() || ctx.request.method.toUpperCase() === \"OPTIONS\") {\n      await next();\n      return;\n    }\n\n    await logsContext.run([], async () => {\n      let path: string | undefined;\n      let statusCode: number | undefined;\n      let serverError: Error | undefined;\n      const startTime = performance.now();\n      const spanHandle = client.spanCollector.startSpan();\n      try {\n        await spanHandle.runInContext(next);\n      } catch (error: any) {\n        path = getPath(ctx);\n        statusCode = error.statusCode || error.status || 500;\n        if (path && statusCode === 500 && error instanceof Error) {\n          serverError = error;\n          client.serverErrorCounter.addServerError({\n            consumer: getConsumer(ctx)?.identifier,\n            method: ctx.request.method,\n            path,\n            type: error.name,\n            msg: error.message,\n            traceback: error.stack || \"\",\n          });\n        }\n        throw error;\n      } finally {\n        const responseTime = performance.now() - startTime;\n\n        if (!path) {\n          path = getPath(ctx);\n        }\n\n        spanHandle.setName(`${ctx.request.method} ${path}`);\n        const spans = spanHandle.end();\n        const traceId = spanHandle.traceId;\n\n        const consumer = getConsumer(ctx);\n        client.consumerRegistry.addOrUpdateConsumer(consumer);\n\n        if (path) {\n          try {\n            client.requestCounter.addRequest({\n              consumer: consumer?.identifier,\n              method: ctx.request.method,\n              path,\n              statusCode: statusCode || ctx.response.status,\n              responseTime,\n              requestSize: ctx.request.length,\n              responseSize: ctx.response.length,\n            });\n          } catch (error) {\n            client.logger.error(\n              \"Error while logging request in Apitally middleware.\",\n              { context: ctx, error },\n            );\n          }\n        }\n\n        if (client.requestLogger.enabled) {\n          const logs = logsContext.getStore();\n          client.requestLogger.logRequest(\n            {\n              timestamp: Date.now() / 1000,\n              method: ctx.request.method,\n              path,\n              url: ctx.request.href,\n              headers: convertHeaders(ctx.request.headers),\n              size: ctx.request.length,\n              consumer: consumer?.identifier,\n              body: convertBody(\n                ctx.request.body,\n                ctx.request.get(\"content-type\"),\n              ),\n            },\n            {\n              statusCode: statusCode || ctx.response.status,\n              responseTime: responseTime / 1000,\n              headers: convertHeaders(ctx.response.headers),\n              size: ctx.response.length,\n              body: convertBody(\n                ctx.response.body,\n                ctx.response.get(\"content-type\"),\n              ),\n            },\n            serverError,\n            logs,\n            spans,\n            traceId,\n          );\n        }\n      }\n    });\n  };\n}\n\nfunction getPath(ctx: Koa.Context) {\n  return ctx._matchedRoute || ctx.routePath; // _matchedRoute is set by koa-router, routePath is set by koa-route\n}\n\nexport function setConsumer(\n  ctx: Koa.Context,\n  consumer: ApitallyConsumer | string | null | undefined,\n) {\n  ctx.state.apitallyConsumer = consumer || undefined;\n}\n\nfunction getConsumer(ctx: Koa.Context) {\n  if (ctx.state.apitallyConsumer) {\n    return consumerFromStringOrObject(ctx.state.apitallyConsumer);\n  } else if (ctx.state.consumerIdentifier) {\n    // For backwards compatibility\n    process.emitWarning(\n      \"The consumerIdentifier property on the ctx.state object is deprecated. Use apitallyConsumer instead.\",\n      \"DeprecationWarning\",\n    );\n    return consumerFromStringOrObject(ctx.state.consumerIdentifier);\n  }\n  return null;\n}\n\nfunction getAppInfo(app: Koa, appVersion?: string): StartupData {\n  const versions: Array<[string, string]> = [\n    [\"nodejs\", process.version.replace(/^v/, \"\")],\n  ];\n  const koaVersion = getPackageVersion(\"koa\");\n  const apitallyVersion = getPackageVersion(\"../..\");\n  if (koaVersion) {\n    versions.push([\"koa\", koaVersion]);\n  }\n  if (apitallyVersion) {\n    versions.push([\"apitally\", apitallyVersion]);\n  }\n  if (appVersion) {\n    versions.push([\"app\", appVersion]);\n  }\n  return {\n    paths: listEndpoints(app),\n    versions: Object.fromEntries(versions),\n    client: \"js:koa\",\n  };\n}\n\nfunction isKoaRouterMiddleware(middleware: any) {\n  return (\n    typeof middleware === \"function\" &&\n    middleware.router &&\n    Array.isArray(middleware.router.stack)\n  );\n}\n\nfunction listEndpoints(app: Koa) {\n  const endpoints: Array<PathInfo> = [];\n  app.middleware.forEach((middleware: any) => {\n    if (isKoaRouterMiddleware(middleware)) {\n      middleware.router.stack.forEach((layer: any) => {\n        if (layer.methods && layer.methods.length > 0) {\n          layer.methods.forEach((method: string) => {\n            if (![\"HEAD\", \"OPTIONS\"].includes(method.toUpperCase())) {\n              endpoints.push({\n                method: method.toUpperCase(),\n                path: layer.path,\n              });\n            }\n          });\n        }\n      });\n    }\n  });\n  return endpoints;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AACA;;;;;;AAAA,8BAAkC;AAElC,oBAA+B;AAC/B,8BAA2C;AAC3C,6BAAkC;AAElC,2BAA4C;AAO5C,qBAA2C;AAEpC,SAASA,YAAYC,KAAUC,QAAsB;AAC1D,QAAMC,SAAS,IAAIC,6BAAeF,MAAAA;AAClC,QAAMG,aAAaC,cAAcH,MAAAA;AACjCF,MAAIM,IAAIF,UAAAA;AAER,QAAMG,iBAAiB,wBAACC,UAAkB,MAAC;AACzC,UAAMC,UAAUC,WAAWV,KAAKC,OAAOU,UAAU;AACjD,QAAIF,QAAQG,MAAMC,SAAS,KAAKL,WAAW,IAAI;AAC7CN,aAAOK,eAAeE,OAAAA;AACtBP,aAAOY,UAAS;IAClB,OAAO;AACLC,iBAAW,MAAMR,eAAeC,UAAU,CAAA,GAAI,GAAA;IAChD;EACF,GARuB;AASvBO,aAAW,MAAMR,eAAAA,GAAkB,GAAA;AACrC;AAfgBR;AAiBhB,SAASM,cAAcH,QAAsB;AAC3C,QAAMc,cAAc,IAAIC,0CAAAA;AAExB,MAAIf,OAAOgB,cAAcjB,OAAOkB,aAAa;AAC3CC,qCAAaJ,WAAAA;AACbK,qCAAaL,WAAAA;EACf;AAEA,SAAO,OAAOM,KAAkBC,SAAAA;AAC9B,QAAI,CAACrB,OAAOsB,UAAS,KAAMF,IAAIG,QAAQC,OAAOC,YAAW,MAAO,WAAW;AACzE,YAAMJ,KAAAA;AACN;IACF;AAEA,UAAMP,YAAYY,IAAI,CAAA,GAAI,YAAA;AA9C9B;AA+CM,UAAIC;AACJ,UAAIC;AACJ,UAAIC;AACJ,YAAMC,YAAYC,YAAYC,IAAG;AACjC,YAAMC,aAAajC,OAAOkC,cAAcC,UAAS;AACjD,UAAI;AACF,cAAMF,WAAWG,aAAaf,IAAAA;MAChC,SAASgB,OAAY;AACnBV,eAAOW,QAAQlB,GAAAA;AACfQ,qBAAaS,MAAMT,cAAcS,MAAME,UAAU;AACjD,YAAIZ,QAAQC,eAAe,OAAOS,iBAAiBG,OAAO;AACxDX,wBAAcQ;AACdrC,iBAAOyC,mBAAmBC,eAAe;YACvCC,WAAUC,iBAAYxB,GAAAA,MAAZwB,mBAAkBC;YAC5BrB,QAAQJ,IAAIG,QAAQC;YACpBG;YACAmB,MAAMT,MAAMU;YACZC,KAAKX,MAAMY;YACXC,WAAWb,MAAMc,SAAS;UAC5B,CAAA;QACF;AACA,cAAMd;MACR,UAAA;AACE,cAAMe,eAAerB,YAAYC,IAAG,IAAKF;AAEzC,YAAI,CAACH,MAAM;AACTA,iBAAOW,QAAQlB,GAAAA;QACjB;AAEAa,mBAAWoB,QAAQ,GAAGjC,IAAIG,QAAQC,MAAM,IAAIG,IAAAA,EAAM;AAClD,cAAM2B,QAAQrB,WAAWsB,IAAG;AAC5B,cAAMC,UAAUvB,WAAWuB;AAE3B,cAAMb,WAAWC,YAAYxB,GAAAA;AAC7BpB,eAAOyD,iBAAiBC,oBAAoBf,QAAAA;AAE5C,YAAIhB,MAAM;AACR,cAAI;AACF3B,mBAAO2D,eAAeC,WAAW;cAC/BjB,UAAUA,qCAAUE;cACpBrB,QAAQJ,IAAIG,QAAQC;cACpBG;cACAC,YAAYA,cAAcR,IAAIyC,SAAStB;cACvCa;cACAU,aAAa1C,IAAIG,QAAQZ;cACzBoD,cAAc3C,IAAIyC,SAASlD;YAC7B,CAAA;UACF,SAAS0B,OAAO;AACdrC,mBAAOgE,OAAO3B,MACZ,uDACA;cAAE4B,SAAS7C;cAAKiB;YAAM,CAAA;UAE1B;QACF;AAEA,YAAIrC,OAAOgB,cAAckD,SAAS;AAChC,gBAAMC,OAAOrD,YAAYsD,SAAQ;AACjCpE,iBAAOgB,cAAcqD,WACnB;YACEC,WAAWC,KAAKvC,IAAG,IAAK;YACxBR,QAAQJ,IAAIG,QAAQC;YACpBG;YACA6C,KAAKpD,IAAIG,QAAQkD;YACjBC,aAASC,qCAAevD,IAAIG,QAAQmD,OAAO;YAC3CE,MAAMxD,IAAIG,QAAQZ;YAClBgC,UAAUA,qCAAUE;YACpBgC,UAAMC,kCACJ1D,IAAIG,QAAQsD,MACZzD,IAAIG,QAAQwD,IAAI,cAAA,CAAA;UAEpB,GACA;YACEnD,YAAYA,cAAcR,IAAIyC,SAAStB;YACvCa,cAAcA,eAAe;YAC7BsB,aAASC,qCAAevD,IAAIyC,SAASa,OAAO;YAC5CE,MAAMxD,IAAIyC,SAASlD;YACnBkE,UAAMC,kCACJ1D,IAAIyC,SAASgB,MACbzD,IAAIyC,SAASkB,IAAI,cAAA,CAAA;UAErB,GACAlD,aACAsC,MACAb,OACAE,OAAAA;QAEJ;MACF;IACF,CAAA;EACF;AACF;AAzGSrD;AA2GT,SAASmC,QAAQlB,KAAgB;AAC/B,SAAOA,IAAI4D,iBAAiB5D,IAAI6D;AAClC;AAFS3C;AAIF,SAAS4C,YACd9D,KACAuB,UAAsD;AAEtDvB,MAAI+D,MAAMC,mBAAmBzC,YAAY0C;AAC3C;AALgBH;AAOhB,SAAStC,YAAYxB,KAAgB;AACnC,MAAIA,IAAI+D,MAAMC,kBAAkB;AAC9B,eAAOE,oDAA2BlE,IAAI+D,MAAMC,gBAAgB;EAC9D,WAAWhE,IAAI+D,MAAMI,oBAAoB;AAEvCC,YAAQC,YACN,wGACA,oBAAA;AAEF,eAAOH,oDAA2BlE,IAAI+D,MAAMI,kBAAkB;EAChE;AACA,SAAO;AACT;AAZS3C;AAcT,SAASpC,WAAWV,KAAUW,YAAmB;AAC/C,QAAMiF,WAAoC;IACxC;MAAC;MAAUF,QAAQG,QAAQC,QAAQ,MAAM,EAAA;;;AAE3C,QAAMC,iBAAaC,0CAAkB,KAAA;AACrC,QAAMC,sBAAkBD,0CAAkB,OAAA;AAC1C,MAAID,YAAY;AACdH,aAASM,KAAK;MAAC;MAAOH;KAAW;EACnC;AACA,MAAIE,iBAAiB;AACnBL,aAASM,KAAK;MAAC;MAAYD;KAAgB;EAC7C;AACA,MAAItF,YAAY;AACdiF,aAASM,KAAK;MAAC;MAAOvF;KAAW;EACnC;AACA,SAAO;IACLC,OAAOuF,cAAcnG,GAAAA;IACrB4F,UAAUQ,OAAOC,YAAYT,QAAAA;IAC7B1F,QAAQ;EACV;AACF;AApBSQ;AAsBT,SAAS4F,sBAAsBlG,YAAe;AAC5C,SACE,OAAOA,eAAe,cACtBA,WAAWmG,UACXC,MAAMC,QAAQrG,WAAWmG,OAAOlD,KAAK;AAEzC;AANSiD;AAQT,SAASH,cAAcnG,KAAQ;AAC7B,QAAM0G,YAA6B,CAAA;AACnC1G,MAAII,WAAWuG,QAAQ,CAACvG,eAAAA;AACtB,QAAIkG,sBAAsBlG,UAAAA,GAAa;AACrCA,iBAAWmG,OAAOlD,MAAMsD,QAAQ,CAACC,UAAAA;AAC/B,YAAIA,MAAMC,WAAWD,MAAMC,QAAQhG,SAAS,GAAG;AAC7C+F,gBAAMC,QAAQF,QAAQ,CAACjF,WAAAA;AACrB,gBAAI,CAAC;cAAC;cAAQ;cAAWoF,SAASpF,OAAOC,YAAW,CAAA,GAAK;AACvD+E,wBAAUR,KAAK;gBACbxE,QAAQA,OAAOC,YAAW;gBAC1BE,MAAM+E,MAAM/E;cACd,CAAA;YACF;UACF,CAAA;QACF;MACF,CAAA;IACF;EACF,CAAA;AACA,SAAO6E;AACT;AAnBSP;","names":["useApitally","app","config","client","ApitallyClient","middleware","getMiddleware","use","setStartupData","attempt","appInfo","getAppInfo","appVersion","paths","length","startSync","setTimeout","logsContext","AsyncLocalStorage","requestLogger","captureLogs","patchConsole","patchWinston","ctx","next","isEnabled","request","method","toUpperCase","run","path","statusCode","serverError","startTime","performance","now","spanHandle","spanCollector","startSpan","runInContext","error","getPath","status","Error","serverErrorCounter","addServerError","consumer","getConsumer","identifier","type","name","msg","message","traceback","stack","responseTime","setName","spans","end","traceId","consumerRegistry","addOrUpdateConsumer","requestCounter","addRequest","response","requestSize","responseSize","logger","context","enabled","logs","getStore","logRequest","timestamp","Date","url","href","headers","convertHeaders","size","body","convertBody","get","_matchedRoute","routePath","setConsumer","state","apitallyConsumer","undefined","consumerFromStringOrObject","consumerIdentifier","process","emitWarning","versions","version","replace","koaVersion","getPackageVersion","apitallyVersion","push","listEndpoints","Object","fromEntries","isKoaRouterMiddleware","router","Array","isArray","endpoints","forEach","layer","methods","includes"]}
+{"version":3,"sources":["../../src/koa/middleware.ts"],"sourcesContent":["import { type Context, context } from \"@opentelemetry/api\";\n\nimport type Koa = require(\"koa\");\n\nimport { activate, isActivated } from \"../activation.js\";\nimport { getConfig } from \"../config.js\";\nimport { captureException, resolveErrorStatus } from \"../exceptions.js\";\nimport { logDebug, logWarning } from \"../logger.js\";\nimport { finalizeRequestObservation } from \"../requestObservation.js\";\nimport {\n  captureNodeResponse,\n  type NodeRequestObservation,\n  registerServerCloseFlush,\n  startNodeRequestObservation,\n} from \"../requestObservationNode.js\";\nimport { resolveMatchedRoute } from \"./routes.js\";\n\nconst MIDDLEWARE_MARKER = Symbol.for(\"apitally.koaMiddleware\");\nconst TRACER_NAME = \"apitally.koa\";\n\ninterface KoaRequestObservation extends NodeRequestObservation {\n  route?: string;\n}\n\ninterface ObservedRequestStart {\n  observation: KoaRequestObservation;\n  requestContext: Context;\n}\n\nexport function installKoaMiddleware(app: Koa): void {\n  const markedApp = app as unknown as Record<symbol, boolean | undefined>;\n  if (markedApp[MIDDLEWARE_MARKER] === true) {\n    return;\n  }\n  markedApp[MIDDLEWARE_MARKER] = true;\n  warnIfMiddlewareAlreadyRegistered(app);\n\n  app.use(async (ctx, next) => {\n    let started: ObservedRequestStart | undefined;\n    try {\n      started = observeRequest(ctx);\n    } catch (error) {\n      logWarning(`Error in the Apitally middleware: ${String(error)}`);\n    }\n    if (!started) {\n      await next();\n      return;\n    }\n\n    try {\n      await context.with(started.requestContext, next);\n    } catch (error) {\n      const errorStatus = resolveErrorStatus(error);\n      if (errorStatus === undefined || errorStatus >= 500) {\n        context.with(started.requestContext, () => captureException(error));\n      }\n      throw error;\n    } finally {\n      started.observation.route = resolveMatchedRoute(ctx);\n    }\n  });\n}\n\nfunction observeRequest(ctx: Koa.Context): ObservedRequestStart | undefined {\n  activate();\n  if (!isActivated()) {\n    return undefined;\n  }\n  registerServerCloseFlush(ctx.req);\n  const started = startNodeRequestObservation({ request: ctx.req, tracerName: TRACER_NAME });\n  context.bind(started.requestContext, ctx.req);\n  context.bind(started.requestContext, ctx.res);\n  const observation: KoaRequestObservation = started.observation;\n  captureNodeResponse(\n    ctx.res,\n    getConfig().captureResponseBody && observation.requestRecord.dropReason === undefined,\n    observation.requestBodyCapture,\n  )\n    .then((completion) => {\n      finalizeRequestObservation({\n        observation,\n        completedAtMillis: completion.completedAtMillis,\n        statusCode: ctx.res.statusCode,\n        route: observation.route ?? resolveMatchedRoute(ctx),\n        clientAddress: ctx.ip,\n        requestHeaders: ctx.req.headers,\n        responseHeaders: ctx.res.getHeaders(),\n        capturedRequestBody: completion.requestBody,\n        capturedResponseBody: completion,\n      });\n    })\n    .catch((error: unknown) => {\n      logWarning(`Error in the Apitally middleware: ${String(error)}`);\n    });\n  return { observation, requestContext: started.requestContext };\n}\n\nfunction warnIfMiddlewareAlreadyRegistered(app: Koa): void {\n  try {\n    if (app.middleware.length > 0) {\n      logWarning(\n        \"useApitally() was called after middleware was registered on the Koa app, so earlier middleware may handle or consume requests before Apitally observes them. To resolve this, call useApitally() immediately after creating the app, before registering middleware and routes.\",\n      );\n    }\n  } catch (error) {\n    logDebug(`Error inspecting the koa app's middleware: ${String(error)}`);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,iBAAsC;AAItC,wBAAsC;AACtC,oBAA0B;AAC1B,wBAAqD;AACrD,oBAAqC;AACrC,gCAA2C;AAC3C,oCAKO;AACP,oBAAoC;AAEpC,MAAM,oBAAoB,uBAAO,IAAI,wBAAwB;AAC7D,MAAM,cAAc;AAWb,SAAS,qBAAqB,KAAgB;AACnD,QAAM,YAAY;AAClB,MAAI,UAAU,iBAAiB,MAAM,MAAM;AACzC;AAAA,EACF;AACA,YAAU,iBAAiB,IAAI;AAC/B,oCAAkC,GAAG;AAErC,MAAI,IAAI,OAAO,KAAK,SAAS;AAC3B,QAAI;AACJ,QAAI;AACF,gBAAU,eAAe,GAAG;AAAA,IAC9B,SAAS,OAAO;AACd,oCAAW,qCAAqC,OAAO,KAAK,CAAC,EAAE;AAAA,IACjE;AACA,QAAI,CAAC,SAAS;AACZ,YAAM,KAAK;AACX;AAAA,IACF;AAEA,QAAI;AACF,YAAM,mBAAQ,KAAK,QAAQ,gBAAgB,IAAI;AAAA,IACjD,SAAS,OAAO;AACd,YAAM,kBAAc,sCAAmB,KAAK;AAC5C,UAAI,gBAAgB,UAAa,eAAe,KAAK;AACnD,2BAAQ,KAAK,QAAQ,gBAAgB,UAAM,oCAAiB,KAAK,CAAC;AAAA,MACpE;AACA,YAAM;AAAA,IACR,UAAE;AACA,cAAQ,YAAY,YAAQ,mCAAoB,GAAG;AAAA,IACrD;AAAA,EACF,CAAC;AACH;AAEA,SAAS,eAAe,KAAoD;AAC1E,kCAAS;AACT,MAAI,KAAC,+BAAY,GAAG;AAClB,WAAO;AAAA,EACT;AACA,8DAAyB,IAAI,GAAG;AAChC,QAAM,cAAU,2DAA4B,EAAE,SAAS,IAAI,KAAK,YAAY,YAAY,CAAC;AACzF,qBAAQ,KAAK,QAAQ,gBAAgB,IAAI,GAAG;AAC5C,qBAAQ,KAAK,QAAQ,gBAAgB,IAAI,GAAG;AAC5C,QAAM,cAAqC,QAAQ;AACnD;AAAA,IACE,IAAI;AAAA,QACJ,yBAAU,EAAE,uBAAuB,YAAY,cAAc,eAAe;AAAA,IAC5E,YAAY;AAAA,EACd,EACG,KAAK,CAAC,eAAe;AACpB,8DAA2B;AAAA,MACzB;AAAA,MACA,mBAAmB,WAAW;AAAA,MAC9B,YAAY,IAAI,IAAI;AAAA,MACpB,OAAO,YAAY,aAAS,mCAAoB,GAAG;AAAA,MACnD,eAAe,IAAI;AAAA,MACnB,gBAAgB,IAAI,IAAI;AAAA,MACxB,iBAAiB,IAAI,IAAI,WAAW;AAAA,MACpC,qBAAqB,WAAW;AAAA,MAChC,sBAAsB;AAAA,IACxB,CAAC;AAAA,EACH,CAAC,EACA,MAAM,CAAC,UAAmB;AACzB,kCAAW,qCAAqC,OAAO,KAAK,CAAC,EAAE;AAAA,EACjE,CAAC;AACH,SAAO,EAAE,aAAa,gBAAgB,QAAQ,eAAe;AAC/D;AAEA,SAAS,kCAAkC,KAAgB;AACzD,MAAI;AACF,QAAI,IAAI,WAAW,SAAS,GAAG;AAC7B;AAAA,QACE;AAAA,MACF;AAAA,IACF;AAAA,EACF,SAAS,OAAO;AACd,gCAAS,8CAA8C,OAAO,KAAK,CAAC,EAAE;AAAA,EACxE;AACF;","names":[]}

package/dist/koa/middleware.d.cts

@@ -1,15 +1,5 @@
-import { ApitallyConsumer, ApitallyConfig } from '../common/types.cjs';
-import Koa from 'koa';
-import '../common/logging.cjs';
-import 'winston';
-import '../common/requestLogger.cjs';
-import 'node:buffer';
-import 'node:http';
-import '../common/spanCollector.cjs';
-import '@opentelemetry/sdk-trace-base';
-import '../common/tempGzipFile.cjs';
+import Koa__default from 'koa';
 
-declare function useApitally(app: Koa, config: ApitallyConfig): void;
-declare function setConsumer(ctx: Koa.Context, consumer: ApitallyConsumer | string | null | undefined): void;
+declare function installKoaMiddleware(app: Koa__default): void;
 
-export { setConsumer, useApitally };
+export { installKoaMiddleware };

package/dist/koa/middleware.d.ts

@@ -1,15 +1,5 @@
-import { ApitallyConsumer, ApitallyConfig } from '../common/types.js';
-import Koa from 'koa';
-import '../common/logging.js';
-import 'winston';
-import '../common/requestLogger.js';
-import 'node:buffer';
-import 'node:http';
-import '../common/spanCollector.js';
-import '@opentelemetry/sdk-trace-base';
-import '../common/tempGzipFile.js';
+import Koa__default from 'koa';
 
-declare function useApitally(app: Koa, config: ApitallyConfig): void;
-declare function setConsumer(ctx: Koa.Context, consumer: ApitallyConsumer | string | null | undefined): void;
+declare function installKoaMiddleware(app: Koa__default): void;
 
-export { setConsumer, useApitally };
+export { installKoaMiddleware };

package/dist/koa/middleware.js

@@ -1,196 +1,91 @@
-var __defProp = Object.defineProperty;
-var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-import { AsyncLocalStorage } from "node:async_hooks";
-import { ApitallyClient } from "../common/client.js";
-import { consumerFromStringOrObject } from "../common/consumerRegistry.js";
-import { getPackageVersion } from "../common/packageVersions.js";
-import { convertBody, convertHeaders } from "../common/requestLogger.js";
-import { patchConsole, patchWinston } from "../loggers/index.js";
-function useApitally(app, config) {
-  const client = new ApitallyClient(config);
-  const middleware = getMiddleware(client);
-  app.use(middleware);
-  const setStartupData = /* @__PURE__ */ __name((attempt = 1) => {
-    const appInfo = getAppInfo(app, config.appVersion);
-    if (appInfo.paths.length > 0 || attempt >= 10) {
-      client.setStartupData(appInfo);
-      client.startSync();
-    } else {
-      setTimeout(() => setStartupData(attempt + 1), 500);
-    }
-  }, "setStartupData");
-  setTimeout(() => setStartupData(), 500);
-}
-__name(useApitally, "useApitally");
-function getMiddleware(client) {
-  const logsContext = new AsyncLocalStorage();
-  if (client.requestLogger.config.captureLogs) {
-    patchConsole(logsContext);
-    patchWinston(logsContext);
+import { context } from "@opentelemetry/api";
+import { activate, isActivated } from "../activation.js";
+import { getConfig } from "../config.js";
+import { captureException, resolveErrorStatus } from "../exceptions.js";
+import { logDebug, logWarning } from "../logger.js";
+import { finalizeRequestObservation } from "../requestObservation.js";
+import {
+  captureNodeResponse,
+  registerServerCloseFlush,
+  startNodeRequestObservation
+} from "../requestObservationNode.js";
+import { resolveMatchedRoute } from "./routes.js";
+const MIDDLEWARE_MARKER = /* @__PURE__ */ Symbol.for("apitally.koaMiddleware");
+const TRACER_NAME = "apitally.koa";
+function installKoaMiddleware(app) {
+  const markedApp = app;
+  if (markedApp[MIDDLEWARE_MARKER] === true) {
+    return;
   }
-  return async (ctx, next) => {
-    if (!client.isEnabled() || ctx.request.method.toUpperCase() === "OPTIONS") {
+  markedApp[MIDDLEWARE_MARKER] = true;
+  warnIfMiddlewareAlreadyRegistered(app);
+  app.use(async (ctx, next) => {
+    let started;
+    try {
+      started = observeRequest(ctx);
+    } catch (error) {
+      logWarning(`Error in the Apitally middleware: ${String(error)}`);
+    }
+    if (!started) {
       await next();
       return;
     }
-    await logsContext.run([], async () => {
-      var _a;
-      let path;
-      let statusCode;
-      let serverError;
-      const startTime = performance.now();
-      const spanHandle = client.spanCollector.startSpan();
-      try {
-        await spanHandle.runInContext(next);
-      } catch (error) {
-        path = getPath(ctx);
-        statusCode = error.statusCode || error.status || 500;
-        if (path && statusCode === 500 && error instanceof Error) {
-          serverError = error;
-          client.serverErrorCounter.addServerError({
-            consumer: (_a = getConsumer(ctx)) == null ? void 0 : _a.identifier,
-            method: ctx.request.method,
-            path,
-            type: error.name,
-            msg: error.message,
-            traceback: error.stack || ""
-          });
-        }
-        throw error;
-      } finally {
-        const responseTime = performance.now() - startTime;
-        if (!path) {
-          path = getPath(ctx);
-        }
-        spanHandle.setName(`${ctx.request.method} ${path}`);
-        const spans = spanHandle.end();
-        const traceId = spanHandle.traceId;
-        const consumer = getConsumer(ctx);
-        client.consumerRegistry.addOrUpdateConsumer(consumer);
-        if (path) {
-          try {
-            client.requestCounter.addRequest({
-              consumer: consumer == null ? void 0 : consumer.identifier,
-              method: ctx.request.method,
-              path,
-              statusCode: statusCode || ctx.response.status,
-              responseTime,
-              requestSize: ctx.request.length,
-              responseSize: ctx.response.length
-            });
-          } catch (error) {
-            client.logger.error("Error while logging request in Apitally middleware.", {
-              context: ctx,
-              error
-            });
-          }
-        }
-        if (client.requestLogger.enabled) {
-          const logs = logsContext.getStore();
-          client.requestLogger.logRequest({
-            timestamp: Date.now() / 1e3,
-            method: ctx.request.method,
-            path,
-            url: ctx.request.href,
-            headers: convertHeaders(ctx.request.headers),
-            size: ctx.request.length,
-            consumer: consumer == null ? void 0 : consumer.identifier,
-            body: convertBody(ctx.request.body, ctx.request.get("content-type"))
-          }, {
-            statusCode: statusCode || ctx.response.status,
-            responseTime: responseTime / 1e3,
-            headers: convertHeaders(ctx.response.headers),
-            size: ctx.response.length,
-            body: convertBody(ctx.response.body, ctx.response.get("content-type"))
-          }, serverError, logs, spans, traceId);
-        }
+    try {
+      await context.with(started.requestContext, next);
+    } catch (error) {
+      const errorStatus = resolveErrorStatus(error);
+      if (errorStatus === void 0 || errorStatus >= 500) {
+        context.with(started.requestContext, () => captureException(error));
       }
-    });
-  };
-}
-__name(getMiddleware, "getMiddleware");
-function getPath(ctx) {
-  return ctx._matchedRoute || ctx.routePath;
-}
-__name(getPath, "getPath");
-function setConsumer(ctx, consumer) {
-  ctx.state.apitallyConsumer = consumer || void 0;
-}
-__name(setConsumer, "setConsumer");
-function getConsumer(ctx) {
-  if (ctx.state.apitallyConsumer) {
-    return consumerFromStringOrObject(ctx.state.apitallyConsumer);
-  } else if (ctx.state.consumerIdentifier) {
-    process.emitWarning("The consumerIdentifier property on the ctx.state object is deprecated. Use apitallyConsumer instead.", "DeprecationWarning");
-    return consumerFromStringOrObject(ctx.state.consumerIdentifier);
-  }
-  return null;
+      throw error;
+    } finally {
+      started.observation.route = resolveMatchedRoute(ctx);
+    }
+  });
 }
-__name(getConsumer, "getConsumer");
-function getAppInfo(app, appVersion) {
-  const versions = [
-    [
-      "nodejs",
-      process.version.replace(/^v/, "")
-    ]
-  ];
-  const koaVersion = getPackageVersion("koa");
-  const apitallyVersion = getPackageVersion("../..");
-  if (koaVersion) {
-    versions.push([
-      "koa",
-      koaVersion
-    ]);
-  }
-  if (apitallyVersion) {
-    versions.push([
-      "apitally",
-      apitallyVersion
-    ]);
+function observeRequest(ctx) {
+  activate();
+  if (!isActivated()) {
+    return void 0;
   }
-  if (appVersion) {
-    versions.push([
-      "app",
-      appVersion
-    ]);
-  }
-  return {
-    paths: listEndpoints(app),
-    versions: Object.fromEntries(versions),
-    client: "js:koa"
-  };
-}
-__name(getAppInfo, "getAppInfo");
-function isKoaRouterMiddleware(middleware) {
-  return typeof middleware === "function" && middleware.router && Array.isArray(middleware.router.stack);
+  registerServerCloseFlush(ctx.req);
+  const started = startNodeRequestObservation({ request: ctx.req, tracerName: TRACER_NAME });
+  context.bind(started.requestContext, ctx.req);
+  context.bind(started.requestContext, ctx.res);
+  const observation = started.observation;
+  captureNodeResponse(
+    ctx.res,
+    getConfig().captureResponseBody && observation.requestRecord.dropReason === void 0,
+    observation.requestBodyCapture
+  ).then((completion) => {
+    finalizeRequestObservation({
+      observation,
+      completedAtMillis: completion.completedAtMillis,
+      statusCode: ctx.res.statusCode,
+      route: observation.route ?? resolveMatchedRoute(ctx),
+      clientAddress: ctx.ip,
+      requestHeaders: ctx.req.headers,
+      responseHeaders: ctx.res.getHeaders(),
+      capturedRequestBody: completion.requestBody,
+      capturedResponseBody: completion
+    });
+  }).catch((error) => {
+    logWarning(`Error in the Apitally middleware: ${String(error)}`);
+  });
+  return { observation, requestContext: started.requestContext };
 }
-__name(isKoaRouterMiddleware, "isKoaRouterMiddleware");
-function listEndpoints(app) {
-  const endpoints = [];
-  app.middleware.forEach((middleware) => {
-    if (isKoaRouterMiddleware(middleware)) {
-      middleware.router.stack.forEach((layer) => {
-        if (layer.methods && layer.methods.length > 0) {
-          layer.methods.forEach((method) => {
-            if (![
-              "HEAD",
-              "OPTIONS"
-            ].includes(method.toUpperCase())) {
-              endpoints.push({
-                method: method.toUpperCase(),
-                path: layer.path
-              });
-            }
-          });
-        }
-      });
+function warnIfMiddlewareAlreadyRegistered(app) {
+  try {
+    if (app.middleware.length > 0) {
+      logWarning(
+        "useApitally() was called after middleware was registered on the Koa app, so earlier middleware may handle or consume requests before Apitally observes them. To resolve this, call useApitally() immediately after creating the app, before registering middleware and routes."
+      );
     }
-  });
-  return endpoints;
+  } catch (error) {
+    logDebug(`Error inspecting the koa app's middleware: ${String(error)}`);
+  }
 }
-__name(listEndpoints, "listEndpoints");
 export {
-  setConsumer,
-  useApitally
+  installKoaMiddleware
 };
 //# sourceMappingURL=middleware.js.map