Merge pull request #117 from beNative/codex/fix-offline-rendering-issue-for-plantuml-6rwc3j

Assume bundled PlantUML jar instead of downloading

Author: beNative

.gitignore

@@ -15,6 +15,7 @@ assets/icon*.png
 assets/icon.ico
 assets/icon.icns
 assets/favicon.ico
+assets/plantuml/plantuml.jar
 
 # Editor directories and files
 .vscode/*

FUNCTIONAL_MANUAL.md

@@ -181,7 +181,7 @@ Accessed via the info icon in the title bar. This view contains tabs for reading
 The **General** settings category includes a **PlantUML Rendering** selector. Choose between:
 
 - **Remote (plantuml.com):** Encodes the diagram and requests the SVG from the public PlantUML server.
-- **Offline (local renderer):** Invokes the bundled PlantUML engine inside the desktop application. This mode requires a local Java Runtime Environment and access to Graphviz (or the bundled `viz.js` assets) so the renderer can generate diagrams without contacting plantuml.com.
+- **Offline (local renderer):** Invokes the PlantUML jar bundled with the application (`assets/plantuml/plantuml.jar`) through the local Java Runtime Environment, letting the app render diagrams without contacting plantuml.com.
 
 If the Java runtime is unavailable, DocForge will report the error in the preview and you can switch back to remote rendering at any time.
 

TECHNICAL_MANUAL.md

@@ -14,7 +14,7 @@ This document provides a technical overview of the DocForge application's archit
 -   **Bundler:** [esbuild](https://esbuild.github.io/) for fast and efficient bundling of the application's source code.
 -   **Styling:** [Tailwind CSS](https://tailwindcss.com/) for a utility-first CSS framework.
 -   **Packaging:** [electron-builder](https://www.electron.build/) for creating distributable application packages.
--   **Diagram Rendering:** [PlantUML](https://plantuml.com/) via either the public plantuml.com service or the bundled [`node-plantuml`](https://www.npmjs.com/package/node-plantuml) renderer. Offline rendering requires a locally installed Java Runtime Environment and access to Graphviz (or the cached `viz.js` binary) so that diagrams can be rendered without network access.
+-   **Diagram Rendering:** [PlantUML](https://plantuml.com/) via either the public plantuml.com service or a PlantUML jar bundled with the application (`assets/plantuml/plantuml.jar`). Offline rendering invokes the jar through the system Java Runtime Environment, so diagrams render without any network connectivity.
 
 ---
 
@@ -95,7 +95,7 @@ This system provides a consistent and extensible editing experience for all docu
 -   **`PreviewPane.tsx`:** This component is responsible for displaying the rendered output of a document. It debounces content updates for performance and uses the `PreviewService` to get the correct output.
 -   **`services/previewService.ts`:** This service acts as a registry for all available renderer "plugins." It exposes a method, `getRendererForLanguage()`, which finds and returns the appropriate renderer for a given language ID (e.g., 'markdown').
 -   **Renderer Plugins (`services/preview/`):** Each file format with a preview is supported by a dedicated renderer class that implements the `IRenderer` interface. This makes the system highly extensible: to support a new format, one only needs to create a new renderer class and add it to the `previewService` registry. The bundled plugins cover Markdown (with Mermaid + PlantUML support), standalone PlantUML documents, HTML, PDFs, common image formats, and a plaintext fallback renderer.
-    -   Both the Markdown renderer and the standalone PlantUML renderer share the `PlantUMLDiagram` component, which routes diagrams through either the remote plantuml.com server or the offline `node-plantuml` IPC bridge depending on the active setting.
+    -   Both the Markdown renderer and the standalone PlantUML renderer share the `PlantUMLDiagram` component, which routes diagrams through either the remote plantuml.com server or the offline Java-based IPC bridge depending on the active setting.
 
 ### LLM Service (`services/llmService.ts`)
 

assets/plantuml/.gitkeep

@@ -181,7 +181,7 @@ Accessed via the info icon in the title bar. This view contains tabs for reading
 The **General** settings category includes a **PlantUML Rendering** selector. Choose between:
 
 - **Remote (plantuml.com):** Encodes the diagram and requests the SVG from the public PlantUML server.
-- **Offline (local renderer):** Invokes the bundled PlantUML engine inside the desktop application. This mode requires a local Java Runtime Environment and access to Graphviz (or the bundled `viz.js` assets) so the renderer can generate diagrams without contacting plantuml.com.
+- **Offline (local renderer):** Invokes the PlantUML jar bundled with the application (`assets/plantuml/plantuml.jar`) through the local Java Runtime Environment, letting the app render diagrams without contacting plantuml.com.
 
 If the Java runtime is unavailable, DocForge will report the error in the preview and you can switch back to remote rendering at any time.
 

docs/FUNCTIONAL_MANUAL.md

@@ -14,7 +14,7 @@ This document provides a technical overview of the DocForge application's archit
 -   **Bundler:** [esbuild](https://esbuild.github.io/) for fast and efficient bundling of the application's source code.
 -   **Styling:** [Tailwind CSS](https://tailwindcss.com/) for a utility-first CSS framework.
 -   **Packaging:** [electron-builder](https://www.electron.build/) for creating distributable application packages.
--   **Diagram Rendering:** [PlantUML](https://plantuml.com/) via either the public plantuml.com service or the bundled [`node-plantuml`](https://www.npmjs.com/package/node-plantuml) renderer. Offline rendering requires a locally installed Java Runtime Environment and access to Graphviz (or the cached `viz.js` binary) so that diagrams can be rendered without network access.
+-   **Diagram Rendering:** [PlantUML](https://plantuml.com/) via either the public plantuml.com service or a PlantUML jar bundled with the application (`assets/plantuml/plantuml.jar`). Offline rendering invokes the jar through the system Java Runtime Environment, so diagrams render without any network connectivity.
 
 ---
 
@@ -95,7 +95,7 @@ This system provides a consistent and extensible editing experience for all docu
 -   **`PreviewPane.tsx`:** This component is responsible for displaying the rendered output of a document. It debounces content updates for performance and uses the `PreviewService` to get the correct output.
 -   **`services/previewService.ts`:** This service acts as a registry for all available renderer "plugins." It exposes a method, `getRendererForLanguage()`, which finds and returns the appropriate renderer for a given language ID (e.g., 'markdown').
 -   **Renderer Plugins (`services/preview/`):** Each file format with a preview is supported by a dedicated renderer class that implements the `IRenderer` interface. This makes the system highly extensible: to support a new format, one only needs to create a new renderer class and add it to the `previewService` registry. The bundled plugins cover Markdown (with Mermaid + PlantUML support), standalone PlantUML documents, HTML, PDFs, common image formats, and a plaintext fallback renderer.
-    -   Both the Markdown renderer and the standalone PlantUML renderer share the `PlantUMLDiagram` component, which routes diagrams through either the remote plantuml.com server or the offline `node-plantuml` IPC bridge depending on the active setting.
+    -   Both the Markdown renderer and the standalone PlantUML renderer share the `PlantUMLDiagram` component, which routes diagrams through either the remote plantuml.com server or the offline Java-based IPC bridge depending on the active setting.
 
 ### LLM Service (`services/llmService.ts`)
 

docs/TECHNICAL_MANUAL.md

@@ -13,7 +13,7 @@ import * as zlib from 'zlib';
 import * as os from 'os';
 import * as stream from 'stream';
 import { promisify } from 'util';
-import { generate as plantumlGenerate } from 'node-plantuml';
+import { spawn } from 'child_process';
 
 // Fix: Inform TypeScript about the __dirname global variable provided by Node.js, which is present in a CommonJS-like environment.
 declare const __dirname: string;
@@ -435,58 +435,72 @@ ipcMain.handle('plantuml:render-svg', async (_, diagram: string, format: 'svg' =
     }
 
     try {
-        const generator = plantumlGenerate(trimmed, { format: 'svg' });
-        generator.out.setEncoding('utf-8');
-        generator.err.setEncoding('utf-8');
+        const jarPath = await resolvePlantUmlJar();
 
         return await new Promise<{ success: boolean; svg?: string; error?: string; details?: string }>((resolve) => {
+            const child = spawn('java', ['-Djava.awt.headless=true', '-jar', jarPath, '-pipe', '-tsvg'], {
+                stdio: ['pipe', 'pipe', 'pipe'],
+            });
+
             let svgOutput = '';
             let errorOutput = '';
+            let resolved = false;
 
-            const cleanup = () => {
-                generator.out.removeAllListeners();
-                generator.err.removeAllListeners();
+            const finalize = (payload: { success: boolean; svg?: string; error?: string; details?: string }) => {
+                if (resolved) {
+                    return;
+                }
+                resolved = true;
+                resolve(payload);
             };
 
-            const resolveWithError = (message: string) => {
-                cleanup();
-                resolve({
-                    success: false,
-                    error: message,
-                    details: errorOutput.trim() || undefined,
-                });
-            };
+            child.stdout.setEncoding('utf-8');
+            child.stderr.setEncoding('utf-8');
+
+            child.stdout.on('data', (chunk) => {
+                svgOutput += chunk.toString();
+            });
 
-            generator.err.on('data', (chunk) => {
+            child.stderr.on('data', (chunk) => {
                 errorOutput += chunk.toString();
             });
 
-            generator.out.on('data', (chunk) => {
-                svgOutput += chunk.toString();
+            child.on('error', (err) => {
+                const message =
+                    err instanceof Error
+                        ? err.message
+                        : 'Failed to start the local PlantUML renderer process.';
+                finalize({
+                    success: false,
+                    error: message,
+                    details: errorOutput.trim() || undefined,
+                });
             });
 
-            generator.out.on('end', () => {
-                cleanup();
-                if (svgOutput.trim()) {
-                    resolve({ success: true, svg: svgOutput });
-                } else {
-                    resolve({
-                        success: false,
-                        error: 'PlantUML renderer produced no SVG output.',
-                        details: errorOutput.trim() || undefined,
-                    });
+            child.on('close', (code) => {
+                if (code === 0 && svgOutput.trim()) {
+                    finalize({ success: true, svg: svgOutput });
+                    return;
                 }
-            });
 
-            generator.out.on('error', (streamError) => {
-                const message = streamError instanceof Error ? streamError.message : String(streamError);
-                resolveWithError(message);
+                const exitDetails = errorOutput.trim() || `Renderer exited with code ${code}.`;
+                finalize({
+                    success: false,
+                    error: 'Local PlantUML renderer failed to produce output.',
+                    details: exitDetails,
+                });
             });
 
-            generator.err.on('error', (streamError) => {
-                const message = streamError instanceof Error ? streamError.message : String(streamError);
-                resolveWithError(message);
+            child.stdin.on('error', (err) => {
+                const message = err instanceof Error ? err.message : String(err);
+                finalize({
+                    success: false,
+                    error: 'Failed to send diagram to the PlantUML renderer.',
+                    details: message,
+                });
             });
+
+            child.stdin.end(trimmed);
         });
     } catch (error) {
         const message = error instanceof Error ? error.message : String(error);
@@ -495,6 +509,54 @@ ipcMain.handle('plantuml:render-svg', async (_, diagram: string, format: 'svg' =
     }
 });
 
+let cachedPlantumlJarPath: string | null = null;
+let plantumlJarLookupPromise: Promise<string> | null = null;
+
+const PLANTUML_JAR_RELATIVE_PATH = path.join('assets', 'plantuml', 'plantuml.jar');
+
+async function resolvePlantUmlJar(): Promise<string> {
+    if (cachedPlantumlJarPath) {
+        return cachedPlantumlJarPath;
+    }
+    if (plantumlJarLookupPromise) {
+        return plantumlJarLookupPromise;
+    }
+
+    const candidates = [
+        path.join(app.getAppPath(), PLANTUML_JAR_RELATIVE_PATH),
+        path.join(process.resourcesPath ?? '', PLANTUML_JAR_RELATIVE_PATH),
+        path.join(__dirname, '..', PLANTUML_JAR_RELATIVE_PATH),
+        path.join(__dirname, PLANTUML_JAR_RELATIVE_PATH),
+    ].reduce<string[]>((paths, candidate) => {
+        const normalized = path.normalize(candidate);
+        if (!paths.includes(normalized)) {
+            paths.push(normalized);
+        }
+        return paths;
+    }, []);
+
+    plantumlJarLookupPromise = (async () => {
+        for (const candidate of candidates) {
+            try {
+                await fs.access(candidate);
+                cachedPlantumlJarPath = candidate;
+                return candidate;
+            } catch {
+                // Continue searching
+            }
+        }
+        throw new Error(
+            'Bundled PlantUML renderer is missing. Ensure assets/plantuml/plantuml.jar is included alongside the application.'
+        );
+    })();
+
+    try {
+        return await plantumlJarLookupPromise;
+    } finally {
+        plantumlJarLookupPromise = null;
+    }
+}
+
 // Python environments & execution
 ipcMain.handle('python:list-envs', async () => {
     return pythonManager.listEnvironments();

electron/main.ts

@@ -34,7 +34,7 @@ const buildOrWatch = async (name, config) => {
         platform: 'node',
         entryPoints: ['electron/main.ts'],
         outfile: 'dist/main.js',
-        external: ['electron', 'better-sqlite3', 'node-plantuml'],
+        external: ['electron', 'better-sqlite3'],
       }),
       buildOrWatch('preload', {
         ...sharedConfig,

esbuild.config.js

@@ -35,7 +35,6 @@
     "electron-log": "^5.1.5",
     "electron-squirrel-startup": "^1.0.1",
     "electron-updater": "^6.2.1",
-    "node-plantuml": "^0.9.0",
     "uuid": "^10.0.0"
   },
   "devDependencies": {