Skip to content
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

Set intermediate path sooner #74229

Merged
merged 6 commits into from
Jul 2, 2024
Merged

Set intermediate path sooner #74229

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
069bd4e
Set intermediate path sooner
ryzngard Jul 1, 2024
b7f5618
Fix non-devkit case. Make sure to utilize right information from devkit
ryzngard Jul 2, 2024
2c30dba
Actually add the fix
ryzngard Jul 2, 2024
a8ab1b9
Update src/Workspaces/Core/Portable/Workspace/ProjectSystem/ProjectSy…
ryzngard Jul 2, 2024
718b008
Fix Path.Combine calls
ryzngard Jul 2, 2024
9ffc34b
Merge branch 'intermediate_path_fix' of https://github.com/ryzngard/r…
ryzngard Jul 2, 2024
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
2 changes: 1 addition & 1 deletion src/EditorFeatures/Core/Interactive/InteractiveSession.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ private Project CreateSubmissionProjectNoLock(Solution solution, ProjectId newSu
name: name,
assemblyName: name,
language: languageName,
compilationOutputFilePaths: default,
compilationOutputInfo: default,
checksumAlgorithm: SourceHashAlgorithms.Default,
isSubmission: true),
compilationOptions: compilationOptions,
Expand Down
2 changes: 1 addition & 1 deletion src/Features/Core/Portable/MetadataAsSource/MetadataAsSourceGeneratedFileInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ public MetadataAsSourceGeneratedFileInfo(string rootPath, Workspace sourceWorksp
name: AssemblyIdentity.Name,
assemblyName: AssemblyIdentity.Name,
language: LanguageName,
compilationOutputFilePaths: default,
compilationOutputInfo: default,
checksumAlgorithm: ChecksumAlgorithm),
compilationOptions: compilationOptions,
parseOptions: _parseOptions,
Expand Down
2 changes: 1 addition & 1 deletion ...Features/Core/Portable/PdbSourceDocument/PdbSourceDocumentMetadataAsSourceFileProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ internal sealed class PdbSourceDocumentMetadataAsSourceFileProvider(
name: $"{assemblyName} ({assemblyVersion})",
assemblyName: assemblyName,
language: languageName,
compilationOutputFilePaths: default,
compilationOutputInfo: default,
checksumAlgorithm: checksumAlgorithm),
compilationOptions: compilationOptions,
parseOptions: parseOptions,
Expand Down
2 changes: 1 addition & 1 deletion src/Features/Core/Portable/Workspace/MiscellaneousFileUtilities.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ internal static ProjectInfo CreateMiscellaneousProjectInfoForDocument(
name: FeaturesResources.Miscellaneous_Files,
assemblyName: assemblyName,
language: languageInformation.LanguageName,
compilationOutputFilePaths: default,
compilationOutputInfo: default,
checksumAlgorithm: checksumAlgorithm,
// Miscellaneous files projects are never fully loaded since, by definition, it won't know
// what the full set of information is except when the file is script code.
Expand Down
2 changes: 1 addition & 1 deletion src/Features/Lsif/Generator/CompilerInvocation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ public static async Task<Project> CreateFromInvocationInfoAsync(CompilerInvocati
name: Path.GetFileNameWithoutExtension(invocationInfo.ProjectFilePath),
assemblyName: parsedCommandLine.CompilationName!,
language: languageName,
compilationOutputFilePaths: default,
compilationOutputInfo: default,
checksumAlgorithm: parsedCommandLine.ChecksumAlgorithm,
filePath: invocationInfo.ProjectFilePath,
outputFilePath: parsedCommandLine.OutputFileName),
Expand Down
2 changes: 1 addition & 1 deletion src/Features/TestUtilities/EditAndContinue/EditAndContinueTestVerifier.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,7 @@ private void CreateProjects(EditScript<SyntaxNode>[] editScripts, AdhocWorkspace
name: "project",
assemblyName: "project",
language: LanguageName,
compilationOutputFilePaths: default,
compilationOutputInfo: default,
filePath: Path.Combine(TempRoot.Root, "project" + ProjectFileExtension),
checksumAlgorithm: SourceHashAlgorithms.Default));

Expand Down
7 changes: 6 additions & 1 deletion ...Server/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/LanguageServerProjectSystem.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,12 @@ private async Task<bool> LoadOrReloadProjectAsync(ProjectToLoad projectToLoad, T
else
{
var projectSystemName = $"{projectPath} (${loadedProjectInfo.TargetFramework})";
var projectCreationInfo = new ProjectSystemProjectCreationInfo { AssemblyName = projectSystemName, FilePath = projectPath };
var projectCreationInfo = new ProjectSystemProjectCreationInfo
{
AssemblyName = projectSystemName,
FilePath = projectPath,
CompilationOutputAssemblyFilePath = loadedProjectInfo.IntermediateOutputFilePath
};

var projectSystemProject = await _workspaceFactory.ProjectSystemProjectFactory.CreateAndAddToWorkspaceAsync(
projectSystemName,
Expand Down
1 change: 1 addition & 0 deletions src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/LoadedProject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ public void Dispose()
_projectSystemProject.DisplayName = projectDisplayName;
_projectSystemProject.OutputFilePath = newProjectInfo.OutputFilePath;
_projectSystemProject.OutputRefFilePath = newProjectInfo.OutputRefFilePath;
_projectSystemProject.CompilationOutputAssemblyFilePath = newProjectInfo.IntermediateOutputFilePath;

if (newProjectInfo.TargetFrameworkIdentifier != null)
{
Expand Down
14 changes: 10 additions & 4 deletions src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/WorkspaceProject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,13 +153,16 @@ public async Task SetBuildSystemPropertiesAsync(IReadOnlyDictionary<string, stri
var disposableBatchScope = await _project.CreateBatchScopeAsync(cancellationToken).ConfigureAwait(false);
await using var _ = disposableBatchScope.ConfigureAwait(false);

string? fileDirectory = null;

foreach (var (name, value) in properties)
{
var valueOrNull = string.IsNullOrEmpty(value) ? null : value;

switch (name)
{
case "AssemblyName": _project.AssemblyName = value; break;
case "IntermediateAssembly": _project.CompilationOutputAssemblyFilePath = GetFullyQualifiedPath(valueOrNull); break;
Copy link
Member

Choose a reason for hiding this comment

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

GetFullyQualifiedPath has a bug, where it won't work for a relative path, because it does Path.Combine(_project.FilePath, value), but _project.FilePath is the full path to the actual project file (ie, .csproj file). When value is an absolute path, then that will be returned and all will be good, but the intermediate output path is a relative path, so we'd end up with CompilationOutputAssemblyFilePath being something like C:\Goo\Bar.csproj\obj\Debug\net8.0 which is not correct.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah I see, that was your comment about why it wasn't completely broken. The paths are coming in as absolute path so Path.Combine is just using the second parameter. I think what I did will fix the issue

case "MaxSupportedLangVersion": _project.MaxLangVersion = value; break;
case "RootNamespace": _project.DefaultNamespace = valueOrNull; break;
case "RunAnalyzers": _project.RunAnalyzers = bool.Parse(valueOrNull ?? bool.TrueString); break;
Expand All @@ -170,15 +173,18 @@ public async Task SetBuildSystemPropertiesAsync(IReadOnlyDictionary<string, stri
}
}

// Workaround for https://devdiv.visualstudio.com/DevDiv/_workitems/edit/1830960
_project.CompilationOutputAssemblyFilePath = _project.OutputFilePath;

string? GetFullyQualifiedPath(string? propertyValue)
{
Contract.ThrowIfNull(_project.FilePath, "We don't have a project path at this point.");

// Path.Combine doesn't check if the first parameter is an absolute path to a file instead of a directory,
// so make sure to use the directory from the _project.FilePath. If the propertyValue is an absolute
// path that will still be used, but if it's a relative path it will correctly construct the full path.
fileDirectory ??= Path.GetDirectoryName(_project.FilePath);
Contract.ThrowIfNull(fileDirectory);

if (propertyValue is not null)
return Path.Combine(_project.FilePath, propertyValue);
return Path.Combine(fileDirectory, propertyValue);
else
return null;
}
Expand Down
2 changes: 1 addition & 1 deletion src/VisualStudio/LiveShare/Impl/Client/Projects/RoslynRemoteProjectInfoProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ private static ProjectInfo CreateProjectInfo(string projectName, string language
name: projectName,
assemblyName: projectName,
language,
compilationOutputFilePaths: default,
compilationOutputInfo: default,
checksumAlgorithm),
documents: docInfos);
}
Expand Down
2 changes: 1 addition & 1 deletion src/VisualStudio/LiveShare/Impl/Client/RemoteLanguageServiceWorkspace.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@ private Document AddDocumentToProject(string filePath, string language, string p
name: projectName,
assemblyName: projectName,
language,
compilationOutputFilePaths: default,
compilationOutputInfo: default,
checksumAlgorithm: SourceHashAlgorithms.Default));

OnProjectAdded(projectInfo);
Expand Down
4 changes: 2 additions & 2 deletions src/Workspaces/Core/MSBuild/MSBuild/MSBuildProjectLoader.Worker.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ private Task<ProjectInfo> CreateProjectInfoAsync(ProjectFileInfo projectFileInfo
name: projectName,
assemblyName: assemblyName,
language: language,
compilationOutputFilePaths: new CompilationOutputInfo(projectFileInfo.IntermediateOutputFilePath),
compilationOutputInfo: new CompilationOutputInfo(projectFileInfo.IntermediateOutputFilePath),
checksumAlgorithm: SourceHashAlgorithms.Default,
filePath: projectPath),
compilationOptions: compilationOptions,
Expand Down Expand Up @@ -370,7 +370,7 @@ private Task<ProjectInfo> CreateProjectInfoAsync(ProjectFileInfo projectFileInfo
projectName,
assemblyName,
language,
compilationOutputFilePaths: new CompilationOutputInfo(projectFileInfo.IntermediateOutputFilePath),
compilationOutputInfo: new CompilationOutputInfo(projectFileInfo.IntermediateOutputFilePath),
checksumAlgorithm: commandLineArgs.ChecksumAlgorithm,
filePath: projectPath,
outputFilePath: projectFileInfo.OutputFilePath,
Expand Down
2 changes: 1 addition & 1 deletion src/Workspaces/Core/Portable/Workspace/CommandLineProject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ public static ProjectInfo CreateProjectInfo(string projectName, string language,
name: projectName,
assemblyName: assemblyName,
language: language,
compilationOutputFilePaths: new CompilationOutputInfo(commandLineArguments.OutputFileName != null ? commandLineArguments.GetOutputFilePath(commandLineArguments.OutputFileName) : null),
compilationOutputInfo: new CompilationOutputInfo(commandLineArguments.OutputFileName != null ? commandLineArguments.GetOutputFilePath(commandLineArguments.OutputFileName) : null),
checksumAlgorithm: commandLineArguments.ChecksumAlgorithm),
compilationOptions: commandLineArguments.CompilationOptions
.WithXmlReferenceResolver(xmlFileResolver)
Expand Down
4 changes: 3 additions & 1 deletion src/Workspaces/Core/Portable/Workspace/ProjectSystem/ProjectSystemProject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,8 @@ internal ProjectSystemProject(
string assemblyName,
CompilationOptions? compilationOptions,
string? filePath,
ParseOptions? parseOptions)
ParseOptions? parseOptions,
string? compilationOutputAssemblyFilePath)
{
_projectSystemProjectFactory = projectSystemProjectFactory;
_hostInfo = hostInfo;
Expand Down Expand Up @@ -196,6 +197,7 @@ internal ProjectSystemProject(
_compilationOptions = compilationOptions;
_filePath = filePath;
_parseOptions = parseOptions;
_compilationOutputAssemblyFilePath = compilationOutputAssemblyFilePath;

var watchedDirectories = GetWatchedDirectories(language, filePath);
_documentFileChangeContext = _projectSystemProjectFactory.FileChangeWatcher.CreateContext(watchedDirectories);
Expand Down
1 change: 1 addition & 0 deletions src/Workspaces/Core/Portable/Workspace/ProjectSystem/ProjectSystemProjectCreationInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ internal class ProjectSystemProjectCreationInfo
public CompilationOptions? CompilationOptions { get; set; }
public string? FilePath { get; set; }
public ParseOptions? ParseOptions { get; set; }
public string? CompilationOutputAssemblyFilePath { get; set; }

public Guid TelemetryId { get; set; }
}
5 changes: 3 additions & 2 deletions src/Workspaces/Core/Portable/Workspace/ProjectSystem/ProjectSystemProjectFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,8 @@ public async Task<ProjectSystemProject> CreateAndAddToWorkspaceAsync(string proj
assemblyName,
creationInfo.CompilationOptions,
creationInfo.FilePath,
creationInfo.ParseOptions);
creationInfo.ParseOptions,
creationInfo.CompilationOutputAssemblyFilePath);

var versionStamp = creationInfo.FilePath != null
? VersionStamp.Create(File.GetLastWriteTimeUtc(creationInfo.FilePath))
Expand All @@ -107,7 +108,7 @@ public async Task<ProjectSystemProject> CreateAndAddToWorkspaceAsync(string proj
name: projectSystemName,
assemblyName,
language,
compilationOutputFilePaths: default, // will be updated when command line is set
compilationOutputInfo: new(creationInfo.CompilationOutputAssemblyFilePath),
SourceHashAlgorithms.Default, // will be updated when command line is set
filePath: creationInfo.FilePath,
telemetryId: creationInfo.TelemetryId),
Expand Down
6 changes: 3 additions & 3 deletions src/Workspaces/Core/Portable/Workspace/Solution/ProjectInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ public static ProjectInfo Create(
name ?? throw new ArgumentNullException(nameof(name)),
assemblyName ?? throw new ArgumentNullException(nameof(assemblyName)),
language ?? throw new ArgumentNullException(nameof(language)),
compilationOutputFilePaths: default,
compilationOutputInfo: default,
checksumAlgorithm: SourceHashAlgorithm.Sha1,
defaultNamespace: null,
filePath: filePath,
Expand Down Expand Up @@ -401,7 +401,7 @@ internal sealed class ProjectAttributes(
string name,
string assemblyName,
string language,
CompilationOutputInfo compilationOutputFilePaths,
CompilationOutputInfo compilationOutputInfo,
SourceHashAlgorithm checksumAlgorithm,
string? defaultNamespace = null,
string? filePath = null,
Expand Down Expand Up @@ -460,7 +460,7 @@ internal sealed class ProjectAttributes(
/// <summary>
/// Paths to the compiler output files.
/// </summary>
public CompilationOutputInfo CompilationOutputInfo { get; } = compilationOutputFilePaths;
public CompilationOutputInfo CompilationOutputInfo { get; } = compilationOutputInfo;

/// <summary>
/// The default namespace of the project.
Expand Down
2 changes: 1 addition & 1 deletion src/Workspaces/CoreTestUtilities/Workspaces/TestHostProject`1.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ public ProjectInfo ToProjectInfo()
name: Name,
assemblyName: AssemblyName,
language: Language,
compilationOutputFilePaths: default,
compilationOutputInfo: default,
checksumAlgorithm: Text.SourceHashAlgorithms.Default,
defaultNamespace: DefaultNamespace,
filePath: FilePath,
Expand Down
Loading