Merge pull request #1059 from TMS-Uni-Stuttgart/puppeteer-to-gotenberg

Puppeteer to gotenberg
TMS-Uni-Stuttgart · Oct 22, 2024 · 8a649f4 · 8a649f4
2 parents 559e269 + a156759
commit 8a649f4
Show file tree

Hide file tree

Showing 13 changed files with 3,032 additions and 3,099 deletions.
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -25,5 +25,13 @@ services:
     networks:
       - tms_dev_db
 
+  gotenberg:
+    container_name: gotenberg
+    image: gotenberg/gotenberg:8
+    ports:
+      - '2000:3000'
+    networks:
+      - tms_dev_db
+
 networks:
   tms_dev_db:
diff --git a/docs/docs/assets/dev/docker-compose.yml b/docs/docs/assets/dev/docker-compose.yml
@@ -22,5 +22,13 @@ services:
     networks:
       - tms_dev_db
 
+  gotenberg:
+    container_name: gotenberg
+    image: gotenberg/gotenberg:8
+    ports:
+      - '2000:3000'
+    networks:
+      - tms_dev_db
+
 networks:
   tms_dev_db:
diff --git a/docs/docs/assets/docker-compose.yml b/docs/docs/assets/docker-compose.yml
@@ -27,9 +27,6 @@ services:
     image: ghcr.io/dudrie/tutor-management-system:<version>
     container_name: tms-server
     restart: on-failure:1
-    cap_add:
-      # This one is needed so puppeteer properly works inside the container (see: https://developers.google.com/web/tools/puppeteer/troubleshooting#tips)
-      - SYS_ADMIN
     depends_on:
       - mysql
     networks:
@@ -43,6 +40,14 @@ services:
       # Replace with the path to the folder containing the configuration and template files of the TMS.
       - <path-to-CONFIG>:/tms/server/config
 
+  gotenberg:
+    container_name: gotenberg
+    image: gotenberg/gotenberg:8
+    ports:
+      - '2000:3000'
+    networks:
+      - tms_db
+
 volumes:
   db_data:
 

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/scripts/build-test-docker/docker-compose.yml b/scripts/build-test-docker/docker-compose.yml
@@ -28,6 +28,14 @@ services:
     volumes:
       - ./config:/tms/server/config
 
+gotenberg:
+    container_name: gotenberg
+    image: gotenberg/gotenberg:8
+    ports:
+      - '2000:3000'
+    networks:
+      - tms_db
+
 volumes:
   db_data:
 

diff --git a/server/config/development.yml b/server/config/development.yml
@@ -9,17 +9,19 @@ handbookUrl: 'https://dudrie.github.io/Tutor-Management-System/'
 
 # Configuration for the database access. More information can be found in the documentation.
 database:
-  host: localhost
-  port: 3306
-  databaseName: tms-big-db
-  maxRetries: 2
-  reconnectTimeout: 10000
+    host: localhost
+    port: 3306
+    databaseName: tms-big-db
+    maxRetries: 2
+    reconnectTimeout: 10000
 
 defaultSettings:
-  canTutorExcuseStudents: true
-  defaultTeamSize: 3
+    canTutorExcuseStudents: true
+    defaultTeamSize: 3
 
-# Settings used for the puppeteer instance
-puppeteer:
-  # Timeout in ms
-  timeout: 30000
+# Settings used for the gotenberg instance
+gotenberg:
+    host: localhost
+    port: 2000
+    # Timeout in ms
+    timeout: 30000
diff --git a/server/config/production.yml b/server/config/production.yml
@@ -9,17 +9,19 @@ handbookUrl: 'https://dudrie.github.io/Tutor-Management-System/'
 
 # Configuration for the database access. More information can be found in the documentation.
 database:
-  host: tms_sql
-  port: 3306
-  databaseName: tms-db
-  maxRetries: 2
-  reconnectTimeout: 10000
+    host: tms_sql
+    port: 3306
+    databaseName: tms-db
+    maxRetries: 2
+    reconnectTimeout: 10000
 
 defaultSettings:
-  canTutorExcuseStudents: true
-  defaultTeamSize: 3
+    canTutorExcuseStudents: true
+    defaultTeamSize: 3
 
-# Settings used for the puppeteer instance
-puppeteer:
-  # Timeout in ms
-  timeout: 30000
+# Settings used for the gotenberg instance
+gotenberg:
+    host: gotenberg
+    port: 3000
+    # Timeout in ms
+    timeout: 30000
diff --git a/server/package.json b/server/package.json
@@ -35,11 +35,13 @@
         "@nestjs/passport": "^9.0.0",
         "@nestjs/platform-express": "^9.0.11",
         "@nestjs/swagger": "^6.1.0",
+        "axios": "^1.7.7",
         "bcryptjs": "^2.4.3",
         "body-parser": "^1.20.0",
         "class-validator": "^0.13.2",
         "excel4node": "^1.8.0",
         "express-session": "^1.17.3",
+        "form-data": "^4.0.1",
         "highlight.js": "^10.7.2",
         "jszip": "^3.10.1",
         "luxon": "^1.25.0",
@@ -48,7 +50,6 @@
         "passport": "^0.6.0",
         "passport-local": "^1.0.0",
         "pug": "^3.0.2",
-        "puppeteer": "5.5.0",
         "reflect-metadata": "^0.1.13",
         "rimraf": "^3.0.2",
         "rxjs": "^7.5.6",
@@ -73,7 +74,6 @@
         "@types/passport": "^1.0.10",
         "@types/passport-local": "^1.0.34",
         "@types/pug": "^2.0.6",
-        "@types/puppeteer": "5.4.2",
         "@types/supertest": "^2.0.12",
         "@types/uuid": "^8.3.4",
         "jest": "^29.0.0",

diff --git a/server/src/module/pdf/subservices/PDFGenerator.core.ts b/server/src/module/pdf/subservices/PDFGenerator.core.ts
@@ -1,9 +1,10 @@
 // noinspection HtmlRequiredLangAttribute,HtmlRequiredTitleElement
 
 import { Logger } from '@nestjs/common';
+import axios from 'axios';
+import FormData from 'form-data';
 import fs from 'fs';
-import puppeteer from 'puppeteer';
-import { StaticSettings } from '../../settings/settings.static';
+import { StaticSettings } from 'module/settings/settings.static';
 
 /**
  * @param T Type of the options passed to `generatePDF`.
@@ -29,52 +30,31 @@ export abstract class PDFGenerator<T = Record<string, unknown>> {
      */
     protected async generatePDFFromBodyContent(body: string): Promise<Buffer> {
         const html = await this.putBodyInHTML(body);
-        let browser: puppeteer.Browser | undefined;
-
-        this.logger.debug('Starting browser...');
-        this.logger.debug(`\tExec path: ${process.env.TMS_PUPPETEER_EXEC_PATH}`);
+        const gotenbergConfig = StaticSettings.getService().getGotenbergConfiguration();
 
         try {
-            browser = await puppeteer.launch({
-                args: ['--disable-dev-shm-usage'],
-                executablePath: process.env.TMS_PUPPETEER_EXEC_PATH,
-                timeout: StaticSettings.getService().getPuppeteerConfiguration()?.timeout,
-            });
-
-            this.logger.debug('Browser started.');
-
-            const page = await browser.newPage();
-            this.logger.debug('Page created.');
-
-            await page.setContent(html, { waitUntil: 'domcontentloaded' });
-            this.logger.debug('Page content loaded');
-
-            const buffer = await page.pdf({
-                format: 'A4',
-                margin: {
-                    top: '1cm',
-                    right: '1cm',
-                    bottom: '1cm',
-                    left: '1cm',
-                },
-                // Fixes CSS 'background' not being respected in printed PDFs.
-                printBackground: true,
-            });
-
-            this.logger.debug('PDF created.');
-
-            await browser.close();
-
-            this.logger.debug('Browser closed');
-
-            return buffer;
+            const form = new FormData();
+            form.append('files', html, { filename: 'index.html', contentType: 'text/html' });
+
+            this.logger.debug('Sending request to Gotenberg for PDF generation...');
+
+            const response = await axios.post(
+                `http://${gotenbergConfig?.host}:${gotenbergConfig?.port}/forms/chromium/convert/html`,
+                form,
+                {
+                    headers: {
+                        ...form.getHeaders(),
+                    },
+                    timeout: gotenbergConfig?.timeout,
+                    responseType: 'arraybuffer',
+                }
+            );
+
+            this.logger.debug('PDF generated successfully from Gotenberg.');
+
+            return Buffer.from(response.data);
         } catch (err) {
-            if (browser) {
-                await browser.close();
-            }
-
-            Logger.error(JSON.stringify(err, null, 2));
-
+            this.logger.error('Failed to generate PDF:', err);
             throw err;
         }
     }

diff --git a/server/src/module/settings/model/ApplicationConfiguration.ts b/server/src/module/settings/model/ApplicationConfiguration.ts
@@ -2,7 +2,7 @@ import { Type } from 'class-transformer';
 import { IsNumber, IsOptional, IsString, IsUrl, Min, ValidateNested } from 'class-validator';
 import { ClientSettingsDTO } from '../settings.dto';
 import { DatabaseConfiguration } from './DatabaseConfiguration';
-import { PuppeteerConfiguration } from './PuppeteerConfiguration';
+import { GotenbergConfiguration } from './GotenbergConfiguration';
 
 export class ApplicationConfiguration {
     @IsOptional()
@@ -28,7 +28,7 @@ export class ApplicationConfiguration {
     readonly defaultSettings: ClientSettingsDTO | undefined;
 
     @IsOptional()
-    @Type(() => PuppeteerConfiguration)
+    @Type(() => GotenbergConfiguration)
     @ValidateNested()
-    readonly puppeteer: PuppeteerConfiguration | undefined;
+    readonly gotenberg: GotenbergConfiguration | undefined;
 }
diff --git a/server/src/module/settings/model/GotenbergConfiguration.ts b/server/src/module/settings/model/GotenbergConfiguration.ts
@@ -0,0 +1,14 @@
+import { IsNumber, IsString, Min } from 'class-validator';
+
+export class GotenbergConfiguration {
+    @IsString()
+    readonly host!: string;
+
+    @IsNumber({}, { always: true })
+    @Min(0)
+    readonly timeout!: number;
+
+    @IsNumber({}, { always: true })
+    @Min(0)
+    readonly port!: number;
+}
diff --git a/server/src/module/settings/model/PuppeteerConfiguration.ts b/server/src/module/settings/model/PuppeteerConfiguration.ts
diff --git a/server/src/module/settings/settings.static.ts b/server/src/module/settings/settings.static.ts
@@ -12,7 +12,7 @@ import {
     DatabaseConnectionOptions,
 } from './model/DatabaseConfiguration';
 import { ENV_VARIABLE_NAMES, EnvironmentConfig } from './model/EnvironmentConfig';
-import { PuppeteerConfiguration } from './model/PuppeteerConfiguration';
+import { GotenbergConfiguration } from './model/GotenbergConfiguration';
 
 export class StaticSettings {
     private static service: StaticSettings = new StaticSettings();
@@ -74,10 +74,10 @@ export class StaticSettings {
     }
 
     /**
-     *  @returns Configuration for the puppeteer instance. Can be `undefined`.
+     *  @returns Configuration for the gotenberg instance. Can be `undefined`.
      */
-    getPuppeteerConfiguration(): PuppeteerConfiguration | undefined {
-        return this.config.puppeteer;
+    getGotenbergConfiguration(): GotenbergConfiguration | undefined {
+        return this.config.gotenberg;
     }
 
     /**