Skip to content

MBTI-PDF-RESULT-SNAPSHOT-PARITY-REALIGN-08: bump snapshot PDF surface to v4 #2573

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
fermatmind merged 1 commit into from
Jul 1, 2026
Merged

MBTI-PDF-RESULT-SNAPSHOT-PARITY-REALIGN-08: bump snapshot PDF surface to v4 #2573

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion backend/app/Http/Middleware/NormalizeApiErrorContract.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public function handle(Request $request, Closure $next): Response
private function isResultPagePdfDiagnostic(array $payload): bool
{
$surface = trim((string) ($payload['surface'] ?? ''));
if (in_array($surface, ['mbti.result_page_export.v1', 'mbti.result_page_export.v2', 'mbti.result_page_snapshot.v3'], true)) {
if (in_array($surface, ['mbti.result_page_export.v1', 'mbti.result_page_export.v2', 'mbti.result_page_snapshot.v4'], true)) {
return true;
}

Expand Down
2 changes: 1 addition & 1 deletion backend/app/Services/Report/Pdf/ReportPdfDocumentService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ final class ReportPdfDocumentService

public const MBTI_RESULT_PAGE_SNAPSHOT_SURFACE = 'mbti_result_page_snapshot';

public const MBTI_RESULT_PAGE_SNAPSHOT_SURFACE_VERSION = 'mbti.result_page_snapshot.v3';
public const MBTI_RESULT_PAGE_SNAPSHOT_SURFACE_VERSION = 'mbti.result_page_snapshot.v4';

public const RESULT_PAGE_EXPORT_ENGINE = 'gotenberg_chromium';

Expand Down
21 changes: 13 additions & 8 deletions backend/tests/Feature/V0_3/AttemptPublicReportPdfParityTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ public function test_public_mbti_result_page_pdf_uses_strict_gotenberg_surface()
$pdf->assertHeader('Content-Type', 'application/pdf');
$pdf->assertHeader('X-Report-Pdf-Engine', 'gotenberg_chromium');
$pdf->assertHeader('X-Pdf-Surface', 'mbti_result_page_snapshot');
$pdf->assertHeader('X-Pdf-Surface-Version', 'mbti.result_page_snapshot.v3');
$pdf->assertHeader('X-Pdf-Surface-Version', 'mbti.result_page_snapshot.v4');
$pdf->assertHeader('X-Pdf-Artifact-Cache', 'MISS');
$pdf->assertHeader('X-Legacy-Mpdf-Fallback', 'false');
$this->assertNotSame('', (string) $pdf->headers->get('X-Gotenberg-Trace'));
Expand Down Expand Up @@ -339,7 +339,7 @@ public function test_public_mbti_result_page_pdf_uses_strict_gotenberg_surface()
$this->assertStringStartsWith("mbti-result-page-pdf-{$attemptId}-", $trace);
$this->assertSame("/zh/result/{$attemptId}/print", (string) parse_url($printUrl, PHP_URL_PATH));
$this->assertStringContainsString('pdf=1', $printUrl);
$this->assertStringContainsString('surface=mbti.result_page_snapshot.v3', $printUrl);
$this->assertStringContainsString('surface=mbti.result_page_snapshot.v4', $printUrl);
$this->assertStringContainsString('pdf_token=', $printUrl);
$this->assertStringContainsString('result_access_token=', $printUrl);
$this->assertSame('window.__FERMAT_PDF_READY__ === true', $payload['waitForExpression'] ?? null);
Expand All @@ -352,7 +352,7 @@ public function test_public_mbti_result_page_pdf_uses_strict_gotenberg_surface()
$this->assertArrayNotHasKey('failOnConsoleExceptions', $payload);

Storage::disk('local')->assertExists(
"artifacts/pdf/MBTI/{$attemptId}/nohash-mbti.result_page_snapshot.v3-gotenberg_chromium-zh-locked-free/report_free.pdf"
"artifacts/pdf/MBTI/{$attemptId}/nohash-mbti.result_page_snapshot.v4-gotenberg_chromium-zh-locked-free/report_free.pdf"
);
}

Expand Down Expand Up @@ -525,7 +525,7 @@ public function test_public_mbti_result_page_pdf_does_not_fallback_to_mpdf_when_
$pdf->assertHeader('X-Report-Scale', 'MBTI');
$pdf->assertHeader('X-Report-Pdf-Engine', 'gotenberg_chromium');
$pdf->assertHeader('X-Pdf-Surface', 'mbti_result_page_snapshot');
$pdf->assertHeader('X-Pdf-Surface-Version', 'mbti.result_page_snapshot.v3');
$pdf->assertHeader('X-Pdf-Surface-Version', 'mbti.result_page_snapshot.v4');
$pdf->assertHeader('X-Legacy-Mpdf-Fallback', 'false');
$pdf->assertHeader('X-Pdf-Error-Stage', 'gotenberg.convert_url');
$this->assertStringContainsString('X-Gotenberg-Trace', (string) $pdf->headers->get('Access-Control-Expose-Headers'));
Expand All @@ -534,12 +534,12 @@ public function test_public_mbti_result_page_pdf_does_not_fallback_to_mpdf_when_
$pdf->assertJsonPath('code', 'PDF_GENERATION_TIMEOUT');
$pdf->assertJsonPath('error_code', 'PDF_GENERATION_TIMEOUT');
$pdf->assertJsonPath('engine', 'gotenberg_chromium');
$pdf->assertJsonPath('surface', 'mbti.result_page_snapshot.v3');
$pdf->assertJsonPath('surface', 'mbti.result_page_snapshot.v4');
$pdf->assertJsonPath('message', 'PDF generation timed out');
$pdf->assertJsonPath('request_id', 'pdf-export-request-1');
$this->assertSame($pdf->headers->get('X-Gotenberg-Trace'), $pdf->json('trace'));
Storage::disk('local')->assertMissing(
"artifacts/pdf/MBTI/{$attemptId}/nohash-mbti.result_page_snapshot.v3-gotenberg_chromium-zh-locked-free/report_free.pdf"
"artifacts/pdf/MBTI/{$attemptId}/nohash-mbti.result_page_snapshot.v4-gotenberg_chromium-zh-locked-free/report_free.pdf"
);
}

Expand Down Expand Up @@ -570,6 +570,10 @@ public function test_public_mbti_result_page_pdf_does_not_hit_legacy_mpdf_surfac
"artifacts/pdf/MBTI/{$attemptId}/nohash-mbti.result_page_export.v2-gotenberg_chromium-zh-locked-free/report_free.pdf",
'%PDF-1.4 old v2 result-page export artifact'
);
Storage::disk('local')->put(
"artifacts/pdf/MBTI/{$attemptId}/nohash-mbti.result_page_snapshot.v3-gotenberg_chromium-zh-locked-free/report_free.pdf",
'%PDF-1.4 old v3 summary snapshot artifact'
);

Http::fake([
'gotenberg:3000/forms/chromium/convert/url' => Http::response('%PDF-1.4 new chromium export', 200, [
Expand All @@ -588,6 +592,7 @@ public function test_public_mbti_result_page_pdf_does_not_hit_legacy_mpdf_surfac
$this->assertStringNotContainsString('old mPDF artifact', (string) $pdf->getContent());
$this->assertStringNotContainsString('old result-page export artifact', (string) $pdf->getContent());
$this->assertStringNotContainsString('old v2 result-page export artifact', (string) $pdf->getContent());
$this->assertStringNotContainsString('old v3 summary snapshot artifact', (string) $pdf->getContent());
}

public function test_public_mbti_result_page_pdf_cache_hit_preserves_engine_headers(): void
Expand All @@ -606,7 +611,7 @@ public function test_public_mbti_result_page_pdf_cache_hit_preserves_engine_head
$this->createResult($attemptId);

Storage::disk('local')->put(
"artifacts/pdf/MBTI/{$attemptId}/nohash-mbti.result_page_snapshot.v3-gotenberg_chromium-zh-locked-free/report_free.pdf",
"artifacts/pdf/MBTI/{$attemptId}/nohash-mbti.result_page_snapshot.v4-gotenberg_chromium-zh-locked-free/report_free.pdf",
'%PDF-1.4 cached chromium export'
);

Expand All @@ -620,7 +625,7 @@ public function test_public_mbti_result_page_pdf_cache_hit_preserves_engine_head
$pdf->assertStatus(200);
$pdf->assertHeader('X-Report-Pdf-Engine', 'gotenberg_chromium');
$pdf->assertHeader('X-Pdf-Surface', 'mbti_result_page_snapshot');
$pdf->assertHeader('X-Pdf-Surface-Version', 'mbti.result_page_snapshot.v3');
$pdf->assertHeader('X-Pdf-Surface-Version', 'mbti.result_page_snapshot.v4');
$pdf->assertHeader('X-Pdf-Artifact-Cache', 'HIT');
$pdf->assertHeader('X-Legacy-Mpdf-Fallback', 'false');
$this->assertStringContainsString('cached chromium export', (string) $pdf->getContent());
Expand Down