improve logs of pdf generation, to include conventionId (for debug pu…

…rposes)

back/src/adapters/primary/routers/technical/createTechnicalRouter.ts

@@ -93,7 +93,7 @@ export const createTechnicalRouter = (
     async (req, res) =>
       sendHttpResponse(req, res, () =>
         deps.useCases.htmlToPdf.execute(
-          req.body.htmlContent,
+          req.body,
           req.payloads?.inclusion ?? req.payloads?.convention,
         ),
       ),

back/src/adapters/primary/routers/technical/technicalRouter.e2e.test.ts

@@ -134,12 +134,16 @@ describe("technical router", () => {
       const response = await httpClient.htmlToPdf({
         body: {
           htmlContent: "<p>some html content</p>",
+          conventionId: "convention-id",
         },
         headers: {
           authorization: validatorJwt,
         },
       });
-      expectToEqual(response.body, 'PDF_OF >> "<p>some html content</p>"');
+      expectToEqual(
+        response.body,
+        'PDF_OF convention convention-id >> "<p>some html content</p>"',
+      );
 
       expectToEqual(response.status, 200);
     });

back/src/domains/core/pdf-generation/adapters/InMemoryPdfGeneratorGateway.ts

@@ -1,7 +1,11 @@
+import { HtmlToPdfRequest } from "shared";
 import { PdfGeneratorGateway } from "../ports/PdfGeneratorGateway";
 
 export class InMemoryPdfGeneratorGateway implements PdfGeneratorGateway {
-  public async make(htmlContent: string): Promise<string> {
-    return `PDF_OF >> "${htmlContent}"`;
+  public async make({
+    htmlContent,
+    conventionId,
+  }: HtmlToPdfRequest): Promise<string> {
+    return `PDF_OF convention ${conventionId} >> "${htmlContent}"`;
   }
 }

back/src/domains/core/pdf-generation/adapters/ScalingoPdfGeneratorGateway.manual.test.ts

@@ -27,7 +27,10 @@ describe("ScalingoPdfGeneratorGateway", () => {
           uuidGenerator,
         );
 
-        const pdfBase64 = await pdfGeneratorGateway.make("TEST");
+        const pdfBase64 = await pdfGeneratorGateway.make({
+          htmlContent: "TEST",
+          conventionId: "osef",
+        });
         expect(pdfBase64).toBeDefined();
         expect(pdfBase64.length).toBeGreaterThan(0);
         expect(Buffer.from(pdfBase64, "base64").toString("binary")).toContain(

back/src/domains/core/pdf-generation/adapters/ScalingoPdfGeneratorGateway.ts

@@ -1,4 +1,8 @@
-import { AbsoluteUrl, withAuthorizationHeaders } from "shared";
+import {
+  AbsoluteUrl,
+  HtmlToPdfRequest,
+  withAuthorizationHeaders,
+} from "shared";
 import { HttpClient, defineRoute, defineRoutes } from "shared-routes";
 import { z } from "zod";
 import { UuidGenerator } from "../../uuid-generator/ports/UuidGenerator";
@@ -46,7 +50,10 @@ export class ScalingoPdfGeneratorGateway implements PdfGeneratorGateway {
     this.#uuidGenerator = uuidGenerator;
   }
 
-  public async make(htmlContent: string): Promise<string> {
+  public async make({
+    htmlContent,
+    conventionId,
+  }: HtmlToPdfRequest): Promise<string> {
     const requestId = this.#uuidGenerator.new();
 
     const response = await this.#httpClient.generate({
@@ -59,7 +66,7 @@ export class ScalingoPdfGeneratorGateway implements PdfGeneratorGateway {
 
     if (response.status !== 200)
       throw new Error(
-        `[requestId : ${requestId}] Pdf generation failed with status ${response.status} - ${response.body}`,
+        `[requestId : ${requestId}, conventionId : ${conventionId}] Pdf generation failed with status ${response.status} - ${response.body}`,
       );
 
     return response.body;

back/src/domains/core/pdf-generation/ports/PdfGeneratorGateway.ts

@@ -1,3 +1,5 @@
+import { HtmlToPdfRequest } from "shared";
+
 export interface PdfGeneratorGateway {
-  make(htmlContent: string): Promise<string>;
+  make(params: HtmlToPdfRequest): Promise<string>;
 }

back/src/domains/core/pdf-generation/use-cases/HtmlToPdf.ts

@@ -1,24 +1,29 @@
 import {
   ConventionJwtPayload,
   ConventionRelatedJwtPayload,
+  HtmlToPdfRequest,
   errors,
-  zStringMinLength1,
+  htmlToPdfRequestSchema,
 } from "shared";
 import { UseCase } from "../../UseCase";
 import { PdfGeneratorGateway } from "../ports/PdfGeneratorGateway";
 
-export class HtmlToPdf extends UseCase<string, string, ConventionJwtPayload> {
-  protected inputSchema = zStringMinLength1;
+export class HtmlToPdf extends UseCase<
+  HtmlToPdfRequest,
+  string,
+  ConventionJwtPayload
+> {
+  protected inputSchema = htmlToPdfRequestSchema;
 
   constructor(protected pdfGeneratorGateway: PdfGeneratorGateway) {
     super();
   }
 
   protected async _execute(
-    htmlContent: string,
+    params: HtmlToPdfRequest,
     jwtPayload?: ConventionRelatedJwtPayload,
   ): Promise<string> {
     if (!jwtPayload) throw errors.user.unauthorized();
-    return this.pdfGeneratorGateway.make(htmlContent);
+    return this.pdfGeneratorGateway.make(params);
   }
 }

back/src/domains/core/pdf-generation/use-cases/HtmlToPdf.unit.test.ts

@@ -17,28 +17,35 @@ const jwtPayload: ConventionJwtPayload = {
 const htmlContent = "<h1>Hello world</h1><p>test</p>";
 
 describe("HtmlToPdf", () => {
+  const conventionId = "convention-id";
   let htmlToPdf: HtmlToPdf;
   beforeEach(() => {
     htmlToPdf = new HtmlToPdf(new InMemoryPdfGeneratorGateway());
   });
 
   it("renders a pdf from a html content", async () => {
-    const base64Pdf = await htmlToPdf.execute(htmlContent, jwtPayload);
-    expectToEqual(base64Pdf, `PDF_OF >> "${htmlContent}"`);
+    const base64Pdf = await htmlToPdf.execute(
+      { htmlContent, conventionId },
+      jwtPayload,
+    );
+    expectToEqual(
+      base64Pdf,
+      `PDF_OF convention convention-id >> "${htmlContent}"`,
+    );
   });
 
   it("returns an error if the html content is empty", async () => {
     await expectPromiseToFailWithError(
-      htmlToPdf.execute("", jwtPayload),
+      htmlToPdf.execute({ htmlContent: "", conventionId }, jwtPayload),
       errors.inputs.badSchema({
-        flattenErrors: ["Obligatoire"],
+        flattenErrors: ["htmlContent : Obligatoire"],
       }),
     );
   });
 
   it("returns an error if no JWT is provided", async () => {
     await expectPromiseToFailWithError(
-      htmlToPdf.execute(htmlContent),
+      htmlToPdf.execute({ htmlContent, conventionId }),
       errors.user.unauthorized(),
     );
   });

front/src/app/pages/convention/ConventionDocumentPage.tsx

@@ -163,7 +163,12 @@ export const ConventionDocumentPage = ({
       setIsPdfLoading(true);
       const pdfContent =
         await outOfReduxDependencies.technicalGateway.htmlToPdf(
-          prepareContentForPdfGenerator(document.documentElement.outerHTML),
+          {
+            htmlContent: prepareContentForPdfGenerator(
+              document.documentElement.outerHTML,
+            ),
+            conventionId: convention.id,
+          },
           jwt,
         );
       const downloadLink = document.createElement("a");

front/src/core-logic/adapters/TechnicalGateway/HttpTechnicalGateway.ts

@@ -5,6 +5,7 @@ import {
   ConventionSupportedJwt,
   Email,
   FeatureFlags,
+  HtmlToPdfRequest,
   TechnicalRoutes,
   ValidateEmailFeedback,
   uploadFileRoute,
@@ -42,12 +43,12 @@ export class HttpTechnicalGateway implements TechnicalGateway {
   }
 
   public htmlToPdf(
-    htmlContent: string,
+    params: HtmlToPdfRequest,
     jwt: ConventionSupportedJwt,
   ): Promise<string> {
     return this.httpClient
       .htmlToPdf({
-        body: { htmlContent },
+        body: params,
         headers: { authorization: jwt },
       })
       .then((response) =>

front/src/core-logic/adapters/TechnicalGateway/SimulatedTechnicalGateway.ts

@@ -4,6 +4,7 @@ import {
   ConventionSupportedJwt,
   Email,
   FeatureFlags,
+  HtmlToPdfRequest,
   ValidateEmailFeedback,
   sleep,
 } from "shared";
@@ -15,7 +16,7 @@ export class SimulatedTechnicalGateway implements TechnicalGateway {
     of(makeStubFeatureFlags());
 
   public htmlToPdf = (
-    _htmlContent: string,
+    _htmlContent: HtmlToPdfRequest,
     _jwt: ConventionSupportedJwt,
   ): Promise<string> => Promise.resolve("YWJjZA==");
 

front/src/core-logic/adapters/TechnicalGateway/TestTechnicalGateway.ts

@@ -4,6 +4,7 @@ import {
   ConventionSupportedJwt,
   Email,
   FeatureFlags,
+  HtmlToPdfRequest,
   ValidateEmailFeedback,
 } from "shared";
 import { TechnicalGateway } from "src/core-logic/ports/TechnicalGateway";
@@ -15,7 +16,7 @@ export class TestTechnicalGateway implements TechnicalGateway {
   public getAllFeatureFlags$ = () => this.featureFlags$;
 
   public htmlToPdf = (
-    _htmlContent: string,
+    _htmlContent: HtmlToPdfRequest,
     _jwt: ConventionSupportedJwt,
   ): Promise<string> => Promise.resolve("YWJjZA==");
 

front/src/core-logic/ports/TechnicalGateway.ts

@@ -4,12 +4,16 @@ import {
   ConventionSupportedJwt,
   Email,
   FeatureFlags,
+  HtmlToPdfRequest,
   ValidateEmailFeedback,
 } from "shared";
 
 export interface TechnicalGateway {
   getAllFeatureFlags$(): Observable<FeatureFlags>;
   uploadFile(file: File, renameFileToId: boolean): Promise<AbsoluteUrl>;
-  htmlToPdf(htmlContent: string, jwt: ConventionSupportedJwt): Promise<string>;
+  htmlToPdf(
+    params: HtmlToPdfRequest,
+    jwt: ConventionSupportedJwt,
+  ): Promise<string>;
   getEmailStatus(email: Email): Promise<ValidateEmailFeedback>;
 }

shared/src/routes/technicalRoutes.ts

@@ -1,5 +1,6 @@
 import { defineRoute, defineRoutes } from "shared-routes";
 import { z } from "zod";
+import { ConventionId } from "../convention/convention.dto";
 import {
   validateEmailInputSchema,
   validateEmailResponseSchema,
@@ -14,8 +15,14 @@ import {
   zStringMinLength1,
 } from "../zodUtils";
 
-const htmlToPdfRequestSchema = z.object({
+export type HtmlToPdfRequest = {
+  htmlContent: string;
+  conventionId: ConventionId;
+};
+
+export const htmlToPdfRequestSchema = z.object({
   htmlContent: zStringMinLength1,
+  conventionId: z.string(),
 });
 
 // @TODO: This should be a proper OpenAPI schema