Add Custom Events by fadi-george · Pull Request #1336 · OneSignal/OneSignal-Website-SDK

fadi-george · 2025-07-23T22:42:24Z

Description

1 Line Summary

Add custom events logic for the web sdk.
Reference docs:

Details

Adds a track event operation and event operation executor logic similar to Android
Updates core director to have both custom event controller and executor
Moves env helpers like getDeviceOS and getDeviceModel to Environment class
Adds sendCustomEvent request service helper
Updates device_os types to just be a string/undefined
Updates resetUserModels to update operation local onesignal ids to new local onesignal ids if valid. This is for situations we call trackEvent before login where trackEvent sets a localid but login resets the ids again so we need to update the previous ids. Since we only check for local id, if user was already create then trackEvent; login; for an existing user should use different ids.
Updates login call to not use currentOneSignalId if its local since login op wont execute for cases we call trackEvent then login.

Systems Affected

WebSDK
Backend
Dashboard

Screenshots

Validation

Tests

Add tests cases for UserNamespace as well OneSignal.test cases for calling track.

Can test manually by setting app id to Mikes Test App. And setting port to 4001 for vite.config.

Info

Checklist

All the automated tests pass or I explained why that is not possible
I have personally tested this on my machine or explained why that is not possible
I have included test coverage for these changes or explained why they are not needed

Programming Checklist
Interfaces:

Don't use default export
New interfaces are in model files

Functions:

Don't use default export
All function signatures have return types
Helpers should not access any data but rather be given the data to operate on.

Typescript:

No Typescript warnings
Avoid silencing null/undefined warnings with the exclamation point

Other:

Iteration: refrain from using elem of array syntax. Prefer forEach or use map
Avoid using global OneSignal accessor for context if possible. Instead, we can pass it to function/constructor so that we don't call OneSignal.context

Info

Checklist

I have included screenshots/recordings of the intended results or explained why they are not needed

Related Tickets

This change is

sherwinski · 2025-07-29T22:31:53Z

+        model.sdk = sub.sdk;
+        model.device_os = sub.device_os;
+        model.device_model = sub.device_model;


does this mean if any of these values are missing, they will get saved/sent as undefined?

refresh call should have the sdk, device_os and device_module information

Also updated device_os to be a string.

sherwinski · 2025-07-29T22:35:03Z

+  get timestamp(): string {
+    return this.getProperty('timestamp');
+  }
+  private set timestamp(value: string) {


should this default to now()?

We set a custom iso string from the caller

sherwinski · 2025-07-29T22:36:06Z

-  /**
-   * Lists all aliases for the user identified by the given subscription id
-   * @param requestMetadata - { appId }
-   * @param subscriptionId - subscription id
-   */
-  static async getIdentityFromSubscription(
-    requestMetadata: RequestMetadata,
-    subscriptionId: string,
-  ) {
-    const { appId } = requestMetadata;
-    return OneSignalApiBase.get<{ identity: IUserIdentity }>(
-      `apps/${appId}/subscriptions/${subscriptionId}/user/identity`,
-    );
-  }
-
-  /**
-   * Upserts one or more aliases for the user identified by the given subscription id
-   * @param requestMetadata - { appId }
-   * @param subscriptionId - subscription id
-   * @param identity - identity label & id
-   */
-  static async identifyUserForSubscription(
-    requestMetadata: RequestMetadata,
-    subscriptionId: string,
-    identity: IdentityModel,
-  ): Promise<OneSignalApiBaseResponse> {
-    const { appId } = requestMetadata;
-    return OneSignalApiBase.patch<{ identity: IUserIdentity }>(
-      `apps/${appId}/users/by/subscriptions/${subscriptionId}/identity`,
-      { identity },
-      requestMetadata.jwtHeader,
-    );
-  }
-


why was this removed?

sherwinski · 2025-07-30T06:09:24Z

+export const getSubscriptionType = (): SubscriptionTypeValue => {
+  const browser = OneSignalUtils.redetectBrowserUserAgent();
+  if (browser.firefox) {
+    return SubscriptionType.FirefoxPush;
+  }
+  if (useSafariVapidPush()) {
+    return SubscriptionType.SafariPush;
+  }
+  if (useSafariLegacyPush) {
+    return SubscriptionType.SafariLegacyPush;
+  }
+  // Other browsers, like Edge, are Chromium based so we consider them "Chrome".
+  return SubscriptionType.ChromePush;
+};
+
+/**
+ * Get the legacy player.device_type
+ * NOTE: Use getSubscriptionType() instead when possible.
+ */
+export function getDeviceType(): DeliveryPlatformKindValue {
+  switch (getSubscriptionType()) {
+    case SubscriptionType.FirefoxPush:
+      return DeliveryPlatformKind.Firefox;
+    case SubscriptionType.SafariLegacyPush:
+      return DeliveryPlatformKind.SafariLegacy;
+    case SubscriptionType.SafariPush:
+      return DeliveryPlatformKind.SafariVapid;
+  }
+  return DeliveryPlatformKind.ChromeLike;
+}
+
+export function getDeviceOS(): string {
+  const environment = EnvironmentInfoHelper.getEnvironmentInfo();
+  return String(
+    isNaN(environment.browserVersion) ? -1 : environment.browserVersion,
+  );
+}
+
+export function getDeviceModel(): string {
+  return navigator.platform;
+}


I'm not sure I follow: why was this moved from FuturePushSubscriptionRecord?

Because its used in multiple places like custom events and subscription op

flesh out the track event operation and create custom logic add tests for custom events add subscription type for custom events

sherwinski · 2025-07-30T21:10:53Z

If I enqueue a trackEvent call and then refresh the page (before the operation gets executed) I get the following error:

ReplayCallsOnOneSignal.ts:15 TypeError: Cannot read properties of undefined (reading 'appId')
    at new TrackEventOperation (TrackEventOperation.ts:29:46)
    at OperationModelStore.create (OperationModelStore.ts:71:21)
    at OperationModelStore.load (ModelStore.ts:169:29)
    at async OperationRepo.loadSavedOperations (OperationRepo.ts:361:11)
    at async OperationRepo.start (OperationRepo.ts:94:5)
    at async OneSignal2._initializeCoreModuleAndOSNamespaces (OneSignal.ts:42:5)
    at async OneSignal2.init (OneSignal.ts:145:5)
    at async ?app_id=77e32082-ea27-42e3-a898-c72e141824ef:40:7
    at async ReplayCallsOnOneSignal.processOneSignalDeferredArray (ReplayCallsOnOneSignal.ts:12:15)

sherwinski · 2025-07-30T21:53:07Z

Sending a custom event without a onesignalId or externalId results in a 403. In this case it should await the onesignalId like addTag.

fadi-george · 2025-07-31T00:58:40Z

If I enqueue a trackEvent call and then refresh the page (before the operation gets executed) I get the following error:

ReplayCallsOnOneSignal.ts:15 TypeError: Cannot read properties of undefined (reading 'appId')
    at new TrackEventOperation (TrackEventOperation.ts:29:46)
    at OperationModelStore.create (OperationModelStore.ts:71:21)
    at OperationModelStore.load (ModelStore.ts:169:29)
    at async OperationRepo.loadSavedOperations (OperationRepo.ts:361:11)
    at async OperationRepo.start (OperationRepo.ts:94:5)
    at async OneSignal2._initializeCoreModuleAndOSNamespaces (OneSignal.ts:42:5)
    at async OneSignal2.init (OneSignal.ts:145:5)
    at async ?app_id=77e32082-ea27-42e3-a898-c72e141824ef:40:7
    at async ReplayCallsOnOneSignal.processOneSignalDeferredArray (ReplayCallsOnOneSignal.ts:12:15)

Should be fixed now

fadi-george · 2025-07-31T00:58:48Z

Sending a custom event without a onesignalId or externalId results in a 403. In this case it should await the onesignalId like addTag.

Try it now

set local id for identity if it doesnt exist, allow to execut after login is called

nan-li · 2025-07-31T18:20:58Z

+  override get createComparisonKey(): string {
+    return this.key;
+  }
+  override get modifyComparisonKey(): string {
+    return this.key;


createComparisonKey and modifyComparisonKey should both be nothing (aka empty string). Having this set to a value can be misleading or confusing down the line if someone was trying to figure out how we were using these keys to batch. It is effectively no different than using a random UUID.

If we do batch in the future, it'll probably be more like ${this.appId}.User.${this.onesignalId}.CustomEvent dropping the name identifier and batch per user.

In our meeting, we said this is fine for now.

add more test cases

fadi-george requested review from jinliu9508 and sherwinski July 23, 2025 22:46

fadi-george force-pushed the fg/custom-events branch 2 times, most recently from 56e3bb5 to b3ff042 Compare July 23, 2025 23:08

fadi-george requested a review from nan-li July 23, 2025 23:48

fadi-george force-pushed the fg/custom-events branch from ed3bc3a to b7a9b6d Compare July 25, 2025 17:48

sherwinski reviewed Jul 29, 2025

View reviewed changes

fadi-george force-pushed the fg/custom-events branch from b7a9b6d to f542664 Compare July 29, 2025 23:53

fadi-george requested a review from sherwinski July 30, 2025 00:06

sherwinski reviewed Jul 30, 2025

View reviewed changes

fadi-george requested a review from sherwinski July 30, 2025 18:18

fadi-george added 3 commits July 30, 2025 11:18

add custom events operation, executor, and controller

a66415b

flesh out the track event operation and create custom logic add tests for custom events add subscription type for custom events

fix import type usage

450ce08

address merge conflict with size optimization changes

2130b0f

fadi-george force-pushed the fg/custom-events branch from 5ef1467 to a23271a Compare July 30, 2025 18:18

address pr comments

1eccea5

fadi-george force-pushed the fg/custom-events branch from a23271a to 1eccea5 Compare July 30, 2025 18:25

fadi-george force-pushed the fg/custom-events branch 4 times, most recently from 09132b1 to 9d1cf40 Compare July 31, 2025 00:58

fadi-george force-pushed the fg/custom-events branch from 9d1cf40 to f13ff4a Compare July 31, 2025 01:06

sherwinski approved these changes Jul 31, 2025

View reviewed changes

Comment thread src/core/executors/LoginUserOperationExecutor.ts Outdated

jinliu9508 reviewed Jul 31, 2025

View reviewed changes

Comment thread src/core/operations/TrackEventOperation.ts Outdated

Comment thread src/onesignal/User.ts Outdated

Comment thread src/onesignal/UserDirector.ts Outdated

Comment thread vite.config.ts Outdated

address pr comments

b2d4239

set local id for identity if it doesnt exist, allow to execut after login is called

fadi-george force-pushed the fg/custom-events branch from f13ff4a to b2d4239 Compare July 31, 2025 17:32

fadi-george force-pushed the fg/custom-events branch 2 times, most recently from 3ef0768 to f5930c6 Compare July 31, 2025 17:38

nan-li reviewed Jul 31, 2025

View reviewed changes

fadi-george force-pushed the fg/custom-events branch from f5930c6 to ef9371d Compare July 31, 2025 18:33

jinliu9508 approved these changes Jul 31, 2025

View reviewed changes

fadi-george force-pushed the fg/custom-events branch from ef9371d to 782513f Compare July 31, 2025 21:18

address more pr comments

17508b2

add more test cases

fadi-george force-pushed the fg/custom-events branch from 782513f to 17508b2 Compare July 31, 2025 21:22

warn user must be logged in first for track event

085cd1d

fadi-george force-pushed the fg/custom-events branch from bdef986 to 085cd1d Compare July 31, 2025 22:32

fadi-george merged commit 467f7b4 into main Jul 31, 2025
4 checks passed

fadi-george deleted the fg/custom-events branch July 31, 2025 22:36

fadi-george mentioned this pull request Jul 31, 2025

chore(release): v160500 #1343

Merged

Conversation

fadi-george commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

1 Line Summary

Details

Systems Affected

Screenshots

Validation

Tests

Info

Checklist

Info

Checklist

Related Tickets

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fadi-george Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sherwinski commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sherwinski commented Jul 30, 2025

Uh oh!

fadi-george commented Jul 31, 2025

Uh oh!

fadi-george commented Jul 31, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nan-li Jul 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fadi-george commented Jul 23, 2025 •

edited

Loading

fadi-george Jul 30, 2025 •

edited

Loading

sherwinski commented Jul 30, 2025 •

edited

Loading

nan-li Jul 31, 2025 •

edited

Loading