Forbedrer feilhåndtering ved pdf-generering

anders-nom · anders-nom · commit e7b78810d193 · 2024-02-09T09:45:35.000+01:00
diff --git a/common/pruneString.ts b/common/pruneString.ts
@@ -0,0 +1,7 @@
+export const pruneString = (str: string, maxLength: number) => {
+    if (str.length <= maxLength) {
+        return str;
+    }
+
+    return `${str.slice(0, maxLength)} (...)`;
+};
diff --git a/server/src/cms/CmsArchiveSite.ts b/server/src/cms/CmsArchiveSite.ts
@@ -165,11 +165,9 @@ export class CmsArchiveSite {
 
             const { filename, data } = result;
 
-            const contentType = mime.lookup(filename) || 'application/octet-stream';
-
             return res
                 .setHeader('Content-Disposition', `attachment; filename="${filename}"`)
-                .setHeader('Content-Type', contentType)
+                .setHeader('Content-Type', 'application/pdf')
                 .cookie(DOWNLOAD_COOKIE_NAME, true)
                 .send(data);
         });
@@ -255,11 +253,9 @@ export class CmsArchiveSite {
         contentDisposition: string,
         res: Response
     ) {
-        const contentType = mime.lookup(filename) || 'application/octet-stream';
-
         return res
             .setHeader('Content-Disposition', contentDisposition)
-            .setHeader('Content-Type', contentType)
+            .setHeader('Content-Type', mime.lookup(filename, 'application/octet-stream'))
             .send(Buffer.from(base64Data, 'base64'));
     }
 }
diff --git a/server/src/pdf/PdfGenerator.ts b/server/src/pdf/PdfGenerator.ts
@@ -1,10 +1,14 @@
 import { Browser } from 'puppeteer';
 import { CmsArchiveContentService } from '../cms/CmsArchiveContentService';
-import { generatePdfFilename, generatePdfFooter, pixelWidthToA4Scale } from './pdf-utils';
+import {
+    generateErrorFilename,
+    generatePdfFilename,
+    generatePdfFooter,
+    pixelWidthToA4Scale,
+} from './pdf-utils';
 import { CmsContent } from '../../../common/cms-documents/content';
 import archiver from 'archiver';
 import { Response } from 'express';
-import mime from 'mime';
 import { DOWNLOAD_COOKIE_NAME } from '../../../common/downloadCookie';
 
 const DEFAULT_WIDTH_PX = 1024;
@@ -35,21 +39,27 @@ export class PdfGenerator {
         width: number = DEFAULT_WIDTH_PX
     ) {
         if (versionKeys.length === 0) {
-            return res.status(400).send();
+            return res
+                .status(400)
+                .cookie(DOWNLOAD_COOKIE_NAME, false)
+                .send('Version keys array must be non-empty');
         }
 
         const contentVersions = await this.contentService.getContentVersions(versionKeys);
         if (!contentVersions || contentVersions.length === 0) {
-            return res.status(404).cookie(DOWNLOAD_COOKIE_NAME, false).send();
+            return res
+                .status(404)
+                .cookie(DOWNLOAD_COOKIE_NAME, false)
+                .send('No content versions found');
         }
 
         const newestVersion = contentVersions[0];
-        const oldestVersion = contentVersions.slice(-1)[0];
+        const oldestVersion = contentVersions[contentVersions.length - 1];
 
-        const zipFilename = `${newestVersion.name}_${newestVersion.meta.timestamp}-${oldestVersion.meta.timestamp}.zip`;
+        const zipFilename = `${newestVersion.name}_${oldestVersion.meta.timestamp}-${newestVersion.meta.timestamp}.zip`;
 
         res.setHeader('Content-Disposition', `attachment; filename="${zipFilename}"`)
-            .setHeader('Content-Type', mime.lookup(zipFilename) || 'application/octet-stream')
+            .setHeader('Content-Type', 'application/zip')
             .setHeader('Transfer-Encoding', 'chunked')
             .cookie(DOWNLOAD_COOKIE_NAME, true);
 
@@ -68,20 +78,14 @@ export class PdfGenerator {
                 continue;
             }
 
-            await this.generateContentPdf(content, width).then((pdf) => {
-                if (!pdf) {
-                    return;
-                }
-
+            await this.generateContentPdf(content, width).then((result) => {
                 if (!res.headersSent) {
                     // Set an estimate for content-length, which allows clients to track the download progress
                     // This header is not according to spec for chunked responses, but browsers seem to respect it
-                    res.setHeader('Content-Length', pdf.length * contentVersions.length);
+                    res.setHeader('Content-Length', result.data.length * contentVersions.length);
                 }
 
-                const fileName = generatePdfFilename(content);
-
-                archive.append(pdf, { name: fileName });
+                archive.append(result.data, { name: result.filename });
             });
         }
 
@@ -97,21 +101,18 @@ export class PdfGenerator {
             return null;
         }
 
-        const data = await this.generateContentPdf(content, width);
-        if (!data) {
-            return null;
-        }
-
-        return {
-            data,
-            filename: generatePdfFilename(content),
-        };
+        return this.generateContentPdf(content, width);
     }
 
-    private async generateContentPdf(content: CmsContent, width: number): Promise<Buffer | null> {
-        const { html } = content;
+    private async generateContentPdf(content: CmsContent, width: number): Promise<PdfResult> {
+        const { html, versionKey } = content;
         if (!html) {
-            return null;
+            return {
+                data: Buffer.from(
+                    `Could not generate PDF from content version ${versionKey} - HTML field was empty`
+                ),
+                filename: generateErrorFilename(content),
+            };
         }
 
         const widthActual = width >= MIN_WIDTH_PX ? width : DEFAULT_WIDTH_PX;
@@ -145,10 +146,17 @@ export class PdfGenerator {
 
             await page.close();
 
-            return pdf;
+            return {
+                data: pdf,
+                filename: generatePdfFilename(content),
+            };
         } catch (e) {
-            console.error(`Error while generating PDF - ${e}`);
-            return null;
+            const msg = `Error while generating PDF for content version ${versionKey} - ${e}`;
+            console.error(msg);
+            return {
+                data: Buffer.from(msg),
+                filename: generateErrorFilename(content),
+            };
         }
     }
 }
diff --git a/server/src/pdf/pdf-utils.ts b/server/src/pdf/pdf-utils.ts
@@ -1,25 +1,28 @@
-import { CmsContent, CmsContentDocument } from '../../../common/cms-documents/content';
+import { CmsContent } from '../../../common/cms-documents/content';
 import { formatTimestamp } from '../../../common/timestamp';
+import { pruneString } from '../../../common/pruneString';
 
 const PUPPETEER_PDF_DPI = 96;
 const A4_INCH_WIDTH = 8.27;
 const SCALE_FACTOR = PUPPETEER_PDF_DPI * A4_INCH_WIDTH;
 
-const MIN = 0.1;
-const MAX = 2;
+const MIN_SCALE = 0.1;
+const MAX_SCALE = 2;
 
-export const pixelWidthToA4Scale = (pxWidth: number): number =>
-    Math.max(MIN, Math.min(MAX, (1 / pxWidth) * SCALE_FACTOR));
+export const pixelWidthToA4Scale = (pxWidth: number) =>
+    Math.max(MIN_SCALE, Math.min(MAX_SCALE, (1 / pxWidth) * SCALE_FACTOR));
 
 export const generatePdfFooter = (content: CmsContent) => `
-    <div style="font-size: 10px; margin-bottom:-16px; padding: 4px; width: 100%; display: flex; justify-content: space-between; flex-wrap: nowrap">
-        <div style="white-space: nowrap; overflow-x: hidden; text-overflow: ellipsis; flex-shrink: 1">
-            ${content.displayName}
-        </div>
-        <div style="white-space: nowrap; flex-shrink: 0">
-            [${formatTimestamp(content.meta.timestamp)} // version: ${content.versionKey}] - (<span class="pageNumber"></span>/<span class="totalPages"></span>)
+    <div style="font-size: 10px; margin-bottom:-16px; padding: 4px; width: 100%; display: flex; justify-content: space-between; white-space: nowrap">
+        <div style="overflow-x: hidden; text-overflow: ellipsis">${pruneString(content.displayName, 110)}</div>
+        <div>
+            [Endret: ${formatTimestamp(content.meta.timestamp)} // Versjon: ${content.versionKey}] - (<span class="pageNumber"></span>/<span class="totalPages"></span>)
         </div>
     </div>`;
 
-export const generatePdfFilename = (content: CmsContentDocument) =>
-    `${content.meta.timestamp}_${content.name}_${content.contentKey}-${content.versionKey}.pdf`;
+const generateFilename = (content: CmsContent) =>
+    `${content.meta.timestamp}_${content.name}_${content.contentKey}-${content.versionKey}`;
+
+export const generatePdfFilename = (content: CmsContent) => `${generateFilename(content)}.pdf`;
+
+export const generateErrorFilename = (content: CmsContent) => `${generateFilename(content)}.txt`;
diff --git a/src/components/main-section/content-view/version-selector/VersionSelector.tsx b/src/components/main-section/content-view/version-selector/VersionSelector.tsx
@@ -4,6 +4,7 @@ import { CmsContent } from '../../../../../common/cms-documents/content';
 import { useApiFetch } from '../../../../fetch/useApiFetch';
 import { useAppState } from '../../../../context/app-state/useAppState';
 import { formatTimestamp } from '../../../../../common/timestamp';
+import { pruneString } from '../../../../../common/pruneString';
 
 const TITLE_MAX_LENGTH = 100;
 
@@ -39,18 +40,10 @@ export const VersionSelector = ({ content }: Props) => {
                 const dateTime = formatTimestamp(version.timestamp);
                 return (
                     <option value={version.key} key={version.key}>
-                        {`${pruneTitle(version.title)} - [${dateTime}]`}
+                        {`${pruneString(version.title, TITLE_MAX_LENGTH)} - [${dateTime}]`}
                     </option>
                 );
             })}
         </Select>
     );
 };
-
-const pruneTitle = (title: string) => {
-    if (title.length < TITLE_MAX_LENGTH) {
-        return title;
-    }
-
-    return `${title.slice(0, TITLE_MAX_LENGTH)} (...)`;
-};
