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

Fix proguard rules #1828

Merged
merged 2 commits into from
Sep 7, 2023
Merged

Fix proguard rules #1828

merged 2 commits into from
Sep 7, 2023

Conversation

emawby
Copy link
Contributor

@emawby emawby commented Sep 1, 2023

Description

One Line Summary

Fix our proguard rules to prevent crashes when running with minify enabled.

Details

Due to how we have implemented dependency injection when minify is enabled the system is removing OneSignal code that is required. This PR implements a catch all solution that should resolve the issue, but does not optimally reduce the size of the SDK. Long term we should look at changing our dependency injection implementation or explciitly removing what can safely be removed.

Motivation

Fix crash

Scope

Entire SDK

Testing

Unit testing

N/A

Manual testing

Tested by adding the same rules to a separate app after adding OneSignal as a customer would.

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

This is a shorterm fix that should be a catch all solution but will increase the size of the SDK.  Long term we should change how we are implementing dependency injection so that pro guard can better detect what can be removed.

Keep all classes that implement IModule since they use reflection
@emawby emawby changed the base branch from main to user-model/main September 5, 2023 17:28
@emawby emawby changed the title WiP Fix proguard rules Fix proguard rules Sep 5, 2023
@emawby emawby merged commit bb3041e into user-model/main Sep 7, 2023
@emawby emawby deleted the fix/proguard_updates branch September 7, 2023 19:03
jinliu9508 pushed a commit that referenced this pull request Jan 31, 2024
jinliu9508 pushed a commit that referenced this pull request Jan 31, 2024
jinliu9508 pushed a commit that referenced this pull request Feb 6, 2024
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.

3 participants