From a54141058d27cd614649c6c94426827a59de40a6 Mon Sep 17 00:00:00 2001 From: stumpylog <797416+stumpylog@users.noreply.github.com> Date: Fri, 20 Nov 2026 10:05:14 -0800 Subject: [PATCH] Chore: number the editor page image URL from 1 like zone pages --- .../ocr-template-editor.component.spec.ts | 4 +-- .../ocr-template-editor.component.ts | 2 +- src/documents/tests/test_api_ocr_templates.py | 27 ++++++++++++++++--- src/documents/views.py | 14 +++++----- 4 files changed, 34 insertions(+), 13 deletions(-) diff --git a/src-ui/src/app/components/manage/ocr-templates/ocr-template-editor/ocr-template-editor.component.spec.ts b/src-ui/src/app/components/manage/ocr-templates/ocr-template-editor/ocr-template-editor.component.spec.ts index d2f6593046..316ddcfe42 100644 --- a/src-ui/src/app/components/manage/ocr-templates/ocr-template-editor/ocr-template-editor.component.spec.ts +++ b/src-ui/src/app/components/manage/ocr-templates/ocr-template-editor/ocr-template-editor.component.spec.ts @@ -225,7 +225,7 @@ describe('OcrTemplateEditorComponent', () => { component.previewPageDisplay = 2 expect(component.previewPage).toBe(1) expect(component.previewPageDisplay).toBe(2) - expect(component.pageImageUrl).toContain('/5/1/') + expect(component.pageImageUrl).toContain('/5/2/') component.pageLoaded.set(true) component.goToPage(1) expect(component.pageLoaded()).toBe(true) @@ -523,7 +523,7 @@ describe('OcrTemplateEditorComponent', () => { expect(component.dialogTitle).toEqual('Edit OCR Template') expect(component.previewDocId).toEqual(5) expect(component.previewPageCount()).toEqual(3) - expect(component.pageImageUrl).toContain('document-page-image/5/0/') + expect(component.pageImageUrl).toContain('document-page-image/5/1/') expect(component.template.match).toEqual('Northwind') expect(component.isDirty).toBeFalsy() diff --git a/src-ui/src/app/components/manage/ocr-templates/ocr-template-editor/ocr-template-editor.component.ts b/src-ui/src/app/components/manage/ocr-templates/ocr-template-editor/ocr-template-editor.component.ts index 2b01943853..62730ab928 100644 --- a/src-ui/src/app/components/manage/ocr-templates/ocr-template-editor/ocr-template-editor.component.ts +++ b/src-ui/src/app/components/manage/ocr-templates/ocr-template-editor/ocr-template-editor.component.ts @@ -241,7 +241,7 @@ export class OcrTemplateEditorComponent implements OnInit, OnDestroy { return this.previewDocId ? this.templateService.getPageImageUrl( this.previewDocId, - this.previewPage + this.previewPage + 1 ) : null } diff --git a/src/documents/tests/test_api_ocr_templates.py b/src/documents/tests/test_api_ocr_templates.py index cc9ba7e01e..bd62a8a579 100644 --- a/src/documents/tests/test_api_ocr_templates.py +++ b/src/documents/tests/test_api_ocr_templates.py @@ -170,7 +170,7 @@ def detail_url(pk: int) -> str: return f"{ENDPOINT}{pk}/" -def preview_url(document: Document, page: int = 0) -> str: +def preview_url(document: Document, page: int = 1) -> str: return f"{ENDPOINT}document-page-image/{document.pk}/{page}/" @@ -2397,13 +2397,32 @@ class TestDocumentPageImage: THEN: - 404 is returned for both """ - response = preview_client.get(f"{ENDPOINT}document-page-image/99999/0/") + response = preview_client.get(f"{ENDPOINT}document-page-image/99999/1/") assert response.status_code == status.HTTP_404_NOT_FOUND assert ( - preview_client.get(preview_url(preview_document, 3)).status_code + preview_client.get(preview_url(preview_document, 4)).status_code == status.HTTP_404_NOT_FOUND ) + def test_page_zero_is_not_found( + self, + preview_client: APIClient, + preview_document: Document, + mock_render: MagicMock, + ) -> None: + """ + GIVEN: + - A 3 page PDF document + WHEN: + - Page 0 is requested, which is not a valid 1-based page + THEN: + - 404 is returned and no page is rendered + """ + response = preview_client.get(preview_url(preview_document, 0)) + + assert response.status_code == status.HTTP_404_NOT_FOUND + mock_render.assert_not_called() + def test_serves_image_documents_without_running_poppler( self, preview_client: APIClient, @@ -2481,7 +2500,7 @@ class TestDocumentPageImage: mock_render.side_effect = render_page - response = preview_client.get(preview_url(preview_document, 1)) + response = preview_client.get(preview_url(preview_document, 2)) assert response.status_code == status.HTTP_200_OK assert response["Content-Type"] == "image/png" diff --git a/src/documents/views.py b/src/documents/views.py index 581ce42dae..c7fa7579c6 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -5897,7 +5897,7 @@ class OcrTemplateViewSet(BulkPermissionMixin, PassUserMixin, ModelViewSet[OcrTem ) -> HttpResponse: """ Render a page for the template editor's zone overlay. The page in the URL is - 0-based, unlike a zone's page, which is 1-based. + 1-based, like a zone's page. """ from documents.zone_ocr import resolve_zone_source @@ -5911,11 +5911,13 @@ class OcrTemplateViewSet(BulkPermissionMixin, PassUserMixin, ModelViewSet[OcrTem file_doc = self._resolve_file_document(document, request) - page_num = int(page) + page_number = int(page) + if page_number < 1: + raise Http404("Page numbers start at 1") - if file_doc.page_count and page_num >= file_doc.page_count: + if file_doc.page_count and page_number > file_doc.page_count: raise Http404( - f"Page {page_num} out of range (document has {file_doc.page_count} pages)", + f"Page {page_number} out of range (document has {file_doc.page_count} pages)", ) source = resolve_zone_source(file_doc) @@ -5937,13 +5939,13 @@ class OcrTemplateViewSet(BulkPermissionMixin, PassUserMixin, ModelViewSet[OcrTem doc_path, rendered, dpi=150, - page=page_num + 1, + page=page_number, timeout=30, ) except ParseError as error: logger.warning( "Failed to render page %s of document %s: %s", - page_num, + page_number, file_doc.pk, error, )