Track GeneratedFilesOutputDirectory in the IDE

[tmat]

Flows CompilerGeneratedFilesOutputPath msbuild property to compiler driver through Solution snapshot.

The compiler constructs the full path of a source generated file from the value of CompilerGeneratedFilesOutputPath msbuild property, if set, or from output path otherwise. This path is then used to generate metadata name of file-scoped types.

The IDE currently uses relative paths for source generated files. This causes compiler crashes during EnC since the metadata names generated by delta emit differ from those generated by the compiler during build. This change updates the IDE to use full paths for source generated files in the same way as the compiler does.

Fixes #51998, #72331

Public API:

• Make GeneratorDriverOptions.BaseDirectory public #75387
• Add GeneratedFilesOutputDirectory to Solution APIs #75389

TODO:

• Make build property CompilerGeneratedFilesOutputPath accessible to Roslyn project project-system#9544

[tmat]

@dotnet/roslyn-ide @dotnet/roslyn-compiler @RikkiGibson @CyrusNajmabadi ptal

[jasonmalinowski]

It's unclear to me why we're taking this approach in this PR, especially given this comment:

The compiler constructs the full path of a source generated file from the value of CompilerGeneratedFilesOutputPath msbuild property, if set, or from output path otherwise. This path is then used to generate metadata name of file-scoped types.

What if we just...didn't do that, and used the source-generator relative path for the metadata name being generated in either case? Would that be much simpler, and also avoid having to create several public APIs in the process?

(I recognize I'm out of the loop here, but it'd be nice if we can write down somewhere what alternate approaches were considered here.)

[tmat]

@RikkiGibson To comment on that. The change he's made in the compiler was mainly for interceptors which also use the file path: #71879

Using full paths for generated files solves other issues. See #51998. I don't see any drawback.

[RikkiGibson]

The latest design of interceptors, which we are pushing all generators to move to, doesn't actually use the file path. It uses the content checksum, and a file name for error reporting.

re: generated files having full paths in general: Behavior of code differs depending on file path in a number of scenarios. It seems like a good thing to always use the same full paths that "would be used when emitting the files to disk". It seems like it is a general preference that we have the ability to take those files emitted to disk, add them to compilation, then remove the associated generators, and get an equivalent result from compilation.

[tmat]

API review feedback incorporated.

[jaredpar]

@jjonescz, @chsienki PTAL at compiler changes.

[CyrusNajmabadi]

seems reasonable. a s long as both APIs were approved, i'm ok with this.