[FSSDK-11197] EventTags type fix

Author: junaed-optimizely

lib/event_processor/event_builder/log_event.spec.ts

@@ -251,6 +251,8 @@ describe('buildConversionEventV1', () => {
       },
 
       tags: {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
         foo: 'bar',
         value: '123',
         revenue: '1000',
@@ -496,6 +498,8 @@ describe('buildConversionEventV1', () => {
       },
 
       tags: {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
         foo: 'bar',
         value: 0,
         revenue: 0,
@@ -582,6 +586,8 @@ describe('buildConversionEventV1', () => {
       },
 
       tags: {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
         foo: 'bar',
         value: '123',
         revenue: '1000',
@@ -665,6 +671,8 @@ describe('makeEventBatch', () => {
       },
 
       tags: {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
         foo: 'bar',
         value: '123',
         revenue: '1000',

lib/optimizely/index.ts

@@ -607,8 +607,9 @@ export default class Optimizely extends BaseService implements Client {
    */
   private filterEmptyValues(map: EventTags | undefined): EventTags | undefined {
     for (const key in map) {
-      if (map.hasOwnProperty(key) && (map[key] === null || map[key] === undefined)) {
-        delete map[key];
+      const typedKey = key as keyof EventTags;
+      if (map.hasOwnProperty(typedKey) && (map[typedKey] === null || map[typedKey] === undefined)) {
+        delete map[typedKey];
       }
     }
     return map;

lib/shared_types.ts

@@ -88,7 +88,11 @@ export interface UserProfile {
   experiment_bucket_map: ExperimentBucketMap;
 }
 
-export type EventTags = Record<string, unknown>;
+export type EventTags = {
+  revenue?: string | number | null;
+  value?: string | number | null;
+  $opt_event_properties?: Record<string, unknown>;
+};
 
 export interface UserProfileService {
   lookup(userId: string): UserProfile;

lib/utils/event_tag_utils/index.spec.ts

@@ -50,6 +50,8 @@ describe('getRevenueValue', () => {
   });
 
   it('should return null if the revenue value is not present in the event tags', () => {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
     const parsedRevenueValue = eventTagUtils.getRevenueValue({ not_revenue: '1337' }, logger);
 
     expect(parsedRevenueValue).toBe(null);
@@ -81,6 +83,8 @@ describe('getEventValue', () => {
   });
 
   it('should return null if the value is not present in the event tags', () => {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
     const parsedNumericValue = eventTagUtils.getEventValue({ not_value: '13.37' }, logger);
 
     expect(parsedNumericValue).toBe(null);

lib/utils/event_tag_utils/index.ts

@@ -44,11 +44,11 @@ export function getRevenueValue(eventTags: EventTags, logger?: LoggerFacade): nu
     return null;
   }
 
-  const amount = typeof rawValue === 'number' ? rawValue : typeof rawValue === 'string' ? parseInt(rawValue) : NaN;
+  const parsedRevenueValue = typeof rawValue === 'string' ? parseInt(rawValue) : rawValue;
 
-  if (isFinite(amount)) {
-    logger?.info(PARSED_REVENUE_VALUE, amount);
-    return amount;
+  if (isFinite(parsedRevenueValue)) {
+    logger?.info(PARSED_REVENUE_VALUE, parsedRevenueValue);
+    return parsedRevenueValue;
   } else {
     // NaN, +/- infinity values
     logger?.info(FAILED_TO_PARSE_REVENUE, rawValue);
@@ -70,11 +70,11 @@ export function getEventValue(eventTags: EventTags, logger?: LoggerFacade): numb
     return null;
   }
 
-  const amount = typeof rawValue === 'number' ? rawValue : typeof rawValue === 'string' ? parseFloat(rawValue) : NaN;
+  const parsedEventValue = typeof rawValue === 'string' ? parseFloat(rawValue) : rawValue;
 
-  if (isFinite(amount)) {
-    logger?.info(PARSED_NUMERIC_VALUE, amount);
-    return amount;
+  if (isFinite(parsedEventValue)) {
+    logger?.info(PARSED_NUMERIC_VALUE, parsedEventValue);
+    return parsedEventValue;
   } else {
     // NaN, +/- infinity values
     logger?.info(FAILED_TO_PARSE_VALUE, rawValue);