Don't pass `RazorCodeDocument` and `SourceText` around together (#10719)

because it's really easy to get one from the other.

While working on rename in cohosting, I noticed this unnecessary extra
bit of work while calling `GetPositionInfo`, so I fixed it. Then I
thought I'd see where else `GetSourceTextAsync` was used in an non-ideal
way, and that was clearly going to be too big for the rename PR so I
separated it out into it's own PR. Then I heard Dustin say he was
changing `DocumentSnapshot` so the unnecessary work will end up being
much less wasteful anyway, plus we'd probably just have conflicts, so I
pared the whole thing right back to just this minor removal of a couple
of unnecessary parameters. Enjoy.
This commit is contained in:
David Wengier 2024-08-09 09:15:19 +10:00 коммит произвёл GitHub
Родитель fb84ae5d9b 79b2d26a80
Коммит d5cfe11b00
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: B5690EEEBB952194
2 изменённых файлов: 34 добавлений и 40 удалений

Просмотреть файл

@ -2,6 +2,7 @@
// Licensed under the MIT license. See License.txt in the project root for license information. // Licensed under the MIT license. See License.txt in the project root for license information.
using System; using System;
using System.Collections.Frozen;
using System.Collections.Generic; using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis; using System.Diagnostics.CodeAnalysis;
using System.Linq; using System.Linq;
@ -36,12 +37,11 @@ internal class RazorTranslateDiagnosticsService(IDocumentMappingService document
private readonly ILogger _logger = loggerFactory.GetOrCreateLogger<RazorTranslateDiagnosticsService>(); private readonly ILogger _logger = loggerFactory.GetOrCreateLogger<RazorTranslateDiagnosticsService>();
private readonly IDocumentMappingService _documentMappingService = documentMappingService; private readonly IDocumentMappingService _documentMappingService = documentMappingService;
// Internal for testing private static readonly FrozenSet<string> s_cSharpDiagnosticsToIgnore = new HashSet<string>(
internal static readonly IReadOnlyCollection<string> CSharpDiagnosticsToIgnore = new HashSet<string>() [
{
"RemoveUnnecessaryImportsFixable", "RemoveUnnecessaryImportsFixable",
"IDE0005_gen", // Using directive is unnecessary "IDE0005_gen", // Using directive is unnecessary
}; ]).ToFrozenSet();
/// <summary> /// <summary>
/// Translates code diagnostics from one representation into another. /// Translates code diagnostics from one representation into another.
@ -64,11 +64,9 @@ internal class RazorTranslateDiagnosticsService(IDocumentMappingService document
return []; return [];
} }
var sourceText = await documentContext.GetSourceTextAsync(cancellationToken).ConfigureAwait(false);
var filteredDiagnostics = diagnosticKind == RazorLanguageKind.CSharp var filteredDiagnostics = diagnosticKind == RazorLanguageKind.CSharp
? FilterCSharpDiagnostics(diagnostics, codeDocument, sourceText) ? FilterCSharpDiagnostics(diagnostics, codeDocument)
: FilterHTMLDiagnostics(diagnostics, codeDocument, sourceText); : FilterHTMLDiagnostics(diagnostics, codeDocument);
if (filteredDiagnostics.Length == 0) if (filteredDiagnostics.Length == 0)
{ {
_logger.LogDebug($"No diagnostics remaining after filtering."); _logger.LogDebug($"No diagnostics remaining after filtering.");
@ -81,24 +79,23 @@ internal class RazorTranslateDiagnosticsService(IDocumentMappingService document
diagnosticKind, diagnosticKind,
filteredDiagnostics, filteredDiagnostics,
documentContext.Snapshot, documentContext.Snapshot,
codeDocument, codeDocument);
sourceText);
return mappedDiagnostics; return mappedDiagnostics;
} }
private Diagnostic[] FilterCSharpDiagnostics(Diagnostic[] unmappedDiagnostics, RazorCodeDocument codeDocument, SourceText sourceText) private Diagnostic[] FilterCSharpDiagnostics(Diagnostic[] unmappedDiagnostics, RazorCodeDocument codeDocument)
{ {
return unmappedDiagnostics.Where(d => return unmappedDiagnostics.Where(d =>
!ShouldFilterCSharpDiagnosticBasedOnErrorCode(d, codeDocument, sourceText)).ToArray(); !ShouldFilterCSharpDiagnosticBasedOnErrorCode(d, codeDocument)).ToArray();
} }
private static Diagnostic[] FilterHTMLDiagnostics( private static Diagnostic[] FilterHTMLDiagnostics(
Diagnostic[] unmappedDiagnostics, Diagnostic[] unmappedDiagnostics,
RazorCodeDocument codeDocument, RazorCodeDocument codeDocument)
SourceText sourceText)
{ {
var syntaxTree = codeDocument.GetSyntaxTree(); var syntaxTree = codeDocument.GetSyntaxTree();
var sourceText = codeDocument.Source.Text;
var processedAttributes = new Dictionary<TextSpan, bool>(); var processedAttributes = new Dictionary<TextSpan, bool>();
@ -115,22 +112,19 @@ internal class RazorTranslateDiagnosticsService(IDocumentMappingService document
private Diagnostic[] MapDiagnostics( private Diagnostic[] MapDiagnostics(
RazorLanguageKind languageKind, RazorLanguageKind languageKind,
IReadOnlyList<Diagnostic> diagnostics, Diagnostic[] diagnostics,
IDocumentSnapshot documentSnapshot, IDocumentSnapshot documentSnapshot,
RazorCodeDocument codeDocument, RazorCodeDocument codeDocument)
SourceText sourceText)
{ {
var projects = RazorDiagnosticConverter.GetProjectInformation(documentSnapshot); var projects = RazorDiagnosticConverter.GetProjectInformation(documentSnapshot);
using var mappedDiagnostics = new PooledArrayBuilder<Diagnostic>(); using var mappedDiagnostics = new PooledArrayBuilder<Diagnostic>();
for (var i = 0; i < diagnostics.Count; i++) foreach (var diagnostic in diagnostics)
{ {
var diagnostic = diagnostics[i];
// C# requests don't map directly to where they are in the document. // C# requests don't map directly to where they are in the document.
if (languageKind == RazorLanguageKind.CSharp) if (languageKind == RazorLanguageKind.CSharp)
{ {
if (!TryGetOriginalDiagnosticRange(diagnostic, codeDocument, sourceText, out var originalRange)) if (!TryGetOriginalDiagnosticRange(diagnostic, codeDocument, out var originalRange))
{ {
continue; continue;
} }
@ -253,7 +247,8 @@ internal class RazorTranslateDiagnosticsService(IDocumentMappingService document
var element = owner.FirstAncestorOrSelf<MarkupElementSyntax>(static n => n.StartTag?.Name.Content == "style"); var element = owner.FirstAncestorOrSelf<MarkupElementSyntax>(static n => n.StartTag?.Name.Content == "style");
var csharp = owner.FirstAncestorOrSelf<CSharpCodeBlockSyntax>(); var csharp = owner.FirstAncestorOrSelf<CSharpCodeBlockSyntax>();
return element?.Body.Any(static c => c is CSharpCodeBlockSyntax) ?? false || csharp is not null; return csharp is not null ||
(element?.Body.Any(static c => c is CSharpCodeBlockSyntax) ?? false);
} }
// Ideally this would be solved instead by not emitting the "!" at the HTML backing file, // Ideally this would be solved instead by not emitting the "!" at the HTML backing file,
@ -405,26 +400,26 @@ internal class RazorTranslateDiagnosticsService(IDocumentMappingService document
} }
} }
private bool ShouldFilterCSharpDiagnosticBasedOnErrorCode(Diagnostic diagnostic, RazorCodeDocument codeDocument, SourceText sourceText) private bool ShouldFilterCSharpDiagnosticBasedOnErrorCode(Diagnostic diagnostic, RazorCodeDocument codeDocument)
{ {
if (!diagnostic.Code.HasValue) if (diagnostic.Code is not { } code ||
!code.TryGetSecond(out var str) ||
str is null)
{ {
return false; return false;
} }
diagnostic.Code.Value.TryGetSecond(out var str);
return str switch return str switch
{ {
"CS1525" => ShouldIgnoreCS1525(diagnostic, codeDocument, sourceText), "CS1525" => ShouldIgnoreCS1525(diagnostic, codeDocument),
_ => CSharpDiagnosticsToIgnore.Contains(str) && _ => s_cSharpDiagnosticsToIgnore.Contains(str) &&
diagnostic.Severity != DiagnosticSeverity.Error, diagnostic.Severity != DiagnosticSeverity.Error
}; };
bool ShouldIgnoreCS1525(Diagnostic diagnostic, RazorCodeDocument codeDocument, SourceText sourceText) bool ShouldIgnoreCS1525(Diagnostic diagnostic, RazorCodeDocument codeDocument)
{ {
if (CheckIfDocumentHasRazorDiagnostic(codeDocument, RazorDiagnosticFactory.TagHelper_EmptyBoundAttribute.Id) && if (CheckIfDocumentHasRazorDiagnostic(codeDocument, RazorDiagnosticFactory.TagHelper_EmptyBoundAttribute.Id) &&
TryGetOriginalDiagnosticRange(diagnostic, codeDocument, sourceText, out var originalRange) && TryGetOriginalDiagnosticRange(diagnostic, codeDocument, out var originalRange) &&
originalRange.IsUndefined()) originalRange.IsUndefined())
{ {
// Empty attribute values will take the following form in the generated C# document: // Empty attribute values will take the following form in the generated C# document:
@ -440,17 +435,16 @@ internal class RazorTranslateDiagnosticsService(IDocumentMappingService document
} }
} }
// Internal & virtual for testing private static bool CheckIfDocumentHasRazorDiagnostic(RazorCodeDocument codeDocument, string razorDiagnosticCode)
internal virtual bool CheckIfDocumentHasRazorDiagnostic(RazorCodeDocument codeDocument, string razorDiagnosticCode)
{ {
return codeDocument.GetSyntaxTree().Diagnostics.Any(d => d.Id.Equals(razorDiagnosticCode, StringComparison.Ordinal)); return codeDocument.GetSyntaxTree().Diagnostics.Any(d => d.Id.Equals(razorDiagnosticCode, StringComparison.Ordinal));
} }
private bool TryGetOriginalDiagnosticRange(Diagnostic diagnostic, RazorCodeDocument codeDocument, SourceText sourceText, [NotNullWhen(true)] out Range? originalRange) private bool TryGetOriginalDiagnosticRange(Diagnostic diagnostic, RazorCodeDocument codeDocument, [NotNullWhen(true)] out Range? originalRange)
{ {
if (IsRudeEditDiagnostic(diagnostic)) if (IsRudeEditDiagnostic(diagnostic))
{ {
if (TryRemapRudeEditRange(diagnostic.Range, codeDocument, sourceText, out originalRange)) if (TryRemapRudeEditRange(diagnostic.Range, codeDocument, out originalRange))
{ {
return true; return true;
} }
@ -487,14 +481,15 @@ internal class RazorTranslateDiagnosticsService(IDocumentMappingService document
str.StartsWith("ENC"); str.StartsWith("ENC");
} }
private bool TryRemapRudeEditRange(Range diagnosticRange, RazorCodeDocument codeDocument, SourceText sourceText, [NotNullWhen(true)] out Range? remappedRange) private bool TryRemapRudeEditRange(Range diagnosticRange, RazorCodeDocument codeDocument, [NotNullWhen(true)] out Range? remappedRange)
{ {
// This is a rude edit diagnostic that has already been mapped to the Razor document. The mapping isn't absolutely correct though, // This is a rude edit diagnostic that has already been mapped to the Razor document. The mapping isn't absolutely correct though,
// it's based on the runtime code generation of the Razor document therefore we need to re-map the already mapped diagnostic in a // it's based on the runtime code generation of the Razor document therefore we need to re-map the already mapped diagnostic in a
// semi-intelligent way. // semi-intelligent way.
var syntaxTree = codeDocument.GetSyntaxTree(); var syntaxTree = codeDocument.GetSyntaxTree();
var span = codeDocument.Source.Text.GetTextSpan(diagnosticRange); var sourceText = codeDocument.Source.Text;
var span = sourceText.GetTextSpan(diagnosticRange);
var owner = syntaxTree.Root.FindNode(span, getInnermostNodeForTie: true); var owner = syntaxTree.Root.FindNode(span, getInnermostNodeForTie: true);
switch (owner?.Kind) switch (owner?.Kind)

Просмотреть файл

@ -36,17 +36,16 @@ internal static class IDocumentMappingServiceExtensions
public static async Task<DocumentPositionInfo> GetPositionInfoAsync(this IDocumentMappingService service, DocumentContext documentContext, int hostDocumentIndex, CancellationToken cancellationToken) public static async Task<DocumentPositionInfo> GetPositionInfoAsync(this IDocumentMappingService service, DocumentContext documentContext, int hostDocumentIndex, CancellationToken cancellationToken)
{ {
var codeDocument = await documentContext.GetCodeDocumentAsync(cancellationToken).ConfigureAwait(false); var codeDocument = await documentContext.GetCodeDocumentAsync(cancellationToken).ConfigureAwait(false);
var sourceText = await documentContext.GetSourceTextAsync(cancellationToken).ConfigureAwait(false);
return service.GetPositionInfo(codeDocument, sourceText, hostDocumentIndex); return service.GetPositionInfo(codeDocument, hostDocumentIndex);
} }
public static DocumentPositionInfo GetPositionInfo( public static DocumentPositionInfo GetPositionInfo(
this IDocumentMappingService service, this IDocumentMappingService service,
RazorCodeDocument codeDocument, RazorCodeDocument codeDocument,
SourceText sourceText,
int hostDocumentIndex) int hostDocumentIndex)
{ {
var sourceText = codeDocument.Source.Text;
var position = sourceText.GetPosition(hostDocumentIndex); var position = sourceText.GetPosition(hostDocumentIndex);
var languageKind = service.GetLanguageKind(codeDocument, hostDocumentIndex, rightAssociative: false); var languageKind = service.GetLanguageKind(codeDocument, hostDocumentIndex, rightAssociative: false);