fix #3391: Remove flowchart as fallback for diagram detection.

mermaid-js · Oct 6, 2022 · 1615c6d · 1615c6d
1 parent d59f878
commit 1615c6d
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 24 deletions.
diff --git a/cypress/platform/sidv.html b/cypress/platform/sidv.html
@@ -0,0 +1,14 @@
+<html>
+  <body>
+    <pre class="mermaid">
+    none
+    hello world
+    </pre>
+    <script src="./mermaid.js"></script>
+    <script>
+      mermaid.initialize({
+        logLevel: 1,
+      });
+    </script>
+  </body>
+</html>
diff --git a/package.json b/package.json
@@ -48,7 +48,8 @@
     "e2e": "start-server-and-test dev http://localhost:9000/ cypress",
     "ci": "vitest run",
     "test": "pnpm lint && vitest run",
-    "test:watch": "vitest --coverage --watch",
+    "test:watch": "vitest --watch",
+    "test:coverage": "vitest --coverage",
     "prepublishOnly": "pnpm build && pnpm test",
     "prepare": "concurrently \"husky install\" \"pnpm build\"",
     "pre-commit": "lint-staged"

diff --git a/packages/mermaid/src/Diagram.ts b/packages/mermaid/src/Diagram.ts
@@ -8,11 +8,18 @@ export class Diagram {
   parser;
   renderer;
   db;
+  private detectTypeFailed = false;
   // eslint-disable-next-line @typescript-eslint/ban-types
   constructor(public txt: string, parseError?: Function) {
     const cnf = configApi.getConfig();
     this.txt = txt;
-    this.type = detectType(txt, cnf);
+    try {
+      this.type = detectType(txt, cnf);
+    } catch (e) {
+      this.handleError(e, parseError);
+      this.type = 'error';
+      this.detectTypeFailed = true;
+    }
     const diagram = getDiagram(this.type);
     log.debug('Type ' + this.type);
     // Setup diagram
@@ -32,29 +39,37 @@ export class Diagram {
 
   // eslint-disable-next-line @typescript-eslint/ban-types
   parse(text: string, parseError?: Function): boolean {
+    if (this.detectTypeFailed) {
+      return false;
+    }
     try {
       text = text + '\n';
       this.db.clear();
       this.parser.parse(text);
       return true;
     } catch (error) {
-      // Is this the correct way to access mermiad's parseError()
-      // method ? (or global.mermaid.parseError()) ?
-      if (parseError) {
-        if (isDetailedError(error)) {
-          // handle case where error string and hash were
-          // wrapped in object like`const error = { str, hash };`
-          parseError(error.str, error.hash);
-        } else {
-          // assume it is just error string and pass it on
-          parseError(error);
-        }
+      this.handleError(error, parseError);
+    }
+    return false;
+  }
+
+  // eslint-disable-next-line @typescript-eslint/ban-types
+  handleError(error: unknown, parseError?: Function) {
+    // Is this the correct way to access mermiad's parseError()
+    // method ? (or global.mermaid.parseError()) ?
+    if (parseError) {
+      if (isDetailedError(error)) {
+        // handle case where error string and hash were
+        // wrapped in object like`const error = { str, hash };`
+        parseError(error.str, error.hash);
       } else {
-        // No mermaid.parseError() handler defined, so re-throw it
-        throw error;
+        // assume it is just error string and pass it on
+        parseError(error);
       }
+    } else {
+      // No mermaid.parseError() handler defined, so re-throw it
+      throw error;
     }
-    return false;
   }
 
   getParser() {

diff --git a/packages/mermaid/src/diagram-api/detectType.ts b/packages/mermaid/src/diagram-api/detectType.ts
@@ -35,16 +35,13 @@ const detectors: Record<string, DetectorRecord> = {};
 export const detectType = function (text: string, config?: MermaidConfig): string {
   text = text.replace(directive, '').replace(anyComment, '\n');
 
-  // console.log(detectors);
-
   for (const [key, detectorRecord] of Object.entries(detectors)) {
     if (detectorRecord.detector(text, config)) {
       return key;
     }
   }
-  // TODO: #3391
-  // throw new Error(`No diagram type detected for text: ${text}`);
-  return 'flowchart';
+
+  throw new Error(`No diagram type detected for text: ${text}`);
 };
 
 export const addDetector = (key: string, detector: DiagramDetector, path: string) => {

diff --git a/packages/mermaid/src/diagram-api/diagramAPI.spec.ts b/packages/mermaid/src/diagram-api/diagramAPI.spec.ts
@@ -15,7 +15,9 @@ describe('DiagramAPI', () => {
 
   it('should handle diagram registrations', () => {
     expect(() => getDiagram('loki')).toThrow();
-    expect(() => detectType('loki diagram')).not.toThrow(); // TODO: #3391
+    expect(() => detectType('loki diagram')).toThrow(
+      'No diagram type detected for text: loki diagram'
+    );
     const detector: DiagramDetector = (str: string) => {
       return str.match('loki') !== null;
     };

diff --git a/packages/mermaid/src/diagrams/flowchart/flowDb.js b/packages/mermaid/src/diagrams/flowchart/flowDb.js
@@ -429,8 +429,7 @@ export const clear = function (ver = 'gen-1') {
   vertices = {};
   classes = {};
   edges = [];
-  funs = [];
-  funs.push(setupToolTips);
+  funs = [setupToolTips];
   subGraphs = [];
   subGraphLookup = {};
   subCount = 0;