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

perf: Use cached MarkdownPipeline instance #10568

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

perf: Use cached MarkdownPipeline instance #10568

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
35 changes: 27 additions & 8 deletions src/Docfx.MarkdigEngine/MarkdigMarkdownService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,17 @@ public class MarkdigMarkdownService : IMarkdownService

private readonly MarkdownServiceParameters _parameters;
private readonly MarkdownContext _context;
private readonly Func<MarkdownPipelineBuilder, MarkdownPipelineBuilder> _configureMarkdig;

private readonly MarkdownPipeline markdownPipeline1; // isInline:true, multipleYamlHeader:true
private readonly MarkdownPipeline markdownPipeline2; // isInline:true, multipleYamlHeader:false
private readonly MarkdownPipeline markdownPipeline3; // isInline:false, multipleYamlHeader:true
private readonly MarkdownPipeline markdownPipeline4; // isInline:false, multipleYamlHeader:false

public MarkdigMarkdownService(
MarkdownServiceParameters parameters,
Func<MarkdownPipelineBuilder, MarkdownPipelineBuilder> configureMarkdig = null)
{
_parameters = parameters;
_configureMarkdig = configureMarkdig;
_context = new MarkdownContext(
key => CollectionExtensions.GetValueOrDefault(_parameters.Tokens, key),
(code, message, origin, line) => Logger.LogInfo(message, null, InclusionContext.File.ToString(), line?.ToString(), code),
Expand All @@ -35,6 +38,11 @@ public MarkdigMarkdownService(
ReadFile,
GetLink,
GetImageLink);

markdownPipeline1 = CreateMarkdownPipeline(configureMarkdig, true, true);
markdownPipeline2 = CreateMarkdownPipeline(configureMarkdig, true, false);
markdownPipeline3 = CreateMarkdownPipeline(configureMarkdig, false, true);
markdownPipeline4 = CreateMarkdownPipeline(configureMarkdig, false, false);
}

public MarkupResult Markup(string content, string filePath)
Expand All @@ -47,7 +55,7 @@ public MarkupResult Markup(string content, string filePath, bool multipleYamlHea
ArgumentNullException.ThrowIfNull(content);
ArgumentException.ThrowIfNullOrEmpty(filePath);

var pipeline = CreateMarkdownPipeline(isInline: false, multipleYamlHeader);
var pipeline = GetOrCreateMarkdownPipeline(isInline: false, multipleYamlHeader);

using (InclusionContext.PushFile((RelativePath)filePath))
{
Expand All @@ -73,7 +81,7 @@ public MarkdownDocument Parse(string content, string filePath, bool isInline)
throw new ArgumentException("file path can't be null or empty.");
}

var pipeline = CreateMarkdownPipeline(isInline);
var pipeline = GetOrCreateMarkdownPipeline(isInline);

using (InclusionContext.PushFile((RelativePath)filePath))
{
Expand All @@ -98,7 +106,7 @@ public MarkupResult Render(MarkdownDocument document, bool isInline)
throw new ArgumentNullException(nameof(document), "file path can't be found in AST.");
}

var pipeline = CreateMarkdownPipeline(isInline);
var pipeline = GetOrCreateMarkdownPipeline(isInline);

using (InclusionContext.PushFile((RelativePath)filePath))
{
Expand All @@ -116,7 +124,18 @@ public MarkupResult Render(MarkdownDocument document, bool isInline)
}
}

private MarkdownPipeline CreateMarkdownPipeline(bool isInline, bool multipleYamlHeader = false)
private MarkdownPipeline GetOrCreateMarkdownPipeline(bool isInline, bool multipleYamlHeader = false)
{
return isInline
? multipleYamlHeader
? markdownPipeline1 // isInline:true, multipleYamlHeader:true
: markdownPipeline2 // isInline:true, multipleYamlHeader:false
: multipleYamlHeader
? markdownPipeline3 // isInline:false, multipleYamlHeader:true
: markdownPipeline4; // isInline:false, multipleYamlHeader:false
}

private MarkdownPipeline CreateMarkdownPipeline(Func<MarkdownPipelineBuilder, MarkdownPipelineBuilder> configureMarkdig, bool isInline, bool multipleYamlHeader)
{
var enableSourceInfo = _parameters?.Extensions?.EnableSourceInfo ?? true;

Expand All @@ -140,9 +159,9 @@ private MarkdownPipeline CreateMarkdownPipeline(bool isInline, bool multipleYaml
builder.UseOptionalExtensions(extensions);
}

if (_configureMarkdig != null)
if (configureMarkdig != null)
{
builder = _configureMarkdig(builder);
builder = configureMarkdig(builder);
}

return builder.Build();
Expand Down