add custom events operation, executor, and controller

flesh out the track event operation and create custom logic

add tests for custom events

add subscription type for custom events

Author: fadi-george

__test__/support/constants.ts

@@ -44,7 +44,7 @@ export const DUMMY_GET_USER_REQUEST_WITH_PUSH_SUB = {
         session_count: 1,
         sdk: __VERSION__,
         device_model: 'MacIntel',
-        device_os: '114',
+        device_os: 114,
         rooted: false,
         test_type: 0,
         app_version: '',

__test__/support/helpers/requests.ts

@@ -325,3 +325,16 @@ export const setUpdateUserError = ({
     status,
     retryAfter,
   });
+
+// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+// custom events
+const getCustomEventsUri = () =>
+  `**/apps/${APP_ID}/integrations/sdk/custom_events`;
+export const sendCustomEventFn = vi.fn();
+export const setSendCustomEventResponse = () =>
+  getHandler({
+    uri: getCustomEventsUri(),
+    method: 'post',
+    status: 200,
+    callback: sendCustomEventFn,
+  });

src/core/CoreModule.ts

@@ -1,4 +1,6 @@
 import { logMethodCall } from 'src/shared/utils/utils';
+import { CustomEventController } from './controllers/CustomEventController';
+import { CustomEventsOperationExecutor } from './executors/CustomEventOperationExecutor';
 import { IdentityOperationExecutor } from './executors/IdentityOperationExecutor';
 import { LoginUserOperationExecutor } from './executors/LoginUserOperationExecutor';
 import { RefreshUserOperationExecutor } from './executors/RefreshUserOperationExecutor';
@@ -26,6 +28,7 @@ export default class CoreModule {
   public subscriptionModelStore: SubscriptionModelStore;
   public identityModelStore: IdentityModelStore;
   public propertiesModelStore: PropertiesModelStore;
+  public customEventController: CustomEventController;
 
   private initPromise: Promise<void>;
 
@@ -56,6 +59,11 @@ export default class CoreModule {
       this.operationModelStore,
       this.newRecordsState,
     );
+    this.customEventController = new CustomEventController(
+      this.identityModelStore,
+      this.operationRepo,
+    );
+
     this.listeners = this.initializeListeners();
     this.initPromise = this.operationRepo.start();
   }
@@ -114,13 +122,15 @@ export default class CoreModule {
       this.rebuildUserService,
       this.newRecordsState,
     );
+    const customEventOpExecutor = new CustomEventsOperationExecutor();
 
     return [
       identityOpExecutor,
       loginOpExecutor,
       refreshOpExecutor,
       subscriptionOpExecutor,
       updateSubOpExecutor,
+      customEventOpExecutor,
     ];
   }
 }

src/core/CoreModuleDirector.ts

@@ -14,6 +14,7 @@ import { PropertiesModelStore } from './modelStores/PropertiesModelStore';
 import { SubscriptionModelStore } from './modelStores/SubscriptionModelStore';
 import { NewRecordsState } from './operationRepo/NewRecordsState';
 import { type OperationRepo } from './operationRepo/OperationRepo';
+import { type ICustomEventController } from './types/customEvents';
 import { ModelChangeTags } from './types/models';
 import {
   SubscriptionChannel,
@@ -45,6 +46,10 @@ export class CoreModuleDirector {
     return this.core.subscriptionModelStore;
   }
 
+  get customEventController(): ICustomEventController {
+    return this.core.customEventController;
+  }
+
   public generatePushSubscriptionModel(
     rawPushSubscription: RawPushSubscription,
   ): SubscriptionModel {

src/core/constants.ts

@@ -15,6 +15,9 @@ export const OPERATION_NAME = {
   UPDATE_SUBSCRIPTION: 'update-subscription',
   DELETE_SUBSCRIPTION: 'delete-subscription',
   TRANSFER_SUBSCRIPTION: 'transfer-subscription',
+
+  // Custom Events Operations
+  CUSTOM_EVENT: 'custom-event',
 } as const;
 
 export const IdentityConstants = {

src/core/controllers/CustomEventController.ts

@@ -0,0 +1,32 @@
+import MainHelper from '../../shared/helpers/MainHelper';
+import { IdentityModelStore } from '../modelStores/IdentityModelStore';
+import { TrackEventOperation } from '../operations/TrackEventOperation';
+import { ICustomEvent, ICustomEventController } from '../types/customEvents';
+import { IOperationRepo } from '../types/operation';
+
+/**
+ * Implements custom event tracking functionality.
+ * This class handles sending custom events by creating TrackEventOperation instances
+ * and enqueueing them for execution via the operation repository.
+ */
+export class CustomEventController implements ICustomEventController {
+  constructor(
+    private readonly _identityModelStore: IdentityModelStore,
+    private readonly _opRepo: IOperationRepo,
+  ) {}
+
+  sendCustomEvent(event: ICustomEvent): void {
+    const appId = MainHelper.getAppId();
+    const identityModel = this._identityModelStore.model;
+
+    const op = new TrackEventOperation({
+      appId,
+      onesignalId: identityModel.onesignalId,
+      externalId: identityModel.externalId,
+      timestamp: new Date().toISOString(),
+      event,
+    });
+
+    this._opRepo.enqueue(op);
+  }
+}

src/core/executors/CustomEventOperationExecutor.ts

@@ -0,0 +1,76 @@
+import Environment from 'src/shared/helpers/Environment';
+import {
+  getResponseStatusType,
+  ResponseStatusType,
+} from 'src/shared/helpers/NetworkUtils';
+import Log from 'src/shared/libraries/Log';
+import { VERSION } from 'src/shared/utils/EnvVariables';
+import { OPERATION_NAME } from '../constants';
+import { ExecutionResponse } from '../operations/ExecutionResponse';
+import { Operation } from '../operations/Operation';
+import { TrackEventOperation } from '../operations/TrackEventOperation';
+import { RequestService } from '../requestService/RequestService';
+import { ICustomEventMetadata } from '../types/customEvents';
+import { ExecutionResult, IOperationExecutor } from '../types/operation';
+
+// Implements logic similar to Android SDK's CustomEventOperationExecutor
+// Reference: https://github.com/OneSignal/OneSignal-Android-SDK/blob/main/OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/operations/impl/executors/CustomEventOperationExecutor.kt
+export class CustomEventsOperationExecutor implements IOperationExecutor {
+  constructor() {}
+
+  get operations(): string[] {
+    return [OPERATION_NAME.CUSTOM_EVENT];
+  }
+
+  private get eventMetadata(): ICustomEventMetadata {
+    return {
+      sdk: VERSION,
+      device_model: Environment.getDeviceModel(),
+      device_os: Environment.getDeviceOS(),
+      type: Environment.getSubscriptionType(),
+    };
+  }
+
+  async execute(operations: Operation[]): Promise<ExecutionResponse> {
+    Log.debug(
+      `CustomEventsOperationExecutor(operations: ${JSON.stringify(
+        operations,
+      )})`,
+    );
+
+    // TODO: each trackEvent is sent individually right now; may need to batch in the future
+    const operation = operations[0];
+
+    if (!(operation instanceof TrackEventOperation)) {
+      throw new Error(
+        `Unrecognized operation! Expected TrackEventOperation, got: ${operation.constructor.name}`,
+      );
+    }
+
+    const response = await RequestService.sendCustomEvent(
+      { appId: operation.appId },
+      {
+        name: operation.event.name,
+        onesignal_id: operation.onesignalId,
+        external_id: operation.externalId,
+        timestamp: operation.timestamp,
+        payload: {
+          ...(operation.event.properties ?? {}),
+          os_sdk: this.eventMetadata,
+        },
+      },
+    );
+
+    const { ok, status } = response;
+    const responseType = getResponseStatusType(status);
+
+    if (ok) return new ExecutionResponse(ExecutionResult.SUCCESS);
+
+    switch (responseType) {
+      case ResponseStatusType.RETRYABLE:
+        return new ExecutionResponse(ExecutionResult.FAIL_RETRY);
+      default:
+        return new ExecutionResponse(ExecutionResult.FAIL_NORETRY);
+    }
+  }
+}

src/core/executors/RefreshUserOperationExecutor.test.ts

@@ -161,9 +161,6 @@ describe('RefreshUserOperationExecutor', () => {
         enabled: false,
         token: 'test@example.com',
         type: SubscriptionType.Email,
-        device_os: '',
-        device_model: '',
-        sdk: '',
       });
     });
 

src/core/executors/RefreshUserOperationExecutor.ts

@@ -106,9 +106,9 @@ export class RefreshUserOperationExecutor implements IOperationExecutor {
         model.type = sub.type;
         model.enabled =
           model.notification_types !== NotificationType.UserOptedOut;
-        model.sdk = sub.sdk ?? '';
-        model.device_os = sub.device_os ?? '';
-        model.device_model = sub.device_model ?? '';
+        model.sdk = sub.sdk;
+        model.device_os = sub.device_os;
+        model.device_model = sub.device_model;
         model.onesignalId = op.onesignalId;
 
         // We only add a non-push subscriptions. For push, the device is the source of truth

src/core/listeners/types.ts

@@ -1,6 +1,8 @@
 import type { Model } from '../models/Model';
-import type { IEventNotifier } from '../types/events';
-import type { ISingletonModelStoreChangeHandler } from '../types/models';
+import type {
+  IEventNotifier,
+  ISingletonModelStoreChangeHandler,
+} from '../types/models';
 
 export interface ISingletonModelStore<TModel extends Model>
   extends IEventNotifier<ISingletonModelStoreChangeHandler<TModel>> {