Browse Source

Do not let HtmlRenderer download a failed PDF image again

pull/26216/head
maliming 2 months ago
parent
commit
dcd9711cb1
No known key found for this signature in database GPG Key ID: A646B9CB645ECEA4
  1. 7
      modules/docs/src/Volo.Docs.Domain/Volo/Docs/Projects/Pdf/PdfSharpHtmlToPdfRenderer.cs
  2. 57
      modules/docs/test/Volo.Docs.Domain.Tests/Volo/Docs/Projects/Pdf/PdfSharpHtmlToPdfRenderer_Tests.cs

7
modules/docs/src/Volo.Docs.Domain/Volo/Docs/Projects/Pdf/PdfSharpHtmlToPdfRenderer.cs

@ -364,11 +364,16 @@ public class PdfSharpHtmlToPdfRenderer : IHtmlToPdfRenderer, ITransientDependenc
images[args.Src] = image;
}
// A failed image is not handed back to HtmlRenderer, so its own downloader can not load it without the limits above.
args.Handled = true;
if (image != null)
{
args.Handled = true;
args.Callback(image);
}
else
{
args.Callback();
}
}
protected virtual async Task<byte[]> DownloadImageAsync(Uri uri)

57
modules/docs/test/Volo.Docs.Domain.Tests/Volo/Docs/Projects/Pdf/PdfSharpHtmlToPdfRenderer_Tests.cs

@ -1,8 +1,10 @@
using System;
using System.Collections.Generic;
using System.IO;
using System.Net;
using System.Linq;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
using PdfSharp.Drawing;
using PdfSharp.Pdf;
@ -175,6 +177,40 @@ public class PdfSharpHtmlToPdfRenderer_Tests : DocsDomainTestBase
}
}
[Fact]
public async Task Should_Not_Download_A_Failed_Image_Again()
{
var gif = System.Convert.FromBase64String("R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7");
var port = GetFreePort();
using var listener = new HttpListener();
listener.Prefixes.Add($"http://localhost:{port}/");
listener.Start();
var requestCount = 0;
_ = Task.Run(async () =>
{
while (listener.IsListening)
{
try
{
var context = await listener.GetContextAsync();
Interlocked.Increment(ref requestCount);
await context.Response.OutputStream.WriteAsync(gif);
context.Response.Close();
}
catch (HttpListenerException)
{
return;
}
}
});
var renderer = new FailingDownloadPdfSharpHtmlToPdfRenderer(GetRequiredService<IHttpClientFactory>());
var html = $"<!DOCTYPE html><html><body><div class='page' id='first'><img src='http://localhost:{port}/image.gif' /></div></body></html>";
await using var stream = await renderer.RenderAsync("Test", html, [new PdfDocument { Title = "First", Id = "first" }]);
requestCount.ShouldBe(0);
}
[Fact]
public void Should_Convert_Gif_Images()
{
@ -239,6 +275,27 @@ public class PdfSharpHtmlToPdfRenderer_Tests : DocsDomainTestBase
return pdf.Pages.Cast<PdfPage>().ToList().FindIndex(x => x.Reference == pageReference) + 1;
}
private static int GetFreePort()
{
using var socket = new System.Net.Sockets.TcpListener(IPAddress.Loopback, 0);
socket.Start();
return ((IPEndPoint)socket.LocalEndpoint).Port;
}
[DisableConventionalRegistration]
private class FailingDownloadPdfSharpHtmlToPdfRenderer : PdfSharpHtmlToPdfRenderer
{
public FailingDownloadPdfSharpHtmlToPdfRenderer(IHttpClientFactory httpClientFactory)
: base(httpClientFactory)
{
}
protected override Task<byte[]> DownloadImageAsync(Uri uri)
{
throw new HttpRequestException("The host does not allow this request.");
}
}
[DisableConventionalRegistration]
private class TestPdfSharpHtmlToPdfRenderer : PdfSharpHtmlToPdfRenderer
{

Loading…
Cancel
Save