🐛 Fix mathjax; cleanup distribution; resolves #224

Author: ebullient

.gitignore

@@ -22,6 +22,7 @@ coverage/
 dist
 old
 examples/
+*.out
 
 slides-extended/
 slides-extended.zip

esbuild.config.mjs

@@ -188,9 +188,8 @@ const parameters = {
         }),
         copy({
             assets: {
-                from: ['node_modules/mathjax/es5/**/*'],
-                to: ['./plugin/math/mathjax'],
-                keepStructure: true
+                from: ['node_modules/mathjax/**/*'],
+                to: ['./plugin/math/mathjax/'],
             }
         }),
         copy({

src/plugin/load-mathjax.js

@@ -1,3 +1,7 @@
+// Queue for typeset calls that happen before MathJax is ready
+const typesetQueue = [];
+let mathJaxReady = false;
+
 window.MathJax = {
     tex: {
         inlineMath: [
@@ -21,24 +25,38 @@ window.MathJax = {
     },
     options: {
         enableMenu: false,
-        enableExplorer: false,
-        enableAssistiveMml: false,
         enableEnrichment: false,
-        menuOptions: {
-            settings: {
-                assistiveMml: false,
-                collapsible: false,
-                explorer: false,
-            },
-        },
-        renderActions: {
-            assistiveMml: [],
-        },
     },
     startup: {
         ready: () => {
             MathJax.startup.defaultReady();
-            console.log("MathJax initialized with all extensions");
+            MathJax.startup.promise.then(() => {
+                console.debug("MathJax initialized and ready");
+                mathJaxReady = true;
+
+                // Process any queued typeset calls
+                if (typesetQueue.length > 0) {
+                    console.debug(
+                        `Processing ${typesetQueue.length} queued MathJax typeset calls`,
+                    );
+                    typesetQueue.forEach((args) => {
+                        MathJax.typesetPromise(...args).catch((err) =>
+                            console.error("Queued typeset error:", err),
+                        );
+                    });
+                    typesetQueue.length = 0;
+                }
+            });
         },
     },
+    // Provide a safe typeset function that queues calls if MathJax isn't ready yet
+    typeset: (...args) => {
+        if (mathJaxReady && MathJax.typesetPromise) {
+            return MathJax.typesetPromise(...args);
+        }
+        // Queue the call for later
+        typesetQueue.push(args);
+        console.debug("MathJax not ready yet, queuing typeset call");
+        return Promise.resolve();
+    },
 };

src/slidesExtended-Distribution.ts

@@ -1,4 +1,11 @@
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import {
+    existsSync,
+    mkdirSync,
+    readFileSync,
+    renameSync,
+    rmSync,
+    writeFileSync,
+} from "node:fs";
 import path from "node:path";
 import JSZip from "jszip";
 import { requestUrl } from "obsidian";
@@ -32,27 +39,71 @@ export class SlidesExtendedDistribution {
     async update() {
         const version = this.plugin.manifest.version;
         const downloadUrl = `https://github.com/ebullient/obsidian-slides-extended/releases/download/${version}/slides-extended.zip`;
-        const response = await requestUrl(downloadUrl);
-        if (response.status !== 200) {
-            console.error(`Failed to download ${downloadUrl}`);
-            return;
+
+        // Backup existing dist directory before attempting update
+        // Use dist-backup instead of dist/.backup to avoid issues with trailing slashes
+        const backupDir = path.join(this.pluginDirectory, "dist-backup");
+        let didBackup = false;
+
+        if (existsSync(this.distDirectory)) {
+            console.debug(
+                "Backing up existing distribution files before update",
+            );
+            // Remove any existing backup first
+            if (existsSync(backupDir)) {
+                rmSync(backupDir, { recursive: true, force: true });
+            }
+            renameSync(this.distDirectory, backupDir);
+            didBackup = true;
         }
 
-        const zip = new JSZip();
-        const contents = await zip.loadAsync(response.arrayBuffer);
-        const pluginDirectory = this.pluginDirectory;
-
-        for (const filename of Object.keys(contents.files)) {
-            if (!contents.files[filename].dir) {
-                zip.file(filename)
-                    .async("nodebuffer")
-                    .then((content) => {
-                        const dest = path.join(pluginDirectory, filename);
-                        const dir = path.dirname(dest);
-                        mkdirSync(dir, { recursive: true });
-                        writeFileSync(dest, content);
+        try {
+            const response = await requestUrl(downloadUrl);
+            if (response.status !== 200) {
+                throw new Error(
+                    `Failed to download ${downloadUrl}: HTTP ${response.status}`,
+                );
+            }
+
+            const zip = new JSZip();
+            const contents = await zip.loadAsync(response.arrayBuffer);
+            const pluginDirectory = this.pluginDirectory;
+
+            for (const filename of Object.keys(contents.files)) {
+                if (!contents.files[filename].dir) {
+                    zip.file(filename)
+                        .async("nodebuffer")
+                        .then((content) => {
+                            const dest = path.join(pluginDirectory, filename);
+                            const dir = path.dirname(dest);
+                            mkdirSync(dir, { recursive: true });
+                            writeFileSync(dest, content);
+                        });
+                }
+            }
+
+            // Update successful, remove backup
+            if (didBackup && existsSync(backupDir)) {
+                console.debug("Update successful, removing backup");
+                rmSync(backupDir, { recursive: true, force: true });
+            }
+        } catch (error) {
+            console.error("Failed to update distribution files:", error);
+
+            // Restore backup on failure
+            if (didBackup && existsSync(backupDir)) {
+                console.debug("Restoring backup due to update failure");
+                // Remove partial update if it exists
+                if (existsSync(this.distDirectory)) {
+                    rmSync(this.distDirectory, {
+                        recursive: true,
+                        force: true,
                     });
+                }
+                renameSync(backupDir, this.distDirectory);
             }
+
+            throw error;
         }
     }
 }

src/template/embed.html

@@ -135,7 +135,7 @@
                 gfm: true,
             },
             mathjax3: {
-                mathjax: '{{{base}}}plugin/math/mathjax/tex-chtml-full.js',
+                mathjax: '{{{base}}}plugin/math/mathjax/tex-chtml.js',
             },
         };
 

src/template/reveal.html

@@ -208,7 +208,7 @@
             allottedTime: {{{.}}} * 1000,
             {{/timeForPresentation}}
             mathjax3: {
-                mathjax: '{{{base}}}plugin/math/mathjax/tex-chtml-full.js',
+                mathjax: '{{{base}}}plugin/math/mathjax/tex-chtml.js',
             },
             markdown: {
                 gfm: true,

test/buildValidation.unit.test.ts

@@ -0,0 +1,60 @@
+import { existsSync, readFileSync, readdirSync } from "node:fs";
+import { join } from "node:path";
+
+const BUILD_DIR = process.env.OUTDIR || "./build";
+const TEMPLATE_DIR = "./src/template";
+
+describe("Build Validation", () => {
+    describe("Template References", () => {
+        const templates = readdirSync(TEMPLATE_DIR).filter((f) =>
+            f.endsWith(".html"),
+        );
+
+        for (const templateFile of templates) {
+            describe(templateFile, () => {
+                const templatePath = join(TEMPLATE_DIR, templateFile);
+                const content = readFileSync(templatePath, "utf-8");
+
+                // Extract all {{{base}}}path references (from any attribute or config)
+                // Matches: {{{base}}}dist/..., {{{base}}}css/..., {{{base}}}plugin/...
+                const basePathPattern =
+                    /\{\{\{base\}\}\}((?:dist|css|plugin)\/[^"'}\s]+)/g;
+                const matches = [...content.matchAll(basePathPattern)];
+
+                if (matches.length === 0) {
+                    it(`should have at least one {{{base}}} reference`, () => {
+                        expect(matches.length).toBeGreaterThan(0);
+                    });
+                }
+
+                for (const match of matches) {
+                    const path = match[1];
+
+                    it(`should have ${path} in build output`, () => {
+                        const fullPath = join(BUILD_DIR, path);
+                        expect(existsSync(fullPath)).toBe(true);
+                    });
+                }
+            });
+        }
+    });
+
+    describe("Critical Build Files", () => {
+        const criticalFiles = [
+            "dist/reveal.js",
+            "plugin/math/math.js",
+            "plugin/math/mathjax/tex-chtml.js",
+            "plugin/load-mathjax.js",
+            "plugin/obsidian-markdown.js",
+            "template/reveal.html",
+            "template/embed.html",
+        ];
+
+        for (const file of criticalFiles) {
+            it(`should have ${file}`, () => {
+                const fullPath = join(BUILD_DIR, file);
+                expect(existsSync(fullPath)).toBe(true);
+            });
+        }
+    });
+});