Tagging API calls withContext

src/index.ts

@@ -200,6 +200,7 @@ const Supergood = () => {
           try {
             const requestData = requestCache.get(requestId) as {
               request: RequestType;
+              tags: Record<string, string | number | string[]>;
             };
 
             if (requestData) {
@@ -263,9 +264,10 @@ const Supergood = () => {
   };
 
   const cacheRequest = async (request: RequestType, baseUrl: string) => {
-    requestCache.set(request.id, { request });
+    requestCache.set(request.id, { request, tags: getTags() });
     log.debug('Setting Request Cache', {
-      request
+      request,
+      tags: getTags()
     });
   };
 
@@ -279,6 +281,10 @@ const Supergood = () => {
     log.debug('Deleting Request Cache', { id: event.request.id });
   };
 
+  const getTags = () => {
+    return { ...supergoodTags, ...(supergoodAsyncLocalStorage.getStore()?.tags || {}) };
+  }
+
   // Force flush cache means don't wait for responses
   const flushCache = async ({ force } = { force: false }) => {
     const responseCacheKeys = responseCache.keys();
@@ -296,7 +302,6 @@ const Supergood = () => {
     const responseArray = prepareData(
       responseCacheValues as EventRequestType[],
       supergoodConfig.remoteConfig,
-      { ...supergoodTags, ...(supergoodAsyncLocalStorage.getStore()?.tags || {}) }
     ) as Array<EventRequestType>;
 
     let data = [...responseArray];
@@ -305,8 +310,7 @@ const Supergood = () => {
     if (force) {
       const requestArray = prepareData(
         requestCacheValues as EventRequestType[],
-        supergoodConfig.remoteConfig,
-        { ...supergoodTags, ...(supergoodAsyncLocalStorage.getStore()?.tags || {}) }
+        supergoodConfig.remoteConfig
       ) as Array<EventRequestType>;
       data = [...requestArray, ...responseArray];
     }

src/types.ts

@@ -89,9 +89,10 @@ interface MetadataType {
 interface EventRequestType {
   request: RequestType;
   response: ResponseType;
+  tags?: Record<string, string | number | string[]>;
   metadata?: {
     sensitiveKeys: Array<SensitiveKeyMetadata>;
-    tags: Record<string, string | number | string[]>;
+    tags?: Record<string, string | number | string[]>;
   };
 }
 

src/utils.test.ts

@@ -400,7 +400,7 @@ it('will prepare the data appropriately for posting to the server', () => {
     }
   };
 
-  const events = prepareData([obj], remoteConfig, {});
+  const events = prepareData([obj], remoteConfig);
   expect(_get(events[0], 'response.body.user.email')).toBeFalsy();
   expect(_get(events[0], 'request.body.blogType.name')).toBeFalsy();
   expect(events[0].metadata.sensitiveKeys.length).toEqual(2);

src/utils.ts

@@ -169,19 +169,27 @@ const expandSensitiveKeySetForArrays = (
 };
 
 const redactValuesFromKeys = (
-  event: { request?: RequestType; response?: ResponseType },
+  event: { request?: RequestType; response?: ResponseType, tags?: Record<string, string | number | string[]> },
   remoteConfig: RemoteConfigType
 ): {
   event: { request?: RequestType; response?: ResponseType };
   sensitiveKeyMetadata: Array<SensitiveKeyMetadata>;
+  tags: Record<string, string | number | string[]>;
 } => {
+  // Move the tags off the event object and into the metadata object
+  let tags = {};
+  if(event.tags) {
+    tags = event.tags;
+    delete event.tags;
+  }
+
   let sensitiveKeyMetadata: Array<SensitiveKeyMetadata> = [];
   const endpointConfig = getEndpointConfigForRequest(
     event.request as RequestType,
     remoteConfig
   );
   if (!endpointConfig || !endpointConfig?.sensitiveKeys?.length)
-    return { event, sensitiveKeyMetadata };
+    return { event, sensitiveKeyMetadata, tags };
   else {
     const sensitiveKeys = expandSensitiveKeySetForArrays(
       event,
@@ -200,7 +208,7 @@ const redactValuesFromKeys = (
         });
       }
     }
-    return { event, sensitiveKeyMetadata };
+    return { event, sensitiveKeyMetadata, tags };
   }
 };
 
@@ -243,10 +251,9 @@ const redactValue = (
 const prepareData = (
   events: Array<EventRequestType>,
   remoteConfig: RemoteConfigType,
-  tags: Record<string, string | number | string[]>
 ) => {
   return events.map((e) => {
-    const { event, sensitiveKeyMetadata } = redactValuesFromKeys(
+    const { event, sensitiveKeyMetadata, tags } = redactValuesFromKeys(
       e,
       remoteConfig
     );

test/e2e/tags.e2e.test.ts

@@ -2,6 +2,7 @@ import fetch from 'node-fetch';
 import { get } from 'lodash';
 
 import Supergood from '../../src';
+import { sleep } from '../../src/utils';
 import {
   MOCK_DATA_SERVER,
   SUPERGOOD_CLIENT_ID,
@@ -46,13 +47,14 @@ describe('Custom tags', () => {
       SUPERGOOD_SERVER
     );
 
-    await Supergood.withContext({ customTag: 'customValue' }, async () => {
+    await Supergood.withContext({ call: 'A' }, async () => {
       await fetch(`${MOCK_DATA_SERVER}/profile`);
-      await Supergood.waitAndFlushCache();
     });
 
+    await Supergood.close();
+
     const eventsPosted = getEvents(postEventsMock);
     expect(eventsPosted.length).toEqual(1);
-    expect(get(eventsPosted[0], 'metadata.tags.customTag')).toEqual('customValue');
+    expect(get(eventsPosted[0], 'metadata.tags.call')).toEqual('A');
   });
 })

test/e2e/telemetry.e2e.test.ts

@@ -36,7 +36,7 @@ describe('telemetry posting', () => {
       getTelemetry(postTelemetryMock);
 
     expect(cacheKeys).toEqual(1);
-    expect(cacheSize).toEqual(160);
+    expect(cacheSize).toEqual(240);
     expect(serviceName).toEqual('test-service-name');
   });
 });