Upgrade everything; explain plan converted to JSON #496
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ad use `plan` which produces a JSON object. You can use the new `import { planToMermaid } from 'grafast/mermaid'` to convert this object back into a mermaid definition.
…GraphileConfig` - these are global namespaces.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously the plan explain was sent as Mermaid; this is now instead sent as JSON and then converted to Mermaid on the client. (This allows us to provide alternative renderers in future.)
planToMermaid(plan)fromgrafast/mermaidenables converting a plan JSON object into a mermaid diagram, this diagram is very close to what was previously generated.Ruru now loads Mermaid from CDN because it's so big, over time we might migrate away to our own renderer, which would allow better interactivity.
Basically everything has been upgraded. A few things were held back because they require ESM or because they have undeclared breaking changes that I couldn't figure out how to fix.
Withheld: