Files
InvoiceShelf/tests/Unit/GotenbergPdfDriverTest.php
Darko Gjorgjijoski 6cb754da60 fix(pdf): give both drivers one contract, and fix what that was hiding (#727)
PdfDriver and ResponseStream existed but nothing implemented them. The factory
returned the vendor dompdf wrapper for one driver and a bespoke class for the
other, so the two were never held to the same shape. Three things had slipped
through that gap.

Report PDFs answered 403 for everyone. The five report routes carry no company
header, so ScopeBouncer is not in their middleware stack and the ability scope
was never set; 'view-financial-reports' is stored scoped to a company, so the
check could not pass. They now scope to the company named in the URL. The policy
still checks membership, so this grants nothing new. Also firstOrFail() on the
hash lookup, so an unknown company is a 404 rather than a 500 on a null.

Report downloads were fatal on Gotenberg. GotenbergPdfResponse had no download(),
and the report controllers are its only callers. Added, alongside stream() and
output(), with the whole set now on the interface.

Streamed documents carried an HTTP preamble. GeneratesPdfTrait wrapped
$pdf->stream() -- already a Response -- in another response()->make(), which
stringified it and prepended "HTTP/1.0 200 OK" plus headers to the file. Readers
scan the first kilobyte for %PDF so nobody noticed, but the bytes were malformed.
Passing ->output() fixes it, and the render test now asserts the position.

Two driver-parity settings, both checked against a real gotenberg:8 rather than
inferred: emulateScreenMediaType(), because Chromium defaults to print media
while config/dompdf.php renders as screen, so a @media print rule applied on one
driver and not the other; and printBackground(), which turns out to affect only
the root background, since Chromium paints element backgrounds either way. No
stock template sets a body background, so that one changes nothing today and is
here to keep custom templates consistent across drivers.

Claude-Session: https://claude.ai/code/session_01QmECndmNZwzN65Zz9P87dF
2026-08-01 12:43:31 +02:00

67 lines
2.4 KiB
PHP

<?php
use App\Support\Pdf\GotenbergPdfDriver;
/**
* These assert against buildRequest(), which assembles the Chromium multipart
* body without sending it. Nothing here needs a running Gotenberg.
*/
beforeEach(function () {
config([
'pdf.connections.gotenberg.host' => 'http://gotenberg.example.com:3000',
'pdf.connections.gotenberg.papersize' => '210mm 297mm',
]);
});
// A real view that renders without any shared document data, so these stay
// unit tests rather than needing a seeded invoice.
function gotenbergRequestBody(string $template = 'app.pdf.partials.fonts'): string
{
return (string) (new GotenbergPdfDriver)->buildRequest($template)->getBody();
}
/**
* printBackground governs the root (body/html) background only — Chromium paints
* element backgrounds regardless, checked against gotenberg:8. dompdf paints the
* body background, so setting this keeps a custom template that styles `body`
* looking the same on either driver. No stock template sets one.
*/
test('the chromium request asks for the page background to be printed', function () {
expect(gotenbergRequestBody())->toContain('printBackground');
});
/**
* config/dompdf.php renders as `screen`; Chromium's own default is `print`. The
* two drivers should not disagree about which media type a template is styled for.
*/
test('the chromium request emulates the same media type dompdf uses', function () {
expect(gotenbergRequestBody())->toContain('emulatedMediaType');
});
test('the configured paper size reaches the request', function () {
config(['pdf.connections.gotenberg.papersize' => '8.5in 11in']);
expect(gotenbergRequestBody())
->toContain('paperWidth')
->toContain('8.5in')
->toContain('11in');
});
test('the rendered document is sent as the index file', function () {
expect(gotenbergRequestBody())->toContain('index.html');
});
test('it throws when the papersize config has an unexpected format', function () {
config(['pdf.connections.gotenberg.papersize' => 'invalid']);
expect(fn () => gotenbergRequestBody())
->toThrow(InvalidArgumentException::class, 'Invalid Gotenberg Papersize specified');
});
test('it throws when the configured host targets a private network address', function () {
config(['pdf.connections.gotenberg.host' => 'http://10.0.0.1:3000']);
expect(fn () => gotenbergRequestBody())
->toThrow(InvalidArgumentException::class, 'Invalid Gotenberg host');
});