Merge pull request #9 from apilytics/query-params

Send query parameters in addition to path in middlewares

Author: ruohola

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Send query parameters in addition to the path.
+
 ## [1.0.2] - 2022-01-16
 
 ### Added

packages/core/README.md

@@ -47,6 +47,7 @@ const myApilyticsMiddleware = async (req, handler) => {
   sendApilyticsMetrics({
     apiKey,
     path: req.path,
+    query: req.queryString,
     method: req.method,
     statusCode: res.statusCode,
     timeMillis: timer(),

packages/core/__tests__/index.test.ts

@@ -108,6 +108,40 @@ describe('sendApilyticsMetrics()', () => {
     });
   });
 
+  it('should send query parameters', async () => {
+    sendApilyticsMetrics({
+      ...params,
+      query: 'key=val&other=123',
+    });
+
+    expect(requestSpy).toHaveBeenCalledTimes(1);
+
+    const data = JSON.parse(clientRequestMock.write.mock.calls[0]);
+    expect(data).toHaveProperty('query', 'key=val&other=123');
+  });
+
+  it('should not send empty query parameters', async () => {
+    sendApilyticsMetrics({
+      ...params,
+      query: undefined,
+    });
+
+    expect(requestSpy).toHaveBeenCalledTimes(1);
+
+    let data = JSON.parse(clientRequestMock.write.mock.calls[0]);
+    expect(data).not.toHaveProperty('query');
+
+    sendApilyticsMetrics({
+      ...params,
+      query: '',
+    });
+
+    expect(requestSpy).toHaveBeenCalledTimes(2);
+
+    data = JSON.parse(clientRequestMock.write.mock.calls[0]);
+    expect(data).not.toHaveProperty('query');
+  });
+
   it('should hide HTTP errors in production', async () => {
     // @ts-ignore: Assigning to a read-only property.
     process.env.NODE_ENV = 'production';

packages/core/src/index.ts

@@ -8,15 +8,28 @@ interface Params {
   method: string;
   statusCode: number | null;
   timeMillis: number;
+  query?: string;
   apilyticsIntegration?: string;
   integratedLibrary?: string;
 }
 
-export const sendApilyticsMetrics = (params: Params): void => {
-  const { apiKey, apilyticsIntegration, integratedLibrary, ...metrics } =
-    params;
-  const data = JSON.stringify(metrics);
-
+export const sendApilyticsMetrics = ({
+  apiKey,
+  path,
+  query,
+  method,
+  statusCode,
+  timeMillis,
+  apilyticsIntegration,
+  integratedLibrary,
+}: Params): void => {
+  const data = JSON.stringify({
+    path,
+    query: query || undefined,
+    method,
+    statusCode,
+    timeMillis,
+  });
   let apilyticsVersion = `${
     apilyticsIntegration ?? 'apilytics-node-core'
   }/${APILYTICS_VERSION};node/${process.versions.node}`;

packages/express/__tests__/index.test.ts

@@ -99,7 +99,7 @@ describe('apilyticsMiddleware()', () => {
     expect(data['timeMillis']).toEqual(Math.trunc(data['timeMillis']));
   });
 
-  it('should not send query parameters', async () => {
+  it('should send query parameters', async () => {
     const agent = createAgent({ apiKey });
     const response = await agent.post('/dummy/123/path/?param=foo&param2=bar');
     expect(response.status).toEqual(201);
@@ -126,6 +126,7 @@ describe('apilyticsMiddleware()', () => {
     const data = JSON.parse(clientRequestMock.write.mock.calls[0]);
     expect(data).toStrictEqual({
       path: '/dummy/123/path/',
+      query: '?param=foo&param2=bar',
       method: 'POST',
       statusCode: 201,
       timeMillis: expect.any(Number),

packages/express/src/index.ts

@@ -1,3 +1,5 @@
+import { URL } from 'url';
+
 import { milliSecondTimer, sendApilyticsMetrics } from '@apilytics/core';
 import type { NextFunction, Request, RequestHandler, Response } from 'express';
 
@@ -15,9 +17,14 @@ export const apilyticsMiddleware = (
   return (req: Request, res: Response, next: NextFunction): void => {
     const timer = milliSecondTimer();
     res.on('finish', () => {
+      const { pathname: path, search: query } = new URL(
+        req.originalUrl,
+        'http://_', // Cannot parse a relative URL, so make it absolute.
+      );
       sendApilyticsMetrics({
         apiKey,
-        path: req.path,
+        path,
+        query,
         method: req.method,
         statusCode: res.statusCode,
         timeMillis: timer(),

packages/next/__tests__/index.test.ts

@@ -119,7 +119,7 @@ describe('withApilytics()', () => {
     expect(data['timeMillis']).toEqual(Math.trunc(data['timeMillis']));
   });
 
-  it('should not send query parameters', async () => {
+  it('should send query parameters', async () => {
     const agent = createAgent({ apiKey });
     const response = await agent.post('/dummy/123/path/?param=foo&param2=bar');
     expect(response.status).toEqual(201);
@@ -146,6 +146,7 @@ describe('withApilytics()', () => {
     const data = JSON.parse(clientRequestMock.write.mock.calls[0]);
     expect(data).toStrictEqual({
       path: '/dummy/123/path/',
+      query: '?param=foo&param2=bar',
       method: 'POST',
       statusCode: 201,
       timeMillis: expect.any(Number),
@@ -178,7 +179,7 @@ describe('withApilytics()', () => {
     });
   });
 
-  it('should use empty strings as default values', async () => {
+  it('should use correct default values', async () => {
     const agent = createAgent({ apiKey });
     const response = await agent.get('/empty');
     expect(response.status).toEqual(200);

packages/next/src/index.ts

@@ -1,3 +1,5 @@
+import { URL } from 'url';
+
 import { milliSecondTimer, sendApilyticsMetrics } from '@apilytics/core';
 import type { NextApiHandler, NextApiRequest, NextApiResponse } from 'next';
 
@@ -24,9 +26,17 @@ export const withApilytics = <T>(
       // otherwise, we could end up sending NextApiResponse's default 200 status.
       statusCode = res.statusCode;
     } finally {
+      let path, query;
+      if (req.url) {
+        ({ pathname: path, search: query } = new URL(
+          req.url,
+          'http://_', // Cannot parse a relative URL, so make it absolute.
+        ));
+      }
       sendApilyticsMetrics({
         apiKey,
-        path: req.url?.split('?')[0] ?? '',
+        path: path ?? '',
+        query,
         method: req.method ?? '',
         statusCode,
         timeMillis: timer(),