Switch New Architecture templates to use prebuilt NuGets (#13338)

jonthysell · web-flow · commit 9ce78de3323b · 2024-08-26T21:34:07.000Z
## Description This PR updates the `cpp-app` and `cpp-lib` new architecture templates to build against the pre-built `Microsoft.ReactNative` NuGet packages by default. ### Type of Change - New feature (non-breaking change which adds functionality) - Breaking change (fix or feature that would cause existing functionality to not work as expected) - This change requires a documentation update ### Why Building the `Microsoft.ReactNative` native code is very resource-intensive. Pre-building that code makes for much faster builds and greatly improved developer experience. This experience has been experimental and poorly support for Paper for some time now - for the new architecture projects we want using NuGets to be the primary experience from day one. Resolves #12639 ### What The `cpp-app` and `cpp-lib` new architecture templates now set up projects to consume the ("-Fabric" versions) of the pre-built `Microsoft.ReactNative` NuGet packages by default. The CI and PR builds have also been updated to make sure nugets for x64, x86, arm64 are built first and then consumed by the new project tests. To support working on RNW itself, the new projects made using "devMode" (i.e. by yarn linking with your local RNW repo) will still build against the source of that local RNW repo rather than the nugets. This PR also fixes the `--singleproc` flag for `run-windows`. Previously it didn't do anything on machines with high RAM, but now if you specify the flag it forces single processor builds as expected. ## Screenshots Building x64 Release Paper (build RNW from source): ![image](https://github.com/user-attachments/assets/d7a529b9-d313-4227-b236-f4781aa25855) Building x64 Release Fabric (use RNW Nugets): ![image](https://github.com/user-attachments/assets/bdb81df2-e111-4d61-a20a-302b3b6b1ecf) ## Testing Verified new projects build and run using the pre-built nugets. ## Changelog Should this change be included in the release notes: _yes_ Switch New Architecture templates to use prebuilt NuGets
diff --git a/.ado/jobs/cli-init-windows.yml b/.ado/jobs/cli-init-windows.yml
@@ -8,6 +8,9 @@ parameters:
       - Continuous
   - name: AgentPool
     type: object
+  - name: buildNuGetOnly
+    type: boolean
+    default: false
   - name: buildMatrix
     type: object
     default:
@@ -18,31 +21,37 @@ parameters:
             configuration: Release
             platform: x64
             additionalRunArguments: --no-autolink
+            useNuGet: true
           - Name: FabricX86Debug
             template: cpp-app
             configuration: Debug
             platform: x86
             additionalRunArguments: --no-autolink
+            useNuGet: true
           - Name: FabricArm64Release
             template: cpp-app
             configuration: Release
             platform: ARM64
             additionalRunArguments: --no-autolink --no-deploy
+            useNuGet: true
           - Name: FabricLibX64Release
             template: cpp-lib
             configuration: Release
             platform: x64
-            additionalRunArguments:
+            additionalRunArguments: --singleproc # --singleproc required to workaround issue #13599
+            useNuGet: true
           - Name: FabricLibX86Debug
             template: cpp-lib
             configuration: Debug
             platform: x86
-            additionalRunArguments:
+            additionalRunArguments: --singleproc # --singleproc required to workaround issue #13599
+            useNuGet: true
           - Name: FabricLibArm64Release
             template: cpp-lib
             configuration: Release
             platform: ARM64
-            additionalRunArguments: --no-deploy
+            additionalRunArguments: --no-deploy --singleproc # --singleproc required to workaround issue #13599
+            useNuGet: true
           - Name: PaperX64ReleaseCpp
             template: old/uwp-cpp-app
             configuration: Release
@@ -108,67 +117,79 @@ parameters:
             configuration: Release
             platform: x64
             additionalRunArguments: --no-autolink
+            useNuGet: true
       - BuildEnvironment: Continuous
         Matrix:
           - Name: FabricX64Debug
             template: cpp-app
             configuration: Debug
             platform: x64
             additionalRunArguments: --no-autolink
+            useNuGet: true
           - Name: FabricX64Release
             template: cpp-app
             configuration: Release
             platform: x64
             additionalRunArguments: --no-autolink
+            useNuGet: true
           - Name: FabricX86Debug
             template: cpp-app
             configuration: Debug
             platform: x86
             additionalRunArguments: --no-autolink
+            useNuGet: true
           - Name: FabricX86Release
             template: cpp-app
             configuration: Release
             platform: x86
+            useNuGet: true
           - Name: FabricArm64Debug
             template: cpp-app
             configuration: Debug
             platform: ARM64
             additionalRunArguments: --no-autolink --no-deploy
+            useNuGet: true
           - Name: FabricArm64Release
             template: cpp-app
             configuration: Release
             platform: ARM64
             additionalRunArguments: --no-autolink --no-deploy
+            useNuGet: true
           - Name: FabricLibX64Debug
             template: cpp-lib
             configuration: Debug
             platform: x64
-            additionalRunArguments:
+            additionalRunArguments: --singleproc # --singleproc required to workaround issue #13599
+            useNuGet: true
           - Name: FabricLibX64Release
             template: cpp-lib
             configuration: Release
             platform: x64
-            additionalRunArguments:
+            additionalRunArguments: --singleproc # --singleproc required to workaround issue #13599
           - Name: FabricLibX86Debug
             template: cpp-lib
             configuration: Debug
             platform: x86
-            additionalRunArguments:
+            additionalRunArguments: --singleproc # --singleproc required to workaround issue #13599
+            useNuGet: true
           - Name: FabricLibX86Release
             template: cpp-lib
             configuration: Release
             platform: x86
-            additionalRunArguments:
+            additionalRunArguments: --singleproc # --singleproc required to workaround issue #13599
+            useNuGet: true
           - Name: FabricLibArm64Debug
             template: cpp-lib
             configuration: Debug
             platform: ARM64
-            additionalRunArguments: --no-deploy
+            additionalRunArguments: --no-deploy --singleproc # --singleproc required to workaround issue #13599
+            useNuGet: true
           - Name: FabricLibArm64Release
             template: cpp-lib
             configuration: Release
             platform: ARM64
-            additionalRunArguments: --no-deploy
+            additionalRunArguments: --no-deploy --singleproc # --singleproc required to workaround issue #13599
+            useNuGet: true
           - Name: PaperX64ReleaseCpp
             template: old/uwp-cpp-app
             configuration: Release
@@ -274,9 +295,14 @@ jobs:
   - ${{ each config in parameters.buildMatrix }}:
     - ${{ if eq(config.BuildEnvironment, parameters.buildEnvironment) }}:
       - ${{ each matrix in config.Matrix }}:
+        - ${{ if eq(coalesce(matrix.useNuGet, false), parameters.buildNuGetOnly) }}:
           - job: CliInitWindows${{ matrix.Name }}
             displayName: Verify CliInitWindows ${{ matrix.Name }}
 
+            ${{ if eq(matrix.useNuGet, true) }}:
+              dependsOn:
+                - UniversalBuild${{ matrix.platform }}ReleaseFabric
+
             variables: [template: ../variables/windows.yml]
 
             ${{ if eq(matrix.lowResource, true) }}:
@@ -315,3 +341,4 @@ jobs:
                   runWack: ${{ coalesce(matrix.runWack, false) }}
                   buildEnvironment: ${{ parameters.buildEnvironment }}
                   useChakra: ${{ coalesce(matrix.useChakra, false) }}
+                  useNuGet: ${{ coalesce(matrix.useNuGet, false) }}
diff --git a/.ado/jobs/universal.yml b/.ado/jobs/universal.yml
@@ -30,14 +30,22 @@
               BuildConfiguration: Debug
               BuildPlatform: x64
               UseFabric: true
+            - Name: X64ReleaseFabric
+              BuildConfiguration: Release
+              BuildPlatform: x64
+              UseFabric: true
             - Name: X86ReleaseFabric # Specifically built so binskim / tests get run on fabric
               BuildConfiguration: Release
               BuildPlatform: x86
               UseFabric: true
+            - Name: Arm64ReleaseFabric
+              BuildConfiguration: Release
+              BuildPlatform: ARM64
+              UseFabric: true
         - BuildEnvironment: SecurePullRequest
           Matrix:
-            - Name: X64DebugFabric
-              BuildConfiguration: Debug
+            - Name: X64ReleaseFabric
+              BuildConfiguration: Release
               BuildPlatform: x64
               UseFabric: true
             - Name: X86ReleaseFabric # Specifically built so binskim / tests get run on fabric
@@ -75,10 +83,26 @@
               BuildConfiguration: Debug
               BuildPlatform: x64
               UseFabric: true
+            - Name: X64ReleaseFabric
+              BuildConfiguration: Release
+              BuildPlatform: x64
+              UseFabric: true
+            - Name: X86DebugFabric
+              BuildConfiguration: Debug
+              BuildPlatform: x86
+              UseFabric: true
             - Name: X86ReleaseFabric # Specifically built so binskim / tests get run on fabric
               BuildConfiguration: Release
               BuildPlatform: x86
               UseFabric: true
+            - Name: Arm64DebugFabric
+              BuildConfiguration: Debug
+              BuildPlatform: ARM64
+              UseFabric: true
+            - Name: Arm64ReleaseFabric
+              BuildConfiguration: Release
+              BuildPlatform: ARM64
+              UseFabric: true
 
   jobs:
     - ${{ each config in parameters.buildMatrix }}:
diff --git a/.ado/stages.yml b/.ado/stages.yml
@@ -34,6 +34,12 @@ stages:
         parameters:
           buildEnvironment: ${{ parameters.buildEnvironment }}
           AgentPool: ${{ parameters.AgentPool }}
+      
+      - template: jobs/cli-init-windows.yml
+        parameters:
+          buildEnvironment: ${{ parameters.buildEnvironment }}
+          AgentPool: ${{ parameters.AgentPool }}
+          buildNuGetOnly: true
 
   - stage: IntegrationTests
     displayName: Tests 🧪
@@ -79,3 +85,4 @@ stages:
         parameters:
           buildEnvironment: ${{ parameters.buildEnvironment }}
           AgentPool: ${{ parameters.AgentPool }}
+          buildNuGetOnly: false
diff --git a/.ado/templates/react-native-init-windows.yml b/.ado/templates/react-native-init-windows.yml
@@ -22,6 +22,9 @@ parameters:
   - name: useChakra
     type: boolean
     default: false
+  - name: useNuGet
+    type: boolean
+    default: false
   - name: runWack
     type: boolean
     default: false
@@ -41,6 +44,17 @@ steps:
     parameters:
       buildEnvironment: ${{ parameters.buildEnvironment }}
 
+  - ${{ if eq(parameters.useNuGet, true) }}:
+    - template: prep-and-pack-nuget.yml
+      parameters:
+        artifactName: ReactWindowsFabric
+        npmVersion: $(npmVersion)-Fabric
+        packMicrosoftReactNative: true
+        packMicrosoftReactNativeCxx: true
+        slices:
+          - platform: ${{ parameters.platform }}
+            configuration: Release
+
   - ${{ if endsWith(parameters.template, '-app') }}:
     - script: | # Change version of @react-native-community/template from 'nightly' to '$(reactNativeDevDependency)' - Windows #13446
         npx --yes @react-native-community/cli@next init testcli --template @react-native-community/template@nightly
@@ -171,6 +185,15 @@ steps:
       ${{ else }}:
         workingDirectory: $(Agent.BuildDirectory)\testcli
 
+  - ${{ if eq(parameters.useNuGet, true) }}:
+    - powershell: |
+        nuget.exe sources add -name TestFeed -source $(System.DefaultWorkingDirectory)\NugetTestFeed
+        nuget.exe sources remove -name react-native
+        nuget.exe sources remove -name Nuget.org
+        nuget.exe sources add -name Nuget.org -source https://api.nuget.org/v3/index.json
+      displayName: Add local NuGet test feed
+      workingDirectory: $(Agent.BuildDirectory)\testcli
+
   - template: ../templates/run-windows-with-certificates.yml
     parameters:
       buildEnvironment: ${{ parameters.BuildEnvironment }}
diff --git a/change/@react-native-windows-cli-bd214a76-535b-4214-aa8d-8e67b0d17c96.json b/change/@react-native-windows-cli-bd214a76-535b-4214-aa8d-8e67b0d17c96.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "Fix run-windows --singleproc to override high memory",
+  "packageName": "@react-native-windows/cli",
+  "email": "jthysell@microsoft.com",
+  "dependentChangeType": "patch"
+}
diff --git a/change/react-native-windows-ce719e54-ce74-4c70-a78a-f3c5a9576d73.json b/change/react-native-windows-ce719e54-ce74-4c70-a78a-f3c5a9576d73.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "Switch New Architecture templates to use prebuilt NuGets",
+  "packageName": "react-native-windows",
+  "email": "jthysell@microsoft.com",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/@react-native-windows/cli/src/utils/msbuildtools.ts b/packages/@react-native-windows/cli/src/utils/msbuildtools.ts
@@ -119,7 +119,7 @@ export default class MSBuildTools {
     // doesn't lead to dramatic performance gains (See #4739). Only enable
     // parallel builds on machines with >16GB of memory to avoid OOM errors
     const highMemory = totalmem() > 16 * 1024 * 1024 * 1024;
-    const enableParallelBuilds = singleproc === false || highMemory;
+    const enableParallelBuilds = singleproc !== true && highMemory;
 
     if (enableParallelBuilds) {
       args.push('/maxCpuCount');
diff --git a/vnext/PropertySheets/External/Microsoft.ReactNative.Composition.Package.props b/vnext/PropertySheets/External/Microsoft.ReactNative.Composition.Package.props
@@ -11,4 +11,5 @@
   <Import Project="$(MSBuildThisFileDirectory)Microsoft.ReactNative.Common.props" />
    <!-- Fixes NuGet restore issues: -->
   <Import Project="$(ReactNativeWindowsDir)\PropertySheets\NuGet.CSharp.props" />
+  <Import Project="$(ReactNativeWindowsDir)\PropertySheets\WinUI.props" />
 </Project>
diff --git a/vnext/PropertySheets/External/Microsoft.ReactNative.Composition.Package.targets b/vnext/PropertySheets/External/Microsoft.ReactNative.Composition.Package.targets
@@ -14,5 +14,9 @@
     <!-- Needed for ucrtbased.dll when running a debug build. -->
     <SDKReference Include="Microsoft.VCLibs, Version=14.0" Condition="'$(Configuration)' == 'Debug'" />
   </ItemGroup>
+
+  <ItemGroup Condition="'$(UseExperimentalNuget)' == 'true'">
+    <PackageReference Include="$(WinUIPackageName)" Version="$(WinUIPackageVersion)" Condition="'$(OverrideWinUIPackage)'!='true'" />
+  </ItemGroup>
   
 </Project>
diff --git a/vnext/PropertySheets/External/Microsoft.ReactNative.Cpp.PackageReferences.props b/vnext/PropertySheets/External/Microsoft.ReactNative.Cpp.PackageReferences.props
@@ -5,8 +5,18 @@
 -->
 <Project xmlns="https://schemas.microsoft.com/developer/msbuild/2003">
   <!-- Only include Microsoft.ReactNative.* NuGet packages that C++ (app and lib) projects need when using UseExperimentalNuget. -->
-  <ItemGroup>
-    <PackageReference Include="Microsoft.ReactNative" Version="$(ReactNativeWindowsVersion)" />
-    <PackageReference Include="Microsoft.ReactNative.Cxx" Version="$(ReactNativeWindowsVersion)" />
-  </ItemGroup>
+  <Choose>
+    <When Condition="'$(UseFabric)' == 'true'">
+      <ItemGroup>
+        <PackageReference Include="Microsoft.ReactNative" Version="$(ReactNativeWindowsVersion)-Fabric" />
+        <PackageReference Include="Microsoft.ReactNative.Cxx" Version="$(ReactNativeWindowsVersion)-Fabric" />
+      </ItemGroup>
+    </When>
+    <Otherwise>
+       <ItemGroup>
+        <PackageReference Include="Microsoft.ReactNative" Version="$(ReactNativeWindowsVersion)" />
+        <PackageReference Include="Microsoft.ReactNative.Cxx" Version="$(ReactNativeWindowsVersion)" />
+      </ItemGroup>
+    </Otherwise>
+  </Choose>
 </Project>
diff --git a/vnext/Scripts/Microsoft.ReactNative.VersionCheck.targets b/vnext/Scripts/Microsoft.ReactNative.VersionCheck.targets
@@ -66,6 +66,8 @@
 
     <PropertyGroup>
       <_ReactNativeWindowsVersionCheckNugetVersion>$$nuGetPackageVersion$$</_ReactNativeWindowsVersionCheckNugetVersion>
+      <!-- Strip out the -Fabric qualifier from the version string if present -->
+      <_ReactNativeWindowsVersionCheckNugetVersion>$(_ReactNativeWindowsVersionCheckNugetVersion.Replace('-Fabric', ''))</_ReactNativeWindowsVersionCheckNugetVersion>
     </PropertyGroup>
    
     <!-- Validate package.json file -->
diff --git a/vnext/templates/cpp-app/NuGet_Config b/vnext/templates/cpp-app/NuGet_Config
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageSources>
+    <clear />
+{{#addReactNativePublicAdoFeed}}
+    <add key="react-native" value="https://pkgs.dev.azure.com/ms/react-native/_packaging/react-native-public/nuget/v3/index.json" />
+{{/addReactNativePublicAdoFeed}}
+    <add key="Nuget.org" value="https://api.nuget.org/v3/index.json" />
+  </packageSources>
+  <disabledPackageSources>
+    <clear />
+  </disabledPackageSources>  
+</configuration>
diff --git a/vnext/templates/cpp-app/template.config.js b/vnext/templates/cpp-app/template.config.js
@@ -21,7 +21,7 @@ async function preInstall(config = {}, options = {}) {}
 
 async function getFileMappings(config = {}, options = {}) {
   const projectRoot = config?.root ?? process.cwd();
-  const {rnwPath, rnwVersion, devMode} = templateUtils.getRnwInfo(config, options);
+  const {rnwPath, rnwVersion, devMode, isCanary} = templateUtils.getRnwInfo(config, options);
 
   const projectName =
     config?.project?.windows?.project?.projectName ?? options?.name ?? 'MyApp';
@@ -66,6 +66,9 @@ async function getFileMappings(config = {}, options = {}) {
 
     devMode,
 
+    useNuGets: !devMode, // default is to use published NuGets except in devMode, change to true here if you want to test devMode and nugets simultaneously
+    addReactNativePublicAdoFeed: isCanary,
+
     cppNugetPackages,
   };
 
diff --git a/vnext/templates/cpp-app/windows/ExperimentalFeatures.props b/vnext/templates/cpp-app/windows/ExperimentalFeatures.props
@@ -4,6 +4,7 @@
   <PropertyGroup Label="Microsoft.ReactNative Experimental Features">
     <UseFabric>true</UseFabric>
     <UseWinUI3>true</UseWinUI3>
+    <UseExperimentalNuget>{{useNuGets}}</UseExperimentalNuget>
 
     <ReactExperimentalFeaturesSet>true</ReactExperimentalFeaturesSet>
   </PropertyGroup>
diff --git a/vnext/templates/cpp-app/windows/MyApp.sln b/vnext/templates/cpp-app/windows/MyApp.sln
diff --git a/vnext/templates/cpp-lib/NuGet_Config b/vnext/templates/cpp-lib/NuGet_Config
diff --git a/vnext/templates/cpp-lib/example/NuGet_Config b/vnext/templates/cpp-lib/example/NuGet_Config
diff --git a/vnext/templates/cpp-lib/template.config.js b/vnext/templates/cpp-lib/template.config.js
diff --git a/vnext/templates/cpp-lib/windows/ExperimentalFeatures.props b/vnext/templates/cpp-lib/windows/ExperimentalFeatures.props
diff --git a/vnext/templates/cpp-lib/windows/MyLib.sln b/vnext/templates/cpp-lib/windows/MyLib.sln
diff --git a/vnext/templates/templateUtils.js b/vnext/templates/templateUtils.js
