Storybook Addon Fixes

[adierkens]

Requires: player-ui/rules_player#63
Will let us remove/deprecate the storybook-webpack plugin here

Release Notes

• 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

📦 Published PR as canary version: 0.7.5--canary.449.15808

Try this version out locally by upgrading relevant packages to 0.7.5--canary.449.15808

Version

Published prerelease version: 0.9.0-next.1

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

• Storybook Addon Fixes #449 (@adierkens)
• [Hermes] Android integration #410 (@sugarmanz @brocollie08)

Authors: 3

• @brocollie08
• Adam Dierkens (@adierkens)
• Jeremiah Zucker (@sugarmanz)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.94%. Comparing base (73d3af9) to head (1197df3).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #449   +/-   ##
=======================================
  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.

[adierkens]

/canary

[KetanReddy]

We'll probably want the rules to be published before this gets merged

[KetanReddy]

Moving this here would be great. We'll probably need to figure out how we want to go about deprecating the webpack xlr plugin

[adierkens]

Is there anything that would stop us from just not publishing new versions? It wouldn't work with the updated storybook plugin updates for v7 anyway

[KetanReddy]

Probably not, we would just need to make sure we announce it somewhere well

[KetanReddy]

Can we add it to the docs, readme, or repo wiki?

[adierkens]

The usage instructions were already updated on the storybook page: https://github.com/player-ui/player/pull/449/files#diff-bb7fbe3850070f90366f286656bbc59ebfb8a8734d46fd8796cd1738f99d40e1R71

[KetanReddy]

We'll definitely need to document this new approach

[KetanReddy]

Probably not, we would just need to make sure we announce it somewhere well

[KetanReddy]

Can we add it to the docs, readme, or repo wiki?