Skip to content

Support source-generated files #193

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

Merged
merged 6 commits into from
Sep 5, 2025
Merged

Support source-generated files #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ae2f6d7
Support source-generated files
jjonescz Aug 16, 2025
73cea20
Fix message
jjonescz Aug 16, 2025
a849cd2
Include source-generated files in stage 1
jjonescz Aug 19, 2025
5f54950
Use complog util
jjonescz Aug 26, 2025
6c9f334
Include `<Compile>` by default
jjonescz Aug 26, 2025
4f4d097
Remove outdated comment
jjonescz Aug 26, 2025
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
11 changes: 6 additions & 5 deletions src/SourceBrowser/src/BinLogToSln/BinLogToSln.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@
<VersionPrefix>1.0.1</VersionPrefix>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="LibGit2Sharp" />
<PackageReference Include="Mono.Options" />
<PackageReference Include="NuGet.Frameworks" />
<PackageReference Include="System.Reflection.Metadata" />
<ItemGroup>
<PackageReference Include="Basic.CompilerLog.Util" />
<PackageReference Include="LibGit2Sharp" />
<PackageReference Include="Mono.Options" />
<PackageReference Include="NuGet.Frameworks" />
<PackageReference Include="System.Reflection.Metadata" />
</ItemGroup>

<ItemGroup>
Expand Down
101 changes: 74 additions & 27 deletions src/SourceBrowser/src/BinLogToSln/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
using LibGit2Sharp;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.SourceBrowser.BinLogParser;
using Mono.Options;
using NuGet.Frameworks;
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
using System.Numerics;
using System.Reflection.Metadata;
using System.Reflection.PortableExecutable;
using System.Runtime.CompilerServices;
using LibGit2Sharp;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.SourceBrowser.BinLogParser;
using Mono.Options;
using NuGet.Frameworks;

[assembly: InternalsVisibleTo("BinLogToSln.Tests")]

Expand Down Expand Up @@ -146,6 +145,7 @@ private static bool ShouldExcludeInvocation(CompilerInvocation invocation)

return false;
}

static void Main(string[] args)
{
string binlog = null;
Expand Down Expand Up @@ -205,7 +205,7 @@ static void Main(string[] args)
WriteSolutionHeader(sln);

IEnumerable<CompilerInvocation> invocations = BinLogCompilerInvocationsReader.ExtractInvocations(binlog);
// Group invocations by assembly name and select the best one for each
var invocationGroups = invocations
.Where(invocation => !ShouldExcludeInvocation(invocation))
Expand Down Expand Up @@ -240,11 +240,10 @@ static void Main(string[] args)
using var projFile = new FileStream(projectFilePath, FileMode.Create);
using var project = new StreamWriter(projFile);

string typeGuid = invocation.Language switch
(string typeGuid, bool isCSharp) = invocation.Language switch
{
LanguageNames.CSharp => CSharpProjectTypeGuid,
LanguageNames.VisualBasic => VBProjectTypeGuid,
_ => CSharpProjectTypeGuid,
LanguageNames.VisualBasic => (VBProjectTypeGuid, false),
_ => (CSharpProjectTypeGuid, true),
};
sln.WriteLine($"Project(\"{typeGuid}\") = \"{projectName}\", \"{Path.Join("src", repoRelativeProjectPath)}\", \"{GetProjectGuid()}\"");
sln.WriteLine("EndProject");
Expand All @@ -255,6 +254,7 @@ static void Main(string[] args)
project.WriteLine(" <GenerateAssemblyInfo>false</GenerateAssemblyInfo>");
project.WriteLine(" <GenerateTargetFrameworkAttribute>false</GenerateTargetFrameworkAttribute>");
project.WriteLine(" <DisableImplicitFrameworkReferences>true</DisableImplicitFrameworkReferences>");
project.WriteLine(" <_SkipAnalyzers>true</_SkipAnalyzers>");
project.WriteLine($" <AssemblyName>{invocation.AssemblyName}</AssemblyName>");
int idx = 1;
if (invocation.Parsed.CompilationOptions is CSharpCompilationOptions cSharpOptions)
Expand All @@ -269,7 +269,7 @@ static void Main(string[] args)
}
if (cSharpOptions.CryptoKeyFile != null)
{
includeFile(cSharpOptions.CryptoKeyFile, out string projectRelativePath, out _);
string projectRelativePath = includeFile(cSharpOptions.CryptoKeyFile, includeCompile: false);
project.WriteLine($" <KeyOriginatorFile>{projectRelativePath}</KeyOriginatorFile>");
}
}
Expand All @@ -283,25 +283,33 @@ static void Main(string[] args)
project.WriteLine(" <ItemGroup>");
foreach (CommandLineSourceFile sourceFile in invocation.Parsed.SourceFiles)
{
includeFile(sourceFile.Path, out string projectRelativePath, out string link);
project.WriteLine($" <Compile Include=\"{projectRelativePath}\"{(link != null ? $" Link=\"{link}\"" : "")}/>");
includeFile(sourceFile.Path);
}
project.WriteLine(" </ItemGroup>");
project.WriteLine(" <ItemGroup>");
foreach (CommandLineReference reference in invocation.Parsed.MetadataReferences)
{
string path = reference.Reference;
if (!File.Exists(path))
includeReference("ReferencePath", reference.Reference);
}
project.WriteLine(" </ItemGroup>");

// Add generated files.
project.WriteLine(" <ItemGroup>");
foreach (var generatedFile in getGeneratedFiles())
{
string filePath = generatedFile.FilePath;
if (!File.Exists(filePath))
{
Console.WriteLine($"Could not find reference '{path}'");
continue;
Directory.CreateDirectory(Path.GetDirectoryName(filePath));
var stream = generatedFile.Stream;
stream.Position = 0;
using var fileStream = File.OpenWrite(filePath);
stream.CopyTo(fileStream);
}
string projToRepoPath = Path.GetRelativePath(invocation.ProjectDirectory, repoRoot);
string projToOutputPath = Path.Join(projToRepoPath, "..");
string refPath = DedupeReference(output, path);
project.WriteLine($" <ReferencePath Include=\"{Path.Join(projToOutputPath, refPath)}\"/>");
includeFile(filePath);
}
project.WriteLine(" </ItemGroup>");

project.WriteLine("</Project>");
if (!string.IsNullOrEmpty(invocation.OutputAssemblyPath))
{
Expand All @@ -311,12 +319,13 @@ static void Main(string[] args)
File.Copy(invocation.OutputAssemblyPath, outputFilePath, true);
}

void includeFile(string originalPath, out string projectRelativePath, out string link)
string includeFile(string originalPath, bool includeCompile = true)
{
string filePath = Path.GetFullPath(originalPath);
string repoRelativePath = Path.GetRelativePath(repoRoot, filePath);
string outputFile;
link = null;
string link = null;
string projectRelativePath;
if (repoRelativePath.StartsWith("..\\", StringComparison.Ordinal) || repoRelativePath.StartsWith("../", StringComparison.Ordinal) || Path.IsPathRooted(repoRelativePath))
{
string externalPath = Path.Join("_external", idx++.ToString(), Path.GetFileName(filePath));
Expand All @@ -338,6 +347,44 @@ void includeFile(string originalPath, out string projectRelativePath, out string
{
File.Copy(filePath, outputFile);
}

if (includeCompile)
{
project.WriteLine($" <Compile Include=\"{projectRelativePath}\"{(link != null ? $" Link=\"{link}\"" : "")}/>");
}

return projectRelativePath;
}

void includeReference(string kind, string path)
{
if (!File.Exists(path))
{
Console.WriteLine($"Could not find {kind} '{path}'");
return;
}

string projToRepoPath = Path.GetRelativePath(invocation.ProjectDirectory, repoRoot);
string projToOutputPath = Path.Join(projToRepoPath, "..");
string refPath = DedupeReference(output, path);
project.WriteLine($" <{kind} Include=\"{Path.Join(projToOutputPath, refPath)}\"/>");
}

IEnumerable<(string FilePath, MemoryStream Stream)> getGeneratedFiles()
{
try
{
return Basic.CompilerLog.Util.RoslynUtil.ReadGeneratedFilesFromPdb(
isCSharp: isCSharp,
diagnosticName: invocation.ProjectFilePath,
invocation.Parsed);
}
catch (Exception ex)
{
// We don't want to fail official builds during stage 1, so just log a warning.
Console.WriteLine($"##vso[task.logissue type=warning;]Error processing generated files for '{invocation.ProjectFilePath}': {ex}");
return [];
}
}
}

Expand Down Expand Up @@ -386,7 +433,7 @@ private static string GetProjectGuid()
return Guid.NewGuid().ToString("B");
}

private static string CSharpProjectTypeGuid = "{9A19103F-16F7-4668-BE54-9A1E7A4F7556}";
private static string VBProjectTypeGuid = "{F184B08F-C81C-45F6-A57F-5ABD9991F28F}";
private static readonly string CSharpProjectTypeGuid = "{9A19103F-16F7-4668-BE54-9A1E7A4F7556}";
private static readonly string VBProjectTypeGuid = "{F184B08F-C81C-45F6-A57F-5ABD9991F28F}";
}
}
1 change: 1 addition & 0 deletions src/SourceBrowser/src/Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
<PackageVersion Include="Shouldly" Version="4.3.0" />

<!-- other dependencies -->
<PackageVersion Include="Basic.CompilerLog.Util" Version="0.9.17" />
Copy link
Member

@ericstj ericstj Aug 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please follow up and make sure https://www.nuget.org/packages/Basic.CompilerLog.Util/ gets a license and source repository added to it's NuGet package? You might even get a component governance alert from this after merging into official build.

Copy link
Member Author

@jjonescz jjonescz Aug 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, I can, but I believe this is already used in other repos, e.g., in sdk (although perhaps only in tests there).

Copy link
Member

@ericstj ericstj Aug 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most repos don't build tests during official builds - official builds are what require CG to pass.

You can check out https://aka.ms/opensource to see what requirements we have for using new dependencies in OSS. I don't object to this dependency, but it would be good to make sure we're checking all the right boxes when taking such a dependency for tools which run in official builds.

Copy link
Member Author

@jjonescz jjonescz Aug 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it fine to follow up separately or is this blocking merge of the PR?

<PackageVersion Include="LibGit2Sharp" Version="0.30.0" />
<PackageVersion Include="MSBuild.StructuredLogger" Version="2.3.45" />
<PackageVersion Include="ManagedEsent" Version="2.0.0" />
Expand Down
Loading