Merge pull request #995 from Dudrie/add-puppeteer-options

Dudrie · web-flow · commit 4c72856018c7 · 2022-04-25T10:08:37.000+02:00
Add timeout option to pass to puppeteer.
diff --git a/server/config/development.yml b/server/config/development.yml
@@ -8,12 +8,15 @@ sessionTimeout: 120
 handbookUrl: 'https://dudrie.github.io/Tutor-Management-System/'
 
 database:
-    databaseURL: 'mongodb://localhost:27017/tms-new-grading'
-    maxRetries: 2
-    config:
-        authSource: 'admin'
-        authMechanism: 'SCRAM-SHA-1'
+  databaseURL: 'mongodb://localhost:27017/tms-new-grading'
+  maxRetries: 2
+  config:
+    authSource: 'admin'
+    authMechanism: 'SCRAM-SHA-1'
 
 defaultSettings:
-    canTutorExcuseStudents: true
-    defaultTeamSize: 3
+  canTutorExcuseStudents: true
+  defaultTeamSize: 3
+
+puppeteer:
+  timeout: abcd
diff --git a/server/config/production.yml b/server/config/production.yml
@@ -9,13 +9,18 @@ handbookUrl: 'https://dudrie.github.io/Tutor-Management-System/'
 
 # Configuration for the database access. More information can be found in the documentation.
 database:
-    databaseURL: 'mongodb://mongo:27017/tms'
-    maxRetries: 2
-    config:
-        authSource: 'admin'
-        authMechanism: 'SCRAM-SHA-1'
+  databaseURL: 'mongodb://mongo:27017/tms'
+  maxRetries: 2
+  config:
+    authSource: 'admin'
+    authMechanism: 'SCRAM-SHA-1'
 
 # Set specific settings to a default value. These settings can also be edited through the client. More information can be found in the documentation.
 defaultSettings:
-    canTutorExcuseStudents: true
-    defaultTeamSize: 3
+  canTutorExcuseStudents: true
+  defaultTeamSize: 3
+
+# Settings used for the puppeteer instance
+puppeteer:
+  # Timeout in ms
+  timeout: 30000
diff --git a/server/src/module/pdf/subservices/PDFGenerator.core.ts b/server/src/module/pdf/subservices/PDFGenerator.core.ts
@@ -1,6 +1,7 @@
 import { Logger } from '@nestjs/common';
 import fs from 'fs';
 import puppeteer from 'puppeteer';
+import { StaticSettings } from '../../settings/settings.static';
 
 /**
  * @param T Type of the options passed to `generatePDF`.
@@ -17,7 +18,7 @@ export abstract class PDFGenerator<T = Record<string, unknown>> {
     public abstract generatePDF(options: T): Promise<Buffer>;
 
     /**
-     * Generates a PDF from the given body. The body gets put in a HTML wrapper first.
+     * Generates a PDF from the given body. The body gets put in an HTML wrapper first.
      *
      * @param body Body content to be put in the PDF as HTML body.
      *
@@ -34,6 +35,7 @@ export abstract class PDFGenerator<T = Record<string, unknown>> {
             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.');
@@ -90,9 +92,9 @@ export abstract class PDFGenerator<T = Record<string, unknown>> {
     <head>
     <style>${githubCSS}</style>
     <style>${highlightCSS}</style>
-    <style>${this.getCustomCSS()}</style>
+    <style>${PDFGenerator.getCustomCSS()}</style>
     </head>
-    <body class="markdown-body">${body}</body>
+    <body class='markdown-body'>${body}</body>
     </html>
     `;
     }
@@ -126,7 +128,7 @@ export abstract class PDFGenerator<T = Record<string, unknown>> {
     /**
      * @returns Some small customizations to the GitHub markdown CSS.
      */
-    private getCustomCSS(): string {
+    private static getCustomCSS(): string {
         return '.markdown-body table { display: table; width: 100%; }';
     }
 }
diff --git a/server/src/module/settings/model/ApplicationConfiguration.ts b/server/src/module/settings/model/ApplicationConfiguration.ts
@@ -2,6 +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';
 
 export class ApplicationConfiguration {
     @IsOptional()
@@ -25,4 +26,9 @@ export class ApplicationConfiguration {
     @Type(() => ClientSettingsDTO)
     @ValidateNested()
     readonly defaultSettings: ClientSettingsDTO | undefined;
+
+    @IsOptional()
+    @Type(() => PuppeteerConfiguration)
+    @ValidateNested()
+    readonly puppeteer: PuppeteerConfiguration | undefined;
 }
diff --git a/server/src/module/settings/model/PuppeteerConfiguration.ts b/server/src/module/settings/model/PuppeteerConfiguration.ts
@@ -0,0 +1,8 @@
+import { IsNumber, Min } from 'class-validator';
+
+export class PuppeteerConfiguration {
+    // @IsOptional()
+    @IsNumber({}, { always: true })
+    @Min(0)
+    readonly timeout!: number;
+}
diff --git a/server/src/module/settings/settings.service.ts b/server/src/module/settings/settings.service.ts
@@ -3,7 +3,7 @@ import { ReturnModelType } from '@typegoose/typegoose';
 import { InjectModel } from 'nestjs-typegoose';
 import { SettingsDocument, SettingsModel } from '../../database/models/settings.model';
 import { StartUpException } from '../../exceptions/StartUpException';
-import { IClientSettings, IMailingSettings } from '../../shared/model/Settings';
+import { IClientSettings, IMailingSettings } from 'shared/model/Settings';
 import { ClientSettingsDTO } from './settings.dto';
 import { StaticSettings } from './settings.static';
 
diff --git a/server/src/module/settings/settings.static.ts b/server/src/module/settings/settings.static.ts
@@ -10,7 +10,8 @@ import {
     DatabaseConfiguration,
     DatabaseConfigurationValidationGroup,
 } from './model/DatabaseConfiguration';
-import { EnvironmentConfig, ENV_VARIABLE_NAMES } from './model/EnvironmentConfig';
+import { ENV_VARIABLE_NAMES, EnvironmentConfig } from './model/EnvironmentConfig';
+import { PuppeteerConfiguration } from './model/PuppeteerConfiguration';
 
 export class StaticSettings {
     private static service: StaticSettings = new StaticSettings();
@@ -27,7 +28,7 @@ export class StaticSettings {
     constructor() {
         this.config = this.loadConfigFile();
 
-        this.envConfig = this.loadEnvironmentVariables();
+        this.envConfig = StaticSettings.loadEnvironmentVariables();
         this.databaseConfig = this.loadDatabaseConfig();
     }
 
@@ -45,7 +46,7 @@ export class StaticSettings {
     /**
      * Returns the encryption secret for the database.
      *
-     * @returns Encrytion secret.
+     * @returns Encryption secret.
      */
     getDatabaseSecret(): string {
         return this.databaseConfig.secret;
@@ -58,6 +59,13 @@ export class StaticSettings {
         return this.databaseConfig;
     }
 
+    /**
+     *  @returns Configuration for the puppeteer instance. Can be `undefined`.
+     */
+    getPuppeteerConfiguration(): PuppeteerConfiguration | undefined {
+        return this.config.puppeteer;
+    }
+
     /**
      * Returns the value of the `sessionTimeout` setting.
      *
@@ -166,12 +174,12 @@ export class StaticSettings {
      * @returns Valid configuration extracted from the environment variables.
      * @throws `StartUpException` - If not all required environment variables were provided.
      */
-    private loadEnvironmentVariables(): EnvironmentConfig {
+    private static loadEnvironmentVariables(): EnvironmentConfig {
         const envConfig = plainToClass(EnvironmentConfig, process.env, {
             excludeExtraneousValues: true,
         });
 
-        this.assertEnvNoErrors(validateSync(envConfig));
+        StaticSettings.assertEnvNoErrors(validateSync(envConfig));
 
         return envConfig;
     }
@@ -182,7 +190,7 @@ export class StaticSettings {
      * @param errors Array containing validation errors from class-validator (or empty).
      * @throws `StartUpException` - If `errors` is not empty.
      */
-    private assertEnvNoErrors(errors: ValidationError[]) {
+    private static assertEnvNoErrors(errors: ValidationError[]) {
         if (errors.length === 0) {
             return;
         }
