Documentation

Author: GaryQian

shell/common/platform_view.h

@@ -628,6 +628,8 @@ class PlatformView {
                                        const uint8_t* snapshot_data,
                                        const uint8_t* snapshot_instructions);
 
+  // TODO(garyq): Implement a proper asset_resolver replacement instead of
+  // overwriting the entire asset manager.
   //--------------------------------------------------------------------------
   /// @brief      Sets the asset manager of the engine to asset_manager
   ///

shell/platform/android/io/flutter/embedding/engine/dynamicfeatures/DynamicFeatureManager.java

@@ -4,6 +4,7 @@
 
 package io.flutter.embedding.engine.dynamicfeatures;
 
+// TODO: add links to external documentation on how to use split aot features.
 /**
  * Basic interface that handles downloading and loading of dynamic features.
  *
@@ -22,10 +23,13 @@
  * should typically ensure the new assets are available to the engine's asset manager by passing an
  * updated android AssetManager to the engine.
  *
- * <p>The methods here may also be called manually via platform channel messages.
+ * <p>The loadAssets and loadDartLibrary methods are separated out because they may also be called
+ * manually via platform channel messages. A full downloadDynamicFeature implementation should call
+ * these two methods as needed.
  *
  * <p>A dynamic feature module is uniquely identified by a module name as defined in bundle_config.yaml.
- * Each feature module may contain one or more loading units, uniquely identified by the loading unit ID.
+ * Each feature module may contain one or more loading units, uniquely identified by the loading unit ID
+ * and assets.
  */
 public interface DynamicFeatureManager {
   /**
@@ -37,9 +41,9 @@ public interface DynamicFeatureManager {
    *
    * <p>This method begins the download and installation of the specified feature module. For example,
    * the Play Store dynamic delivery implementation uses SplitInstallManager to request the download of
-   * the module. Download is not complete when this method returns. Upon completion of
-   * download, loadAssets and loadDartLibrary should be called to complete the dynamic feature load
-   * process.
+   * the module. Download is not complete when this method returns. The download process should be
+   * listened for and upon completion of download, listeners should invoke loadAssets and loadDartLibrary
+   * to complete the dynamic feature load process.
    *
    * <p>Both parameters are not always necessary to identify which module to install. Asset-only modules
    * do not have an associated loadingUnitId. Instead, an invalid ID like -1 may be passed to download

shell/platform/android/io/flutter/embedding/engine/dynamicfeatures/PlayStoreDynamicFeatureManager.java

@@ -36,10 +36,12 @@ public class PlayStoreDynamicFeatureManager implements DynamicFeatureManager {
   private static final String TAG = "PlayStoreDynamicFeatureManager";
 
   private @NonNull SplitInstallManager splitInstallManager;
-  private @NonNull Map<Integer, String> sessionIdToName;
-  private @NonNull Map<Integer, Integer> sessionIdToLoadingUnitId;
   private @NonNull FlutterJNI flutterJNI;
   private @NonNull Context context;
+  // Each request to install a feature module gets a session ID. These maps associate
+  // the session ID with the loading unit and module name that was requested.
+  private @NonNull Map<Integer, String> sessionIdToName;
+  private @NonNull Map<Integer, Integer> sessionIdToLoadingUnitId;
 
   private FeatureInstallStateUpdatedListener listener;