Add output DebugSymbolsFiles to ResolvePackageAssets

This property contains the list of files related to debug symbols, and xml per asset.

Author: ocalles

src/Tasks/Common/MetadataKeys.cs

@@ -131,5 +131,12 @@ internal static class MetadataKeys
         public const string IsVersion5 = "IsVersion5";
         public const string CreateCompositeImage = "CreateCompositeImage";
         public const string PerfmapFormatVersion = "PerfmapFormatVersion";
+
+        // Debug symbols
+        public const string Related = "related";
+        public const string Xml = ".xml";
+        public const string XmlPath = "XmlPath";
+        public const string Pdb = ".pdb";
+        public const string PdbPath = "PdbPath";
     }
 }

src/Tasks/Microsoft.NET.Build.Tasks/PackageAssetCacheFileFormat.txt

@@ -0,0 +1,43 @@
+        ////////////////////////////////////////////////////////////////////////////////////////////////////
+        // Package Asset Cache File Format Details
+        //
+        // Encodings of Int32, Byte[], String as defined by System.IO.BinaryReader/Writer.
+        //
+        // There are 3 sections, written in the following order:
+        //
+        // 1. Header
+        // ---------
+        // Encodes format and enough information to quickly decide if cache is still valid.
+        //
+        // Header:
+        //   Int32 Signature: Spells PKGA ("package assets") when 4 little-endian bytes are interpreted as ASCII chars.
+        //   Int32 Version: Increased whenever format changes to prevent issues when building incrementally with a different SDK.
+        //   Byte[] SettingsHash: SHA-256 of settings that require the cache to be invalidated when changed.
+        //   Int32 MetadataStringTableOffset: Byte offset in file to start of the metadata string table.
+        //
+        // 2. ItemGroup[] ItemGroups
+        // --------------
+        // There is one ItemGroup for each ITaskItem[] output (Analyzers, CompileTimeAssemblies, etc.)
+        // Count and order of item groups is constant and therefore not encoded in to the file.
+        //
+        // ItemGroup:
+        //   Int32   ItemCount
+        //   Item[]  Items
+        //
+        // Item:
+        //    String      ItemSpec (not index to string table because it generally unique)
+        //    Int32       MetadataCount
+        //    Metadata[]  Metadata
+        //
+        // Metadata:
+        //    Int32 Key: Index in to MetadataStringTable for metadata key
+        //    Int32 Value: Index in to MetadataStringTable for metadata value
+        //
+        // 3. MetadataStringTable
+        // ----------------------
+        // Indexes keys and values of item metadata to compress the cache file
+        //
+        // MetadataStringTable:
+        //    Int32 MetadataStringCount
+        //    String[] MetadataStrings
+        ////////////////////////////////////////////////////////////////////////////////////////////////////

src/Tasks/Microsoft.NET.Build.Tasks/ResolvePackageAssets.cs

@@ -231,6 +231,15 @@ public sealed class ResolvePackageAssets : TaskBase
         [Output]
         public ITaskItem[] PackageDependencies { get; private set; }
 
+        /// <summary>
+        /// List of file symbols pdb and xml related to NuGet packages
+        /// </summary>
+        /// <remarks>
+        /// This is the list of files to be copied to the output directory
+        /// </remarks>
+        [Output]
+        public ITaskItem[] DebugSymbolsFiles { get; private set;}
+
         /// <summary>
         /// Messages from the assets file.
         /// These are logged directly and therefore not returned to the targets (note private here).
@@ -311,6 +320,7 @@ private void ReadItemGroups()
                 ApphostsForShimRuntimeIdentifiers = reader.ReadItemGroup();
                 CompileTimeAssemblies = reader.ReadItemGroup();
                 ContentFilesToPreprocess = reader.ReadItemGroup();
+                DebugSymbolsFiles = reader.ReadItemGroup();
                 FrameworkAssemblies = reader.ReadItemGroup();
                 FrameworkReferences = reader.ReadItemGroup();
                 NativeLibraries = reader.ReadItemGroup();
@@ -510,7 +520,7 @@ private static BinaryReader CreateReaderFromDisk(ResolvePackageAssets task, byte
                 BinaryReader reader = null;
                 try
                 {
-                    if (File.GetLastWriteTimeUtc(task.ProjectAssetsCacheFile) > File.GetLastWriteTimeUtc(task.ProjectAssetsFile))
+                    if (IsCacheFileNewerThanAssetsFile())
                     {
                         reader = OpenCacheFile(task.ProjectAssetsCacheFile, settingsHash);
                     }
@@ -537,6 +547,8 @@ private static BinaryReader CreateReaderFromDisk(ResolvePackageAssets task, byte
                 }
 
                 return reader;
+
+                bool IsCacheFileNewerThanAssetsFile() => File.GetLastWriteTimeUtc(task.ProjectAssetsCacheFile) > File.GetLastWriteTimeUtc(task.ProjectAssetsFile);
             }
 
             private static BinaryReader OpenCacheStream(Stream stream, byte[] settingsHash)
@@ -776,6 +788,7 @@ private void WriteItemGroups()
                 WriteItemGroup(WriteApphostsForShimRuntimeIdentifiers);
                 WriteItemGroup(WriteCompileTimeAssemblies);
                 WriteItemGroup(WriteContentFilesToPreprocess);
+                WriteItemGroup(WriteDebugSymbolsFiles);
                 WriteItemGroup(WriteFrameworkAssemblies);
                 WriteItemGroup(WriteFrameworkReferences);
                 WriteItemGroup(WriteNativeLibraries);
@@ -1091,6 +1104,27 @@ private void WriteContentFilesToPreprocess()
                     });
             }
 
+            private void WriteDebugSymbolsFiles()
+            {
+                WriteItems(
+                    _runtimeTarget,
+                    package => package.RuntimeAssemblies,
+                    filter: asset => asset.Properties.ContainsKey(MetadataKeys.Related),
+                    writeMetadata: (package, asset) =>
+                    {
+                        asset.Properties.TryGetValue(MetadataKeys.Related, out string propertyValue);
+                        if (string.Compare(propertyValue, MetadataKeys.Pdb, true) == 0)
+                        {
+                            WriteMetadata(MetadataKeys.PdbPath, Path.ChangeExtension(asset.Path, ".pdb"));
+                        }
+
+                        if (string.Compare(propertyValue, MetadataKeys.Xml, true) == 0)
+                        {
+                            WriteMetadata(MetadataKeys.XmlPath, Path.ChangeExtension(asset.Path, ".xml"));
+                        }
+                    });
+            }
+
             private void WriteFrameworkAssemblies()
             {
                 if (_task.DisableFrameworkAssemblies)