Dupliquer un audit (#377)

* create duplicate modal

* add alert

* update dropdown styles + add icons

* plug duplication into api

* duplicate everything except example images

* try to conditionally show alert

* fully duplicate audit including images

* add audit duplication history

* add doc to duplicateAudit()

* show duplication alert based on history state

* send email on audit duplication

* use original audit name as hint for copy

* use correct deep selector synttax

* update changelog

---------

Co-authored-by: Adrien Boutigny <adrien@slash-tmp.dev>

Author: bellangerq

CHANGELOG.md

@@ -2,26 +2,32 @@
 
 Tous les changements notables de Ara sont documentés ici avec leur date, leur catégorie (nouvelle fonctionnalité, correction de bug ou autre changement) et leur pull request (PR) associée.
 
-# 12/05/2023
+## 16/05/2023
+
+### Nouvelles fonctionnalités 🚀
+
+- Ajout d’un bouton pour dupliquer un audit terminé ([#377](https://github.com/DISIC/Ara/pull/377))
+
+## 12/05/2023
 
 ### Correction 🐛
 
 - Vérifie le poids des images d'exemple avant de les envoyer au serveur ([#394](https://github.com/DISIC/Ara/pull/394))
 
-# 11/05/2023
+## 11/05/2023
 
 ### Correction 🐛
 
 - Corrige l'application de l'état transverse d'un critère via le switch "Sur toutes les pages" qui était parfois ignoré.
 
-# 10/05/2023
+## 10/05/2023
 
 ### Correction 🐛
 
 - Corrige une erreur qui survenait lorsqu'un champ de formulaire de type URL contenait un espace ([#386](https://github.com/DISIC/Ara/pull/386))
 - Corrige l'ordre des erreurs dans l'onglet "Détail des résultats" du rapport d'audit ([#389](https://github.com/DISIC/Ara/pull/389))
 
-## Autres changements ⚙️
+### Autres changements ⚙️
 
 - Les accordéons "Description de la ou des erreurs" et "Recommandation de correction" sont remplacés par un unique accordéon "Description et recommandation" ([#390](https://github.com/DISIC/Ara/pull/390))
 
@@ -34,78 +40,78 @@ Tous les changements notables de Ara sont documentés ici avec leur date, leur c
 
 ## 04/05/2023
 
-## Autres changements ⚙️
+### Autres changements ⚙️
 
 - Ajout d’une notification pour signaler qu’un email avec les liens importants a été envoyé lors de la création d’un audit ([#368](https://github.com/DISIC/Ara/pull/368))
 
 ## 03/05/2023
 
-## Nouvelles fonctionnalités 🚀
+### Nouvelles fonctionnalités 🚀
 
 - Remplacement des filtres de thématique par des ancres lors de la réalisation d’un audit ([#362](https://github.com/DISIC/Ara/pull/362))
 
 ## 28/04/2023
 
-## Autres changements ⚙️
+### Autres changements ⚙️
 
 - Modifications mineures de la page d’accueil ([#361](https://github.com/DISIC/Ara/pull/361))
 
 ## 19/04/2023
 
-## Nouvelles fonctionnalités 🚀
+### Nouvelles fonctionnalités 🚀
 
 - Ajout d'une aide à la saisie en Markdown accessible en cliquant sur le bouton "Markdown pris en compte" en dessous des champs texte concernés ([#350](https://github.com/DISIC/Ara/pull/350))
 
 ## 05/04/2023
 
-## Nouvelles fonctionnalités 🚀
+### Nouvelles fonctionnalités 🚀
 
 - Lors de la création d'un audit, envoie d'un email contenant les liens vers l'audit et le rapport ([#314](https://github.com/DISIC/Ara/pull/314))
 
-## Autres changements ⚙️
+### Autres changements ⚙️
 
 - Mise à jour du titre de la page de génération d’audit ([#345](https://github.com/DISIC/Ara/pull/345))
 - Ajout du métier "Auditeur / Auditrice accessibilité" dans le formulaire de retour ([#346](https://github.com/DISIC/Ara/pull/346))
 
 ## 30/03/2023
 
-## Nouvelles fonctionnalités 🚀
+### Nouvelles fonctionnalités 🚀
 
 - Ajout d’un bouton pour afficher ou cacher la barre latérale des filtres ([#322](https://github.com/DISIC/Ara/pull/322))
 
 ## 24/03/2023
 
-## Nouvelles fonctionnalités 🚀
+### Nouvelles fonctionnalités 🚀
 
 - Ajout d’un filtre pour cacher les tests et références des critères ([#329](https://github.com/DISIC/Ara/pull/329))
 
-## Autres changements ⚙️
+### Autres changements ⚙️
 
 - Petits ajustements d’affichage du contenu de la page Contexte d’un audit ([#331](https://github.com/DISIC/Ara/pull/331))
 - Mise à jour du wording pour la saisie d’un moyen de contact dans la déclaration ([#330](https://github.com/DISIC/Ara/pull/330))
 
 ## 23/03/2023
 
-## Nouvelles fonctionnalités 🚀
+### Nouvelles fonctionnalités 🚀
 
 - Ajout d’un interrupteur pour marquer le résultat d’un critère comme transverse sur toutes les pages ([#317](https://github.com/DISIC/Ara/pull/317))
 
-## Autres changements ⚙️
+### Autres changements ⚙️
 
 - Mise à jour du DSFR en version `1.9.0` ([#326](https://github.com/DISIC/Ara/pull/326))
 - Mise à jour de l’adresse email de contact : ara@design.numerique.gouv.fr ([#328](https://github.com/DISIC/Ara/pull/328))
 
 ## 08/03/2023
 
-## Nouvelles fonctionnalités 🚀
+### Nouvelles fonctionnalités 🚀
 
 - Ajout d’un lien de retour en haut de page pendant l’audit ([#316](https://github.com/DISIC/Ara/pull/316))
 
 ### Correction 🐛
 
 - Améliore la gestion du focus à la fermeture des modales ([#297](https://github.com/DISIC/Ara/pull/297))
 
-## Autres changements ⚙️
+### Autres changements ⚙️
 
 - Un seul des 2 moyens de contact est obligatoire : email ou URL vers un formulaire ([#313](https://github.com/DISIC/Ara/pull/313))
 

confiture-rest-api/package.json

@@ -32,12 +32,15 @@
     "@nestjs/platform-express": "^9.4.0",
     "@nestjs/swagger": "^6.3.0",
     "@prisma/client": "^4.1.1",
+    "@types/lodash": "^4.14.194",
     "@vegardit/prisma-generator-nestjs-dto": "^1.5.1",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.13.2",
     "got": "^11.8.5",
     "handlebars": "^4.7.7",
     "joi": "^17.6.0",
+    "lodash": "^4.17.21",
+    "lodash-es": "^4.17.21",
     "mjml": "^4.14.1",
     "morgan": "^1.10.0",
     "nanoid": "^3.3.4",
@@ -54,6 +57,7 @@
     "@nestjs/testing": "^9.2.1",
     "@types/express": "^4.17.13",
     "@types/jest": "27.4.1",
+    "@types/lodash-es": "^4.17.7",
     "@types/mjml": "^4.7.1",
     "@types/multer": "^1.4.7",
     "@types/node": "^16.0.0",

confiture-rest-api/prisma/migrations/20230512100117_add_audit_duplication_history/migration.sql

@@ -0,0 +1,5 @@
+-- AlterTable
+ALTER TABLE "Audit" ADD COLUMN     "sourceAuditId" INTEGER;
+
+-- AddForeignKey
+ALTER TABLE "Audit" ADD CONSTRAINT "Audit_sourceAuditId_fkey" FOREIGN KEY ("sourceAuditId") REFERENCES "Audit"("id") ON DELETE SET NULL ON UPDATE CASCADE;

confiture-rest-api/prisma/schema.prisma

@@ -75,6 +75,11 @@ model Audit {
   consultUniqueId String     @unique
   auditTraceId    Int        @unique
   auditTrace      AuditTrace @relation(fields: [auditTraceId], references: [id])
+  
+  // Audit duplication history
+  sourceAudit Audit? @relation("AuditDuplicationHistory", fields: [sourceAuditId], references: [id])
+  sourceAuditId Int?
+  auditCopies Audit[] @relation("AuditDuplicationHistory")
 
   @@unique([editUniqueId, consultUniqueId])
 }

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

@@ -11,6 +11,7 @@ import {
 } from '@prisma/client';
 import { nanoid } from 'nanoid';
 import sharp from 'sharp';
+import { omit, setWith } from 'lodash';
 
 import { PrismaService } from '../prisma.service';
 import * as RGAA from '../rgaa.json';
@@ -25,6 +26,11 @@ const AUDIT_EDIT_INCLUDE: Prisma.AuditInclude = {
   recipients: true,
   environments: true,
   pages: true,
+  sourceAudit: {
+    select: {
+      procedureName: true,
+    },
+  },
 };
 
 @Injectable()
@@ -889,4 +895,162 @@ export class AuditService {
 
     return testedCount === expectedCount;
   }
+
+  async duplicateAudit(sourceUniqueId: string, newAuditName: string) {
+    const originalAudit = await this.prisma.audit.findUnique({
+      where: { editUniqueId: sourceUniqueId },
+      include: {
+        environments: true,
+        pages: {
+          include: {
+            results: {
+              include: {
+                exampleImages: true,
+              },
+            },
+          },
+        },
+      },
+    });
+
+    if (!originalAudit) {
+      return;
+    }
+
+    const duplicateEditUniqueId = nanoid();
+    const duplicateConsultUniqueId = nanoid();
+
+    /** 
+    Object storing duplicate exampleImage creation data mapped by
+    - page id
+    - result id
+    - example id
+
+    This object is used within the call to prisma.audit.create() to duplicate the example images.
+
+    Example content:
+    ```
+    {
+      'page-id': {
+        'result-id': {
+          'example-id': {
+            filename: 'foo',
+            ...
+          }
+        }
+      }
+    }
+    ```
+    */
+    const imagesCreateData: {
+      [pageId: string]: {
+        [resultId: string]: object;
+      };
+    } = {};
+
+    /**
+     * contains s3 file duplications which will be executed together by calling
+     * `fileStorageService.duplicateMultipleFiles()`
+     */
+    const imageDuplications: { originalKey: string; destinationKey: string }[] =
+      [];
+
+    originalAudit.pages.forEach((p) => {
+      p.results.forEach((r) => {
+        r.exampleImages.forEach((e) => {
+          const randomPrefix = nanoid();
+
+          const key = `audits/${duplicateEditUniqueId}/${randomPrefix}/${e.originalFilename}`;
+          const thumbnailKey = `audits/${duplicateEditUniqueId}/${randomPrefix}/thumbnail_${e.originalFilename}`;
+
+          const publicUrl = this.fileStorageService.getPublicUrl(key);
+          const thumbnailUrl =
+            this.fileStorageService.getPublicUrl(thumbnailKey);
+
+          imageDuplications.push(
+            {
+              originalKey: e.key,
+              destinationKey: key,
+            },
+            {
+              originalKey: e.thumbnailKey,
+              destinationKey: thumbnailKey,
+            },
+          );
+
+          setWith(
+            imagesCreateData,
+            [p.id, r.id, e.id],
+            {
+              originalFilename: e.originalFilename,
+              url: publicUrl,
+              size: e.size,
+              key: key,
+              thumbnailUrl: thumbnailUrl,
+              thumbnailKey: thumbnailKey,
+            },
+            Object,
+          );
+        });
+      });
+    });
+
+    await this.fileStorageService.duplicateMultipleFiles(imageDuplications);
+
+    const newAudit = await this.prisma.audit.create({
+      data: {
+        ...omit(originalAudit, ['id', 'auditTraceId', 'sourceAuditId']),
+
+        // link new audit with the original
+        sourceAudit: {
+          connect: {
+            editUniqueId: sourceUniqueId,
+          },
+        },
+
+        editUniqueId: duplicateEditUniqueId,
+        consultUniqueId: duplicateConsultUniqueId,
+
+        procedureName: newAuditName,
+
+        creationDate: new Date(),
+        editionDate: undefined,
+        publicationDate: undefined,
+
+        environments: {
+          createMany: {
+            data: originalAudit.environments.map((e) =>
+              omit(e, ['id', 'auditUniqueId']),
+            ),
+          },
+        },
+
+        pages: {
+          create: originalAudit.pages.map((p) => ({
+            name: p.name,
+            url: p.url,
+            results: {
+              create: p.results.map((r) => ({
+                ...omit(r, ['id', 'pageId']),
+                exampleImages: {
+                  create: r.exampleImages.map(
+                    (e) => imagesCreateData[p.id][r.id][e.id],
+                  ),
+                },
+              })),
+            },
+          })),
+        },
+
+        auditTrace: {
+          create: {
+            auditConsultUniqueId: duplicateConsultUniqueId,
+            auditEditUniqueId: duplicateEditUniqueId,
+          },
+        },
+      },
+    });
+
+    return newAudit;
+  }
 }