refactor: deprecate mixpanel /track endpoint (#2833)

* refactor: deprecate mixpanel /track endpoint * fix: used token in place of apiSecret for merge call * fix: no-case-declarations
rudderlabs · May 21, 2024 · 2250af8 · 2250af8
1 parent 0196f20
commit 2250af8
Show file tree

Hide file tree

Showing 8 changed files with 243 additions and 234 deletions.
diff --git a/src/util/prometheus.js b/src/util/prometheus.js
@@ -587,12 +587,6 @@ class Prometheus {
         type: 'gauge',
         labelNames: ['destination_id'],
       },
-      {
-        name: 'mixpanel_batch_track_pack_size',
-        help: 'mixpanel_batch_track_pack_size',
-        type: 'gauge',
-        labelNames: ['destination_id'],
-      },
       {
         name: 'mixpanel_batch_import_pack_size',
         help: 'mixpanel_batch_import_pack_size',

diff --git a/src/v0/destinations/mp/config.js b/src/v0/destinations/mp/config.js
@@ -49,7 +49,6 @@ const MP_IDENTIFY_EXCLUSION_LIST = [
 ];
 
 const GEO_SOURCE_ALLOWED_VALUES = [null, 'reverse_geocoding'];
-const TRACK_MAX_BATCH_SIZE = 50;
 const IMPORT_MAX_BATCH_SIZE = 2000;
 const ENGAGE_MAX_BATCH_SIZE = 2000;
 const GROUPS_MAX_BATCH_SIZE = 200;
@@ -68,7 +67,6 @@ module.exports = {
   MP_IDENTIFY_EXCLUSION_LIST,
   getCreateDeletionTaskEndpoint,
   DISTINCT_ID_MAX_BATCH_SIZE,
-  TRACK_MAX_BATCH_SIZE,
   IMPORT_MAX_BATCH_SIZE,
   ENGAGE_MAX_BATCH_SIZE,
   GROUPS_MAX_BATCH_SIZE,

diff --git a/src/v0/destinations/mp/transform.js b/src/v0/destinations/mp/transform.js
@@ -24,7 +24,6 @@ const {
   mappingConfig,
   BASE_ENDPOINT,
   BASE_ENDPOINT_EU,
-  TRACK_MAX_BATCH_SIZE,
   IMPORT_MAX_BATCH_SIZE,
   ENGAGE_MAX_BATCH_SIZE,
   GROUPS_MAX_BATCH_SIZE,
@@ -47,21 +46,19 @@ const mPEventPropertiesConfigJson = mappingConfig[ConfigCategory.EVENT_PROPERTIE
 const setImportCredentials = (destConfig) => {
   const endpoint =
     destConfig.dataResidency === 'eu' ? `${BASE_ENDPOINT_EU}/import/` : `${BASE_ENDPOINT}/import/`;
-  const headers = { 'Content-Type': 'application/json' };
   const params = { strict: destConfig.strictMode ? 1 : 0 };
-  const { apiSecret, serviceAccountUserName, serviceAccountSecret, projectId } = destConfig;
-  if (apiSecret) {
-    headers.Authorization = `Basic ${base64Convertor(`${apiSecret}:`)}`;
+  const { serviceAccountUserName, serviceAccountSecret, projectId, token } = destConfig;
+  let credentials;
+  if (token) {
+    credentials = `${token}:`;
   } else if (serviceAccountUserName && serviceAccountSecret && projectId) {
-    headers.Authorization = `Basic ${base64Convertor(
-      `${serviceAccountUserName}:${serviceAccountSecret}`,
-    )}`;
+    credentials = `${serviceAccountUserName}:${serviceAccountSecret}`;
     params.projectId = projectId;
-  } else {
-    throw new InstrumentationError(
-      'Event timestamp is older than 5 days and no API secret or service account credentials (i.e. username, secret and projectId) are provided in destination configuration',
-    );
   }
+  const headers = {
+    'Content-Type': 'application/json',
+    Authorization: `Basic ${base64Convertor(credentials)}`,
+  };
   return { endpoint, headers, params };
 };
 
@@ -70,37 +67,26 @@ const responseBuilderSimple = (payload, message, eventType, destConfig) => {
   response.method = defaultPostRequestConfig.requestMethod;
   response.userId = message.userId || message.anonymousId;
   response.body.JSON_ARRAY = { batch: JSON.stringify([removeUndefinedValues(payload)]) };
-  const { apiSecret, serviceAccountUserName, serviceAccountSecret, projectId, dataResidency } =
-    destConfig;
+  const { dataResidency } = destConfig;
   const duration = getTimeDifference(message.timestamp);
   switch (eventType) {
     case EventType.ALIAS:
     case EventType.TRACK:
     case EventType.SCREEN:
-    case EventType.PAGE:
-      if (
-        !apiSecret &&
-        !(serviceAccountUserName && serviceAccountSecret && projectId) &&
-        duration.days <= 5
-      ) {
-        response.endpoint =
-          dataResidency === 'eu' ? `${BASE_ENDPOINT_EU}/track/` : `${BASE_ENDPOINT}/track/`;
-        response.headers = {};
-      } else if (duration.years > 5) {
+    case EventType.PAGE: {
+      if (duration.years > 5) {
         throw new InstrumentationError('Event timestamp should be within last 5 years');
-      } else {
-        const credentials = setImportCredentials(destConfig);
-        response.endpoint = credentials.endpoint;
-        response.headers = credentials.headers;
-        response.params = {
-          project_id: credentials.params?.projectId,
-          strict: credentials.params.strict,
-        };
-        break;
       }
+      const credentials = setImportCredentials(destConfig);
+      response.endpoint = credentials.endpoint;
+      response.headers = credentials.headers;
+      response.params = {
+        project_id: credentials.params?.projectId,
+        strict: credentials.params.strict,
+      };
       break;
-    case 'merge':
-      // eslint-disable-next-line no-case-declarations
+    }
+    case 'merge': {
       const credentials = setImportCredentials(destConfig);
       response.endpoint = credentials.endpoint;
       response.headers = credentials.headers;
@@ -109,7 +95,7 @@ const responseBuilderSimple = (payload, message, eventType, destConfig) => {
         strict: credentials.params.strict,
       };
       break;
-
+    }
     default:
       response.endpoint =
         dataResidency === 'eu' ? `${BASE_ENDPOINT_EU}/engage/` : `${BASE_ENDPOINT}/engage/`;
@@ -484,7 +470,6 @@ const processRouterDest = async (inputs, reqMetadata) => {
   const batchSize = {
     engage: 0,
     groups: 0,
-    track: 0,
     import: 0,
   };
 
@@ -516,23 +501,16 @@ const processRouterDest = async (inputs, reqMetadata) => {
       );
 
       transformedPayloads = lodash.flatMap(transformedPayloads);
-      const { engageEvents, groupsEvents, trackEvents, importEvents, batchErrorRespList } =
+      const { engageEvents, groupsEvents, importEvents, batchErrorRespList } =
         groupEventsByEndpoint(transformedPayloads);
 
       const engageRespList = batchEvents(engageEvents, ENGAGE_MAX_BATCH_SIZE, reqMetadata);
       const groupsRespList = batchEvents(groupsEvents, GROUPS_MAX_BATCH_SIZE, reqMetadata);
-      const trackRespList = batchEvents(trackEvents, TRACK_MAX_BATCH_SIZE, reqMetadata);
       const importRespList = batchEvents(importEvents, IMPORT_MAX_BATCH_SIZE, reqMetadata);
-      const batchSuccessRespList = [
-        ...engageRespList,
-        ...groupsRespList,
-        ...trackRespList,
-        ...importRespList,
-      ];
+      const batchSuccessRespList = [...engageRespList, ...groupsRespList, ...importRespList];
 
       batchSize.engage += engageRespList.length;
       batchSize.groups += groupsRespList.length;
-      batchSize.track += trackRespList.length;
       batchSize.import += importRespList.length;
 
       return [...batchSuccessRespList, ...batchErrorRespList];

diff --git a/src/v0/destinations/mp/util.js b/src/v0/destinations/mp/util.js
@@ -136,7 +136,7 @@ const createIdentifyResponse = (message, type, destination, responseBuilderSimpl
  * @returns
  */
 const isImportAuthCredentialsAvailable = (destination) =>
-  destination.Config.apiSecret ||
+  destination.Config.token ||
   (destination.Config.serviceAccountSecret &&
     destination.Config.serviceAccountUserName &&
     destination.Config.projectId);
@@ -179,7 +179,6 @@ const groupEventsByEndpoint = (events) => {
   const eventMap = {
     engage: [],
     groups: [],
-    track: [],
     import: [],
   };
   const batchErrorRespList = [];
@@ -204,7 +203,6 @@ const groupEventsByEndpoint = (events) => {
   return {
     engageEvents: eventMap.engage,
     groupsEvents: eventMap.groups,
-    trackEvents: eventMap.track,
     importEvents: eventMap.import,
     batchErrorRespList,
   };
@@ -349,7 +347,6 @@ const generatePageOrScreenCustomEventName = (message, userDefinedEventTemplate)
  * @param {Object} batchSize - The object containing the batch size for different endpoints.
  * @param {number} batchSize.engage - The batch size for engage endpoint.
  * @param {number} batchSize.groups - The batch size for group endpoint.
- * @param {number} batchSize.track - The batch size for track endpoint.
  * @param {number} batchSize.import - The batch size for import endpoint.
  * @param {string} destinationId - The ID of the destination.
  * @returns {void}
@@ -361,9 +358,6 @@ const recordBatchSizeMetrics = (batchSize, destinationId) => {
   stats.gauge('mixpanel_batch_group_pack_size', batchSize.groups, {
     destination_id: destinationId,
   });
-  stats.gauge('mixpanel_batch_track_pack_size', batchSize.track, {
-    destination_id: destinationId,
-  });
   stats.gauge('mixpanel_batch_import_pack_size', batchSize.import, {
     destination_id: destinationId,
   });

diff --git a/src/v0/destinations/mp/util.test.js b/src/v0/destinations/mp/util.test.js
@@ -18,7 +18,6 @@ describe('Unit test cases for groupEventsByEndpoint', () => {
     expect(result).toEqual({
       engageEvents: [],
       groupsEvents: [],
-      trackEvents: [],
       importEvents: [],
       batchErrorRespList: [],
     });
@@ -122,19 +121,6 @@ describe('Unit test cases for groupEventsByEndpoint', () => {
           },
         },
       ],
-      trackEvents: [
-        {
-          message: {
-            endpoint: '/track',
-            body: {
-              JSON_ARRAY: {
-                batch: '[{prop:4}]',
-              },
-            },
-            userId: 'user1',
-          },
-        },
-      ],
       importEvents: [
         {
           message: {

diff --git a/test/integrations/destinations/mp/common.ts b/test/integrations/destinations/mp/common.ts
@@ -7,7 +7,7 @@ const defaultMockFns = () => {
 const sampleDestination: Destination = {
   Config: {
     apiKey: 'dummyApiKey',
-    token: 'dummyApiKey',
+    token: 'test_api_token',
     prefixProperties: true,
     useNativeSDK: false,
   },