Re-introduce Desktop integration tests (#16017) (#16023)

* Update packages locks

* Update node locks

* Add FollyWin32 lock

* Add Prototype

* Try adding IDLs from MSRN

* Update Vars target

* Add manifest, just in case

* Export property bag symbols used by desk ITs

* Grab missing generated includes

* Instantiate msrn:ReactNativeHost

* TODO: Obtain main queue

* Implement TestUIDispatcher

* Define HermesPackageName MSBuild property

* split instance settins instantiation

* Set up bundle source and platform

* Init apartment at class init

* Declare TestReactNativeHostHolder

* Update lock

* Add WinAppSDK dependency

* Bootstrap WinApp runtime

* Implement holder synchronization and UI queue

* Update TestUIDispatcher to user DispatcherQueue

* Update yarn lock

* CallJSFunction: runApplication

* CallJSFunction: unmountApplicationComponentAtRootTag

* Add TestModule.h

* Fix REACT_METHOD declarations

* Implement sendAppEvent

* Implement awaiting logic for TestModule

* Add plumbing to make Dummy test pass

* Add AppState mock

* Place test support types into own compilation units and headers

* Place test support types into own compilation units and headers

* Rename MockCompositionContext -> TestCompositionContext

* Set namespace

* Rename Prototype.cpp to RNTesterHeadlessTests.cpp

* Minor edit

* Remove unused activation code

The test DLL is loaded by testhost.exe, which knows nothing about the
DLL's WinRT classes. The DLL has an embedded manifest (resource ID 2)
that registers activatable WinRT classes (like ReactNativeHost). The
code called CreateActCtxW to load that manifest and ActivateActCtx to
push it onto the thread's activation context stack — so that RoGetActivationFactory could resolve those WinRT types at runtime.

* Use infinite wait for events.

Time limits will be enforceb by CI tasks.

* Add failing condition to DummyTest

* Add class diagram

* Change files

* Remove PR.md

* Remove manifest

* Remove comment

* Implement WinRTActivationShims

Leverages the Desktop DLL activation factories removing the need to
declare some types in the DLL DEF list which are only required for
testing and otherwise should stay module-private.

* clang format

* Remove unused test filter entries

* Rename update CI references to RNTesterHeadlessTests

* Put Windows.h in separate "paragraph"

* Install Windows App SDK Runtime into build agents

* Move checkout step before installers downloads

Author: JunielKatarn

.ado/build-template.yml

@@ -265,31 +265,20 @@ extends:
             timeoutInMinutes: 360 # CodeQL requires 3x usual build timeout
             variables:
               - template: .ado/variables/windows.yml@self
-              # Enable if any issues RNTesterIntegrationTests::* become unstable.
+              # Enable if any issues RNTesterHeadlessTests::* become unstable.
               - name: Desktop.IntegrationTests.SkipRNTester
                 value: false
-              #5059 - Disable failing or intermittent tests (IntegrationTestHarness,WebSocket,Logging).
               #10732 - WebSocketIntegrationTest::SendReceiveSsl fails on Windows Server 2022.
               #12714 - Disable for first deployment of test website.
-              #14217 - Reneable RNTesterIntegrationTests
               - name: Desktop.IntegrationTests.Filter
                 value: >
-                  (FullyQualifiedName!=RNTesterIntegrationTests::IntegrationTestHarness)&
-                  (FullyQualifiedName!=RNTesterIntegrationTests::WebSocket)&
-                  (FullyQualifiedName!=RNTesterIntegrationTests::WebSocketBlob)&
-                  (FullyQualifiedName!=RNTesterIntegrationTests::WebSocketMultipleSend)&
                   (FullyQualifiedName!=Microsoft::React::Test::WebSocketIntegrationTest::ConnectClose)&
                   (FullyQualifiedName!=Microsoft::React::Test::WebSocketIntegrationTest::ConnectNoClose)&
                   (FullyQualifiedName!=Microsoft::React::Test::WebSocketIntegrationTest::SendReceiveClose)&
                   (FullyQualifiedName!=Microsoft::React::Test::WebSocketIntegrationTest::SendConsecutive)&
                   (FullyQualifiedName!=Microsoft::React::Test::WebSocketIntegrationTest::SendReceiveLargeMessage)&
                   (FullyQualifiedName!=Microsoft::React::Test::WebSocketIntegrationTest::SendReceiveSsl)&
-                  (FullyQualifiedName!=Microsoft::React::Test::HttpOriginPolicyIntegrationTest)&
-                  (FullyQualifiedName!=RNTesterIntegrationTests::Dummy)&
-                  (FullyQualifiedName!=RNTesterIntegrationTests::Fetch)&
-                  (FullyQualifiedName!=RNTesterIntegrationTests::XHRSample)&
-                  (FullyQualifiedName!=RNTesterIntegrationTests::Blob)&
-                  (FullyQualifiedName!=RNTesterIntegrationTests::Logging)
+                  (FullyQualifiedName!=Microsoft::React::Test::HttpOriginPolicyIntegrationTest)
               #6799 - HostFunctionTest, HostObjectProtoTest crash under JSI/V8;
               #        PreparedJavaScriptSourceTest asserts/fails under JSI/ChakraCore
               - name: Desktop.UnitTests.Filter

.ado/jobs/desktop-single.yml

@@ -21,35 +21,25 @@ parameters:
       - Continuous
 
 steps:
+  - template: ../templates/checkout-shallow.yml
+
   # Set up IIS for integration tests
   - pwsh: |
       Install-WindowsFeature -Name Web-Server, Web-Scripting-Tools
     displayName: Install IIS
 
   - pwsh: |
-      function Invoke-WebRequestWithRetry($Uri, $OutFile, $MaxRetries = 3) {
-        for ($i = 1; $i -le $MaxRetries; $i++) {
-          try {
-            Write-Host "Downloading $OutFile (attempt $i of $MaxRetries)"
-            Invoke-WebRequest -Uri $Uri -OutFile $OutFile
-            return
-          } catch {
-            Write-Host "Attempt $i failed: $_"
-            if ($i -eq $MaxRetries) { throw }
-            Start-Sleep -Seconds (5 * $i)
-          }
-        }
-      }
+      $DownloadScript = "$(Build.SourcesDirectory)\vnext\Scripts\Tfs\Invoke-WebRequestWithRetry.ps1"
 
-      Invoke-WebRequestWithRetry `
+      & $DownloadScript `
         -Uri 'https://download.visualstudio.microsoft.com/download/pr/20598243-c38f-4538-b2aa-af33bc232f80/ea9b2ca232f59a6fdc84b7a31da88464/dotnet-hosting-8.0.3-win.exe' `
         -OutFile dotnet-hosting-8.0.3-win.exe
 
       Write-Host 'Installing .NET hosting bundle'
       Start-Process -Wait -FilePath .\dotnet-hosting-8.0.3-win.exe -ArgumentList '/INSTALL', '/QUIET', '/NORESTART'
       Write-Host 'Installed .NET hosting bundle'
 
-      Invoke-WebRequestWithRetry `
+      & $DownloadScript `
         -Uri 'https://download.visualstudio.microsoft.com/download/pr/f2ec926e-0d98-4a8b-8c70-722ccc2ca0e5/b59941b0c60f16421679baafdb7e9338/dotnet-sdk-7.0.407-win-x64.exe' `
         -OutFile dotnet-sdk-7.0.407-win-x64.exe
 
@@ -58,7 +48,17 @@ steps:
       Write-Host 'Installed .NET 7 SDK'
     displayName: Install the .NET Core Hosting Bundle
 
-  - template: ../templates/checkout-shallow.yml
+  - pwsh: |
+      $DownloadScript = "$(Build.SourcesDirectory)\vnext\Scripts\Tfs\Invoke-WebRequestWithRetry.ps1"
+
+      & $DownloadScript `
+        -Uri 'https://aka.ms/windowsappsdk/1.8/latest/windowsappruntimeinstall-x64.exe' `
+        -OutFile windowsappruntimeinstall-x64.exe
+
+      Write-Host 'Installing Windows App SDK Runtime'
+      Start-Process -Wait -FilePath .\windowsappruntimeinstall-x64.exe -ArgumentList '--quiet'
+      Write-Host 'Installed Windows App SDK Runtime'
+    displayName: Install Windows App SDK Runtime
 
   - template: ../templates/prepare-js-env.yml
 
@@ -72,7 +72,7 @@ steps:
 
   - ${{ if eq(variables['Desktop.IntegrationTests.SkipRNTester'], true) }}:
     - pwsh: |
-        $newValue = '(FullyQualifiedName!~RNTesterIntegrationTests::)&' + "$(Desktop.IntegrationTests.Filter)"
+        $newValue = '(FullyQualifiedName!~Microsoft::React::Test::RNTesterHeadlessTests::)&' + "$(Desktop.IntegrationTests.Filter)"
         Write-Host "##vso[task.setvariable variable=Desktop.IntegrationTests.Filter]$newValue"
       displayName: Update Desktop.IntegrationTests.Filter to exclude RNTester integration tests
 

Directory.Build.targets

@@ -107,6 +107,8 @@
         ReactNativeWindowsDir;
         RnwNewArch;
         FollyDir;
+        IncludeFabricInterface;
+        UseFabric;
         YogaDir;
         WinVer;
       " />

change/react-native-windows-e83b01b1-0133-47da-8a8a-c88a6c16398b.json

@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "Re-introduce Desktop integration tests",
+  "packageName": "react-native-windows",
+  "email": "julio.rocha@microsoft.com",
+  "dependentChangeType": "patch"
+}

vnext/Desktop.DLL/React.Windows.Desktop.DLL.vcxproj

@@ -179,7 +179,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="boost" Version="1.84.0.0" />
-    <PackageReference Include="Microsoft.JavaScript.Hermes" Version="$(HermesVersion)" />
+    <PackageReference Include="$(HermesPackageName)" Version="$(HermesVersion)" />
     <PackageReference Include="$(V8PackageName)" Version="$(V8Version)" Condition="'$(UseV8)' == 'true'" />
   </ItemGroup>
   <Choose>

vnext/Desktop.IntegrationTests/Modules/TestAppState.cpp

@@ -0,0 +1,24 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+#include "TestAppState.h"
+
+namespace Microsoft::React::Test {
+
+void AppState::Initialize(winrt::Microsoft::ReactNative::ReactContext const &) noexcept {}
+
+void AppState::GetCurrentAppState(
+    std::function<void(::Microsoft::ReactNativeSpecs::AppStateSpec_AppState const &)> const &success,
+    std::function<void(winrt::Microsoft::ReactNative::JSValue const &)> const &) noexcept {
+  success({.app_state = "active"});
+}
+
+void AppState::AddListener(std::string) noexcept {}
+
+void AppState::RemoveListeners(double) noexcept {}
+
+::Microsoft::ReactNativeSpecs::AppStateSpec_AppStateConstants AppState::GetConstants() noexcept {
+  return {.initialAppState = "active"};
+}
+
+} // namespace Microsoft::React::Test

vnext/Desktop.IntegrationTests/Modules/TestAppState.h

@@ -0,0 +1,33 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+#pragma once
+
+#include <codegen/NativeAppStateSpec.g.h>
+#include <NativeModules.h>
+
+namespace Microsoft::React::Test {
+
+REACT_MODULE(AppState)
+struct AppState {
+  using ModuleSpec = ::Microsoft::ReactNativeSpecs::AppStateSpec;
+
+  REACT_INIT(Initialize)
+  void Initialize(winrt::Microsoft::ReactNative::ReactContext const &) noexcept;
+
+  REACT_METHOD(GetCurrentAppState, L"getCurrentAppState")
+  void GetCurrentAppState(
+      std::function<void(::Microsoft::ReactNativeSpecs::AppStateSpec_AppState const &)> const &success,
+      std::function<void(winrt::Microsoft::ReactNative::JSValue const &)> const &) noexcept;
+
+  REACT_METHOD(AddListener, L"addListener")
+  void AddListener(std::string) noexcept;
+
+  REACT_METHOD(RemoveListeners, L"removeListeners")
+  void RemoveListeners(double) noexcept;
+
+  REACT_GET_CONSTANTS(GetConstants)
+  ::Microsoft::ReactNativeSpecs::AppStateSpec_AppStateConstants GetConstants() noexcept;
+};
+
+} // namespace Microsoft::React::Test

vnext/Desktop.IntegrationTests/Modules/TestDeviceInfo.cpp

@@ -0,0 +1,22 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+#include "TestDeviceInfo.h"
+
+namespace Microsoft::React::Test {
+
+void DeviceInfo::Initialize(winrt::Microsoft::ReactNative::ReactContext const &) noexcept {}
+
+::Microsoft::ReactNativeSpecs::DeviceInfoSpec_DeviceInfoConstants DeviceInfo::GetConstants() noexcept {
+  ::Microsoft::ReactNativeSpecs::DeviceInfoSpec_DeviceInfoConstants constants;
+  ::Microsoft::ReactNativeSpecs::DeviceInfoSpec_DisplayMetrics dm;
+  dm.fontScale = 1;
+  dm.height = 1024;
+  dm.width = 1024;
+  dm.scale = 1;
+  constants.Dimensions.screen = dm;
+  constants.Dimensions.window = dm;
+  return constants;
+}
+
+} // namespace Microsoft::React::Test

vnext/Desktop.IntegrationTests/Modules/TestDeviceInfo.h

@@ -0,0 +1,22 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+#pragma once
+
+#include <codegen/NativeDeviceInfoSpec.g.h>
+#include <NativeModules.h>
+
+namespace Microsoft::React::Test {
+
+REACT_MODULE(DeviceInfo)
+struct DeviceInfo {
+  using ModuleSpec = ::Microsoft::ReactNativeSpecs::DeviceInfoSpec;
+
+  REACT_INIT(Initialize)
+  void Initialize(winrt::Microsoft::ReactNative::ReactContext const &) noexcept;
+
+  REACT_GET_CONSTANTS(GetConstants)
+  ::Microsoft::ReactNativeSpecs::DeviceInfoSpec_DeviceInfoConstants GetConstants() noexcept;
+};
+
+} // namespace Microsoft::React::Test

vnext/Desktop.IntegrationTests/Modules/TestModule.h

@@ -0,0 +1,80 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+#pragma once
+
+#include <windows.h>
+
+#include <NativeModules.h>
+
+// Standard Library
+#include <atomic>
+#include <functional>
+#include <string>
+
+namespace Microsoft::React::Test {
+
+enum class TestStatus { Pending = 0, Passed, Failed };
+
+REACT_MODULE(TestModule)
+struct TestModule {
+  // Static test signaling - call Reset() before each test.
+  static void Reset() noexcept {
+    ResetEvent(s_completed.get());
+    s_status = TestStatus::Pending;
+  }
+
+  static TestStatus AwaitCompletion(DWORD timeoutMs = INFINITE) noexcept {
+    WaitForSingleObject(s_completed.get(), timeoutMs);
+    return s_status;
+  }
+
+  REACT_INIT(Initialize)
+  void Initialize(winrt::Microsoft::ReactNative::ReactContext const &reactContext) noexcept {
+    m_reactContext = reactContext;
+  }
+
+  REACT_METHOD(MarkTestCompleted, L"markTestCompleted")
+  void MarkTestCompleted() noexcept {
+    MarkTestPassed(true);
+  }
+
+  REACT_METHOD(MarkTestPassed, L"markTestPassed")
+  void MarkTestPassed(bool success) noexcept {
+    s_status = success ? TestStatus::Passed : TestStatus::Failed;
+    SetEvent(s_completed.get());
+  }
+
+  REACT_METHOD(VerifySnapshot, L"verifySnapshot")
+  void VerifySnapshot(std::function<void(bool)> const &callback) noexcept {
+    // Snapshot testing is not supported on Windows; always report success.
+    callback(true);
+  }
+
+  REACT_METHOD(SendAppEvent, L"sendAppEvent")
+  void SendAppEvent(std::string name, ::React::JSValue body) noexcept {
+    m_reactContext.EmitJSEvent(L"RCTDeviceEventEmitter", winrt::to_hstring(name), body);
+  }
+
+  REACT_METHOD(ShouldResolve, L"shouldResolve")
+  void ShouldResolve(::React::ReactPromise<int> &&result) noexcept {
+    result.Resolve(1);
+  }
+
+  REACT_METHOD(ShouldReject, L"shouldReject")
+  void ShouldReject(::React::ReactPromise<::React::JSValue> &&result) noexcept {
+    result.Reject(::React::ReactError{});
+  }
+
+  TestStatus Status() const noexcept {
+    return s_status;
+  }
+
+ private:
+  winrt::Microsoft::ReactNative::ReactContext m_reactContext;
+
+  static inline std::atomic<TestStatus> s_status{TestStatus::Pending};
+  static inline winrt::handle s_completed{CreateEvent(nullptr, TRUE /*manualReset*/, FALSE /*initialState*/, nullptr)};
+};
+
+} // namespace Microsoft::React::Test