Skip to content

Improve safety of callout handling in EnhancedCodeBlockParser. #455

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

Merged
merged 1 commit into from
Feb 10, 2025
Merged

Improve safety of callout handling in EnhancedCodeBlockParser. #455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions src/Elastic.Markdown/DocumentationGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ public async Task GenerateAll(Cancel ctx)

await ExtractEmbeddedStaticResources(ctx);


_logger.LogInformation($"Completing diagnostics channel");
Context.Collector.Channel.TryComplete();

Expand All @@ -92,6 +91,7 @@ private async Task ProcessDocumentationFiles(HashSet<string> offendingFiles, Dat
{
var processedFileCount = 0;
var exceptionCount = 0;
var totalFileCount = DocumentationSet.Files.Count;
_ = Context.Collector.StartAsync(ctx);
await Parallel.ForEachAsync(DocumentationSet.Files, ctx, async (file, token) =>
{
Expand All @@ -112,8 +112,9 @@ await Parallel.ForEachAsync(DocumentationSet.Files, ctx, async (file, token) =>
}

if (processedFiles % 100 == 0)
_logger.LogInformation($"-> Handled {processedFiles} files");
_logger.LogInformation($"-> Processed {processedFiles}/{totalFileCount} files");
});
_logger.LogInformation($"-> Processed {processedFileCount}/{totalFileCount} files");
}

private async Task ExtractEmbeddedStaticResources(Cancel ctx)
Expand Down Expand Up @@ -149,7 +150,7 @@ private async Task ProcessFile(HashSet<string> offendingFiles, DocumentationFile
return;
}

_logger.LogTrace($"{file.SourceFile.FullName}");
_logger.LogTrace($"--> {file.SourceFile.FullName}");
var outputFile = OutputFile(file.RelativePath);
if (file is MarkdownFile markdown)
await HtmlWriter.WriteAsync(outputFile, markdown, token);
Expand Down
4 changes: 2 additions & 2 deletions src/Elastic.Markdown/Myst/CodeBlocks/CallOutParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ namespace Elastic.Markdown.Myst.CodeBlocks;

public static partial class CallOutParser
{
[GeneratedRegex(@"^.+\S+.*?\s<\d+>$", RegexOptions.IgnoreCase, "en-US")]
[GeneratedRegex(@"^.+\S+.*?\s<\d+>$", RegexOptions.IgnoreCase, 2000, "en-US")]
public static partial Regex CallOutNumber();

[GeneratedRegex(@"^.+\S+.*?\s(?:\/\/|#)\s[^""\/#]+$", RegexOptions.IgnoreCase, "en-US")]
[GeneratedRegex(@"^.+\S+.*?\s(?:\/\/|#)\s[^""\/#]+$", RegexOptions.IgnoreCase, 2000, "en-US")]
public static partial Regex MathInlineAnnotation();
}
2 changes: 1 addition & 1 deletion src/Elastic.Markdown/Myst/CodeBlocks/EnhancedCodeBlockParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ public override bool Close(BlockProcessor processor, Block block)
continue;

List<CallOut> callOuts = [];
var hasClassicCallout = span.IndexOf("<") > 0;
var hasClassicCallout = span.IndexOf("<") > 0 && span.LastIndexOf(">") == span.Length - 1;
if (hasClassicCallout)
{
var matchClassicCallout = CallOutParser.CallOutNumber().EnumerateMatches(span);
Expand Down
3 changes: 3 additions & 0 deletions src/Elastic.Markdown/Slices/HtmlWriter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ public HtmlWriter(DocumentationSet documentationSet, IFileSystem writeFileSystem
public ILoggerFactory LoggerFactory { get; }
public ServiceProvider ServiceProvider { get; }

private Task<string> RenderEmptyString(MarkdownFile markdown, Cancel ctx = default) =>
Task.FromResult(string.Empty);

private async Task<string> RenderNavigation(MarkdownFile markdown, Cancel ctx = default)
{
var slice = Layout._TocTree.Create(new NavigationViewModel
Expand Down