[Fabric] Move UriHandler registration to PackageProvider (#13197)

* Move UriHandler registration to PackageProvider * Change files * fix * fix * fix * Remove eval test - eval is not supported by hermes * Fix UT * fix
microsoft · May 8, 2024 · de5c307 · de5c307
1 parent f0966d5
commit de5c307
Show file tree

Hide file tree

Showing 18 changed files with 82 additions and 77 deletions.
diff --git a/change/react-native-windows-5a821784-ada0-45ea-a602-196b255632ca.json b/change/react-native-windows-5a821784-ada0-45ea-a602-196b255632ca.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "Move UriHandler registration to PackageProvider",
+  "packageName": "react-native-windows",
+  "email": "30809111+acoates-ms@users.noreply.github.com",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/playground/windows/playground-composition/Playground-Composition.cpp b/packages/playground/windows/playground-composition/Playground-Composition.cpp
@@ -92,10 +92,15 @@ struct EllipseImageHandler : winrt::implements<
   }
 };
 
-void RegisterEllipseUriImageHandler(const winrt::Microsoft::ReactNative::ReactInstanceSettings &settings) noexcept {
-  winrt::Microsoft::ReactNative::Composition::UriImageManager::AddUriImageProvider(
-      settings.Properties(), winrt::make<EllipseImageHandler>());
-}
+struct EllipseReactPackageProvider
+    : winrt::implements<EllipseReactPackageProvider, winrt::Microsoft::ReactNative::IReactPackageProvider> {
+ public: // IReactPackageProvider
+  void CreatePackage(winrt::Microsoft::ReactNative::IReactPackageBuilder const &packageBuilder) noexcept {
+    // Register ellipse: uri handler for images
+    packageBuilder.as<winrt::Microsoft::ReactNative::IReactPackageBuilderFabric>().AddUriImageProvider(
+        winrt::make<EllipseImageHandler>());
+  }
+};
 
 // Have to use TurboModules to override built in modules.. so the standard attributed package provider doesn't work.
 struct CompReactPackageProvider
@@ -238,7 +243,7 @@ struct WindowData {
                   InstanceSettings(), g_liftedCompositor);
 
               // Register ellipse:// uri hander for images
-              RegisterEllipseUriImageHandler(host.InstanceSettings());
+              host.PackageProviders().Append(winrt::make<EllipseReactPackageProvider>());
 
               auto bridge = winrt::Microsoft::UI::Content::DesktopChildSiteBridge::Create(
                   g_liftedCompositor, winrt::Microsoft::UI::GetWindowIdFromWindow(hwnd));

diff --git a/vnext/Desktop/ABI/TestController.cpp b/vnext/Desktop/ABI/TestController.cpp
@@ -96,6 +96,7 @@ msrn::IReactPackageBuilder TestController::CreateReactPackageBuilder() {
       turboModulesProvider,
 #ifdef USE_FABRIC
       std::shared_ptr<::Microsoft::ReactNative::WindowsComponentDescriptorRegistry>{},
+      std::shared_ptr<winrt::Microsoft::ReactNative::Composition::implementation::UriImageManager>{},
 #endif
       true);
 }

diff --git a/vnext/Microsoft.ReactNative.IntegrationTests/ExecuteJsiTests.cpp b/vnext/Microsoft.ReactNative.IntegrationTests/ExecuteJsiTests.cpp
@@ -24,17 +24,6 @@ struct TestExecuteJsiModule {
     TestEventService::LogEvent("initialize", nullptr);
   }
 
-  REACT_METHOD(TestSimpleExecuteJsi, L"testSimpleExecuteJsi")
-  void TestSimpleExecuteJsi() noexcept {
-    TestEventService::LogEvent("testSimpleExecuteJsi started", nullptr);
-    ExecuteJsi(m_reactContext, [](Runtime &rt) {
-      auto eval = rt.global().getPropertyAsFunction(rt, "eval");
-      auto addFunc = eval.call(rt, "(function(x, y) { return x + y; })").getObject(rt).getFunction(rt);
-      TestCheckEqual(7, addFunc.call(rt, 3, 4).getNumber());
-      TestEventService::LogEvent("testSimpleExecuteJsi completed", nullptr);
-    });
-  }
-
   REACT_METHOD(TestHostFunction, L"testHostFunction")
   void TestHostFunction() noexcept {
     TestEventService::LogEvent("testHostFunction started", nullptr);
@@ -143,8 +132,6 @@ TEST_CLASS (ExecuteJsiTests) {
 
       TestEventService::ObserveEvents({
           TestEvent{"initialize", nullptr},
-          TestEvent{"testSimpleExecuteJsi started", nullptr},
-          TestEvent{"testSimpleExecuteJsi completed", nullptr},
           TestEvent{"testHostFunction started", nullptr},
           TestEvent{"testHostFunction completed", nullptr},
           TestEvent{"testHostObject started", nullptr},

diff --git a/vnext/Microsoft.ReactNative.IntegrationTests/ExecuteJsiTests.js b/vnext/Microsoft.ReactNative.IntegrationTests/ExecuteJsiTests.js
@@ -1,8 +1,7 @@
 import { TurboModuleRegistry } from 'react-native';
 const testExecuteJsiModule = TurboModuleRegistry.getEnforcing('TestExecuteJsiModule');
 
-testExecuteJsiModule.testSimpleExecuteJsi();
 testExecuteJsiModule.testHostFunction();
-testExecuteJsiModule.testHostObject();
+testExecuteJsiModule.testHostObject(); 
 testExecuteJsiModule.testSameJsiRuntime();
 testExecuteJsiModule.testExecuteJsiPromise();
diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/UriImageManager.cpp b/vnext/Microsoft.ReactNative/Fabric/Composition/UriImageManager.cpp
@@ -5,7 +5,6 @@
 #include "UriImageManager.h"
 
 #include "Composition.ImageSource.g.h"
-#include "Composition.UriImageManager.g.cpp"
 #include <AutoDraw.h>
 #include <ReactPropertyBag.h>
 #include <d2d1_3.h>
@@ -183,8 +182,8 @@ struct DataImageHandler : winrt::implements<
   }
 };
 
-static const ReactPropertyId<ReactNonAbiValue<winrt::com_ptr<UriImageManager>>> &UriImageManagerPropertyId() noexcept {
-  static const ReactPropertyId<ReactNonAbiValue<winrt::com_ptr<UriImageManager>>> prop{
+static const ReactPropertyId<ReactNonAbiValue<std::shared_ptr<UriImageManager>>> &UriImageManagerPropertyId() noexcept {
+  static const ReactPropertyId<ReactNonAbiValue<std::shared_ptr<UriImageManager>>> prop{
       L"ReactNative", L"UriImageManager"};
   return prop;
 }
@@ -194,21 +193,21 @@ UriImageManager::UriImageManager() {
   m_providers.push_back(winrt::make<DataImageHandler>());
 }
 
-winrt::com_ptr<UriImageManager> UriImageManager::GetOrCreate(
+void UriImageManager::Install(
+    const winrt::Microsoft::ReactNative::ReactPropertyBag &properties,
+    const std::shared_ptr<UriImageManager> &manager) noexcept {
+  properties.Set(UriImageManagerPropertyId(), manager);
+}
+
+std::shared_ptr<UriImageManager> UriImageManager::Get(
     const winrt::Microsoft::ReactNative::ReactPropertyBag &properties) noexcept {
-  auto uriImageManager =
-      winrt::Microsoft::ReactNative::ReactPropertyBag(properties).GetOrCreate(UriImageManagerPropertyId(), []() {
-        return winrt::make_self<UriImageManager>();
-      });
-  return uriImageManager.Value();
+  return winrt::Microsoft::ReactNative::ReactPropertyBag(properties).Get(UriImageManagerPropertyId()).Value();
 }
 
-void UriImageManager::AddUriImageProvider(
-    const winrt::Microsoft::ReactNative::IReactPropertyBag &properties,
-    const IUriImageProvider &provider) {
+void UriImageManager::AddUriImageProvider(const IUriImageProvider &provider) {
   if (!provider)
     winrt::throw_hresult(E_INVALIDARG);
-  GetOrCreate(winrt::Microsoft::ReactNative::ReactPropertyBag(properties))->m_providers.push_back(provider);
+  m_providers.push_back(provider);
 }
 
 IUriImageProvider UriImageManager::TryGetUriImageProvider(

diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/UriImageManager.h b/vnext/Microsoft.ReactNative/Fabric/Composition/UriImageManager.h
@@ -2,7 +2,6 @@
 // Licensed under the MIT License.
 
 #pragma once
-#include "Composition.UriImageManager.g.h"
 
 #include <ReactPropertyBag.h>
 #include <Utils/ImageUtils.h>
@@ -11,14 +10,16 @@
 
 namespace winrt::Microsoft::ReactNative::Composition::implementation {
 
-struct UriImageManager : UriImageManagerT<UriImageManager> {
+struct UriImageManager {
   UriImageManager();
 
-  static void AddUriImageProvider(
-      const winrt::Microsoft::ReactNative::IReactPropertyBag &properties,
-      const IUriImageProvider &provider);
+  void AddUriImageProvider(const IUriImageProvider &provider);
 
-  static winrt::com_ptr<UriImageManager> GetOrCreate(
+  static void Install(
+      const winrt::Microsoft::ReactNative::ReactPropertyBag &properties,
+      const std::shared_ptr<UriImageManager> &manager) noexcept;
+
+  static std::shared_ptr<UriImageManager> Get(
       const winrt::Microsoft::ReactNative::ReactPropertyBag &properties) noexcept;
 
   IUriImageProvider TryGetUriImageProvider(
@@ -33,7 +34,3 @@ winrt::Microsoft::ReactNative::Composition::ImageSource MakeImageSource(
     const facebook::react::ImageSource &source) noexcept;
 
 } // namespace winrt::Microsoft::ReactNative::Composition::implementation
-
-namespace winrt::Microsoft::ReactNative::Composition::factory_implementation {
-struct UriImageManager : UriImageManagerT<UriImageManager, implementation::UriImageManager> {};
-} // namespace winrt::Microsoft::ReactNative::Composition::factory_implementation
diff --git a/vnext/Microsoft.ReactNative/Fabric/Composition/UriImageManager_emptyimpl.cpp b/vnext/Microsoft.ReactNative/Fabric/Composition/UriImageManager_emptyimpl.cpp
diff --git a/vnext/Microsoft.ReactNative/Fabric/WindowsImageManager.cpp b/vnext/Microsoft.ReactNative/Fabric/WindowsImageManager.cpp
@@ -19,8 +19,8 @@ namespace Microsoft::ReactNative {
 
 WindowsImageManager::WindowsImageManager(winrt::Microsoft::ReactNative::ReactContext reactContext)
     : m_reactContext(reactContext) {
-  m_uriImageManager = winrt::Microsoft::ReactNative::Composition::implementation::UriImageManager::GetOrCreate(
-      reactContext.Properties());
+  m_uriImageManager =
+      winrt::Microsoft::ReactNative::Composition::implementation::UriImageManager::Get(reactContext.Properties());
 }
 
 winrt::com_ptr<IWICBitmapSource> wicBitmapSourceFromStream(

diff --git a/vnext/Microsoft.ReactNative/Fabric/WindowsImageManager.h b/vnext/Microsoft.ReactNative/Fabric/WindowsImageManager.h
@@ -19,7 +19,7 @@ struct WindowsImageManager {
 
  private:
   winrt::Microsoft::ReactNative::ReactContext m_reactContext;
-  winrt::com_ptr<winrt::Microsoft::ReactNative::Composition::implementation::UriImageManager> m_uriImageManager;
+  std::shared_ptr<winrt::Microsoft::ReactNative::Composition::implementation::UriImageManager> m_uriImageManager;
 };
 
 } // namespace Microsoft::ReactNative
diff --git a/vnext/Microsoft.ReactNative/IReactPackageBuilderFabric.idl b/vnext/Microsoft.ReactNative/IReactPackageBuilderFabric.idl
@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 import "IReactViewComponentBuilder.idl";
+import "UriImageManager.idl";
 
 #include "DocString.h"
 
@@ -18,6 +19,10 @@ namespace Microsoft.ReactNative
   {
     DOC_STRING("Registers a custom native view component.")
     void AddViewComponent(String componentName, ReactViewComponentProvider componentProvider);
+
+    DOC_STRING(
+      "Ability to load images using custom Uri protocol handlers. The provider should implement @Composition.IUriImageStreamProvider or @Composition.Experimental.IUriBrushProvider.")
+    void AddUriImageProvider(Microsoft.ReactNative.Composition.IUriImageProvider provider);
   };
 
 } // namespace Microsoft.ReactNative
diff --git a/vnext/Microsoft.ReactNative/ReactHost/React.h b/vnext/Microsoft.ReactNative/ReactHost/React.h
@@ -32,6 +32,10 @@
 #include <ViewManagerProvider.h>
 #include <winrt/Microsoft.ReactNative.h>
 
+#ifdef USE_FABRIC
+#include <Fabric/Composition/UriImageManager.h>
+#endif
+
 namespace Mso::React {
 
 // Forward declarations
@@ -182,6 +186,9 @@ struct ReactOptions {
   std::shared_ptr<NativeModuleProvider2> ModuleProvider;
   std::shared_ptr<ViewManagerProvider2> ViewManagerProvider;
   std::shared_ptr<winrt::Microsoft::ReactNative::TurboModulesProvider> TurboModuleProvider;
+#ifdef USE_FABRIC
+  std::shared_ptr<winrt::Microsoft::ReactNative::Composition::implementation::UriImageManager> UriImageManager;
+#endif
 
   //! Identity of the SDX. Must uniquely describe the SDX across the installed product.
   std::string Identity;

diff --git a/vnext/Microsoft.ReactNative/ReactHost/ReactInstanceWin.cpp b/vnext/Microsoft.ReactNative/ReactHost/ReactInstanceWin.cpp
@@ -52,6 +52,7 @@
 #include "Unicode.h"
 
 #ifdef USE_FABRIC
+#include <Fabric/Composition/UriImageManager.h>
 #include <Fabric/FabricUIManagerModule.h>
 #include <Fabric/ReactNativeConfigProperties.h>
 #include <Fabric/WindowsComponentDescriptorRegistry.h>
@@ -570,6 +571,8 @@ void ReactInstanceWin::InitializeBridgeless() noexcept {
           });
 
   InitDevMenu();
+  winrt::Microsoft::ReactNative::Composition::implementation::UriImageManager::Install(
+      ReactPropertyBag(m_reactContext->Properties()), m_options.UriImageManager);
 
   m_uiQueue->Post([this, weakThis = Mso::WeakPtr{this}]() noexcept {
     // Objects that must be created on the UI thread
@@ -726,6 +729,10 @@ void ReactInstanceWin::InitializeWithBridge() noexcept {
 #endif
 
   InitDevMenu();
+#ifdef USE_FABRIC
+  winrt::Microsoft::ReactNative::Composition::implementation::UriImageManager::Install(
+      ReactPropertyBag(m_reactContext->Properties()), m_options.UriImageManager);
+#endif
 
   m_uiQueue->Post([this, weakThis = Mso::WeakPtr{this}]() noexcept {
     // Objects that must be created on the UI thread

diff --git a/vnext/Microsoft.ReactNative/ReactNativeHost.cpp b/vnext/Microsoft.ReactNative/ReactNativeHost.cpp
@@ -16,6 +16,7 @@
 
 #ifdef USE_FABRIC
 #include <Fabric/WindowsComponentDescriptorRegistry.h>
+#include <ReactPackageBuilder.h>
 #include <react/renderer/componentregistry/ComponentDescriptorProviderRegistry.h>
 #endif
 
@@ -93,6 +94,8 @@ IAsyncAction ReactNativeHost::ReloadInstance() noexcept {
   auto turboModulesProvider = std::make_shared<TurboModulesProvider>();
 
 #ifdef USE_FABRIC
+  auto uriImageManager =
+      std::make_shared<winrt::Microsoft::ReactNative::Composition::implementation::UriImageManager>();
   auto componentregistry = std::make_shared<::Microsoft::ReactNative::WindowsComponentDescriptorRegistry>();
   auto componentDescriptorRegistry = std::make_shared<facebook::react::ComponentDescriptorProviderRegistry>();
 
@@ -108,6 +111,7 @@ IAsyncAction ReactNativeHost::ReloadInstance() noexcept {
       turboModulesProvider,
 #ifdef USE_FABRIC
       componentregistry,
+      uriImageManager,
 #endif
       m_instanceSettings.UseWebDebugger());
 
@@ -164,6 +168,10 @@ IAsyncAction ReactNativeHost::ReloadInstance() noexcept {
 #endif
   reactOptions.TurboModuleProvider = turboModulesProvider;
 
+#ifdef USE_FABRIC
+  reactOptions.UriImageManager = uriImageManager;
+#endif
+
   reactOptions.OnInstanceCreated = [](Mso::CntPtr<Mso::React::IReactContext> &&context) {
     auto notifications = context->Notifications();
     ReactInstanceSettings::RaiseInstanceCreated(

diff --git a/vnext/Microsoft.ReactNative/ReactPackageBuilder.cpp b/vnext/Microsoft.ReactNative/ReactPackageBuilder.cpp
@@ -22,6 +22,7 @@ ReactPackageBuilder::ReactPackageBuilder(
     std::shared_ptr<TurboModulesProvider> const &turboModulesProvider,
 #ifdef USE_FABRIC
     std::shared_ptr<::Microsoft::ReactNative::WindowsComponentDescriptorRegistry> const &componentRegistry,
+    std::shared_ptr<winrt::Microsoft::ReactNative::Composition::implementation::UriImageManager> const &uriImageManager,
 #endif
     bool isWebDebugging) noexcept
     : m_modulesProvider{modulesProvider},
@@ -31,6 +32,7 @@ ReactPackageBuilder::ReactPackageBuilder(
       m_turboModulesProvider{turboModulesProvider},
 #ifdef USE_FABRIC
       m_componentRegistry{componentRegistry},
+      m_uriImageManager{uriImageManager},
 #endif
 
       m_isWebDebugging{isWebDebugging} {
@@ -63,5 +65,11 @@ void ReactPackageBuilder::AddViewComponent(
     ReactViewComponentProvider const &viewComponentProvider) noexcept {
   m_componentRegistry->Add(componentName, viewComponentProvider);
 }
+
+void ReactPackageBuilder::AddUriImageProvider(
+    const winrt::Microsoft::ReactNative::Composition::IUriImageProvider &provider) noexcept {
+  m_uriImageManager->AddUriImageProvider(provider);
+}
+
 #endif
 } // namespace winrt::Microsoft::ReactNative
diff --git a/vnext/Microsoft.ReactNative/ReactPackageBuilder.h b/vnext/Microsoft.ReactNative/ReactPackageBuilder.h
@@ -9,7 +9,9 @@
 #endif
 #include "winrt/Microsoft.ReactNative.h"
 #ifdef USE_FABRIC
+#include <Fabric/Composition/UriImageManager.h>
 #include <Fabric/WindowsComponentDescriptorRegistry.h>
+#include "winrt/Microsoft.ReactNative.Composition.h"
 #endif
 
 namespace winrt::Microsoft::ReactNative {
@@ -30,6 +32,8 @@ struct ReactPackageBuilder : winrt::implements<
       std::shared_ptr<TurboModulesProvider> const &turboModulesProvider,
 #ifdef USE_FABRIC
       std::shared_ptr<::Microsoft::ReactNative::WindowsComponentDescriptorRegistry> const &componentRegistry,
+      std::shared_ptr<winrt::Microsoft::ReactNative::Composition::implementation::UriImageManager> const
+          &uriImageManager,
 #endif
       bool isWebDebugging) noexcept;
 
@@ -43,6 +47,7 @@ struct ReactPackageBuilder : winrt::implements<
 #ifdef USE_FABRIC
   // IReactPackageBuilderFabric
   void AddViewComponent(winrt::hstring componentName, ReactViewComponentProvider const &viewComponentProvider) noexcept;
+  void AddUriImageProvider(const winrt::Microsoft::ReactNative::Composition::IUriImageProvider &provider) noexcept;
 #endif // USE_FABRIC
 
  private:
@@ -54,6 +59,7 @@ struct ReactPackageBuilder : winrt::implements<
 
 #ifdef USE_FABRIC
   std::shared_ptr<::Microsoft::ReactNative::WindowsComponentDescriptorRegistry> m_componentRegistry;
+  std::shared_ptr<winrt::Microsoft::ReactNative::Composition::implementation::UriImageManager> m_uriImageManager;
 #endif
 
   const bool m_isWebDebugging;

diff --git a/vnext/Microsoft.ReactNative/UriImageManager.idl b/vnext/Microsoft.ReactNative/UriImageManager.idl
@@ -72,14 +72,4 @@ namespace Microsoft.ReactNative.Composition
     Windows.Foundation.IAsyncOperation<UriBrushFactory> GetSourceAsync(Microsoft.ReactNative.IReactContext context, Microsoft.ReactNative.Composition.ImageSource imageSource);
   }
   }
-
-  [default_interface]
-  [webhosthidden]
-  [experimental]
-  DOC_STRING(
-    "Ability to load images using custom Uri protocol handlers.  The provider should implement @IUriImageStreamProvider or @Experimental.IUriBrushProvider")
-  runtimeclass UriImageManager
-  {
-    static void AddUriImageProvider(Microsoft.ReactNative.IReactPropertyBag properties, IUriImageProvider provider);
-  }
 } // namespace Microsoft.ReactNative.Composition