Support `lazyLoadedDiagrams` when calling `initThrowsErrors` #3702

aloisklink · 2022-10-20T10:40:21Z

📑 Summary

Adds support for calling lazyLoadedDiagrams in mermaid.initThrowsErrors.

If there is an error when trying to dynamically load a module from lazyLoadedDiagrams, this is now thrown. (Rendering is still performed!!)

Partially gets mermaid-js/mermaid-cli#406 working
(not 100%, puppeteer is throwing some Content-Security-Policy errors, but at least now we can see the errors).

📏 Design Decisions

I've made sure that rendering is still performed, even if there is an error when lazily loading a diagram. This is so if a user has 10 diagrams, but only one relies on a plugin diagram, at least the other 9 diagrams will render properly.

📋 Tasks

Make sure you

📖 have read the contribution guidelines
💻 have added unit/e2e tests (if appropriate)
🔖 targeted develop branch
- Currently targeting the [release_9.2.0_buggfixes](https://github.com/mermaid-js/mermaid/tree/release_9.2.0_buggfixes) branch, however, this PR should also be compatible with the develop branch (my PR is based of a commit before these two branches diverged)

aloisklink · 2022-10-20T10:49:30Z

packages/mermaid/src/mermaid.spec.ts

@@ -48,11 +48,32 @@ describe('when using mermaid and ', function () {
      const node = document.createElement('div');
      node.appendChild(document.createTextNode('graph TD;\na;'));

-      mermaid.initThrowsErrors(undefined, node);
+      await mermaid.initThrowsErrors(undefined, node);


By the way, we should put into the CHANGELOG.md/Release notes that this function is now async.

Can you add that to this PR?

I'm not really sure where to put it.

I could put it into CHANGELOG.md, but that's super out-dated, see #3022

Maybe we should use something like gren changelog to automatically generate the CHANGELOG.md from the GitHub release notes in https://github.com/mermaid-js/mermaid/releases, but then there'll be no point in manually editing the CHANGELOG.md, since it would just be overwritten by whatever is written in https://github.com/mermaid-js/mermaid/releases

aloisklink · 2022-10-20T10:53:04Z

packages/mermaid/src/mermaid.ts

+/**
+ * Equivalent to {@link init()}, except an error will be thrown on error.
+ *
+ * @param config - **Deprecated** Mermaid sequenceConfig.


Possible bug This parameter seems to do nothing. It's set as mermaid.sequenceConfig = config;, but I can't see where sequenceConfig is actually used.

#3406 Same bug?

Looks like it. According to the code, it's only supposed to set the sequenceConfig, but it doesn't seem to set the right sequenceConfig.

Adds and tests basic support for mermaid-mindmaps. Issues ====== - mermaid-mindmap is currently loaded from a CDN, which isn't good. This means that mindmaps won't work if there is no internet connection (or if the network blocks CDNs). - mermaid won't load mermaid-mindmap using mermaid.initThrowsErrors until PR mermaid-js/mermaid#3702 is merged and released

Previously, calling initThrowsErrors would not load any of the lazyLoadedDiagrams entries.

Add some basic tsdoc for initThrowsErrors

Throw an error if lazyLoadedDiagrams fails to load properly. Rendering is still performed, even on a lazyLoadedDiagrams failure.

aloisklink · 2022-10-23T12:44:09Z

I've rebased my commits so that we can make this PR both to the develop branch AND the release_9.2.0_buggfixes branch.

Currently, I've set the base-branch to the release_9.2.0_buggfixes branch, but if we want, I can make this PR for the develop branch, and if it's accepted, I can manually merge it to the release_9.2.0_buggfixes branch as well.

This reverts commit 1a0309f, reversing changes made to 56a8068. This is because the PR mermaid-js#3702 worked fine on the `develop` and `release_9.2.0_buggfixes` branches, but had a bunch of git merge conflicts on the `release/9.2.0` branch.

aloisklink added the bug label Oct 20, 2022

github-actions bot added the Discussion Discussion which may lead to separate issues or PRs label Oct 20, 2022

aloisklink commented Oct 20, 2022

View reviewed changes

aloisklink mentioned this pull request Oct 20, 2022

Feature/mermaid9.2.0rc mermaid-js/mermaid-cli#406

Closed

aloisklink requested a review from knsv October 21, 2022 18:55

sidharthv96 approved these changes Oct 23, 2022

View reviewed changes

sidharthv96 changed the base branch from develop to release_9.2.0_buggfixes October 23, 2022 08:57

sidharthv96 changed the base branch from release_9.2.0_buggfixes to develop October 23, 2022 08:57

aloisklink added 3 commits October 23, 2022 13:19

fix: load lazyLoadedDiagrams in initThrowsErrors

4601c90

Previously, calling initThrowsErrors would not load any of the lazyLoadedDiagrams entries.

docs(mermaid): document initThrowsErrors

895a5eb

Add some basic tsdoc for initThrowsErrors

fix(mermaid): error if lazyLoadedDiagrams fails

3a2669e

Throw an error if lazyLoadedDiagrams fails to load properly. Rendering is still performed, even on a lazyLoadedDiagrams failure.

aloisklink force-pushed the fix/initThrowErrors-support-lazyLoadedDiagrams branch from 572e71b to 3a2669e Compare October 23, 2022 12:21

aloisklink changed the base branch from develop to release_9.2.0_buggfixes October 23, 2022 12:22

knsv merged commit e793aae into mermaid-js:release_9.2.0_buggfixes Oct 24, 2022

aloisklink deleted the fix/initThrowErrors-support-lazyLoadedDiagrams branch October 26, 2022 12:36

aloisklink mentioned this pull request Oct 27, 2022

[9.2.0] Support lazyLoadedDiagrams when calling initThrowsErrorsAsync #3731

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support `lazyLoadedDiagrams` when calling `initThrowsErrors` #3702

Support `lazyLoadedDiagrams` when calling `initThrowsErrors` #3702

aloisklink commented Oct 20, 2022 •

edited

Loading

aloisklink Oct 20, 2022

sidharthv96 Oct 23, 2022

aloisklink Oct 23, 2022

aloisklink Oct 20, 2022

sidharthv96 Oct 23, 2022

aloisklink Oct 23, 2022

aloisklink commented Oct 23, 2022

Support lazyLoadedDiagrams when calling initThrowsErrors #3702

Support lazyLoadedDiagrams when calling initThrowsErrors #3702

Conversation

aloisklink commented Oct 20, 2022 • edited Loading

📑 Summary

📏 Design Decisions

📋 Tasks

aloisklink Oct 20, 2022

Choose a reason for hiding this comment

sidharthv96 Oct 23, 2022

Choose a reason for hiding this comment

aloisklink Oct 23, 2022

Choose a reason for hiding this comment

aloisklink Oct 20, 2022

Choose a reason for hiding this comment

sidharthv96 Oct 23, 2022

Choose a reason for hiding this comment

aloisklink Oct 23, 2022

Choose a reason for hiding this comment

aloisklink commented Oct 23, 2022

Support `lazyLoadedDiagrams` when calling `initThrowsErrors` #3702

Support `lazyLoadedDiagrams` when calling `initThrowsErrors` #3702

aloisklink commented Oct 20, 2022 •

edited

Loading