Beautiful Open-Source Form Builder
fix(pdf-editor): support relative API bases (#1243)
Julien Nahum796d929659d9
diff --git a/client/api/forms.js b/client/api/forms.jsindex f1e1147b8..a9a85a4dd 100644--- a/client/api/forms.js+++ b/client/api/forms.js@@ -1,5 +1,6 @@import { apiService } from './base'import { getOpnRequestsOptions } from '~/composables/useOpnApi'+import { resolvePdfDownloadUrl } from '~/lib/pdf-editor'export const formsApi = {// Form views@@ -93,8 +94,9 @@ export const formsApi = {getDownloadRequest: (formId, templateId) => {const endpoint = `/open/forms/${formId}/pdf-templates/${templateId}/download`const requestOptions = getOpnRequestsOptions(endpoint, {})+ const origin = import.meta.client ? window.location.origin : undefinedreturn {- url: new URL(endpoint, requestOptions.baseURL).toString(),+ url: resolvePdfDownloadUrl(endpoint, requestOptions.baseURL, origin),httpHeaders: requestOptions.headers,}},diff --git a/client/components/open/pdf-editor/PdfZoneEditor.vue b/client/components/open/pdf-editor/PdfZoneEditor.vueindex 803b0dfc9..1ebceab43 100644--- a/client/components/open/pdf-editor/PdfZoneEditor.vue+++ b/client/components/open/pdf-editor/PdfZoneEditor.vue@@ -113,6 +113,7 @@<script setup>import { formsApi } from '~/api/forms'+import { getPdfRenderPages } from '~/lib/pdf-editor'const pdfStore = useWorkingPdfStore()const {@@ -398,12 +399,6 @@ const cancelAllRenderTasks = () => {activeRenderTasks.clear()}-const getPriorityZoomPages = () => {- const current = Number(currentPage.value)- const candidatePages = [current - 1, current, current + 1]- return candidatePages.filter((pageNum) => pageList.value.includes(pageNum) && !isNewPage(pageNum))-}-const getEditorScrollRoot = () => {return pagesContainer.value?.closest?.('.pdf-editor-scroll-container')}@@ -418,9 +413,9 @@ const fitZoomToPageWidth = async () => {if (!pdfDoc.value) returnconst firstPhysicalPage = pageList.value.find((pageNum) => !isNewPage(pageNum))- if (!firstPhysicalPage) return-- const sourcePageNumber = pdfStore.getSourcePageNumber(firstPhysicalPage)+ const sourcePageNumber = firstPhysicalPage+ ? pdfStore.getSourcePageNumber(firstPhysicalPage)+ : 1if (sourcePageNumber == null) returnconst availablePageWidth = getAvailablePageWidth()@@ -488,7 +483,24 @@ const renderAllPages = async (options = {}) => {if (!pdfDoc.value) returnconst { zoomOnlyVisible = false } = optionsconst thisPassId = ++renderPassId.value- const targetPages = zoomOnlyVisible ? getPriorityZoomPages() : pageList.value.filter((p) => !isNewPage(p))+ const { physicalPages, targetPages } = getPdfRenderPages(+ pageList.value,+ currentPage.value,+ isNewPage,+ zoomOnlyVisible+ )++ if (!physicalPages.length) {+ const page = await pdfDoc.value.getPage(1)+ if (thisPassId !== renderPassId.value) return+ const viewport = page.getViewport({ scale: zoomScale.value })+ canvasWidth.value = viewport.width+ canvasHeight.value = viewport.height+ return+ }++ // A visible-only zoom pass can contain only blank pages. Preserve the+ // dimensions established by the last physical-page render in that case.if (!targetPages.length) return// Get dimensions from first physical page (for new pages and initial layout)diff --git a/client/lib/pdf-editor.js b/client/lib/pdf-editor.jsnew file mode 100644index 000000000..f5b0a2b3a--- /dev/null+++ b/client/lib/pdf-editor.js@@ -0,0 +1,17 @@+export function resolvePdfDownloadUrl(endpoint, baseUrl, origin) {+ const normalizedBaseUrl = (baseUrl || '').replace(/\/+$/, '')+ return new URL(normalizedBaseUrl + endpoint, origin).toString()+}++export function getPdfRenderPages(pageList, currentPage, isNewPage, zoomOnlyVisible = false) {+ const physicalPages = pageList.filter((pageNum) => !isNewPage(pageNum))+ if (!zoomOnlyVisible) {+ return { physicalPages, targetPages: physicalPages }+ }++ const current = Number(currentPage)+ const priorityPages = [current - 1, current, current + 1]+ const targetPages = priorityPages.filter((pageNum) => physicalPages.includes(pageNum))++ return { physicalPages, targetPages }+}diff --git a/client/test/unit/pdf-editor.test.ts b/client/test/unit/pdf-editor.test.tsnew file mode 100644index 000000000..b32f60d43--- /dev/null+++ b/client/test/unit/pdf-editor.test.ts@@ -0,0 +1,44 @@+import { describe, expect, it } from 'vitest'+import { getPdfRenderPages, resolvePdfDownloadUrl } from '../../lib/pdf-editor'++describe('PDF editor helpers', () => {+ describe('resolvePdfDownloadUrl', () => {+ const endpoint = '/open/forms/4/pdf-templates/3/download'+ const origin = 'https://forms.example.com'++ it.each([+ ['/api', 'https://forms.example.com/api/open/forms/4/pdf-templates/3/download'],+ ['/api/', 'https://forms.example.com/api/open/forms/4/pdf-templates/3/download'],+ ['', 'https://forms.example.com/open/forms/4/pdf-templates/3/download'],+ ['https://api.opnform.com', 'https://api.opnform.com/open/forms/4/pdf-templates/3/download'],+ ])('resolves the %s API base', (baseUrl, expectedUrl) => {+ expect(resolvePdfDownloadUrl(endpoint, baseUrl, origin)).toBe(expectedUrl)+ })+ })++ describe('getPdfRenderPages', () => {+ const blankPages = new Set([2, 3, 4])+ const isNewPage = (pageNum: number) => blankPages.has(pageNum)++ it('keeps physical and visible render pages distinct', () => {+ expect(getPdfRenderPages([1, 2, 3, 4, 5], 3, isNewPage, true)).toEqual({+ physicalPages: [1, 5],+ targetPages: [],+ })+ })++ it('selects adjacent physical pages during a visible-only render', () => {+ expect(getPdfRenderPages([1, 2, 3, 4, 5], 2, isNewPage, true)).toEqual({+ physicalPages: [1, 5],+ targetPages: [1],+ })+ })++ it('returns no physical pages for an all-blank template', () => {+ expect(getPdfRenderPages([2, 3, 4], 3, isNewPage)).toEqual({+ physicalPages: [],+ targetPages: [],+ })+ })+ })+})