Rewrite deserialize as a class to avoid passing options around.

src/domain/session/room/timeline/deserialize.js

@@ -13,29 +13,21 @@ import sanitizeHtml from "../../../../../lib/sanitize-html/index.js"
  */
 const basicNodes = ["EM", "STRONG", "CODE", "DEL", "P", "DIV", "SPAN" ]
 
-/**
+class Deserializer {
- * Return a builder function for a particular tag.
+    constructor(result, mediaRepository) {
- */
+        this.result = result;
-function basicWrapper(tag) {
+        this.mediaRepository = mediaRepository;
-    return (_, node, children) => new FormatPart(tag, children);
+    }
-}
 
-/**
+    parseLink(node, children) {
- * Return a builder function for a particular header level.
- */
-function headerWrapper(level) {
-    return (_, node, children) => new HeaderBlock(level, children);
-}
-
-function parseLink(options, node, children) {
         // TODO Not equivalent to `node.href`!
         // Add another HTMLParseResult method?
-    let href = options.result.getAttributeValue(node, "href");
+        let href = this.result.getAttributeValue(node, "href");
         return new LinkPart(href, children);
-}
+    }
 
-function parseList(options, node) {
+    parseList(node) {
-    const { result } = options;
+        const result = this.result;
         let start = null;
         if (result.getNodeElementName(node) === "OL") {
             // Will return 1 for, say, '1A', which may not be intended?
@@ -46,14 +38,14 @@ function parseList(options, node) {
             if (result.getNodeElementName(child) !== "LI") {
                 continue;
             }
-        const item = parseNodes(options, result.getChildNodes(child));
+            const item = this.parseNodes(result.getChildNodes(child));
             nodes.push(item);
         }
         return new ListBlock(start, nodes);
-}
+    }
 
-function parseCodeBlock(options, node) {
+    parseCodeBlock(node) {
-    const { result } = options;
+        const result = this.result;
         let codeNode;
         for (const child of result.getChildNodes(node)) {
             codeNode = child;
@@ -71,12 +63,12 @@ function parseCodeBlock(options, node) {
             }
         }
         return new CodeBlock(language, codeNode.textContent);
-}
+    }
 
-function parseImage(options, node) {
+    parseImage(node) {
-    const { result, mediaRepository } = options;
+        const result = this.result;
         const src = result.getAttributeValue(node, "src") || "";
-    const url = mediaRepository.mxcUrl(src);
+        const url = this.mediaRepository.mxcUrl(src);
         // We just ignore non-mxc `src` attributes.
         if (!url) {
             return null;
@@ -86,67 +78,72 @@ function parseImage(options, node) {
         const alt = result.getAttributeValue(node, "alt");
         const title = result.getAttributeValue(node, "title");
         return new ImagePart(url, { width, height, alt, title });
-}
-
-function buildNodeMap() {
-    let map = {
-        A: { descend: true, parsefn: parseLink },
-        UL: { descend: false, parsefn: parseList },
-        OL: { descend: false, parsefn: parseList },
-        PRE: { descend: false, parsefn: parseCodeBlock },
-        BR: { descend: false, parsefn: () => new NewLinePart() },
-        HR: { descend: false, parsefn: () => new RulePart() },
-        IMG: { descend: false, parsefn: parseImage }
     }
-    for (const tag of basicNodes) {
-        map[tag] = { descend: true, parsefn: basicWrapper(tag) }
-    }
-    for (let level = 1; level <= 6; level++) {
-        const tag = "h" + level;
-        map[tag] = { descend: true, parsefn: headerWrapper(level) }
-    }
-    return map;
-}
 
-/**
+    parseElement(node) {
- * Handlers for various nodes.
+        const result = this.result;
- *
+        const tag = result.getNodeElementName(node);
- * Each handler has two properties: `descend` and `parsefn`.
+        switch (tag) {
- * If `descend` is true, the node's children should be
+            case "H1":
- * parsed just like any other node, and fed as a second argument
+            case "H2":
- * to `parsefn`. If not, the node's children are either to be ignored
+            case "H3":
- * (as in <pre>) or processed specially (as in <ul>).
+            case "H4":
- *
+            case "H5":
- * The `parsefn` combines a node's data and its children into
+            case "H6": {
- * an internal representation node.
+                const children = this.parseChildNodes(node);
- */
+                return new HeaderBlock(parseInt(tag[1]), children)
-const nodes = buildNodeMap();
+            }
+            case "A": {
+                const children = this.parseChildNodes(node);
+                return this.parseLink(node, children);
+            }
+            case "UL":
+            case "OL":
+                return this.parseList(node);
+            case "PRE":
+                return this.parseCodeBlock(node);
+            case "BR":
+                return new NewLinePart();
+            case "HR":
+                return new RulePart();
+            case "IMG":
+                return this.parseImage(node);
+            default: {
+                if (!basicNodes.includes(tag)) {
+                    return null;
+                }
+                const children = this.parseChildNodes(node);
+                return new FormatPart(tag, children);
+            }
+        }
+    }
 
-function parseNode(options, node) {
+    parseNode(node) {
-    const { result } = options;
+        const result = this.result;
         if (result.isTextNode(node)) {
             return new TextPart(result.getNodeText(node));
         } else if (result.isElementNode(node)) {
-        const f = nodes[result.getNodeElementName(node)];
+            return this.parseElement(node);
-        if (!f) {
-            return null;
-        }
-        const children = f.descend ? parseNodes(options, node.childNodes) : null;
-        return f.parsefn(options, node, children);
         }
         return null;
-}
+    }
 
-function parseNodes(options, nodes) {
+    parseChildNodes(node) {
+        const childNodes = this.result.getChildNodes(node);
+        return this.parseNodes(childNodes);
+    }
+
+    parseNodes(nodes) {
         const parsed = [];
         for (const htmlNode of nodes) {
-        let node = parseNode(options, htmlNode);
+            let node = this.parseNode(htmlNode);
             // Just ignore invalid / unknown tags.
             if (node) {
                 parsed.push(node);
             }
         }
         return parsed;
+    }
 }
 
 const sanitizeConfig = {
@@ -170,8 +167,8 @@ const sanitizeConfig = {
 
 export function parseHTMLBody({ mediaRepository, platform }, html) {
     const parseResult = platform.parseHTML(sanitizeHtml(html, sanitizeConfig));
-    const options = { result: parseResult, mediaRepository };
+    const deserializer = new Deserializer(parseResult, mediaRepository);
-    const parts = parseNodes(options, parseResult.rootNodes);
+    const parts = deserializer.parseNodes(parseResult.rootNodes);
     return new MessageBody(html, parts);
 }