apitally/dist/koa/middleware.cjs.map

Simple API monitoring & analytics for REST APIs built with Express, Fastify, NestJS, AdonisJS, Hono, H3, Elysia, Hapi, and Koa.

{"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"]}