Skip to content

[Settings] Eliminate XamlIndexBuilder parallel build race #50347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Yu Leng (moooyo) wants to merge 1 commit into
base: main
Choose a base branch
from
+70 −36
Draft

[Settings] Eliminate XamlIndexBuilder parallel build race #50347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 6 additions & 17 deletions src/settings-ui/Settings.UI.XamlIndexBuilder/Settings.UI.XamlIndexBuilder.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,12 @@
<SelfContained>false</SelfContained>
<UseAppHost>false</UseAppHost>
<PlatformTarget>AnyCPU</PlatformTarget>
<IsRidAgnostic>true</IsRidAgnostic>
<ShouldBeValidatedAsExecutableReference>false</ShouldBeValidatedAsExecutableReference>
<RuntimeIdentifier></RuntimeIdentifier>
<!-- Keep tool output out of product scan paths to avoid deps.json audit conflicts -->
<OutputPath>$(MSBuildProjectDirectory)\obj\XamlIndexBuilder\$(Configuration)\</OutputPath>
<RuntimeIdentifiers></RuntimeIdentifiers>
<!-- Keep tool output out of product scan paths and isolate parallel platform builds. -->
<OutputPath>$(MSBuildProjectDirectory)\obj\XamlIndexBuilder\$(Platform)\$(Configuration)\</OutputPath>
</PropertyGroup>

<!-- Remove CsWinRT package introduced by common props; not needed for this tool and causes Windows metadata errors -->
Expand All @@ -25,18 +28,4 @@
<PackageReference Include="System.CommandLine" />
</ItemGroup>

<!-- Remove UI library reference to avoid pulling WindowsDesktop runtime (WindowsBase) -->

<PropertyGroup>
<DotNetExe Condition="'$(DotNetExe)' == ''">dotnet</DotNetExe>
<XamlRootDir Condition="'$(XamlRootDir)' == ''">$(MSBuildProjectDirectory)\..\Settings.UI\SettingsXAML</XamlRootDir>
<XamlRootDir Condition="'$(XamlViewsDir)' != ''">$([System.IO.Path]::GetDirectoryName('$(XamlViewsDir)'))</XamlRootDir>
<GeneratedJsonFile Condition="'$(GeneratedJsonFile)' == ''">$(MSBuildProjectDirectory)\..\Settings.UI\Assets\Settings\search.index.json</GeneratedJsonFile>
</PropertyGroup>
<Target Name="GenerateSearchIndexSelf" AfterTargets="Build">
<RemoveDir Directories="$(MSBuildProjectDirectory)\obj\ARM64;$(MSBuildProjectDirectory)\obj\x64;$(MSBuildProjectDirectory)\bin" />
<MakeDir Directories="$([System.IO.Path]::GetDirectoryName('$(GeneratedJsonFile)'))" />
<Message Importance="high" Text="[XamlIndexBuilder] Generating search index. Root='$(XamlRootDir)'; Out='$(GeneratedJsonFile)'; Tool='$(TargetPath)'; DotNet='$(DotNetExe)'." />
<Exec Command="&quot;$(DotNetExe)&quot; &quot;$(TargetPath)&quot; &quot;$(XamlRootDir)&quot; &quot;$(GeneratedJsonFile)&quot;" />
</Target>
</Project>
</Project>
83 changes: 64 additions & 19 deletions src/settings-ui/Settings.UI/PowerToys.Settings.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,14 +129,42 @@
<ProjectReference Include="..\..\modules\powerdisplay\PowerDisplay.Models\PowerDisplay.Models.csproj" />
<ProjectReference Include="..\Settings.UI.Library\Settings.UI.Library.csproj" />
<ProjectReference Include="..\Settings.UI.Controls\Settings.UI.Controls.csproj" />
<!-- Build the tool through the project graph, but do not reference it from Settings. -->
<ProjectReference Include="..\Settings.UI.XamlIndexBuilder\Settings.UI.XamlIndexBuilder.csproj">
<ReferenceOutputAssembly>false</ReferenceOutputAssembly>
<ExcludeAssets>all</ExcludeAssets>
<Private>false</Private>
<OutputItemType>_XamlIndexBuilderOutput</OutputItemType>
</ProjectReference>
</ItemGroup>

<!-- XamlIndexBuilder now outputs directly to Assets\Settings -->
<PropertyGroup>
<GeneratedJsonFile>$(MSBuildProjectDirectory)\Assets\Settings\search.index.json</GeneratedJsonFile>
<GeneratedJsonFile>$(MSBuildProjectDirectory)\obj\$(Platform)\$(Configuration)\SettingsSearchIndex\search.index.json</GeneratedJsonFile>
<SettingsSearchIndexInputsFile>$(MSBuildProjectDirectory)\obj\$(Platform)\$(Configuration)\SettingsSearchIndex\inputs.txt</SettingsSearchIndexInputsFile>
<XamlIndexBuilderDotNetExe Condition="'$(XamlIndexBuilderDotNetExe)' == '' and '$(DotNetHostPath)' != ''">$(DotNetHostPath)</XamlIndexBuilderDotNetExe>
<XamlIndexBuilderDotNetExe Condition="'$(XamlIndexBuilderDotNetExe)' == ''">dotnet</XamlIndexBuilderDotNetExe>
</PropertyGroup>

<!-- No RID/Platform plumbing needed here. XamlIndexBuilder handles generation after its own Build. -->
<ItemGroup>
<!-- Keep Visual Studio's fast up-to-date check aware of this generated output and all of its inputs. -->
<_SettingsSearchIndexInput Include="SettingsXAML\**\*.xaml" />
<_XamlIndexBuilderInput Include="..\Settings.UI.XamlIndexBuilder\*.cs;..\Settings.UI.XamlIndexBuilder\Settings.UI.XamlIndexBuilder.csproj" />
<UpToDateCheckInput Include="@(_SettingsSearchIndexInput);@(_XamlIndexBuilderInput);..\Settings.UI.XamlIndexBuilder" Set="SettingsSearchIndex" />
<UpToDateCheckInput Include="$(GeneratedJsonFile)" />
<UpToDateCheckOutput Include="$(GeneratedJsonFile)" Set="SettingsSearchIndex" />
<Content Include="$(GeneratedJsonFile)">
<Link>Assets\Settings\search.index.json</Link>
<TargetPath>Assets\Settings\search.index.json</TargetPath>
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
<Visible>false</Visible>
</Content>
</ItemGroup>

<ItemGroup Condition="'$(DesignTimeBuild)' != 'true'">
<EmbeddedResource Include="$(GeneratedJsonFile)">
<LogicalName>Microsoft.PowerToys.Settings.UI.Assets.search.index.json</LogicalName>
</EmbeddedResource>
</ItemGroup>

<PropertyGroup>
<!-- TODO: fix issues and reenable -->
Expand All @@ -145,19 +173,6 @@
<NoWarn>VSTHRD002;VSTHRD110;VSTHRD100;VSTHRD200;VSTHRD101</NoWarn>
</PropertyGroup>

<!-- Removed hard-coded resource exclusion. -->

<ItemGroup>
<!-- Ensure the generated search index is present in the project; only if it exists to prevent CS1566 in clean CI -->
<Content Include="$(GeneratedJsonFile)" Condition="Exists('$(GeneratedJsonFile)')">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
</Content>
<!-- Embed the generated search index; logical name must match PrebuiltIndexResourceName -->
<EmbeddedResource Include="$(GeneratedJsonFile)" Condition="Exists('$(GeneratedJsonFile)')">
<LogicalName>Microsoft.PowerToys.Settings.UI.Assets.search.index.json</LogicalName>
</EmbeddedResource>
</ItemGroup>

<ItemGroup>
<None Update="Assets\Settings\icon.ico">
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
Expand Down Expand Up @@ -212,8 +227,38 @@
</Page>
</ItemGroup>

<Target Name="BuildXamlIndexBeforeSettings" BeforeTargets="CoreCompile" Condition="'$(DesignTimeBuild)' != 'true'">
<Message Importance="high" Text="[Settings] Building XamlIndexBuilder prior to compile. Views='$(MSBuildProjectDirectory)\SettingsXAML\Views' Out='$(GeneratedJsonFile)'" />
<MSBuild Projects="..\Settings.UI.XamlIndexBuilder\Settings.UI.XamlIndexBuilder.csproj" Targets="Build" Properties="Configuration=$(Configuration);Platform=Any CPU;TargetFramework=$(CoreTargetFramework);XamlViewsDir=$(MSBuildProjectDirectory)\SettingsXAML\Views;GeneratedJsonFile=$(GeneratedJsonFile)" />
<Target Name="WriteSettingsSearchIndexInputs" Condition="'$(DesignTimeBuild)' != 'true' and '$(BuildingProject)' == 'true'">
<MakeDir Directories="$([System.IO.Path]::GetDirectoryName('$(SettingsSearchIndexInputsFile)'))" />
<WriteLinesToFile
File="$(SettingsSearchIndexInputsFile)"
Lines="@(_SettingsSearchIndexInput-&gt;'%(FullPath)');@(_XamlIndexBuilderInput-&gt;'%(FullPath)')"
Overwrite="true"
WriteOnlyWhenDifferent="true" />
<ItemGroup>
<FileWrites Include="$(SettingsSearchIndexInputsFile)" />
</ItemGroup>
</Target>

<Target
Name="GenerateSettingsSearchIndex"
DependsOnTargets="ResolveProjectReferences;WriteSettingsSearchIndexInputs"
Inputs="@(_SettingsSearchIndexInput-&gt;'%(FullPath)');@(_XamlIndexBuilderInput-&gt;'%(FullPath)');@(_XamlIndexBuilderOutput-&gt;'%(FullPath)');$(SettingsSearchIndexInputsFile)"
Outputs="$(GeneratedJsonFile)"
Condition="'$(DesignTimeBuild)' != 'true' and '$(BuildingProject)' == 'true'">
<Error Condition="'@(_XamlIndexBuilderOutput)' == ''" Text="Unable to resolve the XamlIndexBuilder output." />
<MakeDir Directories="$([System.IO.Path]::GetDirectoryName('$(GeneratedJsonFile)'))" />
<Message Importance="high" Text="[Settings] Generating search index. Root='$(MSBuildProjectDirectory)\SettingsXAML'; Out='$(GeneratedJsonFile)'; Tool='@(_XamlIndexBuilderOutput)'" />
<Exec Command="&quot;$(XamlIndexBuilderDotNetExe)&quot; &quot;@(_XamlIndexBuilderOutput-&gt;'%(FullPath)')&quot; &quot;$(MSBuildProjectDirectory)\SettingsXAML&quot; &quot;$(GeneratedJsonFile)&quot;" />
</Target>

<Target
Name="PrepareSettingsSearchIndex"
BeforeTargets="AssignTargetPaths"
DependsOnTargets="GenerateSettingsSearchIndex"
Condition="'$(DesignTimeBuild)' != 'true' and '$(BuildingProject)' == 'true'">
<Error Condition="!Exists('$(GeneratedJsonFile)')" Text="Settings search index generation did not produce '$(GeneratedJsonFile)'." />
<ItemGroup>
<FileWrites Include="$(GeneratedJsonFile)" />
</ItemGroup>
</Target>
</Project>