fix: stringifying session ID for airship (#3896)

* fix: stringifying session ID for airship

* fix: test case numbering fix

* fix: adding more test cases

* fix: review comment addressed

* fix: edit error message

* chore: refactored code

* chore: handled stringifcation in convertToUuid

* fix: adding test cases

* fix: small edit

* fix: code review addressed

---------

Co-authored-by: krishnachaitanya <[email protected]>

src/v0/destinations/airship/data/airshipTrackConfig.json

@@ -22,7 +22,10 @@
   {
     "destKey": "session_id",
     "sourceKeys": ["properties.sessionId", "context.sessionId"],
-    "required": false
+    "required": false,
+    "metadata": {
+      "type": "toString"
+    }
   },
   {
     "destKey": "transaction",

src/v0/destinations/airship/transform.js

@@ -22,12 +22,20 @@ const {
   extractCustomFields,
   isEmptyObject,
   simpleProcessRouterDest,
+  convertToUuid,
 } = require('../../util');
 const { JSON_MIME_TYPE } = require('../../util/constant');
-const { transformSessionId } = require('./utils');
 
 const DEFAULT_ACCEPT_HEADER = 'application/vnd.urbanairship+json; version=3';
 
+const transformSessionId = (rawSessionId) => {
+  try {
+    return convertToUuid(rawSessionId);
+  } catch (error) {
+    throw new InstrumentationError(`Failed to transform session ID: ${error.message}`);
+  }
+};
+
 const identifyResponseBuilder = (message, { Config }) => {
   const tagPayload = constructPayload(message, identifyMapping);
   const { apiKey, dataCenter } = Config;
@@ -129,6 +137,8 @@ const trackResponseBuilder = async (message, { Config }) => {
 
   name = name.toLowerCase();
   const payload = constructPayload(message, trackMapping);
+
+  // ref : https://docs.airship.com/api/ua/#operation-api-custom-events-post
   if (isDefinedAndNotNullAndNotEmpty(payload.session_id)) {
     payload.session_id = transformSessionId(payload.session_id);
   }

src/v0/util/index.js

@@ -16,6 +16,7 @@ const uaParser = require('ua-parser-js');
 const moment = require('moment-timezone');
 const sha256 = require('sha256');
 const crypto = require('crypto');
+const { v5 } = require('uuid');
 const {
   InstrumentationError,
   BaseError,
@@ -2330,6 +2331,29 @@ const isEventSentByVDMV1Flow = (event) => event?.message?.context?.mappedToDesti
 
 const isEventSentByVDMV2Flow = (event) =>
   event?.connection?.config?.destination?.schemaVersion === VDM_V2_SCHEMA_VERSION;
+
+const convertToUuid = (input) => {
+  const NAMESPACE = v5.DNS;
+
+  if (!isDefinedAndNotNull(input)) {
+    throw new InstrumentationError('Input is undefined or null.');
+  }
+
+  try {
+    // Stringify and trim the input
+    const trimmedInput = String(input).trim();
+
+    // Check for empty input after trimming
+    if (!trimmedInput) {
+      throw new InstrumentationError('Input is empty or invalid.');
+    }
+    // Generate and return UUID
+    return v5(trimmedInput, NAMESPACE);
+  } catch (error) {
+    const errorMessage = `Failed to transform input to uuid: ${error.message}`;
+    throw new InstrumentationError(errorMessage);
+  }
+};
 // ========================================================================
 // EXPORTS
 // ========================================================================
@@ -2456,4 +2480,5 @@ module.exports = {
   getRelativePathFromURL,
   removeEmptyKey,
   isAxiosError,
+  convertToUuid,
 };

src/v0/util/index.test.js

@@ -2,6 +2,7 @@ const { InstrumentationError } = require('@rudderstack/integrations-lib');
 const utilities = require('.');
 const { getFuncTestData } = require('../../../test/testHelper');
 const { FilteredEventsError } = require('./errorTypes');
+const { v5 } = require('uuid');
 const {
   hasCircularReference,
   flattenJson,
@@ -11,6 +12,7 @@ const {
   groupRouterTransformEvents,
   isAxiosError,
   removeHyphens,
+  convertToUuid,
 } = require('./index');
 const exp = require('constants');
 
@@ -985,3 +987,65 @@ describe('removeHyphens', () => {
     });
   });
 });
+
+describe('convertToUuid', () => {
+  const NAMESPACE = v5.DNS;
+
+  test('should generate UUID for valid string input', () => {
+    const input = 'testInput';
+    const expectedUuid = '7ba1e88f-acf9-5528-9c1c-0c897ed80e1e';
+    const result = convertToUuid(input);
+    expect(result).toBe(expectedUuid);
+  });
+
+  test('should generate UUID for valid numeric input', () => {
+    const input = 123456;
+    const expectedUuid = 'a52b2702-9bcf-5701-852a-2f4edc640fe1';
+    const result = convertToUuid(input);
+    expect(result).toBe(expectedUuid);
+  });
+
+  test('should trim spaces and generate UUID', () => {
+    const input = '   testInput   ';
+    const expectedUuid = '7ba1e88f-acf9-5528-9c1c-0c897ed80e1e';
+    const result = convertToUuid(input);
+    expect(result).toBe(expectedUuid);
+  });
+
+  test('should throw an error for empty input', () => {
+    const input = '';
+    expect(() => convertToUuid(input)).toThrow(InstrumentationError);
+    expect(() => convertToUuid(input)).toThrow('Input is empty or invalid.');
+  });
+
+  test('to throw an error for null input', () => {
+    const input = null;
+    expect(() => convertToUuid(input)).toThrow(InstrumentationError);
+    expect(() => convertToUuid(input)).toThrow('Input is undefined or null');
+  });
+
+  test('to throw an error for undefined input', () => {
+    const input = undefined;
+    expect(() => convertToUuid(input)).toThrow(InstrumentationError);
+    expect(() => convertToUuid(input)).toThrow('Input is undefined or null');
+  });
+
+  test('should throw an error for input that is whitespace only', () => {
+    const input = '   ';
+    expect(() => convertToUuid(input)).toThrow(InstrumentationError);
+    expect(() => convertToUuid(input)).toThrow('Input is empty or invalid.');
+  });
+
+  test('should handle long string input gracefully', () => {
+    const input = 'a'.repeat(1000);
+    const expectedUuid = v5(input, NAMESPACE);
+    const result = convertToUuid(input);
+    expect(result).toBe(expectedUuid);
+  });
+
+  test('any invalid input if stringified does not throw error', () => {
+    const input = {};
+    const result = convertToUuid(input);
+    expect(result).toBe('672ca00c-37f4-5d71-b8c3-6ae0848080ec');
+  });
+});