feat: Add Kotlin MainApplication and suspend initialization support by abdulraqeeb33 · Pull Request #2374 · OneSignal/OneSignal-Android-SDK

abdulraqeeb33 · 2025-10-01T21:22:15Z

Create MainApplicationKT.kt as Kotlin version of MainApplication.java
Add initWithContextSuspend() method for async initialization
Refactor OneSignalImp to use IO dispatcher internally for initialization
Add comprehensive unit tests for suspend initialization
Rename LatchAwaiter to CompletionAwaiter for better semantics and unify suspend and blocking thread notification
Add helper classes for user management (AppIdHelper, LoginHelper, LogoutHelper, UserSwitcher)
Ensure ANR prevention by using background threads for initialization

Description

One Line Summary

Modernizing the SDK to use Kotlin Coroutines

Details

Motivation

Convert MainApplication from Java to Kotlin with modern async handling using coroutines, add suspend methods to OneSignal SDK for better ANR prevention, and deprecate the Java implementation to encourage migration to the improved Kotlin version.

Scope

SDK Initialization
Added new public APIs

Testing

Unit testing

Added a bunch of tests

Manual testing

Tested happy path

Affected code checklist

Checklist

Overview

I have filled out all REQUIRED sections above
PR does one thing
- If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR
Any Public API changes are explained in the PR details and conform to existing APIs

Testing

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

Final pass

Code is as readable as possible.
- Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code.
I have reviewed this PR myself, ensuring it meets each checklist item
- WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this.

This change is

- Add MainApplicationKT.kt as Kotlin version of MainApplication.java - Add initWithContextSuspend() method for async initialization - Refactor OneSignalImp to use IO dispatcher internally for initialization - Add comprehensive unit tests for suspend initialization - Rename LatchAwaiter to CompletionAwaiter for better semantics - Add helper classes for user management (AppIdHelper, LoginHelper, LogoutHelper, UserSwitcher) - Update build.gradle to include Kotlin coroutines dependency - Ensure ANR prevention by using background threads for initialization

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/startup/StartupService.kt

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/internal/OneSignalImp.kt

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/IOneSignal.kt

Examples/OneSignalDemo/app/build.gradle

...esignal/core/src/main/java/com/onesignal/core/internal/preferences/PreferencesExtensionV4.kt

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/startup/StartupService.kt

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/AppIdResolution.kt

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/LoginHelper.kt

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/LogoutHelper.kt

...nalSDK/onesignal/core/src/test/java/com/onesignal/common/threading/CompletionAwaiterTests.kt

* Using dispatcher * Update threads to 2 * Updated methods * linting * readme * using the same thread pool * lint * making sure initstate has the right value * lint * Clear state and skip performance tests * lint * clear preferences * fixing tests * fixing tests * fixing tests * fixing tests * fixing tests * addressed PR comments * Addressed comments and fixed tests * lint * lint * fix test * lint * rewrote the test * fix test * made the test more robust * clear all preferences and simplified mocks * added more robustness --------- Co-authored-by: AR Abdul Azeez <abdul@onesignal.com>

…alls - Replace coVerifyOrder with individual coVerify(exactly = 1) calls - Makes tests more resilient to timing variations in CI/CD environments - Maintains verification of all critical operations while allowing flexibility in exact timing

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/AppIdResolution.kt

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/internal/OneSignalImp.kt

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/user/internal/UserSwitcher.kt

…tcher

abdulraqeeb33

@jkasten2 please check the latest comments as well.

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/http/impl/HttpClient.kt

...signal/core/src/main/java/com/onesignal/core/internal/preferences/impl/PreferencesService.kt

...gnal/core/src/main/java/com/onesignal/user/internal/migrations/RecoverFromDroppedLoginBug.kt

...l/in-app-messages/src/main/java/com/onesignal/inAppMessages/internal/InAppMessagesManager.kt

...java/com/onesignal/notifications/internal/generation/impl/NotificationGenerationProcessor.kt

...va/com/onesignal/notifications/internal/permissions/impl/NotificationPermissionController.kt

...gnalSDK/onesignal/core/src/test/java/com/onesignal/core/internal/application/SDKInitTests.kt

* refactor: move initialization process off main thread * Release 5.4.0-alpha-01 * feat: Add Kotlin MainApplication and suspend initialization support (#2374) * feat: Add Kotlin MainApplication and suspend initialization support - Add MainApplicationKT.kt as Kotlin version of MainApplication.java - Add initWithContextSuspend() method for async initialization - Refactor OneSignalImp to use IO dispatcher internally for initialization - Add comprehensive unit tests for suspend initialization - Rename LatchAwaiter to CompletionAwaiter for better semantics - Add helper classes for user management (AppIdHelper, LoginHelper, LogoutHelper, UserSwitcher) - Update build.gradle to include Kotlin coroutines dependency - Ensure ANR prevention by using background threads for initialization * Added more tests * mandating passing app id in the login/logout methods * linting * Made app id mandatory for login and logout. * cleanup * reduce the forks * Time out, deprecate annotation and appid,context * ktlin * include MainApplication.java, locks, early returns * chore: Dispatcher Threads (#2375) * Using dispatcher * Update threads to 2 * Updated methods * linting * readme * using the same thread pool * lint * making sure initstate has the right value * lint * Clear state and skip performance tests * lint * clear preferences * fixing tests * fixing tests * fixing tests * fixing tests * fixing tests * addressed PR comments * Addressed comments and fixed tests * lint * lint * fix test * lint * rewrote the test * fix test * made the test more robust * clear all preferences and simplified mocks * added more robustness --------- Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> * Fix OperationRepoTests CI/CD flakiness by using individual coVerify calls - Replace coVerifyOrder with individual coVerify(exactly = 1) calls - Makes tests more resilient to timing variations in CI/CD environments - Maintains verification of all critical operations while allowing flexibility in exact timing * remove try catch and lint * Addressed comments, removed global scope launches, broke down userswitcher * fixed flag * fix tests * making sure using the name instead of value * test isolation * logout test * comments * cleanup --------- Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> * chore: bump SDK_VERSION to 5.4.0-alpha-02 (#2386) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Fix permissions activity (#2388) * broke down permissions activity * fixed the permissions dialog * cleanup * permissions tests * lint * waiting to false for pause * added some tests for pause * uncommented the code * removed duplicate class * fixed wrong import * fixed imports * fixed bug to display the dialog after cancelling * formatting ktlint * tests * lint * adding delay * removing the theme and going back to production * add a delay * add a delay --------- Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> * chore: bump SDK_VERSION to 5.4.0-alpha-03 (#2392) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * spotless check * added more time * added more time --------- Co-authored-by: jinliu9508 <jinliu9508@gmail.com> Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* refactor: move initialization process off main thread * Release 5.4.0-alpha-01 * feat: Add Kotlin MainApplication and suspend initialization support (#2374) * feat: Add Kotlin MainApplication and suspend initialization support - Add MainApplicationKT.kt as Kotlin version of MainApplication.java - Add initWithContextSuspend() method for async initialization - Refactor OneSignalImp to use IO dispatcher internally for initialization - Add comprehensive unit tests for suspend initialization - Rename LatchAwaiter to CompletionAwaiter for better semantics - Add helper classes for user management (AppIdHelper, LoginHelper, LogoutHelper, UserSwitcher) - Update build.gradle to include Kotlin coroutines dependency - Ensure ANR prevention by using background threads for initialization * Added more tests * mandating passing app id in the login/logout methods * linting * Made app id mandatory for login and logout. * cleanup * reduce the forks * Time out, deprecate annotation and appid,context * ktlin * include MainApplication.java, locks, early returns * chore: Dispatcher Threads (#2375) * Using dispatcher * Update threads to 2 * Updated methods * linting * readme * using the same thread pool * lint * making sure initstate has the right value * lint * Clear state and skip performance tests * lint * clear preferences * fixing tests * fixing tests * fixing tests * fixing tests * fixing tests * addressed PR comments * Addressed comments and fixed tests * lint * lint * fix test * lint * rewrote the test * fix test * made the test more robust * clear all preferences and simplified mocks * added more robustness --------- Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> * Fix OperationRepoTests CI/CD flakiness by using individual coVerify calls - Replace coVerifyOrder with individual coVerify(exactly = 1) calls - Makes tests more resilient to timing variations in CI/CD environments - Maintains verification of all critical operations while allowing flexibility in exact timing * remove try catch and lint * Addressed comments, removed global scope launches, broke down userswitcher * fixed flag * fix tests * making sure using the name instead of value * test isolation * logout test * comments * cleanup --------- Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> * chore: bump SDK_VERSION to 5.4.0-alpha-02 (#2386) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Fix permissions activity (#2388) * broke down permissions activity * fixed the permissions dialog * cleanup * permissions tests * lint * waiting to false for pause * added some tests for pause * uncommented the code * removed duplicate class * fixed wrong import * fixed imports * fixed bug to display the dialog after cancelling * formatting ktlint * tests * lint * adding delay * removing the theme and going back to production * add a delay * add a delay --------- Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> * chore: bump SDK_VERSION to 5.4.0-alpha-03 (#2392) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * spotless check * added more time * added more time --------- Co-authored-by: jinliu9508 <jinliu9508@gmail.com> Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> # Conflicts: # OneSignalSDK/build.gradle # OneSignalSDK/onesignal/core/src/main/java/com/onesignal/session/internal/session/impl/SessionListener.kt

* refactor: move initialization process off main thread * Release 5.4.0-alpha-01 * feat: Add Kotlin MainApplication and suspend initialization support (#2374) * feat: Add Kotlin MainApplication and suspend initialization support - Add MainApplicationKT.kt as Kotlin version of MainApplication.java - Add initWithContextSuspend() method for async initialization - Refactor OneSignalImp to use IO dispatcher internally for initialization - Add comprehensive unit tests for suspend initialization - Rename LatchAwaiter to CompletionAwaiter for better semantics - Add helper classes for user management (AppIdHelper, LoginHelper, LogoutHelper, UserSwitcher) - Update build.gradle to include Kotlin coroutines dependency - Ensure ANR prevention by using background threads for initialization * Added more tests * mandating passing app id in the login/logout methods * linting * Made app id mandatory for login and logout. * cleanup * reduce the forks * Time out, deprecate annotation and appid,context * ktlin * include MainApplication.java, locks, early returns * chore: Dispatcher Threads (#2375) * Using dispatcher * Update threads to 2 * Updated methods * linting * readme * using the same thread pool * lint * making sure initstate has the right value * lint * Clear state and skip performance tests * lint * clear preferences * fixing tests * fixing tests * fixing tests * fixing tests * fixing tests * addressed PR comments * Addressed comments and fixed tests * lint * lint * fix test * lint * rewrote the test * fix test * made the test more robust * clear all preferences and simplified mocks * added more robustness --------- Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> * Fix OperationRepoTests CI/CD flakiness by using individual coVerify calls - Replace coVerifyOrder with individual coVerify(exactly = 1) calls - Makes tests more resilient to timing variations in CI/CD environments - Maintains verification of all critical operations while allowing flexibility in exact timing * remove try catch and lint * Addressed comments, removed global scope launches, broke down userswitcher * fixed flag * fix tests * making sure using the name instead of value * test isolation * logout test * comments * cleanup --------- Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> * chore: bump SDK_VERSION to 5.4.0-alpha-02 (#2386) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Fix permissions activity (#2388) * broke down permissions activity * fixed the permissions dialog * cleanup * permissions tests * lint * waiting to false for pause * added some tests for pause * uncommented the code * removed duplicate class * fixed wrong import * fixed imports * fixed bug to display the dialog after cancelling * formatting ktlint * tests * lint * adding delay * removing the theme and going back to production * add a delay * add a delay --------- Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> * chore: bump SDK_VERSION to 5.4.0-alpha-03 (#2392) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * spotless check * added more time * added more time --------- Co-authored-by: jinliu9508 <jinliu9508@gmail.com> Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> # Conflicts: # OneSignalSDK/build.gradle # OneSignalSDK/onesignal/core/src/main/java/com/onesignal/session/internal/session/impl/SessionListener.kt # Conflicts: # Examples/OneSignalDemo/gradle.properties # OneSignalSDK/gradle.properties

* refactor: move initialization process off main thread * Release 5.4.0-alpha-01 * feat: Add Kotlin MainApplication and suspend initialization support (#2374) * feat: Add Kotlin MainApplication and suspend initialization support - Add MainApplicationKT.kt as Kotlin version of MainApplication.java - Add initWithContextSuspend() method for async initialization - Refactor OneSignalImp to use IO dispatcher internally for initialization - Add comprehensive unit tests for suspend initialization - Rename LatchAwaiter to CompletionAwaiter for better semantics - Add helper classes for user management (AppIdHelper, LoginHelper, LogoutHelper, UserSwitcher) - Update build.gradle to include Kotlin coroutines dependency - Ensure ANR prevention by using background threads for initialization * Added more tests * mandating passing app id in the login/logout methods * linting * Made app id mandatory for login and logout. * cleanup * reduce the forks * Time out, deprecate annotation and appid,context * ktlin * include MainApplication.java, locks, early returns * chore: Dispatcher Threads (#2375) * Using dispatcher * Update threads to 2 * Updated methods * linting * readme * using the same thread pool * lint * making sure initstate has the right value * lint * Clear state and skip performance tests * lint * clear preferences * fixing tests * fixing tests * fixing tests * fixing tests * fixing tests * addressed PR comments * Addressed comments and fixed tests * lint * lint * fix test * lint * rewrote the test * fix test * made the test more robust * clear all preferences and simplified mocks * added more robustness --------- Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> * Fix OperationRepoTests CI/CD flakiness by using individual coVerify calls - Replace coVerifyOrder with individual coVerify(exactly = 1) calls - Makes tests more resilient to timing variations in CI/CD environments - Maintains verification of all critical operations while allowing flexibility in exact timing * remove try catch and lint * Addressed comments, removed global scope launches, broke down userswitcher * fixed flag * fix tests * making sure using the name instead of value * test isolation * logout test * comments * cleanup --------- Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> * chore: bump SDK_VERSION to 5.4.0-alpha-02 (#2386) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Fix permissions activity (#2388) * broke down permissions activity * fixed the permissions dialog * cleanup * permissions tests * lint * waiting to false for pause * added some tests for pause * uncommented the code * removed duplicate class * fixed wrong import * fixed imports * fixed bug to display the dialog after cancelling * formatting ktlint * tests * lint * adding delay * removing the theme and going back to production * add a delay * add a delay --------- Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> * chore: bump SDK_VERSION to 5.4.0-alpha-03 (#2392) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * spotless check * added more time * added more time --------- Co-authored-by: jinliu9508 <jinliu9508@gmail.com> Co-authored-by: AR Abdul Azeez <abdul@onesignal.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> # Conflicts: # OneSignalSDK/build.gradle # OneSignalSDK/onesignal/core/src/main/java/com/onesignal/session/internal/session/impl/SessionListener.kt # Conflicts: # Examples/OneSignalDemo/gradle.properties # OneSignalSDK/gradle.properties # OneSignalSDK/onesignal/core/src/main/java/com/onesignal/common/threading/OneSignalDispatchers.kt # OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/activities/PermissionsActivity.kt # OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/operations/impl/OperationRepo.kt # OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/internal/permissions/PermissionsViewModel.kt # OneSignalSDK/onesignal/core/src/main/java/com/onesignal/core/services/SyncJobService.kt # OneSignalSDK/onesignal/core/src/main/java/com/onesignal/internal/OneSignalImp.kt # OneSignalSDK/onesignal/core/src/test/java/com/onesignal/core/internal/application/SDKInitSuspendTests.kt # OneSignalSDK/onesignal/core/src/test/java/com/onesignal/core/internal/application/SDKInitTests.kt # OneSignalSDK/onesignal/core/src/test/java/com/onesignal/core/internal/operations/OperationRepoTests.kt # OneSignalSDK/onesignal/core/src/test/java/com/onesignal/core/internal/permissions/PermissionsViewModelTests.kt # OneSignalSDK/onesignal/core/src/test/java/com/onesignal/internal/OneSignalImpTests.kt # OneSignalSDK/onesignal/notifications/src/main/java/com/onesignal/notifications/internal/generation/impl/NotificationGenerationProcessor.kt # OneSignalSDK/onesignal/notifications/src/test/java/com/onesignal/notifications/internal/generation/NotificationGenerationProcessorTests.kt

AR Abdul Azeez added 6 commits October 1, 2025 16:19

Added more tests

ad2197c

mandating passing app id in the login/logout methods

533bb44

linting

f7c4496

Made app id mandatory for login and logout.

1ebe5af

cleanup

d936022

abdulraqeeb33 marked this pull request as ready for review October 3, 2025 00:08

abdulraqeeb33 commented Oct 3, 2025

View reviewed changes

reduce the forks

a35c578

jkasten2 reviewed Oct 3, 2025

View reviewed changes

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/IOneSignal.kt Outdated Show resolved Hide resolved

AR Abdul Azeez added 2 commits October 6, 2025 13:51

Time out, deprecate annotation and appid,context

2a6fc77

ktlin

6e7a833

abdulraqeeb33 changed the base branch from 5.4.0-alpha-01-base to 5.4-main October 9, 2025 18:52

jkasten2 requested changes Oct 13, 2025

View reviewed changes

AR Abdul Azeez and others added 4 commits October 14, 2025 11:46

include MainApplication.java, locks, early returns

cbc440c

remove try catch and lint

a865d41

jkasten2 requested changes Oct 14, 2025

View reviewed changes

Addressed comments, removed global scope launches, broke down userswi…

b2580e7

…tcher

abdulraqeeb33 commented Oct 15, 2025

View reviewed changes

abdulraqeeb33 requested a review from jkasten2 October 15, 2025 00:27

AR Abdul Azeez added 2 commits October 15, 2025 09:15

fixed flag

fb6d730

fix tests

4768f9c

abdulraqeeb33 commented Oct 15, 2025

View reviewed changes

...gnalSDK/onesignal/core/src/test/java/com/onesignal/core/internal/application/SDKInitTests.kt Outdated Show resolved Hide resolved

AR Abdul Azeez added 5 commits October 15, 2025 11:04

making sure using the name instead of value

6a7b7bc

test isolation

007879f

logout test

2496420

comments

e909365

cleanup

71da228

This was referenced Jan 5, 2026

chore: Release 5.3.6 OneSignal/OneSignal-Flutter-SDK#1103

Closed

chore: Release 5.2.20 OneSignal/OneSignal-Cordova-SDK#1138

Closed

chore: Release 5.2.17 OneSignal/react-native-onesignal#1891

Closed

chore: Release 5.1.16 OneSignal/OneSignal-Unity-SDK#835

Closed

onesignal-deploy mentioned this pull request Feb 10, 2026

chore: Release 5.3.0 OneSignal/OneSignal-DotNet-SDK#154

Merged

Conversation

abdulraqeeb33 commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

One Line Summary

Details

Motivation

Scope

Testing

Unit testing

Manual testing

Affected code checklist

Checklist

Overview

Testing

Final pass

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

abdulraqeeb33 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

abdulraqeeb33 commented Oct 1, 2025 •

edited

Loading