Skip to content

fix: make phantoms cover descendant paths and remove skip cap #3375

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

Open
theletterf wants to merge 2 commits into
base: main
Choose a base branch
from
+7 −7
Open

fix: make phantoms cover descendant paths and remove skip cap #3375

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d70836
fix: phantom prefix matching and remove phantom skip cap
theletterf May 21, 2026
b130a45
fix: use StringComparison.Ordinal in StartsWith (CA1310)
theletterf May 21, 2026
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
14 changes: 7 additions & 7 deletions src/services/Elastic.Documentation.Assembler/Navigation/NavigationPrefixChecker.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,6 @@ private async Task FetchAndValidateCrossLinks(IDiagnosticsCollector collector, s
if (!string.IsNullOrEmpty(updateRepository) && updateReference is not null)
crossLinks = crossLinkResolver.UpdateLinkReference(updateRepository, updateReference);

var skippedPhantoms = 0;
foreach (var (repository, linkReference) in crossLinks.LinkReferences)
{
if (!_repositories.Contains(repository))
Expand All @@ -117,14 +116,9 @@ private async Task FetchAndValidateCrossLinks(IDiagnosticsCollector collector, s
var path = relativeLink.Split('/').SkipLast(1);
var pathUri = new Uri($"{repository}://{string.Join('/', path)}");

var baseOfAPhantom = _phantoms.Any(p => p == pathUri);
var baseOfAPhantom = _phantoms.Any(p => IsPhantomOrDescendant(p, pathUri));
if (baseOfAPhantom)
{
skippedPhantoms++;
if (skippedPhantoms > _phantoms.Count * 3)
collector.EmitError(repository, $"Too many items are being marked as part of a phantom this looks like a bug. ({skippedPhantoms})");
continue;
}
collector.EmitError(repository, $"'Can not validate '{crossLink}' it's not declared in any link reference nor is it a phantom");
continue;
}
Expand Down Expand Up @@ -157,6 +151,12 @@ private async Task FetchAndValidateCrossLinks(IDiagnosticsCollector collector, s
}
}

private static bool IsPhantomOrDescendant(Uri phantom, Uri candidate) =>
candidate.Scheme == phantom.Scheme &&
candidate.Host == phantom.Host &&
(candidate.AbsolutePath == phantom.AbsolutePath ||
candidate.AbsolutePath.StartsWith(phantom.AbsolutePath.TrimEnd('/') + '/', StringComparison.Ordinal));

private async Task<RepositoryLinks> ReadLocalLinksJsonAsync(string localLinksJson, Cancel ctx)
{
try
Expand Down
Loading