Add UIDispatcher property to ReactInstanceSettings and IReactContext

change/react-native-windows-2020-05-25-15-56-21-PR-UIDispatcherProperty.json

@@ -0,0 +1,8 @@
+{
+  "type": "prerelease",
+  "comment": "Add UIDispatcher property to ReactInstanceSettings and IReactContext",
+  "packageName": "react-native-windows",
+  "email": "[email protected]",
+  "dependentChangeType": "patch",
+  "date": "2020-05-25T22:56:21.049Z"
+}

packages/playground/windows/playground-win32/Playground-Win32.cpp

@@ -138,9 +138,6 @@ struct WindowData {
           host.InstanceSettings().UseFastRefresh(m_liveReloadEnabled);
           host.InstanceSettings().DebuggerPort(m_debuggerPort);
           host.InstanceSettings().RedBoxHandler(winrt::make<SimpleRedBoxHandler>());
-          host.InstanceSettings().Properties().Set(
-              winrt::Microsoft::ReactNative::ReactDispatcherHelper::UIDispatcherProperty(),
-              winrt::Microsoft::ReactNative::ReactDispatcherHelper::UIThreadDispatcher());
 
           // Nudge the ReactNativeHost to create the instance and wrapping context
           host.ReloadInstance();

packages/playground/windows/playground/MainPage.cpp

@@ -42,9 +42,6 @@ void MainPage::OnLoadClick(
   host.InstanceSettings().DebuggerBreakOnNextLine(x_BreakOnFirstLineCheckBox().IsChecked().GetBoolean());
   host.InstanceSettings().UseFastRefresh(x_UseFastRefreshCheckBox().IsChecked().GetBoolean());
   host.InstanceSettings().DebuggerPort(static_cast<uint16_t>(std::stoi(std::wstring(x_DebuggerPort().Text()))));
-  host.InstanceSettings().Properties().Set(
-      winrt::Microsoft::ReactNative::ReactDispatcherHelper::UIDispatcherProperty(),
-      winrt::Microsoft::ReactNative::ReactDispatcherHelper::UIThreadDispatcher());
 
   // Nudge the ReactNativeHost to create the instance and wrapping context
   host.ReloadInstance();

vnext/Desktop/React.Windows.Desktop.vcxproj

@@ -127,6 +127,8 @@
     <Midl Include="..\Microsoft.ReactNative\ReactInstance.idl" />
   </ItemGroup>
   <ItemGroup>
+    <ClCompile Include="..\Microsoft.ReactNative\IReactDispatcher.cpp" />
+    <ClCompile Include="..\Microsoft.ReactNative\ReactInstanceSettings.cpp" />
     <ClCompile Include="ABI\MemoryTracker.cpp">
       <DependentUpon>ABI\MemoryTracker.idl</DependentUpon>
       <ObjectFileName>$(IntDir)\ABI\</ObjectFileName>

vnext/Desktop/React.Windows.Desktop.vcxproj.filters

@@ -60,6 +60,7 @@
     <Midl Include="..\Microsoft.ReactNative\IViewManager.idl">
       <Filter>ABI</Filter>
     </Midl>
+    <Midl Include="..\Microsoft.ReactNative\ReactInstance.idl" />
     <Midl Include="..\Microsoft.ReactNative\ReactInstanceSettings.idl">
       <Filter>ABI</Filter>
     </Midl>
@@ -81,9 +82,17 @@
     <Midl Include="ABI\NativeTracing.idl">
       <Filter>ABI</Filter>
     </Midl>
-    <Midl Include="..\Microsoft.ReactNative\ReactInstance.idl" />
   </ItemGroup>
   <ItemGroup>
+    <ClCompile Include="..\Microsoft.ReactNative\IReactDispatcher.cpp" />
+    <ClCompile Include="..\Microsoft.ReactNative\IReactNotificationService.cpp" />
+    <ClCompile Include="..\Microsoft.ReactNative\IReactPropertyBag.cpp" />
+    <ClCompile Include="..\Microsoft.ReactNative\ReactHost\AsyncActionQueue.cpp" />
+    <ClCompile Include="..\Microsoft.ReactNative\ReactHost\JSBundle.cpp" />
+    <ClCompile Include="..\Microsoft.ReactNative\ReactHost\JSBundle_Win32.cpp" />
+    <ClCompile Include="..\Microsoft.ReactNative\ReactHost\MsoUtils.cpp" />
+    <ClCompile Include="..\Microsoft.ReactNative\ReactHost\ReactHost.cpp" />
+    <ClCompile Include="..\Microsoft.ReactNative\ReactInstanceSettings.cpp" />
     <ClCompile Include="ABI\MemoryTracker.cpp">
       <Filter>ABI</Filter>
     </ClCompile>
@@ -133,13 +142,6 @@
     <ClCompile Include="WebSocketResourceFactory.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
-    <ClCompile Include="..\Microsoft.ReactNative\IReactNotificationService.cpp" />
-    <ClCompile Include="..\Microsoft.ReactNative\IReactPropertyBag.cpp" />
-    <ClCompile Include="..\Microsoft.ReactNative\ReactHost\ReactHost.cpp" />
-    <ClCompile Include="..\Microsoft.ReactNative\ReactHost\MsoUtils.cpp" />
-    <ClCompile Include="..\Microsoft.ReactNative\ReactHost\AsyncActionQueue.cpp" />
-    <ClCompile Include="..\Microsoft.ReactNative\ReactHost\JSBundle.cpp" />
-    <ClCompile Include="..\Microsoft.ReactNative\ReactHost\JSBundle_Win32.cpp" />
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="ABI\MemoryTracker.h">

vnext/Microsoft.ReactNative.Cxx.UnitTests/ReactContextTest.cpp

@@ -16,6 +16,10 @@ struct ReactContextStub : implements<ReactContextStub, IReactContext> {
     VerifyElseCrashSz(false, "Not implemented");
   }
 
+  IReactDispatcher UIDispatcher() noexcept {
+    VerifyElseCrashSz(false, "Not implemented");
+  }
+
   void DispatchEvent(
       xaml::FrameworkElement const & /*view*/,
       hstring const & /*eventName*/,

vnext/Microsoft.ReactNative.Cxx.UnitTests/ReactModuleBuilderMock.h

@@ -119,6 +119,10 @@ struct ReactContextMock : implements<ReactContextMock, IReactContext> {
     VerifyElseCrashSz(false, "Not implemented");
   }
 
+  IReactDispatcher UIDispatcher() noexcept {
+    VerifyElseCrashSz(false, "Not implemented");
+  }
+
   void DispatchEvent(
       xaml::FrameworkElement const & /*view*/,
       hstring const & /*eventName*/,

vnext/Microsoft.ReactNative.Cxx/ReactContext.h

@@ -37,6 +37,10 @@ struct ReactContext {
     return ReactNotificationService{m_handle.Notifications()};
   }
 
+  ReactDispatcher UIDispatcher() const noexcept {
+    return ReactDispatcher{m_handle.UIDispatcher()};
+  }
+
   // Call methodName JS function of module with moduleName.
   // args are either function arguments or a single lambda with 'IJSValueWriter const&' argument.
   template <class... TArgs>

vnext/Microsoft.ReactNative.IntegrationTests/Microsoft.ReactNative.IntegrationTests.vcxproj

@@ -107,6 +107,7 @@
     </Link>
   </ItemDefinitionGroup>
   <ItemGroup>
+    <ClCompile Include="ReactInstanceSettingsTests.cpp" />
     <ClCompile Include="ReactNonAbiValueTests.cpp" />
     <ClCompile Include="ReactNotificationServiceTests.cpp" />
     <ClCompile Include="ReactPropertyBagTests.cpp" />

vnext/Microsoft.ReactNative.IntegrationTests/ReactInstanceSettingsTests.cpp

@@ -0,0 +1,47 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+#include "pch.h"
+
+#include <winrt/Microsoft.ReactNative.h>
+#include <winrt/Windows.System.h>
+
+using namespace winrt;
+using namespace Microsoft::ReactNative;
+using namespace Windows::System;
+
+namespace ReactNativeIntegrationTests {
+
+TEST_CLASS (ReactInstanceSettingsTests) {
+  TEST_METHOD(DefaultUIDispatcher_NonUIThread) {
+    // In case if current thread has no ThreadDispatcher, then the
+    // ReactInstanceSettings::UIDispatcher is not initialized.
+    ReactInstanceSettings settings;
+    TestCheck(settings);
+    TestCheck(!settings.UIDispatcher());
+    // UIDispatcher() is a shortcut for getting property value.
+    TestCheck(!settings.Properties().Get(ReactDispatcherHelper::UIDispatcherProperty()));
+  }
+
+  TEST_METHOD(DefaultUIDispatcher_UIThread) {
+    // ReactInstanceSettings::UIDispatcher is set to a non-null value if it is
+    // creates from a UI thread. We simulate the UI thread with DispatcherQueueController.
+    auto queueController = DispatcherQueueController::CreateOnDedicatedThread();
+    auto uiDispatcher = queueController.DispatcherQueue();
+    TestCheck(uiDispatcher);
+    uiDispatcher.TryEnqueue([]() noexcept {
+      ReactInstanceSettings settings;
+      TestCheck(settings);
+      TestCheck(settings.UIDispatcher());
+      // UIDispatcher() is a shortcut for getting property value.
+      TestCheck(settings.Properties().Get(ReactDispatcherHelper::UIDispatcherProperty()));
+      TestCheckEqual(ReactDispatcherHelper::UIThreadDispatcher(), settings.UIDispatcher());
+      TestCheckEqual(
+          ReactDispatcherHelper::UIThreadDispatcher(),
+          settings.Properties().Get(ReactDispatcherHelper::UIDispatcherProperty()));
+    });
+    queueController.ShutdownQueueAsync().get();
+  }
+};
+
+} // namespace ReactNativeIntegrationTests

vnext/Microsoft.ReactNative.Managed.UnitTests/ReactModuleBuilderMock.cs

@@ -309,6 +309,8 @@ public ReactContextMock(ReactModuleBuilderMock builder)
 
     public IReactNotificationService Notifications { get; } = ReactNotificationServiceHelper.CreateNotificationService();
 
+    public IReactDispatcher UIDispatcher => Properties.Get(ReactDispatcherHelper.UIDispatcherProperty) as IReactDispatcher;
+
     public void DispatchEvent(FrameworkElement view, string eventName, JSValueArgWriter eventDataArgWriter)
     {
       throw new NotImplementedException();

vnext/Microsoft.ReactNative/ABIViewManager.cpp

@@ -27,7 +27,7 @@ ABIViewManager::ABIViewManager(
       m_viewManagerWithChildren{viewManager.try_as<IViewManagerWithChildren>()},
       m_name{to_string(viewManager.Name())} {
   if (m_viewManagerWithReactContext) {
-    m_viewManagerWithReactContext.ReactContext(winrt::make<ReactContext>(Mso::Copy(reactContext)));
+    m_viewManagerWithReactContext.ReactContext(winrt::make<implementation::ReactContext>(Mso::Copy(reactContext)));
   }
   if (m_viewManagerWithNativeProperties) {
     m_nativeProps = m_viewManagerWithNativeProperties.NativeProps();

vnext/Microsoft.ReactNative/IReactContext.cpp

@@ -5,7 +5,7 @@
 #include "IReactContext.h"
 #include "DynamicWriter.h"
 
-namespace winrt::Microsoft::ReactNative {
+namespace winrt::Microsoft::ReactNative::implementation {
 
 ReactContext::ReactContext(Mso::CntPtr<Mso::React::IReactContext> &&context) noexcept : m_context{std::move(context)} {}
 
@@ -17,6 +17,10 @@ IReactNotificationService ReactContext::Notifications() noexcept {
   return m_context->Notifications();
 }
 
+IReactDispatcher ReactContext::UIDispatcher() noexcept {
+  return Properties().Get(ReactDispatcherHelper::UIDispatcherProperty()).try_as<IReactDispatcher>();
+}
+
 void ReactContext::DispatchEvent(
     xaml::FrameworkElement const &view,
     hstring const &eventName,
@@ -55,4 +59,4 @@ void ReactContext::EmitJSEvent(
   m_context->CallJSFunction(to_string(eventEmitterName), "emit", std::move(params));
 }
 
-} // namespace winrt::Microsoft::ReactNative
+} // namespace winrt::Microsoft::ReactNative::implementation

vnext/Microsoft.ReactNative/IReactContext.h

@@ -6,14 +6,15 @@
 #include "ReactHost/React.h"
 #include "winrt/Microsoft.ReactNative.h"
 
-namespace winrt::Microsoft::ReactNative {
+namespace winrt::Microsoft::ReactNative::implementation {
 
 struct ReactContext : winrt::implements<ReactContext, IReactContext> {
   ReactContext(Mso::CntPtr<Mso::React::IReactContext> &&context) noexcept;
 
  public: // IReactContext
   IReactPropertyBag Properties() noexcept;
   IReactNotificationService Notifications() noexcept;
+  IReactDispatcher UIDispatcher() noexcept;
   void DispatchEvent(
       xaml::FrameworkElement const &view,
       hstring const &eventName,
@@ -31,4 +32,4 @@ struct ReactContext : winrt::implements<ReactContext, IReactContext> {
   Mso::CntPtr<Mso::React::IReactContext> m_context;
 };
 
-} // namespace winrt::Microsoft::ReactNative
+} // namespace winrt::Microsoft::ReactNative::implementation

vnext/Microsoft.ReactNative/IReactContext.idl

@@ -26,6 +26,9 @@ namespace Microsoft.ReactNative {
     // The subscriptions added to IReactInstanceSettings.Notifications kept as long as IReactInstanceSettings alive.
     IReactNotificationService Notifications { get; };
 
+    // Get ReactDispatcherHelper::UIDispatcherProperty from the Properties property bag.
+    IReactDispatcher UIDispatcher { get; };
+
     // Dispatch UI event. This method is to be moved to IReactViewContext.
     void DispatchEvent(XAML_NAMESPACE.FrameworkElement view, String eventName, JSValueArgWriter eventDataArgWriter);
 

vnext/Microsoft.ReactNative/IReactDispatcher.cpp

@@ -29,20 +29,40 @@ void ReactDispatcher::Post(ReactDispatcherCallback const &callback) noexcept {
 }
 
 /*static*/ IReactDispatcher ReactDispatcher::UIThreadDispatcher() noexcept {
-  return make<ReactDispatcher>(Mso::DispatchQueue::MakeCurrentThreadUIQueue());
+  static thread_local weak_ref<IReactDispatcher> *tlsWeakDispatcher{nullptr};
+  IReactDispatcher dispatcher{nullptr};
+  auto queue = Mso::DispatchQueue::GetCurrentUIThreadQueue();
+  if (queue && queue.HasThreadAccess()) {
+    queue.InvokeElsePost([&queue, &dispatcher ]() noexcept {
+      // This code runs synchronously, but we want it to be run the queue context to
+      // access the queue local value where we store the weak_ref to the dispatcher.
+      // The queue local values are destroyed along with the queue.
+      // To access queue local value we temporary swap it with the thread local value.
+      // It must be a TLS value to ensure proper indexing of the queue local value entry.
+      auto tlsGuard{queue.LockLocalValue(&tlsWeakDispatcher)};
+      dispatcher = tlsWeakDispatcher->get();
+      if (!dispatcher) {
+        dispatcher = winrt::make<ReactDispatcher>(std::move(queue));
+        *tlsWeakDispatcher = dispatcher;
+      }
+    });
+  }
+
+  return dispatcher;
 }
 
-/*static*/ ReactPropertyId<IReactDispatcher> ReactDispatcher::UIDispatcherProperty() noexcept {
-  static ReactPropertyId<IReactDispatcher> uiThreadDispatcherProperty{L"ReactNative.Dispatcher", L"UIDispatcher"};
+/*static*/ IReactPropertyName ReactDispatcher::UIDispatcherProperty() noexcept {
+  static IReactPropertyName uiThreadDispatcherProperty{ReactPropertyBagHelper::GetName(
+      ReactPropertyBagHelper::GetNamespace(L"ReactNative.Dispatcher"), L"UIDispatcher")};
   return uiThreadDispatcherProperty;
 }
 
 /*static*/ IReactDispatcher ReactDispatcher::GetUIDispatcher(IReactPropertyBag const &properties) noexcept {
-  return ReactPropertyBag{properties}.Get(UIDispatcherProperty());
+  return properties.Get(UIDispatcherProperty()).try_as<IReactDispatcher>();
 }
 
 /*static*/ void ReactDispatcher::SetUIThreadDispatcher(IReactPropertyBag const &properties) noexcept {
-  ReactPropertyBag{properties}.Set(UIDispatcherProperty(), UIThreadDispatcher());
+  properties.Set(UIDispatcherProperty(), UIThreadDispatcher());
 }
 
 } // namespace winrt::Microsoft::ReactNative::implementation

vnext/Microsoft.ReactNative/IReactDispatcher.h

@@ -3,13 +3,12 @@
 
 #pragma once
 #include "ReactDispatcherHelper.g.h"
-#include <ReactPropertyBag.h>
 #include <dispatchQueue/dispatchQueue.h>
 #include <winrt/Microsoft.ReactNative.h>
 
 namespace winrt::Microsoft::ReactNative::implementation {
 
-struct ReactDispatcher : implements<ReactDispatcher, IReactDispatcher> {
+struct ReactDispatcher : implements<ReactDispatcher, winrt::default_interface<IReactDispatcher>> {
   ReactDispatcher() = default;
   ReactDispatcher(Mso::DispatchQueue &&queue) noexcept;
 
@@ -21,7 +20,7 @@ struct ReactDispatcher : implements<ReactDispatcher, IReactDispatcher> {
   static Mso::DispatchQueue GetUIDispatchQueue(IReactPropertyBag const &properties) noexcept;
 
   static IReactDispatcher UIThreadDispatcher() noexcept;
-  static ReactPropertyId<IReactDispatcher> UIDispatcherProperty() noexcept;
+  static IReactPropertyName UIDispatcherProperty() noexcept;
   static IReactDispatcher GetUIDispatcher(IReactPropertyBag const &properties) noexcept;
   static void SetUIThreadDispatcher(IReactPropertyBag const &properties) noexcept;
 
@@ -41,7 +40,7 @@ struct ReactDispatcherHelper {
   }
 
   static IReactPropertyName UIDispatcherProperty() noexcept {
-    return ReactDispatcher::UIDispatcherProperty().Handle();
+    return ReactDispatcher::UIDispatcherProperty();
   }
 };
 

vnext/Microsoft.ReactNative/IReactDispatcher.idl

@@ -30,6 +30,6 @@ namespace Microsoft.ReactNative {
     static IReactDispatcher UIThreadDispatcher{ get; };
 
     // Get name of the UIDispatcher property for the IReactPropertyBag.
-    static IReactPropertyName UIDispatcherProperty();
+    static IReactPropertyName UIDispatcherProperty { get; };
   }
 } // namespace ReactNative

vnext/Microsoft.ReactNative/NativeModulesProvider.cpp

@@ -34,7 +34,7 @@ std::vector<facebook::react::NativeModuleDescription> NativeModulesProvider::Get
     m_modulesWorkerQueue = react::uwp::MakeSerialQueueThread();
   }
 
-  auto winrtReactContext = winrt::make<ReactContext>(Mso::Copy(reactContext));
+  auto winrtReactContext = winrt::make<implementation::ReactContext>(Mso::Copy(reactContext));
 
   for (auto &entry : m_moduleProviders) {
     modules.emplace_back(

vnext/Microsoft.ReactNative/ReactHost/ReactInstanceWin.cpp

@@ -503,6 +503,7 @@ void ReactInstanceWin::InitNativeMessageThread() noexcept {
 void ReactInstanceWin::InitUIMessageThread() noexcept {
   // Native queue was already given us in constructor.
   m_uiQueue = winrt::Microsoft::ReactNative::implementation::ReactDispatcher::GetUIDispatchQueue(m_options.Properties);
+  VerifyElseCrashSz(m_uiQueue, "No UI Dispatcher provided");
   m_uiMessageThread.Exchange(
       std::make_shared<MessageDispatchQueue>(m_uiQueue, Mso::MakeWeakMemberFunctor(this, &ReactInstanceWin::OnError)));
 

vnext/Microsoft.ReactNative/ReactInstanceSettings.cpp

@@ -7,4 +7,19 @@
 #include "ReactInstanceSettings.g.cpp"
 #endif
 
-namespace winrt::Microsoft::ReactNative::implementation {} // namespace winrt::Microsoft::ReactNative::implementation
+namespace winrt::Microsoft::ReactNative::implementation {
+
+ReactInstanceSettings::ReactInstanceSettings() noexcept {
+  // Use current thread dispatcher as a default UI dispatcher.
+  m_properties.Set(ReactDispatcherHelper::UIDispatcherProperty(), ReactDispatcherHelper::UIThreadDispatcher());
+}
+
+IReactDispatcher ReactInstanceSettings::UIDispatcher() noexcept {
+  return m_properties.Get(ReactDispatcherHelper::UIDispatcherProperty()).try_as<IReactDispatcher>();
+}
+
+void ReactInstanceSettings::UIDispatcher(IReactDispatcher const &value) noexcept {
+  m_properties.Set(ReactDispatcherHelper::UIDispatcherProperty(), value);
+}
+
+} // namespace winrt::Microsoft::ReactNative::implementation

vnext/Microsoft.ReactNative/ReactInstanceSettings.h

@@ -22,7 +22,7 @@
 namespace winrt::Microsoft::ReactNative::implementation {
 
 struct ReactInstanceSettings : ReactInstanceSettingsT<ReactInstanceSettings> {
-  ReactInstanceSettings() = default;
+  ReactInstanceSettings() noexcept;
 
   IReactPropertyBag Properties() noexcept;
 
@@ -85,6 +85,9 @@ struct ReactInstanceSettings : ReactInstanceSettingsT<ReactInstanceSettings> {
   IRedBoxHandler RedBoxHandler() noexcept;
   void RedBoxHandler(IRedBoxHandler const &value) noexcept;
 
+  IReactDispatcher UIDispatcher() noexcept;
+  void UIDispatcher(IReactDispatcher const &value) noexcept;
+
   hstring SourceBundleHost() noexcept;
   void SourceBundleHost(hstring const &value) noexcept;