@reservamos/browser-analytics 1.0.3 → 1.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reservamos/browser-analytics",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/reservamos/reservamos-browser-analytics.git"

package/src/events/customEvent/trackCustomEvent.ts

@@ -1,5 +1,5 @@
 import type { EventData, EventMetadata } from '@/types/eventData';
-import { trackEvent } from '@/track';
+import { trackEvent, trackEventError } from '@/track';
 import { eventNameSchema } from './customEventSchema';
 
 /**
@@ -18,7 +18,7 @@ function trackCustomEvent(
     trackEvent(eventName, eventData, meta);
   } catch (error) {
     console.error('Error trackCustomEvent:', error);
-    return;
+    trackEventError(eventName, error);
   }
 }
 

package/src/events/identify/identify.ts

@@ -1,5 +1,6 @@
 import createAnonymousProfile from '@/profiles/createAnonymousProfile';
 import validatorService from '@/services/validator';
+import { trackEventError } from '@/track';
 import fingerprintService from '../../services/fingerprint';
 import mixpanelService from '../../services/mixpanel';
 import { DefaultProperties } from './identifySchema';
@@ -70,8 +71,8 @@ async function identify(
     }
     const anonymousProfile = await createAnonymousProfile(properties);
 
-    if(anonymousProfile){
-      properties.reservamos_one_id= anonymousProfile.id
+    if (anonymousProfile) {
+      properties.reservamos_one_id = anonymousProfile.id;
     }
     const mappedProps = mapProperties(properties);
     mixpanelService.identify(userId, mappedProps);
@@ -81,6 +82,7 @@ async function identify(
     }
   } catch (error) {
     console.error('Error identifying user', error);
+    trackEventError('Identify', error);
   }
 }
 

package/src/services/validator/index.ts

@@ -0,0 +1,4 @@
+import validatorService, { eventSchemas, InitConfigSchema } from './validator';
+
+export { InitConfigSchema, eventSchemas };
+export default validatorService;

package/src/services/validator/validator.test.ts

@@ -0,0 +1,41 @@
+import { describe, expect, it } from 'vitest';
+import { customEventSchema } from '@/events/customEvent';
+import validatorService, { eventSchemas } from './validator';
+
+describe('parseEventProps', () => {
+  /**
+   * This test supposes that unknownEvent is not a known event.
+   * And that the customEventSchema does not support objects as values for a field.
+   */
+  it('Should use the customEventSchema if the event name is not a known event.', () => {
+    const customEventName = 'unknownEvent';
+    const invalidCustomEventData = {
+      test: {
+        test: 'test',
+      },
+    };
+    expect(Object.keys(eventSchemas).includes(customEventName)).toBe(false);
+    expect(() =>
+      validatorService.validateProps(invalidCustomEventData, customEventSchema),
+    ).toThrow();
+    expect(() =>
+      validatorService.parseEventProps(customEventName, invalidCustomEventData),
+    ).toThrow();
+  });
+
+  /**
+   * This test supposes that all known event schema validations
+   * will fail if the event data is empty.
+   */
+  it('Should use the known event schema if the event name is a known event.', () => {
+    const invalidKnownEventData = {};
+    Object.entries(eventSchemas).forEach(([eventName, eventSchema]) => {
+      expect(() =>
+        validatorService.validateProps(invalidKnownEventData, eventSchema),
+      ).toThrow();
+      expect(() =>
+        validatorService.parseEventProps(eventName, invalidKnownEventData),
+      ).toThrow();
+    });
+  });
+});

package/src/services/{validator.ts → validator/validator.ts}

@@ -11,8 +11,7 @@ import { searchSchema } from '@/events/search';
 import { seatChangeSchema } from '@/events/seatChange';
 import { viewResultsSchema } from '@/events/viewResults';
 
-const TrackTestEventSchema = z.object({}); // Allow empty object for track test event
-export const InitConfigSchema = z.object({
+const InitConfigSchema = z.object({
   /**
    * The Mixpanel token used for authenticating API requests.
    */
@@ -40,6 +39,7 @@ export const InitConfigSchema = z.object({
    */
   identifyProxyUrl: z.string().optional(),
 });
+
 interface CustomError {
   field: string;
   error_type: string;
@@ -48,6 +48,7 @@ interface CustomError {
   message: string;
   suggestion: string;
 }
+
 // Error formatting
 const SchemaErrorFormatter = (error: ZodError): CustomError[] => {
   return error.issues.map((issue) => {
@@ -84,7 +85,6 @@ const SchemaErrorFormatter = (error: ZodError): CustomError[] => {
 
 // Mapping event names to Zod schemas
 const eventSchemas: Record<string, z.ZodSchema> = {
-  'Track Test': TrackTestEventSchema,
   'Search': searchSchema,
   'Seat Change': seatChangeSchema,
   'Interest In Home': interestInHomeSchema,
@@ -109,10 +109,6 @@ type EventDataSchema = z.infer<
 function parseEventProps(eventName: string, eventData: EventDataSchema): void {
   const eventSchema = eventSchemas[eventName] || customEventSchema;
 
-  if (!eventSchema) {
-    throw { message: `Event ${eventName} not found` };
-  }
-
   try {
     eventSchema.parse(eventData);
   } catch (error) {
@@ -167,5 +163,5 @@ const validatorService = {
   validateProps,
 };
 
-// Export the validator object
+export { InitConfigSchema, eventSchemas };
 export default validatorService;

package/src/track.ts

@@ -63,6 +63,23 @@ function flattenEventData(data: object): EventData {
   }, {} as EventData);
 }
 
+/**
+ * Send an error event to Mixpanel when an event fails to track.
+ * The event contains the event name, error message, and validation errors.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function trackEventError(eventName: string, error: any): void {
+  try {
+    mixpanelService.track('Track Event Error', {
+      'Failed Event Name': eventName,
+      'Error Message': error?.message ?? 'Failed to track event',
+      'Validation Errors': error?.errors || [],
+    });
+  } catch (trackingError) {
+    console.error('Failed to track error event:', trackingError);
+  }
+}
+
 /**
  * Base function to track events with Mixpanel.
  * This function adds default properties like User Fingerprint.
@@ -101,6 +118,7 @@ export async function trackEvent(
     mixpanelService.track(eventName, properties);
   } catch (error) {
     console.error(`Error tracking event '${eventName}':`, error);
+    trackEventError(eventName, error);
   }
 }