Merge pull request #957 from mermaid-js/sidv/panzoom

Add PanZoom
This commit is contained in:
Sidharth Vinod
2022-08-16 00:50:54 +05:30
committed by GitHub
18 changed files with 258 additions and 91 deletions
+6 -6
View File
@@ -9,6 +9,11 @@ on:
jobs:
cypress-run:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
# run 3 copies of the current job in parallel
containers: [1, 2, 3]
steps:
- name: Checkout
@@ -30,12 +35,6 @@ jobs:
node-version: 16
cache: 'yarn'
- name: Lint & Test
run: |
yarn install
yarn lint
yarn test:unit
# Install NPM dependencies, cache them correctly
# and run all Cypress tests
- name: Cypress run
@@ -46,5 +45,6 @@ jobs:
wait-on: 'http://localhost:3000'
record: true
headless: true
parallel: true
env:
CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
+36
View File
@@ -0,0 +1,36 @@
name: Unit Tests
on:
pull_request:
branches:
- master
- develop
jobs:
unit-tests:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- uses: actions/cache@v3
id: yarn-and-build-cache
with:
path: |
build
node_modules
key: ${{ runner.os }}-node_modules-build-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-node_modules-build-
- uses: actions/setup-node@v3
with:
node-version: 16
cache: 'yarn'
- name: Lint & Test
run: |
yarn install
yarn lint
yarn test:unit
+5 -1
View File
@@ -8,6 +8,10 @@ export default defineConfig({
snapshotFileName: './cypress/snapshots.js',
defaultCommandTimeout: 16000,
requestTimeout: 16000,
retries: {
runMode: 2,
openMode: 0
},
e2e: {
setupNodeEvents(on, config) {
on('task', {
@@ -26,6 +30,6 @@ export default defineConfig({
});
},
baseUrl: 'http://localhost:3000',
specPattern: 'cypress/e2e/**/*.{js,jsx,ts,tsx}'
specPattern: 'cypress/e2e/**/*.spec.ts'
}
});
+3 -2
View File
@@ -1,7 +1,9 @@
import { disableDebounce } from './util';
describe('Check actions', () => {
beforeEach(() => {
cy.clearLocalStorage();
cy.visit('/edit');
disableDebounce();
});
it('should update markdown code', () => {
@@ -24,8 +26,7 @@ describe('Check actions', () => {
});
it('should download png and svg', () => {
const now = new Date(2022, 0, 1).getTime();
cy.clock(now);
cy.clock(new Date(2022, 0, 1).getTime());
const downloadsFolder = Cypress.config('downloadsFolder');
const verifyFileSize = (fileType: string, size: number) => {
+21 -12
View File
@@ -1,16 +1,10 @@
describe('Auto sync tests', () => {
const cmd = Cypress.platform === 'darwin' ? 'meta' : 'ctrl';
const getEditor = ({ bottom = true, newline = false } = {}) =>
cy
.get('#editor textarea:first')
.click()
.focused()
.type(`${bottom ? '{pageDown}' : `{${cmd}}`}`)
.type(`${newline ? '{enter}' : `{${cmd}}`}`);
import { getEditor, cmd, disableDebounce } from './util';
describe('Auto sync tests', () => {
beforeEach(() => {
cy.clearLocalStorage();
cy.visit('/');
disableDebounce();
});
it('should dim diagram when code is edited', () => {
@@ -26,7 +20,7 @@ describe('Auto sync tests', () => {
cy.get('#view').should('not.have.class', 'outOfSync');
getEditor().type(' C --> Test');
cy.get('#view').should('have.class', 'outOfSync');
getEditor().type(`{${cmd}}{enter}`);
getEditor().type(`${cmd}{enter}`);
cy.get('#view').should('not.have.class', 'outOfSync');
});
@@ -52,10 +46,10 @@ describe('Auto sync tests', () => {
});
it('supports commenting code out/in', () => {
getEditor().type(`{uparrow}{${cmd}}/`);
getEditor().type(`{uparrow}${cmd}/`);
cy.get('#view').contains('Car').should('not.exist');
getEditor().type(`{uparrow}{${cmd}}/`);
getEditor().type(`{uparrow}${cmd}/`);
cy.get('#view').contains('Car').should('exist');
});
@@ -73,3 +67,18 @@ describe('Auto sync tests', () => {
.should('exist');
});
});
describe.only('Pan and Zoom', () => {
beforeEach(() => {
cy.clearLocalStorage();
cy.visit('/');
disableDebounce();
});
it('should toggle pan and zoom', () => {
cy.get('#svg-pan-zoom-reset-pan-zoom').should('not.exist');
cy.contains('Pan & Zoom').click();
cy.get('#svg-pan-zoom-reset-pan-zoom').should('exist');
cy.contains('Pan & Zoom').click();
cy.get('#svg-pan-zoom-reset-pan-zoom').should('not.exist');
});
});
+7 -4
View File
@@ -1,8 +1,11 @@
import { getEditor, disableDebounce } from './util';
describe('Save History', () => {
beforeEach(() => {
cy.clock();
cy.clearLocalStorage();
cy.visit('/edit');
disableDebounce();
cy.contains('Actions').click();
cy.contains('History').click();
});
@@ -18,14 +21,14 @@ describe('Save History', () => {
expect(str).to.equal('State already saved.');
});
cy.on('window:confirm', () => true);
cy.get('#editor').type(' C --> HistoryTest');
getEditor().type(' C --> HistoryTest');
cy.get('#saveHistory').click();
cy.get('#historyList').find('li').should('have.length', 2);
});
it('should be able to restore and delete', () => {
cy.get('#saveHistory').click();
cy.get('#editor').type(' C --> HistoryTest');
getEditor().type(' C --> HistoryTest');
cy.get('#historyList').find('No items in History').should('not.exist');
cy.get('#historyList').find('li').should('have.length', 1);
cy.contains('HistoryTest');
@@ -35,7 +38,7 @@ describe('Save History', () => {
cy.get('#historyList').find('li').should('have.length', 0);
cy.get('#historyList').contains('No items in History');
cy.get('#saveHistory').click();
cy.get('#editor').type(' C --> HistoryTest');
getEditor().type(' C --> HistoryTest');
cy.get('#saveHistory').click();
cy.get('#editor').type('ing');
cy.get('#clearHistory').click();
@@ -48,7 +51,7 @@ describe('Save History', () => {
// TODO: Fix #639
xit('should auto save history', () => {
cy.get('#editor').type(' C --> HistoryTest');
getEditor().type(' C --> HistoryTest');
cy.tick(70000);
cy.contains('Timeline').click();
cy.get('#historyList').find('li').should('have.length', 1);
+5 -8
View File
@@ -1,11 +1,13 @@
import { toBase64 } from 'js-base64';
import { disableDebounce } from './util';
describe('Site Loads', () => {
beforeEach(() => {
cy.clearLocalStorage();
cy.visit('/');
disableDebounce();
});
it('Check Home page load', () => {
cy.visit('/');
cy.url().should('include', '/edit');
cy.contains('History').click();
cy.getLocalStorage('codeStore').snapshot();
@@ -15,12 +17,7 @@ describe('Site Loads', () => {
cy.visit(
'/#/edit/eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0NocmlzdG1hc10gLS0-fEdldCBtb25leXwgQihHbyBzaG9wcGluZylcbiAgICBCIC0tPiBDe0xldCBtZSB0aGlua31cbiAgICBDIC0tPnxPbmV8IERbTGFwdG9wXVxuICAgIEMgLS0-fFR3b3wgRVtpUGhvbmVdXG4gICAgQyAtLT58VGhyZWV8IEZbZmE6ZmEtY2FyIENhcl0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9LCJ1cGRhdGVFZGl0b3IiOmZhbHNlfQ'
);
cy.url().should(
'include',
'/edit#pako:eNpVkM1qw0AMhF9F6NRC_AI-FBo7zSXQQHLz-iC8cnZJ9oe1TAm2373rmkKrk9B8MwyasAuascRbomjgWisPed6byiQ7iKOhhaJ4m48s4ILn5wz7l2OAwYQYrb-9bvx-haCaTivGIMb6-7JJ1Y__0_MMdXOiKCG2f5XrV5jh0NizyfH_FZM4uz6ansqeio4SVJRa3KHj5MjqXHtaDQrFsGOFZV419zQ-RKHyS0bHqEn4oK2EhDnmMfAOaZRwefoOS0kj_0K1pfwFtx2XbzAdW4g'
);
cy.contains('History').click();
cy.getLocalStorage('codeStore').snapshot();
cy.url().should('include', '/edit#pako:eNp');
});
it('should load sample diagrams when clicked', () => {
@@ -91,6 +88,7 @@ describe('Site Loads', () => {
it('should show troubleshooting steps if loading fails', () => {
cy.visit('/#/edit/eyJjb2RlIjoiZ3JhcGggVERcbiAg');
cy.reload(true);
cy.contains('Please Click here to Raise an issue in github.');
});
@@ -117,7 +115,6 @@ describe('Site Loads', () => {
cy.visit(
'/edit#pako:eNptkU1PwzAMhv9K5BOI9Q9EXBDbJA477YYqITcxndV8QD40weh_Jy1rGR0-OY_tV2_sEyivCSQogzGuGduAtnaixINji0bcf1WVWGfVXdMtx8M1faYm4B8sxR27JLClJd6nwK4VLTlN4bI4jMQd2pLe3C4KFhNNcLQ92jv9ADGLNoTdozc-zIV4ZDsNlud7RtVN7_5Sb_jYrFcN3iN_0pPbEqUZK3QbTP_Ojyv4NdR4bwTHlyMbPcOQ3WJ2CliBpWCRdbnLqFJDOpClGmRJNYauhtr1pS-_6bKMjebkA8hXNJFWgDn5_YdTIFPINDWdb3vu6r8BaWOZRQ'
);
cy.reload();
cy.contains('Animal');
});
});
+11
View File
@@ -0,0 +1,11 @@
export const cmd = `{${Cypress.platform === 'darwin' ? 'meta' : 'ctrl'}}`;
export const getEditor = ({ bottom = true, newline = false } = {}) =>
cy
.get('#editor textarea:first')
.click()
.focused()
.type(`${bottom ? '{pageDown}' : cmd}`)
.type(`${newline ? '{enter}' : cmd}`);
export const disableDebounce = () => cy.setLocalStorage('noDebounce', 'true');
+2 -1
View File
@@ -73,7 +73,8 @@
"monaco-editor": "0.34.0",
"monaco-mermaid": "1.0.6",
"pako": "2.0.4",
"random-word-slugs": "0.1.6"
"random-word-slugs": "0.1.6",
"svg-pan-zoom": "^3.6.1"
},
"lint-staged": {
"*.{ts,svelte,js,css,md,json}": [
+10 -7
View File
@@ -24,15 +24,18 @@
};
let oldText = text;
$: editor && Monaco?.editor.setModelLanguage(editor.getModel(), language);
$: {
if (text !== oldText) {
const handleTextUpdate = (newText: string) => {
if (newText !== oldText) {
if ($stateStore.updateEditor) {
editor?.setValue(text);
editor?.setValue(newText);
}
oldText = text;
oldText = newText;
}
editor && Monaco?.editor.setModelMarkers(editor.getModel(), 'test', $stateStore.errorMarkers);
}
};
$: handleTextUpdate(text);
themeStore.subscribe(({ isDark }) => {
editor && Monaco?.editor.setTheme(isDark ? 'mermaid-dark' : 'mermaid');
@@ -62,9 +65,9 @@
initEditor(Monaco);
editor = Monaco.editor.create(divEl, editorOptions);
editor.onDidChangeModelContent(() => {
text = editor.getValue();
oldText = editor.getValue();
dispatch('update', {
text
text: oldText
});
});
editor.addAction({
+2 -1
View File
@@ -97,7 +97,8 @@
const loadSampleDiagram = (diagramType: string): void => {
updateCode(samples[diagramType], {
updateDiagram: true,
updateEditor: true
updateEditor: true,
resetPanZoom: true
});
};
</script>
+65 -6
View File
@@ -1,7 +1,9 @@
<script lang="ts">
import { inputStateStore, stateStore } from '$lib/util/state';
import { inputStateStore, stateStore, updateCodeStore } from '$lib/util/state';
import { onMount } from 'svelte';
import mermaid from 'mermaid';
import panzoom from 'svg-pan-zoom';
import type { State } from '$lib/types';
let code = '';
let config = '';
@@ -9,7 +11,46 @@
let view: HTMLDivElement;
let error = false;
let outOfSync = false;
let hide = false;
let manualUpdate = true;
let panZoomEnabled = $stateStore.panZoom;
let pzoom: SvgPanZoom.Instance;
let debounce: number;
const handlePanZoomChange = () => {
const pan = pzoom.getPan();
const zoom = pzoom.getZoom();
clearTimeout(debounce);
debounce = window.setTimeout(() => {
updateCodeStore({ pan, zoom });
}, 200);
};
const handlePanZoom = (state: State) => {
if (!state.panZoom) {
return;
}
hide = true;
pzoom?.destroy();
pzoom = undefined;
Promise.resolve().then(() => {
const graphDiv = document.getElementById('graph-div');
pzoom = panzoom(graphDiv, {
onPan: handlePanZoomChange,
onZoom: handlePanZoomChange,
controlIconsEnabled: true,
fit: true,
center: true
});
const { pan, zoom } = state;
if (pan !== undefined && zoom !== undefined && Number.isFinite(zoom)) {
pzoom.zoom(zoom);
pzoom.pan(pan);
}
hide = false;
});
};
onMount(() => {
stateStore.subscribe((state) => {
if (state.error !== undefined) {
@@ -24,19 +65,23 @@
}
outOfSync = false;
manualUpdate = true;
if (code === state.code && config === state.mermaid) {
// Do not render if there is no change in Code/Config
if (code === state.code && config === state.mermaid && panZoomEnabled === state.panZoom) {
// Do not render if there is no change in Code/Config/PanZoom
return;
}
code = state.code;
config = state.mermaid;
panZoomEnabled = state.panZoom;
const scroll = view.parentElement.scrollTop;
delete container.dataset.processed;
mermaid.initialize(Object.assign({}, JSON.parse(state.mermaid)));
mermaid.render('graph-div', code, (svgCode) => {
if (svgCode.length > 0) {
console.log(svgCode);
handlePanZoom(state);
container.innerHTML = svgCode;
const graphDiv = document.getElementById('graph-div');
graphDiv.setAttribute('height', '100%');
graphDiv.style.maxWidth = '100%';
}
});
view.parentElement.scrollTop = scroll;
@@ -51,6 +96,11 @@
error = true;
}
});
window.addEventListener('resize', () => {
if ($stateStore.panZoom && pzoom) {
pzoom.resize();
}
});
});
</script>
@@ -58,16 +108,25 @@
<div class="p-2 text-red-600" id="errorContainer">{$stateStore.error}</div>
{/if}
<div id="view" bind:this={view} class="p-2" class:error class:outOfSync>
<div id="container" bind:this={container} class="flex-1 overflow-auto" />
<div id="view" bind:this={view} class="p-2 h-full" class:error class:outOfSync>
<div id="container" bind:this={container} class="h-full overflow-auto" class:hide />
</div>
<style>
#view {
flex: 1;
}
#container {
transition: visibility 0.3s;
}
.error,
.outOfSync {
opacity: 0.5;
}
.hide {
visibility: hidden;
}
</style>
+3
View File
@@ -39,6 +39,9 @@ export interface State {
updateEditor: boolean;
updateDiagram: boolean;
autoSync: boolean;
panZoom?: boolean;
pan?: { x: number; y: number };
zoom?: number;
loader?: LoaderConfig;
}
+10 -2
View File
@@ -79,7 +79,7 @@ export const stateStore: Readable<ValidatedState> = derived([inputStateStore], (
export const loadState = (data: string): void => {
let state: State;
console.log('Loading', data);
console.log(`Loading '${data}'`);
try {
state = deserializeState(data);
const mermaidConfig: { [key: string]: string } =
@@ -114,7 +114,11 @@ export const updateCodeStore = (newState: Partial<State>): void => {
let prompted = false;
export const updateCode = (
code: string,
{ updateEditor, updateDiagram = false }: { updateEditor: boolean; updateDiagram?: boolean }
{
updateEditor,
updateDiagram = false,
resetPanZoom = false
}: { updateEditor: boolean; updateDiagram?: boolean; resetPanZoom?: boolean }
): void => {
saveStatistics(code);
const lines = (code.match(/\n/g) || '').length + 1;
@@ -132,6 +136,10 @@ export const updateCode = (
}
inputStateStore.update((state) => {
if (resetPanZoom) {
state.pan = undefined;
state.zoom = undefined;
}
return { ...state, code, updateEditor, updateDiagram };
});
};
+2
View File
@@ -24,3 +24,5 @@ export const initHandler = async (): Promise<void> => {
export const isMac = navigator.platform.toUpperCase().indexOf('MAC') >= 0;
export const cmdKey = isMac ? 'Cmd' : 'Ctrl';
export const debounceEnabled = window.localStorage.getItem('noDebounce') !== 'true';
+4
View File
@@ -5,10 +5,14 @@
import { loadingStateStore } from '$lib/util/loading';
import { setTheme, themeStore } from '$lib/util/theme';
import { toggleDarkTheme } from '$lib/util/state';
import { initHandler } from '$lib/util/util';
// This can be removed once https://github.com/sveltejs/kit/issues/1612 is fixed.
// Then move it into src and vite will bundle it automatically.
onMount(() => {
window.addEventListener('hashchange', async (ev) => {
await initHandler();
});
if ('serviceWorker' in navigator) {
navigator.serviceWorker
.register(`${base}/service-worker.js`, {
+61 -41
View File
@@ -7,7 +7,7 @@
import Card from '$lib/components/card/card.svelte';
import History from '$lib/components/history/history.svelte';
import { updateCode, updateConfig, inputStateStore, stateStore } from '$lib/util/state';
import { cmdKey, initHandler, syncDiagram } from '$lib/util/util';
import { cmdKey, debounceEnabled, initHandler, syncDiagram } from '$lib/util/util';
import { onMount } from 'svelte';
import type { EditorUpdateEvent, State, Tab, DocConfig } from '$lib/types';
import { base } from '$app/paths';
@@ -63,14 +63,15 @@
let text = '';
let docURL = docURLBase;
let language: Languages = 'mermaid';
$: language = languageMap[selectedMode];
$: {
if (selectedMode === 'code') {
const handleModeUpdate = (mode: Modes) => {
if (mode === 'code') {
text = $stateStore.code;
} else {
text = $stateStore.mermaid;
}
}
};
$: language = languageMap[selectedMode];
$: handleModeUpdate(selectedMode);
stateStore.subscribe((state: State) => {
if (state.updateEditor) {
@@ -100,14 +101,26 @@
}
];
const updateHandler = (message: CustomEvent<EditorUpdateEvent>) => {
const code = message.detail.text;
const handleUpdate = (text: string) => {
if (selectedMode === 'code') {
updateCode(code, {
updateCode(text, {
updateEditor: false
});
} else {
updateConfig(code, false);
updateConfig(text, false);
}
};
let debounce: { [key: string]: number } = {};
const updateHandler = ({ detail: { text } }: CustomEvent<EditorUpdateEvent>) => {
console.log({ debounceEnabled });
if (debounceEnabled) {
clearTimeout(debounce[selectedMode]);
debounce[selectedMode] = window.setTimeout(() => {
handleUpdate(text);
}, 300);
} else {
handleUpdate(text);
}
};
@@ -138,34 +151,32 @@
<div class="flex-1 flex overflow-hidden">
<div class="hidden md:flex flex-col" id="editorPane" style="width: 40%">
<Card on:select={tabSelectHandler} {tabs} isCloseable={false} title="Mermaid">
<div slot="actions">
<div class="flex flex-row items-center">
<div class="form-control flex-row items-center">
<label class="cursor-pointer label" for="autoSync">
<span> Auto sync</span>
<input
type="checkbox"
class="toggle {$stateStore.autoSync ? 'btn-secondary' : 'toggle-primary'} ml-1"
id="autoSync"
bind:checked={$inputStateStore.autoSync} />
</label>
</div>
{#if !$stateStore.autoSync}
<button
class="btn btn-secondary btn-xs mr-1"
title="Sync Diagram ({cmdKey} + Enter)"
data-cy="sync"
on:click={syncDiagram}><i class="fas fa-sync" /></button>
{/if}
<button class="btn btn-secondary btn-xs" title="View documentation">
<a target="_blank" href={docURL} data-cy="docs"><i class="fas fa-book mr-1" />Docs</a>
</button>
<div slot="actions" class="flex flex-row items-center">
<div class="form-control flex-row items-center">
<label class="cursor-pointer label" for="autoSync">
<span> Auto sync</span>
<input
type="checkbox"
class="toggle {$stateStore.autoSync ? 'btn-secondary' : 'toggle-primary'} ml-1"
id="autoSync"
bind:checked={$inputStateStore.autoSync} />
</label>
</div>
{#if !$stateStore.autoSync}
<button
class="btn btn-secondary btn-xs mr-1"
title="Sync Diagram ({cmdKey} + Enter)"
data-cy="sync"
on:click={syncDiagram}><i class="fas fa-sync" /></button>
{/if}
<button class="btn btn-secondary btn-xs" title="View documentation">
<a target="_blank" href={docURL} data-cy="docs"><i class="fas fa-book mr-1" />Docs</a>
</button>
</div>
<Editor on:update={updateHandler} {language} bind:text />
<Editor on:update={updateHandler} {language} {text} />
</Card>
<div class="-mt-2">
@@ -177,13 +188,22 @@
<div id="resizeHandler" class="hidden md:block" />
<div class="flex-1 flex flex-col overflow-hidden">
<Card title="Diagram" isCloseable={false}>
<a
href={`${base}/view#${$stateStore.serialized}`}
target="_blank"
slot="actions"
class="btn btn-secondary btn-xs"
title="View diagram in new page"
><i class="fas fa-external-link-alt mr-1" />Full screen</a>
<div slot="actions" class="flex flex-row items-center">
<label class="cursor-pointer label py-0" for="panZoom">
<span>Pan & Zoom</span>
<input
type="checkbox"
class="toggle {$stateStore.panZoom ? 'btn-secondary' : 'toggle-primary'} ml-1"
id="panZoom"
bind:checked={$inputStateStore.panZoom} />
</label>
<a
href={`${base}/view#${$stateStore.serialized}`}
target="_blank"
class="btn btn-secondary btn-xs"
title="View diagram in new page"
><i class="fas fa-external-link-alt mr-1" />Full screen</a>
</div>
<div class="flex-1 overflow-auto">
<View />
+5
View File
@@ -4807,6 +4807,11 @@ svelte@3.49.0:
resolved "https://registry.yarnpkg.com/svelte/-/svelte-3.49.0.tgz#5baee3c672306de1070c3b7888fc2204e36a4029"
integrity sha512-+lmjic1pApJWDfPCpUUTc1m8azDqYCG1JN9YEngrx/hUyIcFJo6VZhj0A1Ai0wqoHcEIuQy+e9tk+4uDgdtsFA==
svg-pan-zoom@^3.6.1:
version "3.6.1"
resolved "https://registry.yarnpkg.com/svg-pan-zoom/-/svg-pan-zoom-3.6.1.tgz#f880a1bb32d18e9c625d7715350bebc269b450cf"
integrity sha512-JaKkGHHfGvRrcMPdJWkssLBeWqM+Isg/a09H7kgNNajT1cX5AztDTNs+C8UzpCxjCTRrG34WbquwaovZbmSk9g==
svgo@^2.7.0:
version "2.8.0"
resolved "https://registry.yarnpkg.com/svgo/-/svgo-2.8.0.tgz#4ff80cce6710dc2795f0c7c74101e6764cfccd24"