Rename consumerIdentifier to apitallyConsumer (#17)

apitally · Jun 27, 2024 · 8b56b8f · 8b56b8f
1 parent 6eb5087
commit 8b56b8f
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 14 deletions.
diff --git a/src/express/middleware.ts b/src/express/middleware.ts
@@ -8,7 +8,8 @@ import listEndpoints from "./listEndpoints.js";
 
 declare module "express" {
   interface Request {
-    consumerIdentifier?: string;
+    apitallyConsumer?: string;
+    consumerIdentifier?: string; // For backwards compatibility
   }
 }
 
@@ -121,7 +122,13 @@ const getMiddleware = (app: Express, client: ApitallyClient) => {
 };
 
 const getConsumer = (req: Request) => {
-  return req.consumerIdentifier ? String(req.consumerIdentifier) : null;
+  if (req.apitallyConsumer) {
+    return String(req.apitallyConsumer);
+  } else if (req.consumerIdentifier) {
+    // For backwards compatibility
+    return String(req.consumerIdentifier);
+  }
+  return null;
 };
 
 const extractExpressValidatorErrors = (responseBody: any) => {

diff --git a/src/fastify/plugin.ts b/src/fastify/plugin.ts
@@ -12,7 +12,8 @@ declare module "fastify" {
   }
 
   interface FastifyRequest {
-    consumerIdentifier?: string;
+    apitallyConsumer?: string;
+    consumerIdentifier?: string; // For backwards compatibility
   }
 }
 
@@ -23,7 +24,8 @@ const apitallyPlugin: FastifyPluginAsync<ApitallyConfig> = async (
   const client = new ApitallyClient(config);
   const routes: PathInfo[] = [];
 
-  fastify.decorateRequest("consumerIdentifier", null);
+  fastify.decorateRequest("apitallyConsumer", null);
+  fastify.decorateRequest("consumerIdentifier", null); // For backwards compatibility
   fastify.decorateReply("payload", null);
 
   fastify.addHook("onRoute", (routeOptions) => {
@@ -138,7 +140,13 @@ const getAppInfo = (routes: PathInfo[], appVersion?: string) => {
 };
 
 const getConsumer = (request: FastifyRequest) => {
-  return request.consumerIdentifier ? String(request.consumerIdentifier) : null;
+  if (request.apitallyConsumer) {
+    return String(request.apitallyConsumer);
+  } else if (request.consumerIdentifier) {
+    // For backwards compatibility
+    return String(request.consumerIdentifier);
+  }
+  return null;
 };
 
 const extractAjvErrors = (message: string): ValidationError[] => {

diff --git a/src/koa/middleware.ts b/src/koa/middleware.ts
@@ -65,9 +65,13 @@ const getPath = (ctx: Koa.Context) => {
 };
 
 const getConsumer = (ctx: Koa.Context) => {
-  return ctx.state.consumerIdentifier
-    ? String(ctx.state.consumerIdentifier)
-    : null;
+  if (ctx.state.apitallyConsumer) {
+    return String(ctx.state.apitallyConsumer);
+  } else if (ctx.state.consumerIdentifier) {
+    // For backwards compatibility
+    return String(ctx.state.consumerIdentifier);
+  }
+  return null;
 };
 
 const getAppInfo = (app: Koa, appVersion?: string): AppInfo => {

diff --git a/tests/express/app.ts b/tests/express/app.ts
@@ -8,7 +8,7 @@ import { CLIENT_ID, ENV } from "../utils.js";
 
 declare module "express" {
   interface Request {
-    consumerIdentifier?: string;
+    apitallyConsumer?: string;
   }
 }
 
@@ -32,7 +32,7 @@ export const getAppWithCelebrate = () => {
       { abortEarly: false },
     ),
     (req: Request, res) => {
-      req.consumerIdentifier = "test";
+      req.apitallyConsumer = "test";
       res.send(
         `Hello ${req.query?.name}! You are ${req.query?.age} years old!`,
       );
@@ -79,7 +79,7 @@ export const getAppWithValidator = () => {
     query("name").isString().isLength({ min: 2 }),
     query("age").isInt({ min: 18 }),
     (req: Request, res) => {
-      req.consumerIdentifier = "test";
+      req.apitallyConsumer = "test";
       const result = validationResult(req);
       if (result.isEmpty()) {
         return res.send(

diff --git a/tests/fastify/app.ts b/tests/fastify/app.ts
@@ -40,7 +40,7 @@ export const getApp = async () => {
     },
     async function (request) {
       const { name, age } = request.query;
-      request.consumerIdentifier = "test";
+      request.apitallyConsumer = "test";
       return `Hello ${name}! You are ${age} years old!`;
     },
   );

diff --git a/tests/koa/app.ts b/tests/koa/app.ts
@@ -17,7 +17,7 @@ export const getAppWithKoaRouter = () => {
   });
 
   router.get("/hello", async (ctx) => {
-    ctx.state.consumerIdentifier = "test";
+    ctx.state.apitallyConsumer = "test";
     ctx.body = `Hello ${ctx.query.name}! You are ${ctx.query.age} years old!`;
   });
   router.get("/hello/:id", async (ctx) => {
@@ -50,7 +50,7 @@ export const getAppWithKoaRoute = () => {
   app.use(bodyParser());
   app.use(
     route.get("/hello", async (ctx) => {
-      ctx.state.consumerIdentifier = "test";
+      ctx.state.apitallyConsumer = "test";
       ctx.body = `Hello ${ctx.query.name}! You are ${ctx.query.age} years old!`;
     }),
   );