DeferredComponent utility class for manual handling of Deferred Components #72895

GaryQian · 2020-12-23T22:01:08Z

Adds a utility class DeferredComponent which contains wrappers around system channel methods that handle manual installation/uninstallation/state of deferred components.

The current API exposes only installation and querying by module name, which restricts the API to asset-only components. Dart code should be loaded via calling loadLibrary() on the deferred import. Exposing a parameter for loadingUnitId would require additional dart work and is not necessary for the initial release of Deferred components.

xster · 2021-01-07T17:57:40Z

The general concept seems sound to me. Though we should get some feedback from the framework team too for adding a new top level API class to services package.

goderbauer · 2021-01-08T18:05:50Z

packages/flutter/lib/src/services/deferred_component.dart

+///
+/// Returned by [DeferredComponent.getDeferredComponentInstallState].
+///
+/// These states may differ in custom deferred component implementations.


What makes a component "custom"? Where could the reader learn more about custom components?

What would DeferredComponent.getDeferredComponentInstallState return for custom components that have different state?

I'll be writing a guide on creating custom deferred components. Custom components are very open ended, and thus, this API has been left open ended. Since this state getting API is informational/quality-of-life, this open-ended-ness should not impact functionality, so I planned on leaving it as a channel to pass whatever information custom implementers wish. Also, custom implementations can be considered a very advanced feature, as it requires not only the custom impl and servers to host the files, but also a custom build setup to build the custom components. Thus, I'm erring on the less restrictive side here.

packages/flutter/lib/src/services/deferred_component.dart

goderbauer · 2021-01-08T18:11:41Z

packages/flutter/lib/src/services/deferred_component.dart

+}
+
+/// Manages the installation and loading of deferred component modules.
+///


The docs above mention "Google Play Store". Is this an Android-only feature (for now)? May be worthwhile to mention that here as well?

The initial version of this is Android only, but I do plan on extending this in some form to other platforms in the future.

That's fine but for now, at least say somewhere that it does something on Android only. Describe what happens when used in other platforms.

+1 We can update the docs when this does more on other platforms.

goderbauer · 2021-01-08T18:12:22Z

packages/flutter/lib/src/services/deferred_component.dart

+/// avoiding installing unnessecary code/assets on end user devices. Common
+/// use cases include deferring installation of advanced or infrequently
+/// used features and limiting locale specific features to users of matching
+/// locales.


Are there docs we can link to from here in case a developer wants to learn more about how to add a DeferredComponent to his project?

I'll be writing up a full set of guides, examples, and whatnot for the release of this feature. I'll add links to the full docs once those exist.

goderbauer · 2021-01-08T18:34:38Z

packages/flutter/lib/src/services/deferred_component.dart

+  /// may only be used after the Future completes succesfully, regardless of what
+  /// the installation state is in.
+  static Future<String?> getDeferredComponentInstallState({@required String? moduleName}) async {
+    await SystemChannels.deferredComponent.invokeMethod<void>(


Shouldn't this method return something?

Maybe worthwhile to add a test...

packages/flutter/lib/src/services/deferred_component.dart

goderbauer · 2021-01-08T18:36:20Z

packages/flutter/lib/src/services/deferred_component.dart

+
+  /// Requests that a deferred component identified by the [moduleName] be
+  /// uninstalled.
+  ///


Is this always safe to be called? What if the dart code from the component or the asset is still "in use"?

Once loaded in and in use, uninstallation should not effect the dart code in the app's current session, though assets may become inaccessible. I'll make note of this.

packages/flutter/lib/src/services/system_channels.dart

packages/flutter/test/services/deferred_component_test.dart

xster · 2021-01-11T20:10:47Z

packages/flutter/lib/src/services/deferred_component.dart

+}
+
+/// Manages the installation and loading of deferred component modules.
+///


That's fine but for now, at least say somewhere that it does something on Android only. Describe what happens when used in other platforms.

packages/flutter/lib/src/services/deferred_component.dart

xster · 2021-01-11T20:15:06Z

packages/flutter/lib/src/services/deferred_component.dart

+
+/// Manages the installation and loading of deferred component modules.
+///
+/// Deferred components allow Flutter applications to download precompiled AOT


Need to be a bit clearer on the fact that this is only for parts that are part of the same app you built and uploaded to the store. You can't add new things.

xster · 2021-01-12T06:38:04Z

packages/flutter/lib/src/services/deferred_component.dart

+  /// This method will not load associated dart libraries contained in the dynamic
+  /// feature module, though it will download the files necessary and subsequent
+  /// calls to `loadLibrary()` to load will complete faster.
+  ///


Brief reference or description on how to subsequently consume said asset after loading.

packages/flutter/lib/src/services/deferred_component.dart

goderbauer · 2021-01-12T17:49:11Z

packages/flutter/lib/src/services/deferred_component.dart

+  ///    the dart method to trigger the installation of the corresponding deferred component that
+  ///    contains the dart library.
+  ///  * [installDeferredComponent], a method to install asset-only components.
+  static Future<String?> getDeferredComponentInstallState({required String moduleName}) {


Can this ever return null? or should the ? be removed?

Also, as said above, it is confusing that this returns a String, but the doc above talks about it returning an enum value of DeferredComponentInstallState.

I'm going to just remove this feature from the initial release of deferred components to avoid releasing a strange/limiting API as per discussion earlier today. We can add this method back in at a later date once how this feature works across other platforms is fleshed out further.

The nullable String is because invokeMethod always completes with a nullable value. The value can be null when the method does not exist.

goderbauer

LGTM

goderbauer · 2021-01-13T17:32:03Z

packages/flutter/lib/src/services/deferred_component.dart

+/// app that was built and installed on the device. It cannot load new code
+/// written after the app is distributed.
+///
+/// Deferred components are currently and Android-only feature. The methods in


typo: and -> an

goderbauer · 2021-01-13T17:34:26Z

packages/flutter/lib/src/services/deferred_component.dart

+  ///
+  /// Since uninstallation typically requires significant disk i/o, this method only
+  /// signals the intent to uninstall. Completion of the returned future indicates
+  /// that the request to uninstall has been registered. Actual uninstallation (eg,


nit: eg -> e.g.

GaryQian added c: new feature Nothing broken; request for a new capability engine flutter/engine related. See also e: labels. customer: money (g3) labels Dec 23, 2020

flutter-dashboard bot added the framework flutter/packages/flutter repository. See also f: labels. label Dec 23, 2020

google-cla bot added the cla: yes label Dec 23, 2020

GaryQian marked this pull request as ready for review December 28, 2020 17:52

GaryQian changed the title ~~[WIP] DynamicFeatures utility class for manual handling of DynamicFeatures~~ DynamicFeature utility class for manual handling of DynamicFeatures Dec 28, 2020

GaryQian requested a review from xster December 28, 2020 17:52

GaryQian added 8 commits January 4, 2021 22:15

Add uninstall docs and dynamicfeatures utility class

17f95c1

Add more methods, docs

9745ab1

Make state nullable

8eae7ac

More states, more docs

47a6e6a

Add tests and rename, docs

dc48b75

Trailing newline

35ea8c1

Analyzer

6c66e2f

Fix docs

c00f843

GaryQian force-pushed the splitaotchannel branch from 6aa3109 to c00f843 Compare January 5, 2021 06:16

GaryQian mentioned this pull request Jan 5, 2021

☂️ Deferred Components: Build and load split AOT Android App Bundles #57617

Closed

18 tasks

xster requested a review from goderbauer January 7, 2021 17:56

GaryQian added 4 commits January 7, 2021 15:13

Rename to deferred component

bc4e057

Missed a spot

9842d24

Rename test file

82e4528

Fix test naming

867b185

GaryQian changed the title ~~DynamicFeature utility class for manual handling of DynamicFeatures~~ DeferredComponent utility class for manual handling of Deferred Components Jan 8, 2021

goderbauer reviewed Jan 8, 2021

View reviewed changes

GaryQian added 4 commits January 8, 2021 14:55

First round of addressing comments

0e891ee

Address comments part 2

184dba9

Analyzer

4605c23

Adjust testf or framework test

19e4eba

xster approved these changes Jan 12, 2021

View reviewed changes

goderbauer reviewed Jan 12, 2021

View reviewed changes

GaryQian added 3 commits January 12, 2021 14:17

Remove state getter for initial version

c89373b

Address comments

997ed99

Fix docs

2d81946

GaryQian requested a review from goderbauer January 13, 2021 02:22

goderbauer approved these changes Jan 13, 2021

View reviewed changes

Nits

8a51393

GaryQian added the waiting for tree to go green label Jan 13, 2021

fluttergithubbot merged commit 49667ba into flutter:master Jan 13, 2021

DeferredComponent utility class for manual handling of Deferred Components #72895

DeferredComponent utility class for manual handling of Deferred Components #72895

Uh oh!

Conversation

GaryQian commented Dec 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xster commented Jan 7, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GaryQian Jan 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GaryQian Jan 12, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

goderbauer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

GaryQian commented Dec 23, 2020 •

edited

Loading

GaryQian Jan 8, 2021 •

edited

Loading

GaryQian Jan 12, 2021 •

edited

Loading