Améliorer la saisie avec un éditeur WYSIWYG

.github/workflows/prune-images.yml

@@ -0,0 +1,19 @@
+name: prune-images
+
+on:
+  schedule:
+    - cron: "0 0 1 * *" # Runs at 00:00, on day 1 of the month
+  workflow_dispatch: # Can also be run manually from the github UI
+
+jobs:
+  request_pruning:
+    name: Request images pruning
+    runs-on: ubuntu-latest
+
+    steps:
+      - env:
+          PRUNING_ACCESS_TOKEN: ${{ secrets.PRUNING_ACCESS_TOKEN }}
+        run: |
+          curl 'https://ara.numerique.gouv.fr/api/system/prune-uploads' 
+            -H 'X-PruneToken: Bearer "$PRUNING_ACCESS_TOKEN"' 
+            -d ''

.vscode/launch.json

@@ -0,0 +1,40 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    // Frontend (Chrome)
+    {
+      "type": "chrome",
+      "request": "launch",
+      "name": "FRONT (Vue.js) – Chrome",
+      "url": "http://localhost:3000",
+      "webRoot": "${workspaceFolder}/confiture-web-app/src",
+      "sourceMapPathOverrides": {
+        "webpack:///src/*": "${webRoot}/*"
+      }
+    },
+    // Frontend (Chrome)
+    {
+      "type": "firefox",
+      "request": "launch",
+      "name": "FRONT (Vue.js) – Firefox",
+      "url": "http://localhost:3000",
+      "webRoot": "${workspaceFolder}/confiture-web-app/src",
+      "pathMappings": [
+        { "url": "webpack:///confiture-web-app/src/", "path": "${webRoot}/" }
+      ]
+    },
+    // Backend (REST API)
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "BACKEND (nest)",
+      "runtimeExecutable": "npm",
+      "runtimeArgs": ["run", "start:debug", "--", "--inspect-brk"],
+      "autoAttachChildProcesses": true,
+      "restart": true,
+      "sourceMaps": true,
+      "stopOnEntry": false,
+      "console": "integratedTerminal"
+    }
+  ]
+}

confiture-rest-api/.env.example

@@ -19,4 +19,8 @@ S3_VIRTUAL_HOST="xxx"
 AWS_ACCESS_KEY_ID="xxx"
 AWS_SECRET_ACCESS_KEY="xxx"
 
-JWT_SECRET="xxx"
+JWT_SECRET="xxx"
+
+# Debug Prisma queries
+# More info: [Logging | Prisma Documentation](https://www.prisma.io/docs/orm/prisma-client/observability-and-logging/logging)
+DEBUG="prisma:query"

confiture-rest-api/prisma/migrations/20240906161141_add_display_field_on_files_attachment_or_editor/migration.sql

@@ -0,0 +1,8 @@
+-- CreateEnum
+CREATE TYPE "FileDisplay" AS ENUM ('EDITOR', 'ATTACHMENT');
+
+-- AlterTable
+ALTER TABLE "AuditFile" ADD COLUMN     "display" "FileDisplay" NOT NULL DEFAULT 'ATTACHMENT';
+
+-- AlterTable
+ALTER TABLE "StoredFile" ADD COLUMN     "display" "FileDisplay" NOT NULL DEFAULT 'ATTACHMENT';

confiture-rest-api/prisma/migrations/20250121151450_add_audit_file_creation_date/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "AuditFile" ADD COLUMN     "creationDate" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP;

confiture-rest-api/prisma/migrations/20250124221428_add_stored_file_creation_date/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "StoredFile" ADD COLUMN     "creationDate" TIMESTAMP(3) NOT NULL DEFAULT CURRENT_TIMESTAMP;

confiture-rest-api/prisma/migrations/20250126234052_thumbnail_optional_for_stored_file/migration.sql

@@ -0,0 +1,2 @@
+-- AlterTable
+ALTER TABLE "StoredFile" ALTER COLUMN "thumbnailKey" DROP NOT NULL;

confiture-rest-api/prisma/schema.prisma

@@ -169,6 +169,11 @@ model AuditTrace {
   Audit                Audit?
 }
 
+enum FileDisplay {
+  EDITOR
+  ATTACHMENT
+}
+
 model StoredFile {
   id               Int    @id @default(autoincrement())
   originalFilename String
@@ -182,7 +187,12 @@ model StoredFile {
 
   // S3 storage keys
   key          String
-  thumbnailKey String
+  thumbnailKey String?
+
+  // Inside TipTap editor (EDITOR) or added as an attachment (ATTACHMENT)?
+  display FileDisplay @default(ATTACHMENT)
+
+  creationDate DateTime @default(now())
 
   criterionResult   CriterionResult? @relation(fields: [criterionResultId], references: [id], onDelete: Cascade, onUpdate: Cascade)
   criterionResultId Int?
@@ -203,6 +213,11 @@ model AuditFile {
   key          String
   thumbnailKey String?
 
+  creationDate DateTime @default(now())
+
+  // Inside TipTap editor (EDITOR) or added as an attachment (ATTACHMENT)?
+  display FileDisplay @default(ATTACHMENT)
+
   audit         Audit?  @relation(fields: [auditUniqueId], references: [editUniqueId], onDelete: Cascade)
   auditUniqueId String?
 }

confiture-rest-api/src/app.module.ts

@@ -7,6 +7,7 @@ import { configValidationSchema } from "./config-validation-schema";
 import { MailModule } from "./mail/mail.module";
 import { AuthModule } from "./auth/auth.module";
 import { ProfileModule } from "./profile/profile.module";
+import { SystemModule } from "./system/system.module";
 import { UserMiddleware } from "./auth/user.middleware";
 
 @Module({
@@ -19,7 +20,8 @@ import { UserMiddleware } from "./auth/user.middleware";
     AuditsModule,
     MailModule,
     AuthModule,
-    ProfileModule
+    ProfileModule,
+    SystemModule
   ],
   controllers: [HealthCheckController]
 })

confiture-rest-api/src/audits/audit.service.ts

@@ -4,6 +4,7 @@ import {
   CriterionResult,
   CriterionResultStatus,
   CriterionResultUserImpact,
+  FileDisplay,
   Prisma,
   StoredFile
 } from "@prisma/client";
@@ -418,30 +419,14 @@ export class AuditService {
     pageId: number,
     topic: number,
     criterium: number,
-    file: Express.Multer.File
+    file: Express.Multer.File,
+    display: FileDisplay = FileDisplay.ATTACHMENT
   ) {
-    const randomPrefix = nanoid();
-
-    const key = `audits/${editUniqueId}/${randomPrefix}/${file.originalname}`;
-
-    const thumbnailKey = `audits/${editUniqueId}/${randomPrefix}/thumbnail_${file.originalname}`;
-
-    const thumbnailBuffer = await sharp(file.buffer)
-      .jpeg({
-        mozjpeg: true
-      })
-      .flatten({ background: { r: 255, g: 255, b: 255, alpha: 0 } })
-      .resize(200, 200, { fit: "inside" })
-      .toBuffer();
-
-    await Promise.all([
-      this.fileStorageService.uploadFile(file.buffer, file.mimetype, key),
-      this.fileStorageService.uploadFile(
-        thumbnailBuffer,
-        "image/jpeg",
-        thumbnailKey
-      )
-    ]);
+    const { key, thumbnailKey } = await this.uploadFileToStorage(
+      editUniqueId,
+      file,
+      { createThumbnail: display === FileDisplay.ATTACHMENT }
+    );
 
     const storedFile = await this.prisma.storedFile.create({
       data: {
@@ -459,7 +444,8 @@ export class AuditService {
         originalFilename: file.originalname,
         mimetype: file.mimetype,
         size: file.size,
-        thumbnailKey
+        thumbnailKey,
+        display
       }
     });
 
@@ -500,22 +486,59 @@ export class AuditService {
     return true;
   }
 
-  async saveNotesFile(editUniqueId: string, file: Express.Multer.File) {
+  async saveNotesFile(
+    editUniqueId: string,
+    file: Express.Multer.File,
+    display: FileDisplay = FileDisplay.ATTACHMENT
+  ) {
+    const { key, thumbnailKey } = await this.uploadFileToStorage(
+      editUniqueId,
+      file,
+      { createThumbnail: display === FileDisplay.ATTACHMENT }
+    );
+
+    const storedFile = await this.prisma.auditFile.create({
+      data: {
+        audit: {
+          connect: {
+            editUniqueId
+          }
+        },
+
+        key,
+        originalFilename: file.originalname,
+        mimetype: file.mimetype,
+        size: file.size,
+
+        thumbnailKey,
+        display
+      }
+    });
+
+    return storedFile;
+  }
+
+  async uploadFileToStorage(
+    uniqueId: string,
+    file: Express.Multer.File,
+    options?: { createThumbnail: boolean }
+  ): Promise<{ key: string; thumbnailKey?: string }> {
     const randomPrefix = nanoid();
 
-    const key = `audits/${editUniqueId}/${randomPrefix}/${file.originalname}`;
+    const key: string = `audits/${uniqueId}/${randomPrefix}/${file.originalname}`;
 
-    let thumbnailKey;
+    let thumbnailKey: string;
 
-    if (file.mimetype.startsWith("image")) {
+    if (file.mimetype.startsWith("image") && options.createThumbnail) {
       // If it's an image, create a thumbnail and upload it
-      thumbnailKey = `audits/${editUniqueId}/${randomPrefix}/thumbnail_${file.originalname}`;
+      thumbnailKey = `audits/${uniqueId}/${randomPrefix}/thumbnail_${file.originalname}`;
 
       const thumbnailBuffer = await sharp(file.buffer)
-        .resize(200, 200, { fit: "inside" })
         .jpeg({
           mozjpeg: true
         })
+        .flatten({ background: { r: 255, g: 255, b: 255, alpha: 0 } })
+        .resize(200, 200, { fit: "inside" })
         .toBuffer();
 
       await Promise.all([
@@ -529,29 +552,11 @@ export class AuditService {
     } else {
       await this.fileStorageService.uploadFile(file.buffer, file.mimetype, key);
     }
-
-    const storedFile = await this.prisma.auditFile.create({
-      data: {
-        audit: {
-          connect: {
-            editUniqueId
-          }
-        },
-
-        key,
-        originalFilename: file.originalname,
-        mimetype: file.mimetype,
-        size: file.size,
-
-        thumbnailKey
-      }
-    });
-
-    return storedFile;
+    return { key, thumbnailKey };
   }
 
   /**
-   * Returns true if stored filed was found and deleted. False if not found.
+   * Returns true if stored file has been found and deleted. False if not found.
    */
   async deleteAuditFile(
     editUniqueId: string,
@@ -585,6 +590,42 @@ export class AuditService {
     return true;
   }
 
+  /**
+   * Returns true if all stored file have been found and deleted. False otherwise.
+   */
+  async deleteAuditFiles(fileIds: number[]): Promise<boolean> {
+    const storedFiles = await this.prisma.auditFile.findMany({
+      select: {
+        id: true,
+        key: true,
+        thumbnailKey: true
+      },
+      where: {
+        id: {
+          in: fileIds
+        }
+      }
+    });
+
+    const filesToDelete = storedFiles.map((e) => e.key);
+    const thumbnailsToDelete = storedFiles
+      .map((e) => e.thumbnailKey)
+      .filter((e) => e != null);
+    await this.fileStorageService.deleteMultipleFiles(
+      ...filesToDelete.concat(thumbnailsToDelete)
+    );
+
+    await this.prisma.auditFile.deleteMany({
+      where: {
+        id: {
+          in: fileIds
+        }
+      }
+    });
+
+    return true;
+  }
+
   /**
    * Completely delete an audit and all the data associated with it.
    * @returns True if an audit was deleted, false otherwise.
@@ -832,7 +873,8 @@ export class AuditService {
         key: file.key,
         thumbnailKey: file.thumbnailKey,
         size: file.size,
-        mimetype: file.mimetype
+        mimetype: file.mimetype,
+        display: file.display
       })),
 
       criteriaCount: {
@@ -999,7 +1041,8 @@ export class AuditService {
         exampleImages: r.exampleImages.map((img) => ({
           filename: img.originalFilename,
           key: img.key,
-          thumbnailKey: img.thumbnailKey
+          thumbnailKey: img.thumbnailKey,
+          display: img.display
         }))
       }))
     };

confiture-rest-api/src/audits/audits.controller.ts

@@ -28,6 +28,7 @@ import {
 import { Audit } from "src/generated/nestjs-dto/audit.entity";
 import { CriterionResult } from "src/generated/nestjs-dto/criterionResult.entity";
 import { MailService } from "../mail/mail.service";
+import { NotesFileDto } from "./dto/notes-file.dto";
 import { AuditExportService } from "./audit-export.service";
 import { AuditService } from "./audit.service";
 import { CreateAuditDto } from "./dto/create-audit.dto";
@@ -174,7 +175,8 @@ export class AuditsController {
       body.pageId,
       body.topic,
       body.criterium,
-      file
+      file,
+      body.display
     );
   }
 
@@ -191,15 +193,16 @@ export class AuditsController {
           errorHttpStatusCode: HttpStatus.UNPROCESSABLE_ENTITY
         })
     )
-    file: Express.Multer.File
+    file: Express.Multer.File,
+    @Body() body: NotesFileDto
   ) {
     const audit = await this.auditService.getAuditWithEditUniqueId(uniqueId);
 
     if (!audit) {
       return this.sendAuditNotFoundStatus(uniqueId);
     }
 
-    return await this.auditService.saveNotesFile(uniqueId, file);
+    return await this.auditService.saveNotesFile(uniqueId, file, body.display);
   }
 
   @Delete("/:uniqueId/results/examples/:exampleId")