Skip to content

fix: Pdf generation failed when navigating to same page or hash fragment navigation #10768

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
Sep 2, 2025
Merged

fix: Pdf generation failed when navigating to same page or hash fragment navigation #10768

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
36 changes: 28 additions & 8 deletions src/Docfx.App/PdfBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,22 +181,42 @@ IResult TocPage(string url)

try
{
Uri beforeUri = new(page.Url);
var response = await page.GotoAsync(url.ToString(), new() { WaitUntil = WaitUntilState.DOMContentLoaded });
if (response?.Status is 404)
return null;

if (response is null || !response.Ok)
throw new InvalidOperationException($"Failed to build PDF page [{response?.Status}]: {url}");
bool isSameUrlNavigation = response == null && beforeUri == url;
bool isHashFragmentNavigation = response == null
&& beforeUri.GetLeftPart(UriPartial.Path) == url.GetLeftPart(UriPartial.Path)
&& beforeUri.Fragment != url.Fragment;

try
if (isSameUrlNavigation)
{
// Specified page content is already loaded.
}
else if (isHashFragmentNavigation)
{
await page.AddScriptTagAsync(new() { Content = EnsureHeadingAnchorScript });
await page.WaitForFunctionAsync("!window.docfx || window.docfx.ready");
await page.WaitForLoadStateAsync(LoadState.NetworkIdle);
// Hash fragment navigation inside page. network request is not executed.
await page.WaitForURLAsync(url.ToString());
}
catch (TimeoutException)
else if (response is null || !response.Ok)
{
Logger.LogWarning($"Timeout waiting for page to load, generated PDF page may be incomplete: {url}");
// Goto navigation failed.
throw new InvalidOperationException($"Failed to build PDF page [{response?.Status}]: {url}");
}
else
{
try
{
await page.AddScriptTagAsync(new() { Content = EnsureHeadingAnchorScript });
await page.WaitForFunctionAsync("!window.docfx || window.docfx.ready");
await page.WaitForLoadStateAsync(LoadState.NetworkIdle);
}
catch (TimeoutException)
{
Logger.LogWarning($"Timeout waiting for page to load, generated PDF page may be incomplete: {url}");
}
}

return await page.PdfAsync(new PagePdfOptions
Expand Down
Loading