Skip to content

MBTI-PDF-SNAPSHOT-PRINT-LAYOUT-POLISH-10: add snapshot PDF render version #2577

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-SNAPSHOT-PRINT-LAYOUT-POLISH-10: add snapshot PDF render version #2577

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
3 changes: 3 additions & 0 deletions backend/app/Http/Controllers/API/V0_3/AttemptReadController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3105,6 +3105,7 @@ public function resultPagePdf(Request $request, string $id): Response|JsonRespon
'X-Report-Pdf-Engine' => (string) ($generated['engine'] ?? ReportPdfDocumentService::RESULT_PAGE_EXPORT_ENGINE),
'X-Pdf-Surface' => (string) ($generated['surface'] ?? ReportPdfDocumentService::MBTI_RESULT_PAGE_SNAPSHOT_SURFACE),
'X-Pdf-Surface-Version' => (string) ($generated['surface_version'] ?? ReportPdfDocumentService::MBTI_RESULT_PAGE_SNAPSHOT_SURFACE_VERSION),
'X-Pdf-Render-Version' => (string) ($generated['render_version'] ?? ReportPdfDocumentService::MBTI_RESULT_PAGE_SNAPSHOT_RENDER_VERSION),
'X-Pdf-Artifact-Cache' => ((bool) ($generated['cached'] ?? false)) ? 'HIT' : 'MISS',
'X-Legacy-Mpdf-Fallback' => 'false',
'X-Gotenberg-Trace' => (string) ($generated['trace_id'] ?? ''),
Expand All @@ -3123,6 +3124,7 @@ private function resultPagePdfFailureHeaders(Request $request, string $traceId):
'X-Report-Pdf-Engine' => ReportPdfDocumentService::RESULT_PAGE_EXPORT_ENGINE,
'X-Pdf-Surface' => ReportPdfDocumentService::MBTI_RESULT_PAGE_SNAPSHOT_SURFACE,
'X-Pdf-Surface-Version' => ReportPdfDocumentService::MBTI_RESULT_PAGE_SNAPSHOT_SURFACE_VERSION,
'X-Pdf-Render-Version' => ReportPdfDocumentService::MBTI_RESULT_PAGE_SNAPSHOT_RENDER_VERSION,
'X-Gotenberg-Trace' => $traceId,
'X-Legacy-Mpdf-Fallback' => 'false',
'X-Pdf-Error-Stage' => 'gotenberg.convert_url',
Expand All @@ -3146,6 +3148,7 @@ private function resultPagePdfCorsHeaders(Request $request): array
'X-Report-Pdf-Engine',
'X-Pdf-Surface',
'X-Pdf-Surface-Version',
'X-Pdf-Render-Version',
'X-Legacy-Mpdf-Fallback',
'X-Gotenberg-Trace',
'X-Pdf-Error-Stage',
Expand Down
5 changes: 5 additions & 0 deletions backend/app/Services/Report/Pdf/ReportPdfDocumentService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ final class ReportPdfDocumentService

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

public const MBTI_RESULT_PAGE_SNAPSHOT_RENDER_VERSION = 'mbti.snapshot.print_layout.v1';

public const RESULT_PAGE_EXPORT_ENGINE = 'gotenberg_chromium';

private const MBTI_LEGACY_RESULT_PAGE_EXPORT_SURFACE_VERSION = 'mbti.result_page_export.v2';
Expand Down Expand Up @@ -402,6 +404,7 @@ public function getOrGenerateMbtiResultPageExport(Attempt $attempt, array $gate,
'engine' => self::RESULT_PAGE_EXPORT_ENGINE,
'surface' => self::MBTI_RESULT_PAGE_SNAPSHOT_SURFACE,
'surface_version' => self::MBTI_RESULT_PAGE_SNAPSHOT_SURFACE_VERSION,
'render_version' => self::MBTI_RESULT_PAGE_SNAPSHOT_RENDER_VERSION,
'trace_id' => $traceId,
];
}
Expand All @@ -419,6 +422,7 @@ public function getOrGenerateMbtiResultPageExport(Attempt $attempt, array $gate,
'engine' => self::RESULT_PAGE_EXPORT_ENGINE,
'surface' => self::MBTI_RESULT_PAGE_SNAPSHOT_SURFACE,
'surface_version' => self::MBTI_RESULT_PAGE_SNAPSHOT_SURFACE_VERSION,
'render_version' => self::MBTI_RESULT_PAGE_SNAPSHOT_RENDER_VERSION,
'trace_id' => $traceId,
];
}
Expand All @@ -437,6 +441,7 @@ private function resolveResultPageExportManifestHash(Attempt $attempt, array $ga
return implode('-', [
$baseHash,
self::MBTI_RESULT_PAGE_SNAPSHOT_SURFACE_VERSION,
self::MBTI_RESULT_PAGE_SNAPSHOT_RENDER_VERSION,

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 1, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Keep PDF artifact keys under the catalog limit

When the artifact-slot dual-write rollout is enabled and an attempt has a normal 64-character content manifest hash but no report_snapshots row to supply a shorter hash, adding this render version makes the value passed as manifest_hash 157 characters (64 + surface + render + engine + locale + entitlement + variant). That exceeds report_artifact_versions.manifest_hash (string(..., 128)), so the sidecar insert fails under the app's strict MySQL config and the surrounding recordReportPdfSidecars() catch also skips the unified-access pdf_state=ready refresh for newly generated PDFs.

Useful? React with 👍 / 👎.

self::RESULT_PAGE_EXPORT_ENGINE,
preg_replace('/[^a-z0-9_.-]+/i', '_', $locale) ?: 'locale',
$entitlement,
Expand Down
14 changes: 11 additions & 3 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 @@ -309,6 +309,7 @@ public function test_public_mbti_result_page_pdf_uses_strict_gotenberg_surface()
$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.v4');
$pdf->assertHeader('X-Pdf-Render-Version', 'mbti.snapshot.print_layout.v1');
$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 @@ -352,7 +353,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.v4-gotenberg_chromium-zh-locked-free/report_free.pdf"
"artifacts/pdf/MBTI/{$attemptId}/nohash-mbti.result_page_snapshot.v4-mbti.snapshot.print_layout.v1-gotenberg_chromium-zh-locked-free/report_free.pdf"
);
}

Expand Down Expand Up @@ -526,6 +527,7 @@ public function test_public_mbti_result_page_pdf_does_not_fallback_to_mpdf_when_
$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.v4');
$pdf->assertHeader('X-Pdf-Render-Version', 'mbti.snapshot.print_layout.v1');
$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 @@ -539,7 +541,7 @@ public function test_public_mbti_result_page_pdf_does_not_fallback_to_mpdf_when_
$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.v4-gotenberg_chromium-zh-locked-free/report_free.pdf"
"artifacts/pdf/MBTI/{$attemptId}/nohash-mbti.result_page_snapshot.v4-mbti.snapshot.print_layout.v1-gotenberg_chromium-zh-locked-free/report_free.pdf"
);
}

Expand Down Expand Up @@ -574,6 +576,10 @@ public function test_public_mbti_result_page_pdf_does_not_hit_legacy_mpdf_surfac
"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'
);
Storage::disk('local')->put(
"artifacts/pdf/MBTI/{$attemptId}/nohash-mbti.result_page_snapshot.v4-gotenberg_chromium-zh-locked-free/report_free.pdf",
'%PDF-1.4 old v4 snapshot artifact without render version'
);

Http::fake([
'gotenberg:3000/forms/chromium/convert/url' => Http::response('%PDF-1.4 new chromium export', 200, [
Expand All @@ -593,6 +599,7 @@ public function test_public_mbti_result_page_pdf_does_not_hit_legacy_mpdf_surfac
$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());
$this->assertStringNotContainsString('old v4 snapshot artifact without render version', (string) $pdf->getContent());
}

public function test_public_mbti_result_page_pdf_cache_hit_preserves_engine_headers(): void
Expand All @@ -611,7 +618,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.v4-gotenberg_chromium-zh-locked-free/report_free.pdf",
"artifacts/pdf/MBTI/{$attemptId}/nohash-mbti.result_page_snapshot.v4-mbti.snapshot.print_layout.v1-gotenberg_chromium-zh-locked-free/report_free.pdf",
'%PDF-1.4 cached chromium export'
);

Expand All @@ -626,6 +633,7 @@ public function test_public_mbti_result_page_pdf_cache_hit_preserves_engine_head
$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.v4');
$pdf->assertHeader('X-Pdf-Render-Version', 'mbti.snapshot.print_layout.v1');
$pdf->assertHeader('X-Pdf-Artifact-Cache', 'HIT');
$pdf->assertHeader('X-Legacy-Mpdf-Fallback', 'false');
$this->assertStringContainsString('cached chromium export', (string) $pdf->getContent());
Expand Down