New project system doesn't copy PDBs from packages

[davkean]

From @bording on July 27, 2017 3:12

When a NuGet package includes PDBs in its lib folder, the legacy project system copies the PDB as well as the assembly into the build output folder.

The new project system only copies the assembly.

We've recently added source link support , and when using the new project system with a .NET Core target, everything works fine since the PDB is referenced correctly from the global NuGet package folder.

However, because the PDB isn't copied for a .NET Framework target, we don't get any of the benefit of our sourcelinked PDB.

It would be great if the new project system would behave like the legacy project system in this case, and also copy the PDB into the project's build output folder.

Copied from original issue: dotnet/project-system#2667

EDIT: We are also using this issue to track copying XML files

[wli3]

https://github.com/Microsoft/msbuild/blob/master/src/Tasks/AssemblyDependency/ResolveAssemblyReference.cs#L75 the old code

[wli3]

wli3@0fefc41
an end to end repo/test for this bug

[wli3]

sdk/src/Tasks/Microsoft.NET.Build.Tasks/build/Microsoft.PackageDependencyResolution.targets

Line 501 in 98ea6b2

<Target Name="_ComputeLockFileCopyLocal"

decide what to copy local, there should be a FileGroup called something like "DebugSymbol". However, FileGroup are from NuGet

https://github.com/NuGet/NuGet.Client/blob/efae789c75899ca0bdd063f34a4b73cd41510d56/src/NuGet.Core/NuGet.ProjectModel/LockFile/LockFileTargetLibrary.cs#L27

We need NugGet.ProjectModel to tell they are debug symbol

[dsplaisted]

If we add a FileGroup for .pdbs to the asset file, it probably makes sense to add one for the .xml documentation files too.

[dasMulli]

Maybe even for everything that msbuild considers to be related file extensions:

private string[] _relatedFileExtensions = new string[] { ".pdb", ".xml", ".pri" };

[bording]

@wli3 Is there any more progress on this?

[onyxmaster]

Really would like this being fixed. Having dependent PDBs is crucial for in-production diagnostics + debugging.

[jnm2]

I figured out a workaround which can be pasted into the csproj:

  <!-- https://github.com/dotnet/sdk/issues/1458 -->
  <PropertyGroup>
    <AllowedReferenceRelatedFileExtensions>.pdb</AllowedReferenceRelatedFileExtensions>
  </PropertyGroup>
  <Target Name="AddReferenceRelatedPathsToCopyLocal" AfterTargets="ResolveAssemblyReferences">
    <ItemGroup>
      <ReferenceCopyLocalPaths Include="@(_ReferenceRelatedPaths)" />
    </ItemGroup>
  </Target>