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

Async node android #469

Merged
merged 8 commits into from
Aug 6, 2024
Merged

Async node android #469

merged 8 commits into from
Aug 6, 2024

Conversation

sakuntala-motukuri
Copy link
Contributor

@sakuntala-motukuri sakuntala-motukuri commented Aug 1, 2024

This PR accommodates to this requirement #459 i.e Port internal async node plugin implementation to android

Change Type (required)

Indicate the type of change your pull request is:
Added a new component as per the following plugins/async-node
├── core
│ ├── BUILD
│ ├── src
│ └── package.json
└── jvm
├── BUILD
├── deps.bzl
├── src/main/kotlin/com/intuit/playerui/plugins/asyncnode
│ └── AsyncNodePlugin.kt
└── src/test/kotlin/com/intuit/playerui/plugins/asyncnode
└── AsyncNodePluginTest.kt

All tests are passing in local :
image

  • patch
  • minor
  • major

Does your PR have any documentation updates?

  • Updated docs
  • No Update needed
  • Unable to update docs

Version

Published prerelease version: 0.9.0-next.2

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)
}

[!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: 4

Copy link

codecov bot commented Aug 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.94%. Comparing base (0c12e2a) to head (a1bd8f6).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #469   +/-   ##
=======================================
  Coverage   91.94%   91.94%           
=======================================
  Files         340      340           
  Lines       26838    26838           
  Branches     1946     1946           
=======================================
+ Hits        24675    24677    +2     
+ Misses       2149     2147    -2     
  Partials       14       14           

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

Copy link
Member

@sugarmanz sugarmanz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly small things - feel free to ignore Nits if you disagree or think it's scope creep. Also looks like //jvm/core:lint test is failing, but should be fixable with bazel run //jvm/core:lint-fix (or ./tools/lint-kotlin to apply on all Kotlin targets).

The only other thing that I see missing in this PR is the ported PromiseTest changes:

    @TestTemplate
    fun testPromiseConstructor() = runBlockingTest {
        runtime.execute(
            """
            class TestClass {
                name = 'foo';
                constructor(promise) {
                    promise.then((value) => {
                        this.name = value;
                    });
                };
            }"""
        )
        val promise = runtime.Promise<String> { jsRes, _ ->
            val result = "bar"
            jsRes(result)
        }
        runtime.add("myPromise", promise)
        val value = runtime.execute("new TestClass(myPromise)") as Node
        promise.toCompletable(String.serializer()).await()
        assertEquals("bar", value["name"])
    }

Added the ported test

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.

2 participants