Ryan/documenso
1
0
Fork 1
mirror of https://github.com/documenso/documenso.git synced 2025-11-10 12:32:34 +10:00
Code Issues Packages Projects Releases Wiki Activity

fix: set correct envelope item cache url (#2144)

Browse Source
This commit is contained in:
David Nguyen
2025-11-07 16:50:58 +11:00
committed by GitHub
parent 1650c55b19
commit 88371b665a
7 changed files with 52 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
apps/remix/server/api/files/files.helpers.ts
View File

@ -59,7 +59,7 @@ export const handleEnvelopeItemFileRequest = async ({
c.header('Cache-Control', 'public, max-age=31536000, immutable'); c.header('Cache-Control', 'public, max-age=31536000, immutable');
} else { } else {
// Set a tiny 1 minute cache, with must-revalidate to ensure the client always checks for updates. // Set a tiny 1 minute cache, with must-revalidate to ensure the client always checks for updates.
c.header('Cache-Control', 'public, max-age=60, must-revalidate'); c.header('Cache-Control', 'public, max-age=0, must-revalidate');
} }
} }

8
packages/app-tests/e2e/envelopes/envelope-alignment.spec.ts
View File

@ -25,7 +25,7 @@ import { DocumentStatus } from '@prisma/client';
import fs from 'node:fs'; import fs from 'node:fs';
import path from 'node:path'; import path from 'node:path';
import * as pdfjsLib from 'pdfjs-dist/legacy/build/pdf.js'; import * as pdfjsLib from 'pdfjs-dist/legacy/build/pdf.js';
import { getEnvelopeDownloadUrl } from '@documenso/lib/utils/envelope-download'; import { getEnvelopeItemPdfUrl } from '@documenso/lib/utils/envelope-download';
import { prisma } from '@documenso/prisma'; import { prisma } from '@documenso/prisma';
import { seedAlignmentTestDocument } from '@documenso/prisma/seed/initial-seed'; import { seedAlignmentTestDocument } from '@documenso/prisma/seed/initial-seed';
import { seedUser } from '@documenso/prisma/seed/users'; import { seedUser } from '@documenso/prisma/seed/users';
@ -94,7 +94,8 @@ test.skip('field placement visual regression', async ({ page }, testInfo) => {
await Promise.all( await Promise.all(
completedDocument.envelopeItems.map(async (item) => { completedDocument.envelopeItems.map(async (item) => {
const documentUrl = getEnvelopeDownloadUrl({ const documentUrl = getEnvelopeItemPdfUrl({
type: 'download',
envelopeItem: item, envelopeItem: item,
token, token,
version: 'signed', version: 'signed',
@ -179,7 +180,8 @@ test.skip('download envelope images', async ({ page }) => {
await Promise.all( await Promise.all(
completedDocument.envelopeItems.map(async (item) => { completedDocument.envelopeItems.map(async (item) => {
const documentUrl = getEnvelopeDownloadUrl({ const documentUrl = getEnvelopeItemPdfUrl({
type: 'download',
envelopeItem: item, envelopeItem: item,
token, token,
version: 'signed', version: 'signed',

20
packages/app-tests/e2e/features/include-document-certificate.spec.ts
View File

@ -3,7 +3,7 @@ import { expect, test } from '@playwright/test';
import { DocumentStatus, FieldType } from '@prisma/client'; import { DocumentStatus, FieldType } from '@prisma/client';
import { getDocumentByToken } from '@documenso/lib/server-only/document/get-document-by-token'; import { getDocumentByToken } from '@documenso/lib/server-only/document/get-document-by-token';
import { getEnvelopeDownloadUrl } from '@documenso/lib/utils/envelope-download'; import { getEnvelopeItemPdfUrl } from '@documenso/lib/utils/envelope-download';
import { prisma } from '@documenso/prisma'; import { prisma } from '@documenso/prisma';
import { seedPendingDocumentWithFullFields } from '@documenso/prisma/seed/documents'; import { seedPendingDocumentWithFullFields } from '@documenso/prisma/seed/documents';
import { seedTeam } from '@documenso/prisma/seed/teams'; import { seedTeam } from '@documenso/prisma/seed/teams';
@ -34,7 +34,8 @@ test.describe('Signing Certificate Tests', () => {
}, },
}) })
.then(async (data) => { .then(async (data) => {
const documentUrl = getEnvelopeDownloadUrl({ const documentUrl = getEnvelopeItemPdfUrl({
type: 'download',
envelopeItem: data, envelopeItem: data,
token: recipient.token, token: recipient.token,
version: 'signed', version: 'signed',
@ -85,7 +86,8 @@ test.describe('Signing Certificate Tests', () => {
const firstDocumentData = completedDocument.envelopeItems[0]; const firstDocumentData = completedDocument.envelopeItems[0];
const documentUrl = getEnvelopeDownloadUrl({ const documentUrl = getEnvelopeItemPdfUrl({
type: 'download',
envelopeItem: firstDocumentData, envelopeItem: firstDocumentData,
token: recipient.token, token: recipient.token,
version: 'signed', version: 'signed',
@ -139,7 +141,8 @@ test.describe('Signing Certificate Tests', () => {
}, },
}) })
.then(async (data) => { .then(async (data) => {
const documentUrl = getEnvelopeDownloadUrl({ const documentUrl = getEnvelopeItemPdfUrl({
type: 'download',
envelopeItem: data, envelopeItem: data,
token: recipient.token, token: recipient.token,
version: 'signed', version: 'signed',
@ -188,7 +191,8 @@ test.describe('Signing Certificate Tests', () => {
const firstDocumentData = completedDocument.envelopeItems[0]; const firstDocumentData = completedDocument.envelopeItems[0];
const documentUrl = getEnvelopeDownloadUrl({ const documentUrl = getEnvelopeItemPdfUrl({
type: 'download',
envelopeItem: firstDocumentData, envelopeItem: firstDocumentData,
token: recipient.token, token: recipient.token,
version: 'signed', version: 'signed',
@ -242,7 +246,8 @@ test.describe('Signing Certificate Tests', () => {
}, },
}) })
.then(async (data) => { .then(async (data) => {
const documentUrl = getEnvelopeDownloadUrl({ const documentUrl = getEnvelopeItemPdfUrl({
type: 'download',
envelopeItem: data, envelopeItem: data,
token: recipient.token, token: recipient.token,
version: 'signed', version: 'signed',
@ -289,7 +294,8 @@ test.describe('Signing Certificate Tests', () => {
}, },
}); });
const documentUrl = getEnvelopeDownloadUrl({ const documentUrl = getEnvelopeItemPdfUrl({
type: 'download',
envelopeItem: completedDocument.envelopeItems[0], envelopeItem: completedDocument.envelopeItems[0],
token: recipient.token, token: recipient.token,
version: 'signed', version: 'signed',

5
packages/lib/client-only/download-pdf.ts
View File

@ -1,6 +1,6 @@
import type { EnvelopeItem } from '@prisma/client'; import type { EnvelopeItem } from '@prisma/client';
import { getEnvelopeDownloadUrl } from '../utils/envelope-download'; import { getEnvelopeItemPdfUrl } from '../utils/envelope-download';
import { downloadFile } from './download-file'; import { downloadFile } from './download-file';
type DocumentVersion = 'original' | 'signed'; type DocumentVersion = 'original' | 'signed';
@ -24,7 +24,8 @@ export const downloadPDF = async ({
fileName, fileName,
version = 'signed', version = 'signed',
}: DownloadPDFProps) => { }: DownloadPDFProps) => {
const downloadUrl = getEnvelopeDownloadUrl({ const downloadUrl = getEnvelopeItemPdfUrl({
type: 'download',
envelopeItem: envelopeItem, envelopeItem: envelopeItem,
token, token,
version, version,

6
packages/lib/client-only/providers/envelope-render-provider.tsx
View File

@ -8,7 +8,7 @@ import { AVAILABLE_RECIPIENT_COLORS } from '@documenso/ui/lib/recipient-colors';
import type { TEnvelope } from '../../types/envelope'; import type { TEnvelope } from '../../types/envelope';
import type { FieldRenderMode } from '../../universal/field-renderer/render-field'; import type { FieldRenderMode } from '../../universal/field-renderer/render-field';
import { getEnvelopeDownloadUrl } from '../../utils/envelope-download'; import { getEnvelopeItemPdfUrl } from '../../utils/envelope-download';
type FileData = type FileData =
| { | {
@ -124,10 +124,10 @@ export const EnvelopeRenderProvider = ({
} }
try { try {
const downloadUrl = getEnvelopeDownloadUrl({ const downloadUrl = getEnvelopeItemPdfUrl({
type: 'view',
envelopeItem: envelopeItem, envelopeItem: envelopeItem,
token, token,
version: 'signed',
}); });
const blob = await fetch(downloadUrl).then(async (res) => await res.blob()); const blob = await fetch(downloadUrl).then(async (res) => await res.blob());

33
packages/lib/utils/envelope-download.ts
View File

@ -2,18 +2,33 @@ import type { EnvelopeItem } from '@prisma/client';
import { NEXT_PUBLIC_WEBAPP_URL } from '../constants/app'; import { NEXT_PUBLIC_WEBAPP_URL } from '../constants/app';
export type EnvelopeDownloadUrlOptions = { export type EnvelopeItemPdfUrlOptions =
envelopeItem: Pick<EnvelopeItem, 'id' | 'envelopeId'>; | {
token: string | undefined; type: 'download';
version: 'original' | 'signed'; envelopeItem: Pick<EnvelopeItem, 'id' | 'envelopeId'>;
}; token: string | undefined;
version: 'original' | 'signed';
}
| {
type: 'view';
envelopeItem: Pick<EnvelopeItem, 'id' | 'envelopeId'>;
token: string | undefined;
};
export const getEnvelopeDownloadUrl = (options: EnvelopeDownloadUrlOptions) => { export const getEnvelopeItemPdfUrl = (options: EnvelopeItemPdfUrlOptions) => {
const { envelopeItem, token, version } = options; const { envelopeItem, token, type } = options;
const { id, envelopeId } = envelopeItem; const { id, envelopeId } = envelopeItem;
if (type === 'download') {
const version = options.version;
return token
? `${NEXT_PUBLIC_WEBAPP_URL()}/api/files/token/${token}/envelopeItem/${id}/download/${version}`
: `${NEXT_PUBLIC_WEBAPP_URL()}/api/files/envelope/${envelopeId}/envelopeItem/${id}/download/${version}`;
}
return token return token
? `${NEXT_PUBLIC_WEBAPP_URL()}/api/files/token/${token}/envelopeItem/${id}/download/${version}` ? `${NEXT_PUBLIC_WEBAPP_URL()}/api/files/token/${token}/envelopeItem/${id}`
: `${NEXT_PUBLIC_WEBAPP_URL()}/api/files/envelope/${envelopeId}/envelopeItem/${id}/download/${version}`; : `${NEXT_PUBLIC_WEBAPP_URL()}/api/files/envelope/${envelopeId}/envelopeItem/${id}`;
}; };

6
packages/ui/primitives/pdf-viewer.tsx
View File

@ -12,7 +12,7 @@ import 'react-pdf/dist/esm/Page/AnnotationLayer.css';
import 'react-pdf/dist/esm/Page/TextLayer.css'; import 'react-pdf/dist/esm/Page/TextLayer.css';
import { PDF_VIEWER_PAGE_SELECTOR } from '@documenso/lib/constants/pdf-viewer'; import { PDF_VIEWER_PAGE_SELECTOR } from '@documenso/lib/constants/pdf-viewer';
import { getEnvelopeDownloadUrl } from '@documenso/lib/utils/envelope-download'; import { getEnvelopeItemPdfUrl } from '@documenso/lib/utils/envelope-download';
import { cn } from '../lib/utils'; import { cn } from '../lib/utils';
import { useToast } from './use-toast'; import { useToast } from './use-toast';
@ -157,10 +157,10 @@ export const PDFViewer = ({
try { try {
setIsDocumentBytesLoading(true); setIsDocumentBytesLoading(true);
const documentUrl = getEnvelopeDownloadUrl({ const documentUrl = getEnvelopeItemPdfUrl({
type: 'view',
envelopeItem: envelopeItem, envelopeItem: envelopeItem,
token, token,
version,
}); });
const bytes = await fetch(documentUrl).then(async (res) => await res.arrayBuffer()); const bytes = await fetch(documentUrl).then(async (res) => await res.arrayBuffer());