Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[User Model] Safeguard against activities/services/receivers being called before initialization #1746

Merged

Conversation

brismithers
Copy link
Contributor

@brismithers brismithers commented Mar 9, 2023

Description

One Line Summary

Safeguard against activities/services/receivers being called before initialization.

Motivation

  • Update IOneSignal.initWithContext interface to return whether initialization was successful or not.
  • Implementation fails initialization if no app ID is provided and no app ID has been saved.
  • Update all activities/services/receivers to check and not proceed when initialization unsuccessful.

Scope

Fixes #1745
Covers all SDK services/receivers/activities initialization flows, which call OneSignal.initWithContext without an appId (as they don't know the appId) on the assumption the appId has already been provided by the external OneSignal.initWithContext. Now these services/receivers/activities can bail out if this is not the case, rather than blow up.

Testing

Manual testing

Test various scenarios related to initializing (or not initializing) the OneSignal SDK and driving the services/receivers/activities that exist within the SDK.

Affected code checklist

  • Notifications
    • Display
    • Open
    • Push Processing
    • Confirm Deliveries
  • Outcomes
  • Sessions
  • In-App Messaging
  • REST API requests
  • Public API changes

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 Reviewable

…lled before initialization.

* Update `IOneSignal.initWithContext` interface to return whether initialization was successful or not.
* Implementation fails initialization if no app ID is provided and no app ID has been saved.
* Update all activities/services/receivers to check and not proceed when initialization unsuccessful.
@brismithers brismithers merged commit f9b0f75 into user-model/main Mar 14, 2023
@brismithers brismithers deleted the user-model/upgrade-receiver-called-before-init branch March 14, 2023 17:27
@emawby emawby mentioned this pull request May 1, 2023
jinliu9508 pushed a commit that referenced this pull request Jan 31, 2024
…alled-before-init

[User Model] Safeguard against activities/services/receivers being called before initialization
jinliu9508 pushed a commit that referenced this pull request Jan 31, 2024
…alled-before-init

[User Model] Safeguard against activities/services/receivers being called before initialization
jinliu9508 pushed a commit that referenced this pull request Feb 6, 2024
…alled-before-init

[User Model] Safeguard against activities/services/receivers being called before initialization
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant