Fix building slnf with @ in the path

[surayya-MS]

Context

Fixes #11050

If the path to the solution file contains @, it builds normally. But, if solution filter references this solution then the build fails:

{my-path-to}/bugtest%40commithash/Solution/Solution.sln : Solution file error MSB5026: The solution filter file at "{my-path-to}/bugtest@commithash/Solution/Test.slnf" specifies there will be a solution file at "{my-path-to}/bugtest%40commithash/Solution/Solution.sln", but that file does not exist.

same happens with other symbols like % and $.

See the issue description for more details.

Details

The problem occurs on this line:

msbuild/src/Build/Construction/Solution/SolutionFile.cs

Line 661 in a1c2e74

return FileUtilities.GetFullPath(solution.GetProperty("path").GetString(), Path.GetDirectoryName(solutionFilterFile));

FileUtilities.GetFullPath changes @ to %40.

Specifically this happens here:

msbuild/src/Shared/FileUtilities.cs

Line 762 in 18c6b2e

string fullPath = EscapingUtilities.Escape(NormalizePath(Path.Combine(currentDirectory, fileSpec)));

Changes

Added bool escape param to FileUtilities.GetFullPath to be able to skip escape for getting solution path from solution filter (.slnf) json

Testing

Added new test to cover this scenario

[rainersigwald]

Could this be

Suggested change

	return FileUtilities.GetFullPath(solution.GetProperty("path").GetString(), Path.GetDirectoryName(solutionFilterFile), escape: false);
	return FileUtilities.NormalizePath(Path.GetDirectoryName(solutionFilterFile), solution.GetProperty("path").GetString());

without changing GetFullPath?

[surayya-MS]

this won't work because in GetFullPath before normalization the solution path that is provided in slnf needs to be fixed for the current machine.

msbuild/src/Shared/FileUtilities.cs

Line 759 in 04b6e1b

fileSpec = FixFilePath(EscapingUtilities.UnescapeAll(fileSpec));

I can create new function GetFullPathUnescaped and duplicate the code there. What do you think?

[YuliiaKovalova]

is it possible to do here

string fullPath = NormalizePath(Path.Combine(currentDirectory, FileUtilities.FixFilePath(EscapingUtilities.UnescapeAll(fileSpec)));
instead of making modification of FileUtilities.cs?

[surayya-MS]

there is also adding trailing slash at the end of the full path

msbuild/src/Shared/FileUtilities.cs

Lines 764 to 772 in aff5455

	if (NativeMethodsShared.IsWindows && !EndsWithSlash(fullPath))
	{
	if (FileUtilitiesRegex.IsDrivePattern(fileSpec) ||
	FileUtilitiesRegex.IsUncPattern(fullPath))
	{
	// append trailing slash if Path.GetFullPath failed to (this happens with drive-specs and UNC shares)
	fullPath += Path.DirectorySeparatorChar;
	}
	}

Not modifying the FileUtilities.GetFullPath by adding extra check makes sense because it is on a hot path. Adding a new method FileUtilities.GetFullPathUnescaped that will duplicate most of the code except escaping would be a compromise for that reason.

Is there other reason not to modify FileUtilities.cs that I miss?

[Mik4sa]

Could this PR maybe also fix #11442?

[surayya-MS]

Could this PR maybe also fix #11442?

This is probably not related. The bug that this PR fixes is not recent and existed before. The one you described looks like a regression. Nevertheless, we will fix it soon. Thanks for reporting!

[Mik4sa]

hmm too bad but thank you for your time and feedback :)
I'm looking forward to a fix :)