Refactor and rename methods

Rename to LoadDartDeferredLibrary

Additional renaming

Add back moduleName to params

Documentation

Pass asset manager to persistent cache

Fix license, cleanup, fix docs, rename methods

Javadocs, API adjustments

More docs, rename log tag

Author: GaryQian

shell/common/engine.cc

@@ -511,15 +511,16 @@ const std::string& Engine::GetLastEntrypointLibrary() const {
 // feature. Left commented out until it lands:
 
 // // |RuntimeDelegate|
-// void Engine::OnDartLoadLibrary(intptr_t loading_unit_id) {
-//   return delegate_.OnDartLoadLibrary(loading_unit_id);
+// void Engine::RequestDartDeferredLibrary(intptr_t loading_unit_id) {
+//   return delegate_.RequestDartDeferredLibrary(loading_unit_id);
 // }
 
-void Engine::CompleteDartLoadLibrary(intptr_t loading_unit_id,
-                                     const uint8_t* snapshot_data,
-                                     const uint8_t* snapshot_instructions) {
+void Engine::CompleteDartDeferredLibraryLoading(
+    intptr_t loading_unit_id,
+    const uint8_t* snapshot_data,
+    const uint8_t* snapshot_instructions) {
   if (runtime_controller_->IsRootIsolateRunning()) {
-    // runtime_controller_->CompleteDartLoadLibrary(loading_unit_id,
+    // runtime_controller_->CompleteDartDeferredLibraryLoading(loading_unit_id,
     //    snapshot_data, snapshot_instructions);
   }
 }

shell/common/engine.h

@@ -270,7 +270,7 @@ class Engine final : public RuntimeDelegate,
     /// @param[in]  loading_unit_id  The unique id of the deferred library's
     ///                              loading unit.
     ///
-    virtual void OnDartLoadLibrary(intptr_t loading_unit_id) = 0;
+    virtual void RequestDartDeferredLibrary(intptr_t loading_unit_id) = 0;
   };
 
   //----------------------------------------------------------------------------
@@ -795,9 +795,9 @@ class Engine final : public RuntimeDelegate,
   /// @param[in]  snapshot_data    Dart snapshot instructions of the loading
   ///                              unit's shared library.
   ///
-  void CompleteDartLoadLibrary(intptr_t loading_unit_id,
-                               const uint8_t* snapshot_data,
-                               const uint8_t* snapshot_instructions);
+  void CompleteDartDeferredLibraryLoading(intptr_t loading_unit_id,
+                                          const uint8_t* snapshot_data,
+                                          const uint8_t* snapshot_instructions);
 
  private:
   Engine::Delegate& delegate_;
@@ -851,7 +851,7 @@ class Engine final : public RuntimeDelegate,
   // feature. Left commented out until it lands:
 
   // // |RuntimeDelegate|
-  // void OnDartLoadLibrary(intptr_t loading_unit_id) override;
+  // void RequestDartDeferredLibrary(intptr_t loading_unit_id) override;
 
   void SetNeedsReportTimings(bool value) override;
 

shell/common/engine_unittests.cc

@@ -13,7 +13,6 @@
 #include "rapidjson/document.h"
 #include "rapidjson/stringbuffer.h"
 #include "rapidjson/writer.h"
-#include "third_party/dart/runtime/include/dart_api.h"
 
 ///\note Deprecated MOCK_METHOD macros used until this issue is resolved:
 // https://github.com/google/googletest/issues/2490
@@ -33,7 +32,7 @@ class MockDelegate : public Engine::Delegate {
   MOCK_METHOD1(ComputePlatformResolvedLocale,
                std::unique_ptr<std::vector<std::string>>(
                    const std::vector<std::string>&));
-  MOCK_METHOD1(OnDartLoadLibrary, Dart_Handle(intptr_t));
+  MOCK_METHOD1(RequestDartDeferredLibrary, void(intptr_t));
 };
 
 class MockResponse : public PlatformMessageResponse {
@@ -57,7 +56,7 @@ class MockRuntimeDelegate : public RuntimeDelegate {
   MOCK_METHOD1(ComputePlatformResolvedLocale,
                std::unique_ptr<std::vector<std::string>>(
                    const std::vector<std::string>&));
-  MOCK_METHOD1(OnDartLoadLibrary, Dart_Handle(intptr_t));
+  MOCK_METHOD1(RequestDartDeferredLibrary, void(intptr_t));
 };
 
 class MockRuntimeController : public RuntimeController {

shell/common/platform_view.cc

@@ -159,9 +159,9 @@ PlatformView::ComputePlatformResolvedLocales(
   return out;
 }
 
-void PlatformView::OnDartLoadLibrary(intptr_t loading_unit_id) {}
+void PlatformView::RequestDartDeferredLibrary(intptr_t loading_unit_id) {}
 
-void PlatformView::CompleteDartLoadLibrary(
+void PlatformView::CompleteDartDeferredLibraryLoading(
     intptr_t loading_unit_id,
     const uint8_t* snapshot_data,
     const uint8_t* snapshot_instructions) {}

shell/common/platform_view.h

@@ -211,16 +211,6 @@ class PlatformView {
     virtual void OnPlatformViewMarkTextureFrameAvailable(
         int64_t texture_id) = 0;
 
-    //--------------------------------------------------------------------------
-    /// @brief      Invoked when the dart VM requests that a deferred library
-    ///             be loaded. Notifies the engine that the requested loading
-    ///             unit should be downloaded and loaded.
-    ///
-    /// @param[in]  loading_unit_id  The unique id of the deferred library's
-    ///                              loading unit.
-    ///
-    virtual void OnPlatformViewDartLoadLibrary(intptr_t loading_unit_id) = 0;
-
     //--------------------------------------------------------------------------
     /// @brief      Loads the dart shared library into the dart VM. When the
     ///             dart library is loaded successfully, the dart future
@@ -238,7 +228,7 @@ class PlatformView {
     /// @param[in]  snapshot_data    Dart snapshot instructions of the loading
     ///                              unit's shared library.
     ///
-    virtual void CompleteDartLoadLibrary(
+    virtual void CompleteDartDeferredLibraryLoading(
         intptr_t loading_unit_id,
         const uint8_t* snapshot_data,
         const uint8_t* snapshot_instructions) = 0;
@@ -611,7 +601,7 @@ class PlatformView {
   /// @param[in]  loading_unit_id  The unique id of the deferred library's
   ///                              loading unit.
   ///
-  virtual void OnDartLoadLibrary(intptr_t loading_unit_id);
+  virtual void RequestDartDeferredLibrary(intptr_t loading_unit_id);
 
   //--------------------------------------------------------------------------
   /// @brief      Loads the dart shared library into the dart VM. When the
@@ -630,9 +620,10 @@ class PlatformView {
   /// @param[in]  snapshot_data    Dart snapshot instructions of the loading
   ///                              unit's shared library.
   ///
-  virtual void CompleteDartLoadLibrary(intptr_t loading_unit_id,
-                                       const uint8_t* snapshot_data,
-                                       const uint8_t* snapshot_instructions);
+  virtual void CompleteDartDeferredLibraryLoading(
+      intptr_t loading_unit_id,
+      const uint8_t* snapshot_data,
+      const uint8_t* snapshot_instructions);
 
   //--------------------------------------------------------------------------
   /// @brief      Sets the asset manager of the engine to asset_manager

shell/common/shell.cc

@@ -1181,25 +1181,21 @@ std::unique_ptr<std::vector<std::string>> Shell::ComputePlatformResolvedLocale(
   return platform_view_->ComputePlatformResolvedLocales(supported_locale_data);
 }
 
-void Shell::CompleteDartLoadLibrary(intptr_t loading_unit_id,
-                                    const uint8_t* snapshot_data,
-                                    const uint8_t* snapshot_instructions) {
-  engine_->CompleteDartLoadLibrary(loading_unit_id, snapshot_data,
-                                   snapshot_instructions);
+void Shell::CompleteDartDeferredLibraryLoading(
+    intptr_t loading_unit_id,
+    const uint8_t* snapshot_data,
+    const uint8_t* snapshot_instructions) {
+  engine_->CompleteDartDeferredLibraryLoading(loading_unit_id, snapshot_data,
+                                              snapshot_instructions);
 }
 
 void Shell::UpdateAssetManager(std::shared_ptr<AssetManager> asset_manager) {
   engine_->UpdateAssetManager(std::move(asset_manager));
 }
 
 // |Engine::Delegate|
-void Shell::OnDartLoadLibrary(intptr_t loading_unit_id) {
-  OnPlatformViewDartLoadLibrary(loading_unit_id);
-}
-
-// |PlatformView::Delegate|
-void Shell::OnPlatformViewDartLoadLibrary(intptr_t loading_unit_id) {
-  platform_view_->OnDartLoadLibrary(loading_unit_id);
+void Shell::RequestDartDeferredLibrary(intptr_t loading_unit_id) {
+  platform_view_->RequestDartDeferredLibrary(loading_unit_id);
 }
 
 void Shell::ReportTimings() {

shell/common/shell.h

@@ -509,12 +509,10 @@ class Shell final : public PlatformView::Delegate,
   void OnPlatformViewSetNextFrameCallback(const fml::closure& closure) override;
 
   // |PlatformView::Delegate|
-  void OnPlatformViewDartLoadLibrary(intptr_t loading_unit_id) override;
-
-  // |PlatformView::Delegate|
-  void CompleteDartLoadLibrary(intptr_t loading_unit_id,
-                               const uint8_t* snapshot_data,
-                               const uint8_t* snapshot_instructions) override;
+  void CompleteDartDeferredLibraryLoading(
+      intptr_t loading_unit_id,
+      const uint8_t* snapshot_data,
+      const uint8_t* snapshot_instructions) override;
 
   // |PlatformView::Delegate|
   void UpdateAssetManager(std::shared_ptr<AssetManager> asset_manager) override;
@@ -561,7 +559,7 @@ class Shell final : public PlatformView::Delegate,
       const std::vector<std::string>& supported_locale_data) override;
 
   // |Engine::Delegate|
-  void OnDartLoadLibrary(intptr_t loading_unit_id) override;
+  void RequestDartDeferredLibrary(intptr_t loading_unit_id) override;
 
   // |Rasterizer::Delegate|
   void OnFrameRasterized(const FrameTiming&) override;

shell/platform/android/io/flutter/embedding/engine/FlutterEngine.java

@@ -306,7 +306,6 @@ public FlutterEngine(
 
     dynamicFeatureManager = new PlayStoreDynamicFeatureManager(context, flutterJNI);
     flutterJNI.setDynamicFeatureManager(dynamicFeatureManager);
-    flutterJNI.setDynamicFeatureContext(context);
 
     attachToJni();
 

shell/platform/android/io/flutter/embedding/engine/FlutterJNI.java

@@ -951,69 +951,63 @@ public void setDynamicFeatureManager(@NonNull DynamicFeatureManager dynamicFeatu
     this.dynamicFeatureManager = dynamicFeatureManager;
   }
 
-  private Context dynamicFeatureContext;
-
-  @UiThread
-  public void setDynamicFeatureContext(@NonNull Context context) {
-    ensureRunningOnMainThread();
-    this.dynamicFeatureContext = context;
-  }
-
-  @SuppressWarnings("unused")
-  @UiThread
-  public void downloadDynamicFeature(int loadingUnitId) {
-    int moduleNameIdentifier =
-        dynamicFeatureContext
-            .getResources()
-            .getIdentifier(
-                "loadingUnit" + loadingUnitId, "string", dynamicFeatureContext.getPackageName());
-    String moduleName = dynamicFeatureContext.getResources().getString(moduleNameIdentifier);
-    downloadDynamicFeature(moduleName, loadingUnitId);
-  }
-
-  // Called by the engine upon invocation of dart loadLibrary() request
+  /**
+   * Called by dart's deferred load handler to request that a dart deferred library corresponding
+   * to loadingUnitId be downloaded (if necessary) and loaded into the dart vm.
+   *
+   * <p>This method delegates the task to DynamicFeatureManager, which handles the download and
+   * loading of the dart library and any assets.
+   *
+   * @param loadingUnitId The loadingUnitId is assigned during compile time by gen_snapshot and is
+   *                      automatically retrieved when loadLibrary() is called on a dart deferred
+   *                      library.
+   */
   @SuppressWarnings("unused")
   @UiThread
-  public void downloadDynamicFeature(String moduleName, int loadingUnitId) {
-    dynamicFeatureManager.downloadFeature(moduleName, loadingUnitId);
+  public void RequestDartDeferredLibrary(int loadingUnitId) {
+    dynamicFeatureManager.downloadDynamicFeature(loadingUnitId, null);
   }
 
   /**
-   * This should be called for every loading unit to be loaded into the dart isolate.
-   *
-   * <p>abi, libName, and apkPaths are used together to search the installed apks for the desired
-   * .so library. If not found, soPath may be provided as a fallback if a pre-extracted .so exists,
-   * especially on older devices with libs compressed in the apk.
+   * Searches each of the provided paths for a valid dart shared library .so file and resolves
+   * symbols to load into the dart VM.
    *
-   * <p>Successful loading of the dart library also completes the loadLibrary() future that
+   * <p>Successful loading of the dart library completes the future returned by loadLibrary() that
    * triggered the install/load process.
+   *
+   * @param loadingUnitId The loadingUnitId is assigned during compile time by gen_snapshot and is
+   *                      automatically retrieved when loadLibrary() is called on a dart deferred
+   *                      library. This is used to identify which dart deferred library the resolved
+   *                      correspond to.
+   *
+   * @param searchPaths   An array of paths in which to look for valid dart shared libraries. This
+   *                      supports paths within zipped apks as long as the apks are not compressed
+   *                      using the `path/to/apk.apk!path/inside/apk/lib.so` format. Paths will be
+   *                      tried first to last and ends when a library is sucessfully found. When the
+   *                      found library is invalid, no additional paths will be attempted.
    */
   @UiThread
-  public void loadDartLibrary(
+  public void loadDartDeferredLibrary(
       int loadingUnitId,
-      @NonNull String libName,
-      @NonNull String[] apkPaths,
-      @NonNull String abi,
-      @NonNull String soPath) {
+      @NonNull String[] searchPaths) {
     ensureRunningOnMainThread();
     ensureAttachedToNative();
-    nativeLoadDartLibrary(nativePlatformViewId, loadingUnitId, libName, apkPaths, abi, soPath);
+    nativeLoadDartDeferredLibrary(nativePlatformViewId, loadingUnitId, searchPaths);
   }
 
-  private native void nativeLoadDartLibrary(
+  private native void nativeLoadDartDeferredLibrary(
       long nativePlatformViewId,
       int loadingUnitId,
-      @NonNull String libName,
-      @NonNull String[] apkPaths,
-      @NonNull String abi,
-      @NonNull String soPath);
+      @NonNull String[] searchPaths);
 
   /**
    * Specifies a new AssetManager that has access to the dynamic feature's assets in addition to the
    * base module's assets.
    *
-   * <p>assetBundlePath is the subdirectory that the flutter assets are stored in. The typical value
-   * is `flutter_assets`.
+   * @param assetManager    An android AssetManager that is able to access the newly downloaded assets.
+   *
+   * @param assetBundlePath The subdirectory that the flutter assets are stored in. The typical value
+   *                        is `flutter_assets`.
    */
   @UiThread
   public void updateAssetManager(
@@ -1028,19 +1022,34 @@ private native void nativeUpdateAssetManager(
       @NonNull AssetManager assetManager,
       @NonNull String assetBundlePath);
 
-  // Called when an install encounters a failure during the Android portion of installing a module.
-  // When transient is false, new attempts to install will automatically result in same error in
-  // dart before the request is passed to Android.
+  /**
+   * Indicates that a failure was encountered during the Android portion of downloading a dynamic
+   * feature module and loading a dart deferred library, which is typically done by
+   * DynamicFeatureManager.
+   *
+   * <p>This will inform dart that the future returned by loadLibrary() should complete with an error.
+   *
+   * @param loadingUnitId The loadingUnitId that corresponds to the dart deferred library that
+   *                      failed to install.
+   *
+   * @param moduleName    The name of the module that includes the loadingUnitId. This parameter is
+   *                      not necessary and used for logging purposes.
+   *
+   * @param error         The error message to display.
+   *
+   * @param isTransient   When isTransient is false, new attempts to install will automatically result in
+   *                      same error in dart before the request is passed to Android.
+   */
   @SuppressWarnings("unused")
   @UiThread
   public void dynamicFeatureInstallFailure(
-      @NonNull String moduleName, int loadingUnitId, @NonNull String error, boolean trans) {
+      int loadingUnitId, String moduleName, @NonNull String error, boolean isTransient) {
     ensureRunningOnMainThread();
-    nativeDynamicFeatureInstallFailure(moduleName, loadingUnitId, error, trans);
+    nativeDynamicFeatureInstallFailure(loadingUnitId, moduleName, error, isTransient);
   }
 
   private native void nativeDynamicFeatureInstallFailure(
-      @NonNull String moduleName, int loadingUnitId, @NonNull String error, boolean trans);
+      int loadingUnitId, String moduleName, @NonNull String error, boolean isTransient);
 
   // ----- End Dynamic Features Support ----