Add setConsumer helper functions (#111)

* Add setConsumer functions

* Add tests

Author: itssimon

src/adonisjs/index.ts

@@ -3,12 +3,12 @@ import type { HttpContext } from "@adonisjs/core/http";
 import type { ApitallyConfig } from "../common/types.js";
 export type { ApitallyConfig, ApitallyConsumer } from "../common/types.js";
 
-export const defineConfig = (config: ApitallyConfig) => {
+export function defineConfig(config: ApitallyConfig) {
   return config;
-};
+}
 
-export const captureError = (error: unknown, ctx: HttpContext) => {
+export function captureError(error: unknown, ctx: HttpContext) {
   if (error instanceof Error) {
     ctx.apitallyError = error;
   }
-};
+}

src/adonisjs/provider.ts

@@ -41,7 +41,7 @@ export default class ApitallyProvider {
   }
 }
 
-const listRoutes = (router: Router) => {
+function listRoutes(router: Router) {
   const routes = router.toJSON();
   const paths: Array<PathInfo> = [];
   for (const domain in routes) {
@@ -57,9 +57,9 @@ const listRoutes = (router: Router) => {
     }
   }
   return paths;
-};
+}
 
-const getVersions = (appVersion?: string) => {
+function getVersions(appVersion?: string) {
   const versions = [["nodejs", process.version.replace(/^v/, "")]];
   const adonisJsVersion = getPackageVersion("@adonisjs/core");
   const apitallyVersion = getPackageVersion("../..");
@@ -73,4 +73,4 @@ const getVersions = (appVersion?: string) => {
     versions.push(["app", appVersion]);
   }
   return Object.fromEntries(versions);
-};
+}

src/express/index.ts

@@ -1,2 +1,2 @@
-export type { ApitallyConsumer } from "../common/types.js";
-export { useApitally } from "./middleware.js";
+export type { ApitallyConfig, ApitallyConsumer } from "../common/types.js";
+export { setConsumer, useApitally } from "./middleware.js";

src/express/middleware.ts

@@ -26,10 +26,10 @@ declare module "express" {
   }
 }
 
-export const useApitally = (
+export function useApitally(
   app: Express | Router,
   config: ApitallyConfig & { basePath?: string },
-) => {
+) {
   const client = new ApitallyClient(config);
   const middleware = getMiddleware(app, client);
   app.use(middleware);
@@ -43,9 +43,9 @@ export const useApitally = (
     }
   };
   setTimeout(() => setStartupData(), 500);
-};
+}
 
-const getMiddleware = (app: Express | Router, client: ApitallyClient) => {
+function getMiddleware(app: Express | Router, client: ApitallyClient) {
   let errorHandlerConfigured = false;
 
   return (req: Request, res: Response, next: NextFunction) => {
@@ -185,9 +185,9 @@ const getMiddleware = (app: Express | Router, client: ApitallyClient) => {
       next();
     }
   };
-};
+}
 
-const getRoutePath = (req: Request) => {
+function getRoutePath(req: Request) {
   if (!req.route) {
     return;
   }
@@ -199,9 +199,9 @@ const getRoutePath = (req: Request) => {
     }
   }
   return req.route.path;
-};
+}
 
-const getRouterPath = (stack: any[], baseUrl: string) => {
+function getRouterPath(stack: any[], baseUrl: string) {
   const routerPaths: string[] = [];
   while (stack && stack.length > 0) {
     const routerLayer = stack.find(
@@ -240,9 +240,16 @@ const getRouterPath = (stack: any[], baseUrl: string) => {
     }
   }
   return routerPaths.filter((path) => path !== "/").join("");
-};
+}
+
+export function setConsumer(
+  req: Request,
+  consumer: ApitallyConsumer | string | null | undefined,
+) {
+  req.apitallyConsumer = consumer || undefined;
+}
 
-const getConsumer = (req: Request) => {
+function getConsumer(req: Request) {
   if (req.apitallyConsumer) {
     return consumerFromStringOrObject(req.apitallyConsumer);
   } else if (req.consumerIdentifier) {
@@ -254,9 +261,9 @@ const getConsumer = (req: Request) => {
     return consumerFromStringOrObject(req.consumerIdentifier);
   }
   return null;
-};
+}
 
-const extractExpressValidatorErrors = (responseBody: any) => {
+function extractExpressValidatorErrors(responseBody: any) {
   try {
     const errors: ValidationError[] = [];
     if (
@@ -278,9 +285,9 @@ const extractExpressValidatorErrors = (responseBody: any) => {
   } catch (error) {
     return [];
   }
-};
+}
 
-const extractCelebrateErrors = (responseBody: any) => {
+function extractCelebrateErrors(responseBody: any) {
   try {
     const errors: ValidationError[] = [];
     if (responseBody && responseBody.validation) {
@@ -305,9 +312,9 @@ const extractCelebrateErrors = (responseBody: any) => {
   } catch (error) {
     return [];
   }
-};
+}
 
-const extractNestValidationErrors = (responseBody: any) => {
+function extractNestValidationErrors(responseBody: any) {
   try {
     const errors: ValidationError[] = [];
     if (responseBody && Array.isArray(responseBody.message)) {
@@ -323,20 +330,20 @@ const extractNestValidationErrors = (responseBody: any) => {
   } catch (error) {
     return [];
   }
-};
+}
 
-const subsetJoiMessage = (message: string, key: string) => {
+function subsetJoiMessage(message: string, key: string) {
   const messageWithKey = message
     .split(". ")
     .find((message) => message.includes(`"${key}"`));
   return messageWithKey ? messageWithKey : message;
-};
+}
 
-const getAppInfo = (
+function getAppInfo(
   app: Express | Router,
   basePath?: string,
   appVersion?: string,
-): StartupData => {
+): StartupData {
   const versions: Array<[string, string]> = [
     ["nodejs", process.version.replace(/^v/, "")],
   ];
@@ -360,4 +367,4 @@ const getAppInfo = (
     versions: Object.fromEntries(versions),
     client: "js:express",
   };
-};
+}

src/fastify/index.ts

@@ -1,2 +1,2 @@
-export type { ApitallyConsumer } from "../common/types.js";
-export { default as apitallyPlugin } from "./plugin.js";
+export type { ApitallyConfig, ApitallyConsumer } from "../common/types.js";
+export { default as apitallyPlugin, setConsumer } from "./plugin.js";

src/fastify/plugin.ts

@@ -164,7 +164,7 @@ const apitallyPlugin: FastifyPluginAsync<ApitallyConfig> = async (
   });
 };
 
-const getAppInfo = (routes: PathInfo[], appVersion?: string) => {
+function getAppInfo(routes: PathInfo[], appVersion?: string) {
   const versions = [["nodejs", process.version.replace(/^v/, "")]];
   const fastifyVersion = getPackageVersion("fastify");
   const apitallyVersion = getPackageVersion("../..");
@@ -182,9 +182,16 @@ const getAppInfo = (routes: PathInfo[], appVersion?: string) => {
     versions: Object.fromEntries(versions),
     client: "js:fastify",
   };
-};
+}
 
-const getConsumer = (request: FastifyRequest) => {
+export function setConsumer(
+  request: FastifyRequest,
+  consumer: ApitallyConsumer | string | null | undefined,
+) {
+  request.apitallyConsumer = consumer || undefined;
+}
+
+function getConsumer(request: FastifyRequest) {
   if (request.apitallyConsumer) {
     return consumerFromStringOrObject(request.apitallyConsumer);
   } else if (request.consumerIdentifier) {
@@ -196,18 +203,18 @@ const getConsumer = (request: FastifyRequest) => {
     return consumerFromStringOrObject(request.consumerIdentifier);
   }
   return null;
-};
+}
 
-const getResponseTime = (reply: FastifyReply) => {
+function getResponseTime(reply: FastifyReply) {
   if (reply.elapsedTime !== undefined) {
     return reply.elapsedTime;
   } else if ((reply as any).getResponseTime !== undefined) {
     return (reply as any).getResponseTime();
   }
   return 0;
-};
+}
 
-const extractAjvErrors = (message: string): ValidationError[] => {
+function extractAjvErrors(message: string): ValidationError[] {
   const regex =
     /(?<=^|, )((?:headers|params|query|querystring|body)[/.][^ ]+)(?= )/g;
   const matches: { match: string; index: number }[] = [];
@@ -229,7 +236,7 @@ const extractAjvErrors = (message: string): ValidationError[] => {
       type: "",
     };
   });
-};
+}
 
 export default fp(apitallyPlugin, {
   name: "apitally",

src/h3/index.ts

@@ -1,2 +1,2 @@
-export type { ApitallyConsumer } from "../common/types.js";
-export { apitallyPlugin } from "./plugin.js";
+export type { ApitallyConfig, ApitallyConsumer } from "../common/types.js";
+export { apitallyPlugin, setConsumer } from "./plugin.js";

src/h3/plugin.ts

@@ -131,9 +131,9 @@ export const apitallyPlugin = definePlugin<ApitallyConfig>((app, config) => {
         {
           statusCode,
           responseTime: responseTime / 1000,
-          headers: responseHeaders
-            ? convertHeaders(Object.fromEntries(responseHeaders.entries()))
-            : [],
+          headers: convertHeaders(
+            Object.fromEntries(responseHeaders.entries()),
+          ),
           size: responseSize,
           body: responseBody,
         },
@@ -179,6 +179,13 @@ export const apitallyPlugin = definePlugin<ApitallyConfig>((app, config) => {
     );
 });
 
+export function setConsumer(
+  event: H3Event,
+  consumer: ApitallyConsumer | string | null | undefined,
+) {
+  event.context.apitallyConsumer = consumer || undefined;
+}
+
 function getConsumer(event: H3Event) {
   const consumer = event.context.apitallyConsumer;
   if (consumer) {

src/hono/index.ts

@@ -1,2 +1,2 @@
-export type { ApitallyConsumer } from "../common/types.js";
-export { useApitally } from "./middleware.js";
+export type { ApitallyConfig, ApitallyConsumer } from "../common/types.js";
+export { setConsumer, useApitally } from "./middleware.js";

src/hono/middleware.ts

@@ -137,7 +137,14 @@ function getMiddleware(client: ApitallyClient): MiddlewareHandler {
   };
 }
 
-export function getConsumer(c: Context) {
+export function setConsumer(
+  c: Context,
+  consumer: ApitallyConsumer | string | null | undefined,
+) {
+  c.set("apitallyConsumer", consumer || undefined);
+}
+
+function getConsumer(c: Context) {
   const consumer = c.get("apitallyConsumer");
   if (consumer) {
     return consumerFromStringOrObject(consumer);

src/koa/index.ts

@@ -1,2 +1,2 @@
-export type { ApitallyConsumer } from "../common/types.js";
-export { useApitally } from "./middleware.js";
+export type { ApitallyConfig, ApitallyConsumer } from "../common/types.js";
+export { setConsumer, useApitally } from "./middleware.js";