Skip to content

6691: update packet diagram to use new class-based DB approach #6804

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

Jump to bottom
Merged
merged 2 commits into from
Jul 30, 2025
Merged

6691: update packet diagram to use new class-based DB approach #6804

merged 2 commits into from
Jul 30, 2025

Conversation

omkarht
Copy link
Contributor

@omkarht omkarht commented Jul 29, 2025 •
edited
Loading

📑 Summary

  1. Migrated the db implementation for Packet diagrams from a plain object to a PacketDB class.
    • PacketDB now implements the DiagramDB interface for consistency and type safety.
    • Moved diagram DB instantiation inside a get db() accessor to allow fresh instance creation per parse.
    • Updated parser logic to:
      • Accept an instance of PacketDB.
      • Perform runtime checks to validate the instance.
    • Improved import grouping and readability across files.
  2. Cleanups & Minor Improvements
    • Centralized all commonDb exports into grouped imports.
    • Removed unnecessary shared state by encapsulating state inside the PacketDB class.
    • Enhanced maintainability and future extensibility.

Resolves #6691

📏 Design Decisions

Describe the way your implementation works or what design decisions you made if applicable.

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests.
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jul 29, 2025 •
edited
Loading

🦋 Changeset detected

Latest commit: e27a9da

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
mermaid Patch
@mermaid-js/examples Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@netlify Netlify
Copy link

netlify bot commented Jul 29, 2025 •
edited
Loading

✅ Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit e27a9da
🔍 Latest deploy log https://app.netlify.com/projects/mermaid-js/deploys/6889ce5f28a0ef0008dc1ec6
😎 Deploy Preview https://deploy-preview-6804--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Jul 29, 2025 •
edited
Loading

Open in StackBlitz

@mermaid-js/examples

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/examples@6804

mermaid

npm i https://pkg.pr.new/mermaid-js/mermaid@6804

@mermaid-js/layout-elk

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6804

@mermaid-js/mermaid-zenuml

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6804

@mermaid-js/parser

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6804

@mermaid-js/tiny

npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/tiny@6804

commit: e27a9da

@codecov Codecov
Copy link

codecov bot commented Jul 29, 2025 •
edited
Loading

Codecov Report

❌ Patch coverage is 0% with 42 lines in your changes missing coverage. Please review.
✅ Project coverage is 3.71%. Comparing base (5986189) to head (e27a9da).
⚠️ Report is 14 commits behind head on develop.

Files with missing lines Patch % Lines
packages/mermaid/src/diagrams/packet/db.ts 0.00% 29 Missing ⚠️
packages/mermaid/src/diagrams/packet/parser.ts 0.00% 9 Missing ⚠️
packages/mermaid/src/diagrams/packet/diagram.ts 0.00% 4 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           develop   #6804      +/-   ##
==========================================
- Coverage     3.71%   3.71%   -0.01%     
==========================================
  Files          454     454              
  Lines        44733   44738       +5     
  Branches       708     708              
==========================================
  Hits          1660    1660              
- Misses       43073   43078       +5
Flag Coverage Δ
unit 3.71% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
packages/mermaid/src/diagrams/packet/diagram.ts 8.33% <0.00%> (-1.67%) ⬇️
packages/mermaid/src/diagrams/packet/parser.ts 1.12% <0.00%> (-0.09%) ⬇️
packages/mermaid/src/diagrams/packet/db.ts 0.00% <0.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@argos-ci Argos CI
Copy link

argos-ci bot commented Jul 29, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) ✅ No changes detected - Jul 30, 2025, 7:59 AM

@omkarht omkarht marked this pull request as ready for review July 29, 2025 12:32
sidharthv96
sidharthv96 approved these changes Jul 30, 2025
View reviewed changes
@omkarht @sidharthv96
Update .changeset/vast-buses-see.md
e27a9da 
Co-authored-by: Sidharth Vinod <github@sidharth.dev>
@shubhamparikh2704 shubhamparikh2704 added this pull request to the merge queue Jul 30, 2025
Merged via the queue into develop with commit e464d08 Jul 30, 2025
25 checks passed
@shubhamparikh2704 shubhamparikh2704 deleted the 6691-update-packet-diagram-class-based-db branch July 30, 2025 13:49
This was referenced Aug 19, 2025
Closed
Merged
@sidharthv96 sidharthv96 mentioned this pull request Aug 19, 2025
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sidharthv96 sidharthv96 sidharthv96 approved these changes

@shubhamparikh2704 shubhamparikh2704 Awaiting requested review from shubhamparikh2704

Assignees
No one assigned
Labels
Sponsored by MermaidChart
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update packet diagram to use the new class based approach in the DB
3 participants
@omkarht @sidharthv96 @shubhamparikh2704