From 1f2a4a110e356808d721358ce358de4f88923795 Mon Sep 17 00:00:00 2001
From: Swaroop Sridhar <Swaroop.Sridhar@microsoft.com>
Date: Tue, 3 Mar 2020 09:02:58 -0800
Subject: [PATCH] Adjust ordering of Single-file publish targets (#10740)

* Adjust ordering of Single-file publish targets

This change reorders certain publish targets in preparation for upcoming changes to single-file publish support in .net 5.

The behavior of `dotnet publish /p:PublishSingleFile=true` is different in .net 5, compared to .net core 3, as explained in [this document](https://github.com/dotnet/designs/blob/master/accepted/single-file/design.md#build-system-interface).
In some cases, the single-file bundler in HostModel library will leave certain types of files unbundled into the single-file app.
These files need to be copied into the publish directory.

Currently, the Single-file bundle generator after the copy step, which places files in the publish directory.
However, this model is unsuitable in .net 5, because the files to be copied will only be determined after bundle-generation.

Therefore, the `BundlePublishDirectory` targets now run before the copy step, along with the `ILLink` and `ReadyToRun` targets.
In an upcoming change, the `GenerateBundle` task will generate outputs to trim `ResolvedFileToPublish` based on the `PublishSingleFile` settings.

This change actually simplified a few other targets.
---
 .../targets/Microsoft.NET.Publish.targets     | 64 +++++++------------
 1 file changed, 23 insertions(+), 41 deletions(-)

diff --git a/src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Publish.targets b/src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Publish.targets
index 141da1718ac9..07e79a8cafb8 100644
--- a/src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Publish.targets
+++ b/src/Tasks/Microsoft.NET.Build.Tasks/targets/Microsoft.NET.Publish.targets
@@ -47,8 +47,6 @@ Copyright (c) .NET Foundation. All rights reserved.
     <_CorePublishTargets>
       PrepareForPublish;
       ComputeAndCopyFilesToPublishDirectory;
-      GeneratePublishDependencyFile;
-      BundlePublishDirectory;
     </_CorePublishTargets>
 
     <_PublishNoBuildAlternativeDependsOn>$(_BeforePublishNoBuildTargets);$(_CorePublishTargets)</_PublishNoBuildAlternativeDependsOn>
@@ -194,11 +192,8 @@ Copyright (c) .NET Foundation. All rights reserved.
     </RemoveDuplicates>
 
     <ItemGroup>
-      <_CurrentPublishFileWritesUnfiltered Include="@(ResolvedFileToPublish->'$(_NormalizedPublishDir)%(RelativePath)')" Condition="'$(PublishSingleFile)' != 'true'"/>
-      <_CurrentPublishFileWritesUnfiltered Include="@(ResolvedFileToPublish->'$(_NormalizedPublishDir)%(RelativePath)')" 
-                                           Condition="'$(PublishSingleFile)' == 'true' And '%(ResolvedFileToPublish.ExcludeFromSingleFile)' == 'true'"/>
+      <_CurrentPublishFileWritesUnfiltered Include="@(ResolvedFileToPublish->'$(_NormalizedPublishDir)%(RelativePath)')"/>
       <_CurrentPublishFileWritesUnfiltered Include="$(_NormalizedPublishDir)$(AssemblyName)$(_NativeExecutableExtension)" Condition="'$(UseAppHost)' == 'true'"/>
-      <_CurrentPublishFileWritesUnfiltered Include="$(_NormalizedPublishDir)$(ProjectDepsFileName)" Condition="'$(GenerateDependencyFile)' == 'true' And '$(PublishSingleFile)' != 'true'"/>
     </ItemGroup>
 
     <ConvertToAbsolutePath Paths="@(_CurrentPublishFileWritesUnfiltered)">
@@ -216,7 +211,6 @@ Copyright (c) .NET Foundation. All rights reserved.
                                         _CopyResolvedFilesToPublishPreserveNewest
 
     Copy _ResolvedFileToPublishPreserveNewest items to the publish directory 
-    (except files that will be bundled, during PublishSingleFile).
     ============================================================
     -->
   <Target Name="_CopyResolvedFilesToPublishPreserveNewest"
@@ -224,20 +218,13 @@ Copyright (c) .NET Foundation. All rights reserved.
           Inputs="@(_ResolvedFileToPublishPreserveNewest)"
           Outputs="@(_ResolvedFileToPublishPreserveNewest->'$(PublishDir)%(RelativePath)')">
 
-    <ItemGroup>
-      <_ResolvedUnbundledFileToPublishPreserveNewest 
-                    Include="@(_ResolvedFileToPublishPreserveNewest)" 
-                    Condition="'$(PublishSingleFile)' != 'true' or 
-                               '%(_ResolvedFileToPublishPreserveNewest.ExcludeFromSingleFile)'=='true'" />
-    </ItemGroup>
-
     <!--
       PreserveNewest means that we will only copy the source to the destination if the source is newer.
       SkipUnchangedFiles is not used for that purpose because it will copy if the source and destination
       differ by size too.  Instead, this target uses inputs and outputs to only copy when the source is newer.
       -->
-    <Copy SourceFiles = "@(_ResolvedUnbundledFileToPublishPreserveNewest)"
-          DestinationFiles="@(_ResolvedUnbundledFileToPublishPreserveNewest->'$(PublishDir)%(RelativePath)')"
+    <Copy SourceFiles = "@(_ResolvedFileToPublishPreserveNewest)"
+          DestinationFiles="@(_ResolvedFileToPublishPreserveNewest->'$(PublishDir)%(RelativePath)')"
           OverwriteReadOnlyFiles="$(OverwriteReadOnlyFiles)"
           Retries="$(CopyRetryCount)"
           RetryDelayMilliseconds="$(CopyRetryDelayMilliseconds)"
@@ -255,26 +242,18 @@ Copyright (c) .NET Foundation. All rights reserved.
                                         _CopyResolvedFilesToPublishAlways
 
     Copy _ResolvedFileToPublishAlways items to the publish directory
-    (except files that will be bundled, during PublishSingleFile).    
     ============================================================
     -->
   <Target Name="_CopyResolvedFilesToPublishAlways"
           DependsOnTargets="_ComputeResolvedFilesToPublishTypes">
 
-    <ItemGroup>
-      <_ResolvedUnbundledFileToPublishAlways
-                    Include="@(_ResolvedFileToPublishAlways)"
-                    Condition="'$(PublishSingleFile)' != 'true' or 
-                               '%(_ResolvedFileToPublishAlways.ExcludeFromSingleFile)'=='true'" />
-    </ItemGroup>
-
     <!--
       Use SkipUnchangedFiles to prevent unnecessary file copies. The copy will occur if the
       destination doesn't exist, the source is newer than the destination, or if the source and
       destination differ by file size.
       -->
-    <Copy SourceFiles = "@(_ResolvedUnbundledFileToPublishAlways)"
-          DestinationFiles="@(_ResolvedUnbundledFileToPublishAlways->'$(PublishDir)%(RelativePath)')"
+    <Copy SourceFiles = "@(_ResolvedFileToPublishAlways)"
+          DestinationFiles="@(_ResolvedFileToPublishAlways->'$(PublishDir)%(RelativePath)')"
           SkipUnchangedFiles="$(SkipCopyUnchangedFiles)"
           OverwriteReadOnlyFiles="$(OverwriteReadOnlyFiles)"
           Retries="$(CopyRetryCount)"
@@ -475,7 +454,9 @@ Copyright (c) .NET Foundation. All rights reserved.
   <Target Name="ComputeFilesToPublish"
           DependsOnTargets="ComputeResolvedFilesToPublishList;
                             ILLink;
-                            CreateReadyToRunImages">
+                            CreateReadyToRunImages;
+                            GeneratePublishDependencyFile;
+                            GenerateSingleFileBundle">
   </Target>
 
   <PropertyGroup>
@@ -942,26 +923,23 @@ Copyright (c) .NET Foundation. All rights reserved.
 
   <!--
     ============================================================
-                                        BundlePublishDirectory
+                                        GenerateSingleFileBundle
 
-    Bundle the _ResolvedFileToPublish* items one file in PublishDir
-    (except those marked ExcludeFromSingleFile)
+    Bundle the ResolvedFileToPublish items into one file in PublishDir
+    (except those marked ExcludeFromSingleFile) 
     ============================================================
     -->
   <Target Name="_ComputeFilesToBundle"
         Condition="'$(PublishSingleFile)' == 'true'">
 
     <ItemGroup>
-      <_FilesToBundle Include="@(_ResolvedFileToPublishPreserveNewest)" 
-                      Condition="'%(_ResolvedFileToPublishPreserveNewest.ExcludeFromSingleFile)' != 'true'"/>
-      <_FilesToBundle Include="@(_ResolvedFileToPublishAlways)" 
-                      Condition="'%(_ResolvedFileToPublishAlways.ExcludeFromSingleFile)' != 'true'"/>
+      <_FilesToBundle Include="@(ResolvedFileToPublish)" Condition="'%(ResolvedFileToPublish.ExcludeFromSingleFile)' != 'true'"/>
     </ItemGroup>
 
   </Target>
 
   <UsingTask TaskName="GenerateBundle" AssemblyFile="$(MicrosoftNETBuildTasksAssembly)" />
-  <Target Name="BundlePublishDirectory" 
+  <Target Name="GenerateSingleFileBundle" 
           Condition="'$(PublishSingleFile)' == 'true'"
           DependsOnTargets="_ComputeFilesToBundle" 
           Inputs="@(_FilesToBundle)"
@@ -972,7 +950,13 @@ Copyright (c) .NET Foundation. All rights reserved.
                     IncludeSymbols="$(IncludeSymbolsInSingleFile)"
                     OutputDir="$(PublishDir)"
                     ShowDiagnosticOutput="false"/>
-    
+
+    <ItemGroup>
+      <ResolvedFileToPublish Remove="@(_FilesToBundle)"/>
+      <!-- ResolvedFileToPublish shouldn't include the output; the single-file bundle is written directly to the publish directory -->
+    </ItemGroup>
+
+
   </Target>
 
   <!--
@@ -993,10 +977,8 @@ Copyright (c) .NET Foundation. All rights reserved.
           Condition="'$(GenerateDependencyFile)' == 'true' and '$(_UseBuildDependencyFile)' != 'true'">
 
     <PropertyGroup>
-      <PublishDepsFilePath Condition=" '$(PublishDepsFilePath)' == '' And '$(PublishSingleFile)' != 'true'">$(PublishDir)$(ProjectDepsFileName)</PublishDepsFilePath>
-      <PublishDepsFilePath Condition=" '$(PublishDepsFilePath)' == '' And '$(PublishSingleFile)' == 'true'">$(IntermediateOutputPath)$(ProjectDepsFileName)</PublishDepsFilePath>
+      <PublishDepsFilePath Condition=" '$(PublishDepsFilePath)' == ''">$(IntermediateOutputPath)$(ProjectDepsFileName)</PublishDepsFilePath>
     </PropertyGroup>
-
     <ItemGroup>
       <ResolvedCompileFileDefinitions Remove="@(_PublishConflictPackageFiles)" Condition="'%(_PublishConflictPackageFiles.ConflictItemType)' == 'Reference'" />
       <RuntimeTargetsCopyLocalItems Remove="@(_PublishConflictPackageFiles)" Condition="'%(_PublishConflictPackageFiles.ConflictItemType)' != 'Reference'" />
@@ -1036,9 +1018,9 @@ Copyright (c) .NET Foundation. All rights reserved.
                       RuntimeGraphPath="$(BundledRuntimeIdentifierGraphFile)"/>
 
     <ItemGroup>
-      <_FilesToBundle Include="$(PublishDepsFilePath)" Condition="'$(PublishSingleFile)' == 'true'">
+      <ResolvedFileToPublish Include="$(PublishDepsFilePath)">
         <RelativePath>$(ProjectDepsFileName)</RelativePath>
-      </_FilesToBundle>
+      </ResolvedFileToPublish>
     </ItemGroup>
     
   </Target>