SDK-2871 Optimize Bundle Size by Using Simple UserAgent Parsing by fadi-george · Pull Request #1342 · OneSignal/OneSignal-Website-SDK

fadi-george · 2025-07-29T20:40:47Z

Description

1 Line Summary

remove bowser library in favor of simple user agent parsing

Details

removes bowser library and bowserCastle helpers
creates user agent shared helpers for determining browser name, version, is a mobile browser, is a tablet browser, etc.
removes mockUserAgent test helper by updating setup tests to set a default user agent
moves some helpers from utils/utils to helpers/general, helpers/dom for better organization
split out event helpers logic to shared/listeners that are more tree-shake-able

# Previous Build fe3613
  build/releases/OneSignalSDK.page.js
  Size limit: 631 B
  Size:       631 B gzipped
  
  build/releases/OneSignalSDK.page.es6.js
  Size limit: 63.75 kB
  Size:       63.68 kB gzipped
  
  build/releases/OneSignalSDK.sw.js
  Size limit: 34 kB
  Size:       33.96 kB gzipped
  
  build/releases/OneSignalSDK.page.styles.css
  Size limit: 8.81 kB
  Size:       8.8 kB  gzipped

# Current Branch
  build/releases/OneSignalSDK.page.js
  Size limit: 631 B
  Size:       631 B gzipped
  
  build/releases/OneSignalSDK.page.es6.js
  Size limit: 60.6 kB
  Size:       60.53 kB gzipped
  
  build/releases/OneSignalSDK.sw.js
  Size limit: 25.25 kB
  Size:       25.19 kB gzipped
  
  build/releases/OneSignalSDK.page.styles.css
  Size limit: 8.81 kB
  Size:       8.8 kB  gzipped

Screenshots

iPad - Safari Desktop Browsing

iPad- Request Mobile Site

iPhone Safari:

macOS Safari:

Firefox:

Opera:

Edge:

Chrome:

Systems Affected

WebSDK
Backend
Dashboard

Validation

Tests

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

FYI the following test is failing locally on this branch, it might be flaky:

src/onesignal/OneSignal.test.ts > OneSignal > Custom Events > custom event can execute before login for an existing user w/ no external id
Error: Timed out in waitUntil!

sherwinski · 2025-08-06T18:17:46Z

+      (getBrowserName() === Browser.Chrome &&
+        (isTabletBrowser() || isMobileBrowser())) ||
+      requiresUserInteraction()


I'm not sure if this is still important today but we're missing this check:

Number(browserVersion) >= 63

sherwinski · 2025-08-06T18:22:52Z

+  /* S T A T I C */
+
+  /**
+   * Get the User Model Subscription type based on browser detection.
+   */
+  public static getSubscriptionType(): SubscriptionTypeValue {
+    const browserName = getBrowserName();
+    if (browserName === 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.
+   */
+  public static getDeviceType(): DeliveryPlatformKindValue {
+    switch (this.getSubscriptionType()) {
+      case SubscriptionType.FirefoxPush:
+        return DeliveryPlatformKind.Firefox;
+      case SubscriptionType.SafariLegacyPush:
+        return DeliveryPlatformKind.SafariLegacy;
+      case SubscriptionType.SafariPush:
+        return DeliveryPlatformKind.SafariVapid;
+    }
+    return DeliveryPlatformKind.ChromeLike;
+  }
+
+  public static getDeviceOS(): string | number {
+    const browserVersion = getBrowserVersion();
+    return isNaN(browserVersion) ? -1 : browserVersion;
+  }
+
+  public static getDeviceModel(): string {
+    return navigator.platform;
+  }
+
+  public static getSdk(): string {
+    return String(VERSION);
+  }


nit: I'm a little confused why this logic is being moved to this file

Not intended, removed

sherwinski · 2025-08-06T19:16:47Z

+export function isTabletBrowser(): boolean {
+  const ua = navigator.userAgent.toLowerCase();
+
+  const isIPad = /\bipad\b/.test(ua);
+  const isAndroidTablet = /android/.test(ua) && !/mobile/.test(ua); // Android tablets don't include "mobile"
+  const isWindowsTablet =
+    /windows/.test(ua) && /touch/.test(ua) && !/phone/.test(ua);
+  const isKindleOrFire = /kindle|silk|kf[a-z]{2,}/.test(ua); // Amazon devices
+
+  return isIPad || isAndroidTablet || isWindowsTablet || isKindleOrFire;
+}


Is there a resource we can link to that exhaustively lists the different user agents we can expect? It would be good for future reference.

Ah I see there's one mentioned here: __test__/constants/useragent.ts. Might be good to add a comment in this file to either reference that same URL or this file.

Added comment, logic was based off detect-ua package

sherwinski · 2025-08-06T19:33:15Z

+/**
+ * NOTE: This uses the OneSignal REST API POST /notifications with
+ * include_player_ids. This field will be dropped by 2025 so a
+ * replacement will needed by then.
+ */


Is this still a concern? Something we might have to address in a future PR.

I see a sendConvertedAPIRequests that reports a notification as clicked but I dont see post call anymore. This seems to be a misleading comment.

sherwinski · 2025-08-06T20:02:02Z

+    if (useSafariVapidPush()) {
+      return SubscriptionType.SafariPush;
+    }
+    if (useSafariLegacyPush) {


Should this be useSafariLegacyPush()?

I made it a basic constant. Also Ill remove these since they are in shared/environment

sherwinski · 2025-08-06T20:07:16Z

@@ -0,0 +1,137 @@
+import Log from 'src/sw/libraries/Log';


what's the difference between this Log and the one in src/shared/libraries/Log.ts?

Should be src/shared/libraries/Log. In future prs ill combine them together

- remove duplicate code - add version check for prompts manager

fadi-george requested review from jkasten2 and sherwinski July 29, 2025 20:46

fadi-george marked this pull request as draft July 30, 2025 08:22

fadi-george force-pushed the fadi/sdk-2871-use-simpler-user-agent-helpers branch from f6603b1 to 8e4f09c Compare July 30, 2025 18:38

fadi-george marked this pull request as ready for review July 31, 2025 01:48

fadi-george force-pushed the fadi/sdk-2871-use-simpler-user-agent-helpers branch from 29eb2c7 to 2c2c9e8 Compare July 31, 2025 23:28

fadi-george added 11 commits August 1, 2025 15:00

replace bowser castle logic for simpler user agent helpers

5958719

fix tests

dc95596

move session module to src/shared/session

6193016

move from utils/utils to helpers

ab6463a

move events helpers to shared/listeners

ec09b10

add tests for browser name

ee12190

add newer user agent constants

2576937

simplify user agent logic

c895ec1

more improvements to user agent logic

78e312c

more improvements

2f56b2e

address merge conflicts

b7667b0

fadi-george force-pushed the fadi/sdk-2871-use-simpler-user-agent-helpers branch from 2c2c9e8 to b7667b0 Compare August 1, 2025 22:00

fadi-george changed the title ~~Optimize Bundle Size by Using Simple UserAgent Parsing~~ SDK-2871 Optimize Bundle Size by Using Simple UserAgent Parsing Aug 4, 2025

sherwinski requested changes Aug 6, 2025

View reviewed changes

fadi-george force-pushed the fadi/sdk-2871-use-simpler-user-agent-helpers branch 6 times, most recently from 747f4a3 to 5463db9 Compare August 6, 2025 21:42

address pr comments

b069192

- remove duplicate code - add version check for prompts manager

fadi-george force-pushed the fadi/sdk-2871-use-simpler-user-agent-helpers branch from 5463db9 to b069192 Compare August 6, 2025 22:28

fadi-george requested a review from sherwinski August 6, 2025 22:29

sherwinski approved these changes Aug 6, 2025

View reviewed changes

fadi-george merged commit 5174ae4 into main Aug 6, 2025
4 checks passed

fadi-george deleted the fadi/sdk-2871-use-simpler-user-agent-helpers branch August 6, 2025 22:37

Conversation

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

Uh oh!

Description

1 Line Summary

Details

Screenshots

iPad - Safari Desktop Browsing

iPad- Request Mobile Site

iPhone Safari:

macOS Safari:

Firefox:

Opera:

Edge:

Chrome:

Systems Affected

Validation

Tests

Info

Checklist

Info

Checklist

Related Tickets

Uh oh!

sherwinski left a comment

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!

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!

sherwinski Aug 6, 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!

fadi-george Aug 6, 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!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

fadi-george commented Jul 29, 2025 •

edited

Loading

sherwinski Aug 6, 2025 •

edited

Loading

fadi-george Aug 6, 2025 •

edited

Loading