Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor: Change flowDB to class based architecture. #6161

Open
wants to merge 16 commits into
base: develop
Choose a base branch
from
Open

Refactor: Change flowDB to class based architecture. #6161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
9ef6090
convert flowDb to class.
saurabhg772244 Dec 31, 2024
0695893
Added test cases
saurabhg772244 Jan 3, 2025
f5bae98
Set generation to gen-2 in clear
saurabhg772244 Jan 3, 2025
3cad798
Update packages/mermaid/src/mermaidAPI.spec.ts
saurabhg772244 Jan 6, 2025
8dc016e
Update packages/mermaid/src/mermaidAPI.spec.ts
saurabhg772244 Jan 6, 2025
6836e9c
Updated test cases
saurabhg772244 Jan 7, 2025
16d2251
Merge branch 'develop' of https://github.com/mermaid-js/mermaid into …
saurabhg772244 Jan 10, 2025
29ca150
Added unit test cases for flow DB to have functions used in flow JISON
saurabhg772244 Jan 10, 2025
6cc31b7
Added changeset
saurabhg772244 Jan 10, 2025
c869730
Code refactor.
saurabhg772244 Jan 14, 2025
e1aab25
Updated changeset message.
saurabhg772244 Jan 14, 2025
0f08c3b
Updated FlowDB instance.
saurabhg772244 Jan 14, 2025
f7fe8f2
Merge branch 'develop' of https://github.com/mermaid-js/mermaid into …
saurabhg772244 Jan 16, 2025
f9ac986
Updated as per Alois suggestion.
saurabhg772244 Jan 21, 2025
6ea13cd
Fixed binding issue
saurabhg772244 Jan 22, 2025
1575a93
Merge branch 'develop' of https://github.com/mermaid-js/mermaid into …
saurabhg772244 Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/new-kiwis-listen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'mermaid': patch
---

fix: `mermaidAPI.getDiagramFromText()` now returns a new different db for each flowchart
63 changes: 15 additions & 48 deletions cypress/platform/saurabh.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,56 +62,23 @@

<body style="display: flex; gap: 2rem; flex-direction: row">
<pre id="diagram4" class="mermaid">
flowchart LR
A@{ icon: "fa:window-minimize", form: circle }
E@{ icon: "fa:window-minimize", form: circle }
B@{ icon: "fa:bell", form: circle }
B2@{ icon: "fa:bell", form: circle }
C@{ icon: "fa:address-book", form: square }
D@{ icon: "fa:star-half", form: square }
A --> E
B --> B2

flowchart
A --> A
subgraph B
B1 --> B1
end
subgraph C
subgraph C1
C2 --> C2
subgraph D
D1 --> D1
end
D --> D
end
C1 --> C1
end

</pre>
<pre id="diagram4" class="mermaid2">
flowchart TB
A --test2--> B2@{ icon: "fa:bell", form: "rounded", label: "B2 aiduaid uyawduad uaduabd uyduadb", pos: "b" }
B2 --test--> C
D --> B2 --> E
style B2 fill:#f9f,stroke:#333,stroke-width:4px
</pre
>
<pre id="diagram43" class="mermaid2">
flowchart BT
A --test2--> B2@{ icon: "fa:bell", form: "square", label: "B2", pos: "t", h: 40, w: 30 }
B2 --test--> C
D --> B2 --> E
</pre
>
<pre id="diagram4" class="mermaid2">
flowchart BT
A --test2--> B2@{ icon: "fa:bell", label: "B2 awiugdawu uydgayuiwd wuydguy", pos: "b", h: 40, w: 30 }
B2 --test--> C
</pre
>
<pre id="diagram43" class="mermaid2">
flowchart BT
A --test2--> B2@{ icon: "fa:bell", label: "B2 dawuygd ayuwgd uy", pos: "t", h: 40, w: 30 }
B2 --test--> C
</pre
>
<pre id="diagram6" class="mermaid2">
flowchart TB
A --> B2@{ icon: "fa:bell", form: "circle", label: "test augfuyfavf ydvaubfuac", pos: "t", w: 200, h: 100 } --> C
</pre
>
<pre id="diagram6" class="mermaid2">
flowchart TB
A --> B2@{ icon: "fa:bell", form: "circle", label: "test augfuyfavf ydvaubfuac", pos: "b", w: 200, h: 100 } --> C
D --> B2 --> E
</pre
>
<script type="module">
import mermaid from './mermaid.esm.mjs';
import layouts from './mermaid-layout-elk.esm.mjs';
Expand Down
37 changes: 35 additions & 2 deletions packages/mermaid/src/diagrams/flowchart/flowDb.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import flowDb from './flowDb.js';
import { FlowDB } from './flowDb.js';
import type { FlowSubGraph } from './types.js';

describe('flow db subgraphs', () => {
let flowDb: FlowDB;
let subgraphs: FlowSubGraph[];
beforeEach(() => {
flowDb = new FlowDB();
subgraphs = [
{ nodes: ['a', 'b', 'c', 'e'] },
{ nodes: ['f', 'g', 'h'] },
Expand Down Expand Up @@ -44,8 +46,9 @@ describe('flow db subgraphs', () => {
});

describe('flow db addClass', () => {
let flowDb: FlowDB;
beforeEach(() => {
flowDb.clear();
flowDb = new FlowDB();
});
it('should detect many classes', () => {
flowDb.addClass('a,b', ['stroke-width: 8px']);
Expand All @@ -65,3 +68,33 @@ describe('flow db addClass', () => {
expect(classes.get('a')?.styles).toEqual(['stroke-width: 8px']);
});
});

describe('flow db class', () => {
let flowDb: FlowDB;
beforeEach(() => {
flowDb = new FlowDB();
});
// This is to ensure that functions used in flow JISON are exposed as function from FlowDB
it('should have functions used in flow JISON as own property', () => {
const functionsUsedInParser = [
'setDirection',
'addSubGraph',
'setAccTitle',
'setAccDescription',
'addVertex',
'addLink',
'setClass',
'destructLink',
'addClass',
'setClickEvent',
'setTooltip',
'setLink',
'updateLink',
'updateLinkInterpolate',
] as const satisfies (keyof FlowDB)[];

for (const fun of functionsUsedInParser) {
expect(Object.hasOwn(flowDb, fun)).toBe(true);
}
});
});
Loading
Loading