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

iOS: fix memory leak issues #486

Merged
merged 4 commits into from
Aug 8, 2024
Merged

iOS: fix memory leak issues #486

merged 4 commits into from
Aug 8, 2024

Conversation

nancywu1
Copy link
Contributor

@nancywu1 nancywu1 commented Aug 8, 2024

  • Fix hooks.state.tap not capturing weak self
  • Fix retain cycle in errorHandler by referencing variables from outside
  • Clearing exceptionHandler to remove logger reference

Change Type (required)

Indicate the type of change your pull request is:

  • patch
  • minor
  • major

Does your PR have any documentation updates?

  • Updated docs
  • No Update needed
  • Unable to update docs
📦 Published PR as canary version: 0.8.1--canary.486.16730

Try this version out locally by upgrading relevant packages to 0.8.1--canary.486.16730

Version

Published prerelease version: 0.9.0-next.4

Changelog

Release Notes

Storybook Addon Fixes (#449)

  • Re-adds the ability to render Asset properties as a tab in storybook
  • Re-adds the flow-refresh addon
  • Fixes the dependencies & package layout for the storybook addon
  • Fix dark-mode support

[Hermes] Android integration (#410)

Initial integration with the Hermes JavaScript runtime. This shows a tremendous size improvement over the existing J2V8 integration of ~70% (7.6 MB -> 2.3 MB, architecture dependent).

Opt-in

For now, the default runtime integration provided by the Android Player will still be com.intuit.playerui:j2v8-android, but Hermes can be opted in manually by excluding the J2V8 transitive dependency and including the Hermes artifact:

dependencies {
    // Android Player dependency
    implementation("com.intuit.playerui", "android", PLAYER_VERSION) {
        // J2V8 included for release versions
        exclude(group = "com.intuit.playerui", module = "j2v8-android")
        // Debuggable J2V8 included for canary versions
        exclude(group = "com.intuit.playerui", module = "j2v8-android-debug")
    }
    // Override with Hermes runtime
    implementation("com.intuit.playerui", "hermes-android", PLAYER_VERSION)
}

// Exclude J2V8 transitive dependency for all configurations in this module
configurations { 
    all {
        exclude(group = "com.intuit.playerui", module = "j2v8-android")
        // Debuggable J2V8 included for canary versions
        exclude(group = "com.intuit.playerui", module = "j2v8-android-debug")
    }
}

[!TIP]
If your application includes dependencies that may transitively depend on com.intuit.playerui:android, you would likely need to ensure the default runtime is transitively excluded from those as well, either manually or as a global strategy.

The AndroidPlayer will pick the first runtime it finds on the classpath - you can at least verify which runtime was used for the Player with a new log: Player created using $runtime. But that won't tell you for certain if the other runtimes were successfully excluded. You'll need to examine your APK, or your apps dependency tree, to tell for sure that redundant runtimes aren't unintentionally included.

Most of the setup for this integration is done simply by including the right dependency (and excluding the wrong one), however, the hermes-android integration also relies on the SoLoader for loading the native libraries. All that's needed is to initialize the SoLoader (should be on your classpath with the hermes-android dependency) with an Android Context somewhere before you use the AndroidPlayer, potentially in your activities onCreate:

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)

    SoLoader.init(this, false)
    // ...
}

🚀 Enhancement

🐛 Bug Fix

Authors: 5

@nancywu1 nancywu1 requested a review from hborawski as a code owner August 8, 2024 16:27
Copy link

codecov bot commented Aug 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.93%. Comparing base (fbf685c) to head (8529783).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #486      +/-   ##
==========================================
- Coverage   91.94%   91.93%   -0.01%     
==========================================
  Files         339      339              
  Lines       26819    26831      +12     
  Branches     1945     1945              
==========================================
+ Hits        24658    24668      +10     
- Misses       2147     2149       +2     
  Partials       14       14              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nancywu1
Copy link
Contributor Author

nancywu1 commented Aug 8, 2024

/canary

fix memory leak issues

fix memory leak issues
@nancywu1
Copy link
Contributor Author

nancywu1 commented Aug 8, 2024

/canary

@nancywu1 nancywu1 merged commit ebdcb61 into main Aug 8, 2024
9 checks passed
@nancywu1 nancywu1 deleted the PLAYA-9020 branch August 8, 2024 21:26
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