From 90f24d71e67220a5e8f39271d261891c00b91147 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Florian=20Sch=C3=A4fer?= <florian.schaefer@fumix.de>
Date: Tue, 10 Jan 2023 18:33:23 +0100
Subject: [PATCH] Fix markdown converter (Promise/await issues)

---
 client/src/components/MarkDown.vue       |  7 +-
 client/src/markdown-converter-client.ts  | 26 ++++---
 common/src/markdown-converter-common.ts  | 92 ++++++++++++++----------
 server/src/markdown-converter-server.ts  | 27 ++++---
 server/src/routes/posts.ts               |  7 +-
 server/src/service/testdata-generator.ts |  5 +-
 6 files changed, 96 insertions(+), 68 deletions(-)

diff --git a/client/src/components/MarkDown.vue b/client/src/components/MarkDown.vue
index a94451b..88d4cf6 100644
--- a/client/src/components/MarkDown.vue
+++ b/client/src/components/MarkDown.vue
@@ -19,8 +19,7 @@
 <script lang="ts">
 import type { PropType } from "vue";
 import { defineComponent, ref, watch } from "vue";
-import { sanitizeHtml } from "@fumix/fu-blog-common";
-import DOMPurify from "dompurify";
+import { MarkdownConverterClient } from "../markdown-converter-client.js";
 
 export default defineComponent({
   props: {
@@ -32,12 +31,12 @@ export default defineComponent({
   emits: ["loading"],
 
   setup(props, emits) {
-    const sanitizedHtml = ref<String>("");
+    const sanitizedHtml = ref<string>("");
 
     watch(props, async () => {
       try {
         emits.emit("loading", true);
-        sanitizedHtml.value = sanitizeHtml(props.markdown as string, DOMPurify);
+        sanitizedHtml.value = await MarkdownConverterClient.Instance.convert(props.markdown ?? "");
       } catch (e) {
         // TODO erro handling
       } finally {
diff --git a/client/src/markdown-converter-client.ts b/client/src/markdown-converter-client.ts
index f7dfc79..51ac4e7 100644
--- a/client/src/markdown-converter-client.ts
+++ b/client/src/markdown-converter-client.ts
@@ -1,10 +1,16 @@
-import { marked } from "marked";
-import {
-  createWalkTokensExtension,
-  rendererExtension,
-} from "@fumix/fu-blog-common";
-
-marked.use(
-  createWalkTokensExtension((url) => fetch(url).then((it) => it.text())),
-);
-marked.use(rendererExtension);
+import { MarkdownConverter } from "@fumix/fu-blog-common";
+import DOMPurify from "dompurify";
+
+export class MarkdownConverterClient extends MarkdownConverter {
+  private static instance: MarkdownConverterClient;
+
+  protected override dompurify: DOMPurify.DOMPurifyI = DOMPurify;
+
+  private constructor() {
+    super((url: string) => fetch(url).then((it) => it.text()));
+  }
+
+  public static get Instance() {
+    return this.instance ?? (this.instance = new this());
+  }
+}
diff --git a/common/src/markdown-converter-common.ts b/common/src/markdown-converter-common.ts
index 6299f14..451159f 100644
--- a/common/src/markdown-converter-common.ts
+++ b/common/src/markdown-converter-common.ts
@@ -3,46 +3,64 @@ import { Buffer } from "buffer";
 import pako from "pako";
 import { DOMPurifyI } from "dompurify";
 
-const KROKI_SERVICE_URL = "https://kroki.io";
-const KROKI_DIAGRAM_INFOSTRING = "diagram-plantuml";
-
-export function createWalkTokensExtension(fetchTextFromUrl: FetchTextFromUrlFunction): marked.MarkedExtension {
-  return {
-    async: true,
-    walkTokens: async (token: marked.Token) => {
-      if (token.type === "code" && token.lang === KROKI_DIAGRAM_INFOSTRING) {
-        const inputText = token.text;
-        const data = Buffer.from(inputText, "utf8");
-        const compressed = pako.deflate(data, { level: 9 });
-        const res = Buffer.from(compressed).toString("base64").replace(/\+/g, "-").replace(/\//g, "_");
-        token.text = await fetchTextFromUrl(`${KROKI_SERVICE_URL}/plantuml/svg/${res}`);
-      }
-    },
-  };
-}
-
-export const rendererExtension: marked.MarkedExtension = {
-  renderer: {
-    code(code: string, infostring: string) {
-      if (infostring === KROKI_DIAGRAM_INFOSTRING) {
-        return code;
-      }
-      return false;
-    },
-  },
-};
-
-export const sanitizeHtml: (input: string, purify: DOMPurifyI) => string = (input, purify) => {
-  return purify.sanitize(marked.parse(input), {
-    // Allowed tags and attributes inside markdown
-    ADD_TAGS: ["iframe"],
-    ADD_ATTR: ["allow", "allowfullscreen", "frameborder", "scrolling"],
-  });
-};
-
 /**
  * Takes a URL as argument, fetches text content from there and returns a promise resolving to that content.
  * This is `(url) => fetch(url).then((it) => it.text())` on client and server, but using a different fetch() function
  * (on the server from `node-fetch`, on the client the browser Fetch API is used).
  */
 type FetchTextFromUrlFunction = (a: string) => Promise<string>;
+
+export abstract class MarkdownConverter {
+  private static KROKI_SERVICE_URL = "https://kroki.io";
+  private static KROKI_DIAGRAM_INFOSTRING = "diagram-plantuml";
+
+  private static rendererExtension: marked.MarkedExtension = {
+    renderer: {
+      code(code: string, infostring: string) {
+        if (infostring === MarkdownConverter.KROKI_DIAGRAM_INFOSTRING) {
+          return code;
+        }
+        return false;
+      },
+    },
+  };
+  private static walkTokensExtension: (fetchTextFromUrl: FetchTextFromUrlFunction) => marked.MarkedExtension = //
+    (fetchTextFromUrl) => {
+      return {
+        async: true,
+        walkTokens: async (token: marked.Token) => {
+          if (token.type === "code" && token.lang === MarkdownConverter.KROKI_DIAGRAM_INFOSTRING) {
+            const inputText = token.text;
+            const data = Buffer.from(inputText, "utf8");
+            const compressed = pako.deflate(data, { level: 9 });
+            const res = Buffer.from(compressed).toString("base64").replace(/\+/g, "-").replace(/\//g, "_");
+            token.text = await fetchTextFromUrl(`${MarkdownConverter.KROKI_SERVICE_URL}/plantuml/svg/${res}`);
+          }
+        },
+      };
+    };
+
+  protected abstract dompurify: DOMPurifyI;
+
+  /**
+   *
+   * @param fetch the fetch function used by client/server
+   */
+  protected constructor(fetch: FetchTextFromUrlFunction) {
+    // Initialize marked with our custom extensions
+    marked.use(MarkdownConverter.walkTokensExtension(fetch));
+    marked.use(MarkdownConverter.rendererExtension);
+  }
+
+  convert(input: string): Promise<string> {
+    return marked
+      .parse(input, { async: true }) //
+      .then((parsedInput) =>
+        this.dompurify.sanitize(parsedInput, {
+          // Allowed tags and attributes inside markdown
+          ADD_TAGS: ["iframe"],
+          ADD_ATTR: ["allow", "allowfullscreen", "frameborder", "scrolling"],
+        }),
+      );
+  }
+}
diff --git a/server/src/markdown-converter-server.ts b/server/src/markdown-converter-server.ts
index 38b6737..75bf705 100644
--- a/server/src/markdown-converter-server.ts
+++ b/server/src/markdown-converter-server.ts
@@ -1,15 +1,22 @@
-import { marked } from "marked";
-import { createWalkTokensExtension, rendererExtension } from "@fumix/fu-blog-common";
+import { MarkdownConverter } from "@fumix/fu-blog-common";
 import fetch from "node-fetch";
 import DOMPurify from "dompurify";
 import { JSDOM } from "jsdom";
 
-marked.use(createWalkTokensExtension((url) => fetch(url).then((it) => it.text())));
-marked.use(rendererExtension);
+export class MarkdownConverterServer extends MarkdownConverter {
+  private static instance: MarkdownConverterServer;
 
-/**
- * On the server side, we need to pass a new window object to DOMPurify.
- * It doesn't work to just call `DOMPurify.sanitize()` directly like on the client side.
- */
-export const createDomPurify: () => DOMPurify.DOMPurifyI = //
-  () => DOMPurify(new JSDOM("").window as unknown as Window);
+  /**
+   * On the server side, we need to pass a new window object to DOMPurify.
+   * It doesn't work to just call `DOMPurify.sanitize()` directly like on the client side.
+   */
+  protected override dompurify: DOMPurify.DOMPurifyI = DOMPurify(new JSDOM("").window as unknown as Window);
+
+  private constructor() {
+    super((url: string) => fetch(url).then((it) => it.text()));
+  }
+
+  public static get Instance() {
+    return this.instance ?? (this.instance = new this());
+  }
+}
diff --git a/server/src/routes/posts.ts b/server/src/routes/posts.ts
index 6dae020..d1b055e 100644
--- a/server/src/routes/posts.ts
+++ b/server/src/routes/posts.ts
@@ -1,9 +1,8 @@
-import { sanitizeHtml } from "@fumix/fu-blog-common";
 import express, { Request, Response, Router } from "express";
 import { AppDataSource } from "../data-source.js";
 import { PostEntity } from "../entity/Post.entity.js";
 import { UserEntity } from "../entity/User.entity.js";
-import { createDomPurify } from "../markdown-converter-server.js";
+import { MarkdownConverterServer } from "../markdown-converter-server.js";
 
 const router: Router = express.Router();
 
@@ -92,7 +91,7 @@ router.post("/new", async (req: Request, res: Response) => {
       createdBy: await getUser(),
       createdAt: new Date(),
       updatedAt: new Date(),
-      sanitizedHtml: sanitizeHtml(req.body.markdown, createDomPurify()),
+      sanitizedHtml: await MarkdownConverterServer.Instance.convert(req.body.markdown),
       updatedBy: undefined,
       draft: req.body.draft || true,
       attachments: [],
@@ -118,7 +117,7 @@ router.post("/:id", async (req: Request, res: Response) => {
     post.description = req.body.description;
     post.markdown = req.body.markdown;
     post.updatedAt = new Date();
-    post.sanitizedHtml = sanitizeHtml(req.body.markdown, createDomPurify());
+    post.sanitizedHtml = await MarkdownConverterServer.Instance.convert(req.body.markdown);
     post.updatedBy = await getUser();
     // TODO
     post.draft = req.body.draft || true;
diff --git a/server/src/service/testdata-generator.ts b/server/src/service/testdata-generator.ts
index 3eef7a6..3f4da2e 100644
--- a/server/src/service/testdata-generator.ts
+++ b/server/src/service/testdata-generator.ts
@@ -1,11 +1,10 @@
 import { faker } from "@faker-js/faker/locale/de";
-import { sanitizeHtml } from "@fumix/fu-blog-common";
 import fs from "fs";
 import { AppDataSource } from "../data-source.js";
 import { AttachmentEntity } from "../entity/Attachment.entity.js";
 import { PostEntity } from "../entity/Post.entity.js";
 import { UserEntity } from "../entity/User.entity.js";
-import { createDomPurify } from "../markdown-converter-server.js";
+import { MarkdownConverterServer } from "../markdown-converter-server.js";
 
 const usersCount = 10;
 const postsPerUser = 25;
@@ -64,7 +63,7 @@ export async function createRandomUser(): Promise<UserEntity> {
 export async function createRandomPost(createdBy: UserEntity): Promise<PostEntity> {
   try {
     const dirty = faker.lorem.sentences(29);
-    const sanitized = sanitizeHtml(dirty, createDomPurify());
+    const sanitized = await MarkdownConverterServer.Instance.convert(dirty);
     const post: PostEntity = {
       title: faker.lorem.sentence(4),
       description: faker.lorem.sentences(8),