Skip to content

Improve marked js file discovery in BitMarkdownService (#11318) #11320

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
msynk merged 2 commits into from
Sep 2, 2025
Merged

Improve marked js file discovery in BitMarkdownService (#11318) #11320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e30a88b
improve marked js file discovery in BitMarkdownService #11318
msynk Sep 2, 2025
8455280
improve marked file stream reading
msynk Sep 2, 2025
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
12 changes: 6 additions & 6 deletions src/BlazorUI/Bit.BlazorUI.Extras/Bit.BlazorUI.Extras.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@
</ItemGroup>

<ItemGroup>
<PackageReference Include="Newtonsoft.Json" Version="13.0.3">
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Include="Jint" Version="4.4.1">
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Condition="'$(TargetFramework)' == 'net8.0'" Include="Microsoft.AspNetCore.Components.Web" Version="8.0.0" />
<PackageReference Condition="'$(TargetFramework)' == 'net9.0'" Include="Microsoft.AspNetCore.Components.Web" Version="9.0.0" />
</ItemGroup>

<ItemGroup>
<FrameworkReference Include="Microsoft.AspNetCore.App" PrivateAssets="all" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" PrivateAssets="all" />
<PackageReference Include="Jint" Version="4.4.1" PrivateAssets="all" />
</ItemGroup>

<ItemGroup>
<Content Remove="compilerconfig.json" />
<None Include="compilerconfig.json" />
Expand Down
55 changes: 27 additions & 28 deletions src/BlazorUI/Bit.BlazorUI.Extras/Services/BitMarkdownService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
using System.Globalization;
using Microsoft.Extensions.DependencyInjection;
using Jint;

namespace Bit.BlazorUI;

/// <summary>
/// A utility service to parse Markdown texts into html strings. Works smoothly in both server and client.
/// </summary>
public class BitMarkdownService(IJSRuntime js)
public class BitMarkdownService(IJSRuntime js, IServiceProvider serviceProvider)
{
private const string MARKED_FILE = "marked/marked-15.0.7.js";
private const string MARKED_FILE = "_content/Bit.BlazorUI.Extras/marked/marked-15.0.7.js";



private static string? _markedScriptText;
private static readonly SemaphoreSlim _markedScriptReadTextSemaphore = new(1, 1);
private static string? _markedScriptContent;
private static readonly SemaphoreSlim _markedScriptReadSemaphore = new(1, 1);



Expand All @@ -27,11 +28,11 @@ public async Task<string> Parse(string? markdown, CancellationToken cancellation
{
try
{
html = await Task.Run(async () => await RuntJint(markdown, cancellationToken), cancellationToken);
html = await Task.Run(async () => await RunJint(markdown, cancellationToken), cancellationToken);
}
catch (FileNotFoundException ex) when (ex.FileName?.StartsWith("Jint") is true)
{
Console.Error.WriteLine("Please install `Jint` nuget package on the server project.");
Console.Error.WriteLine("Please install `Jint` NuGet package on the server project.");
}
catch (Exception ex)
{
Expand All @@ -40,10 +41,9 @@ public async Task<string> Parse(string? markdown, CancellationToken cancellation
}
else // client
{
var scriptPath = "_content/Bit.BlazorUI.Extras/marked/marked-15.0.7.js";
if ((await js.BitMarkdownViewerCheckScriptLoaded(scriptPath)) is false)
if ((await js.BitMarkdownViewerCheckScriptLoaded(MARKED_FILE)) is false)
{
await js.BitExtrasInitScripts([scriptPath]);
await js.BitExtrasInitScripts([MARKED_FILE]);
}

html = await js.BitMarkdownViewerParse(markdown!);
Expand All @@ -54,53 +54,52 @@ public async Task<string> Parse(string? markdown, CancellationToken cancellation



private static async Task<string> RuntJint(string? markdown, CancellationToken cancellationToken)
private async Task<string> RunJint(string? markdown, CancellationToken cancellationToken)
{
if (markdown.HasNoValue()) return string.Empty;

await ReadMarkedScriptText(cancellationToken);
if (_markedScriptText.HasNoValue()) return string.Empty;
await ReadMarkedScriptContent(cancellationToken);
if (_markedScriptContent.HasNoValue()) return string.Empty;

using var engine = new Engine(options =>
{
options.Strict();
options.CancellationToken(cancellationToken);
options.Culture(CultureInfo.CurrentUICulture);
}).Execute(_markedScriptText!);
}).Execute(_markedScriptContent!);

var fn = engine.Evaluate("marked.parse").AsFunctionInstance();

return fn.Call(markdown).AsString();
}

private static async Task<string> ReadMarkedScriptText(CancellationToken cancellationToken)
private async Task<string> ReadMarkedScriptContent(CancellationToken cancellationToken)
{
if (_markedScriptText is not null) return _markedScriptText;
if (_markedScriptContent is not null) return _markedScriptContent;

try
{
await _markedScriptReadTextSemaphore.WaitAsync(cancellationToken);
if (_markedScriptText is not null) return _markedScriptText;
await _markedScriptReadSemaphore.WaitAsync(cancellationToken);

//TODO: this script path discovery needs improvement!
var scriptPath = Path.Combine(Directory.GetCurrentDirectory(), "wwwroot", "_content", "Bit.BlazorUI.Extras", MARKED_FILE);
if (_markedScriptContent is not null) return _markedScriptContent;

if (File.Exists(scriptPath) is false)
{
scriptPath = Path.Combine(AppContext.BaseDirectory, "wwwroot", MARKED_FILE);
}
var env = serviceProvider.GetRequiredService<Microsoft.AspNetCore.Hosting.IWebHostEnvironment>();

var fileInfo = env.WebRootFileProvider.GetFileInfo(MARKED_FILE);

if (File.Exists(scriptPath) is false)
if (fileInfo.Exists is false)
{
Console.Error.WriteLine("Could not find the marked js script file!");
return _markedScriptText = string.Empty;
Console.Error.WriteLine("Could not find the marked js script file.");
return _markedScriptContent = string.Empty;
}

return _markedScriptText = await File.ReadAllTextAsync(scriptPath, cancellationToken);
using var stream = fileInfo.CreateReadStream();
using var reader = new StreamReader(stream, detectEncodingFromByteOrderMarks: true);
return _markedScriptContent = await reader.ReadToEndAsync(cancellationToken);
}
finally
{
_markedScriptReadTextSemaphore.Release();
_markedScriptReadSemaphore.Release();
}
}
}
Loading