New Diagram - Use case diagram #4268

[teyc]

📑 Summary

Brief description about the content of your PR.

Creates Use Case diagrams

Here's the textual representation of the use case diagram above.

usecase-beta
      title Student Management System Use Cases

      actor Student
      actor Admin
      service Authentication
      service Grades as Grades Database
      service Courses

      systemboundary
        title Student Management System
        (Login) 
        (Submit Assignment)
        (View) as (View Grades)
        (Manage Users) 
        (Manage Courses)
        (Generate Reports)
        (View Grades) 
      end

      Student -> (Login) -> Authentication
      Student -> (Submit Assignment) -> Courses
      Student -> (View) -> Grades
      Admin -> (Login) -> Authentication
      Admin -> (Manage Users) -> Courses
      Admin -> (Manage Courses) -> Courses
      Admin -> (Generate Reports) -> Courses, Grades
      Admin -> (View) -> Grades

Resolves #4628

📏 Design Decisions

• We use brackets to denote Use Cases, which are usually rendered inside an ellipse
• We support the use of aliases via as
• The actor and service declaration are optional. If we provide Admin -> (View) -> Grades, it implicitly assumes that Admin (being the first one) is the actor, while Grades (being the last) is the service.

CI/CD Issues

1. 5 e2e tests are failing:

   Error: You have reached the maximum screenshot capacity included in your Pro open source xl Plan. Please upgrade your Plan.
   

2. Test coverage is not picking up my usecase.spec.ts - why?

📋 Tasks

Make sure you

• 📖 have read the contribution guidelines
• 💻 have added necessary unit/e2e tests. Test coverage is not picking up my usecase.spec.ts - why?
• 📓 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 detected

Latest commit: fd3e70c

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

This PR includes changesets to release 1 package

Name	Type
mermaid	Minor

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]

✅ Deploy Preview for mermaid-js ready!

Name	Link
🔨 Latest commit	fd3e70c
🔍 Latest deploy log	https://app.netlify.com/sites/mermaid-js/deploys/677749a60a013b00084ba1ae
😎 Deploy Preview	https://deploy-preview-6141--mermaid-js.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[pkg-pr-new]

Open in Stackblitz

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

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

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

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

commit: fd3e70c

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 633 lines in your changes missing coverage. Please review.

Project coverage is 4.43%. Comparing base (df636c6) to head (fd3e70c).

Files with missing lines	Patch %	Lines
packages/mermaid/src/diagrams/usecase/usecaseDB.ts	0.00%	290 Missing ⚠️
...endering-util/rendering-elements/shapes/ellipse.ts	0.00%	108 Missing ⚠️
.../rendering-util/rendering-elements/shapes/actor.ts	0.00%	80 Missing ⚠️
...es/mermaid/src/diagrams/usecase/usecaseRenderer.ts	0.00%	54 Missing ⚠️
packages/mermaid/src/diagrams/usecase/styles.ts	0.00%	28 Missing ⚠️
...id/src/rendering-util/rendering-elements/shapes.ts	0.00%	25 Missing ⚠️
...es/mermaid/src/diagrams/usecase/usecaseDetector.ts	0.00%	20 Missing ⚠️
...ges/mermaid/src/diagrams/usecase/usecaseDiagram.ts	0.00%	17 Missing ⚠️
...kages/mermaid/src/diagrams/usecase/usecaseUtils.ts	0.00%	8 Missing ⚠️
...s/mermaid/src/diagram-api/diagram-orchestration.ts	0.00%	2 Missing ⚠️
... and 1 more

Additional details and impacted files

@@            Coverage Diff             @@
##           develop   #6141      +/-   ##
==========================================
- Coverage     4.48%   4.43%   -0.06%     
==========================================
  Files          383     390       +7     
  Lines        54038   54654     +616     
  Branches       596     629      +33     
==========================================
  Hits          2425    2425              
- Misses       51613   52229     +616     

Flag	Coverage Δ
unit	4.43% <0.00%> (-0.06%)	⬇️

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

Files with missing lines	Coverage Δ
packages/mermaid/src/diagrams/flowchart/flowDb.ts	0.00% <ø> (ø)
.build/jsonSchema.ts	0.00% <0.00%> (ø)
...s/mermaid/src/diagram-api/diagram-orchestration.ts	0.00% <0.00%> (ø)
...kages/mermaid/src/diagrams/usecase/usecaseUtils.ts	0.00% <0.00%> (ø)
...ges/mermaid/src/diagrams/usecase/usecaseDiagram.ts	0.00% <0.00%> (ø)
...es/mermaid/src/diagrams/usecase/usecaseDetector.ts	0.00% <0.00%> (ø)
...id/src/rendering-util/rendering-elements/shapes.ts	0.00% <0.00%> (ø)
packages/mermaid/src/diagrams/usecase/styles.ts	0.00% <0.00%> (ø)
...es/mermaid/src/diagrams/usecase/usecaseRenderer.ts	0.00% <0.00%> (ø)
.../rendering-util/rendering-elements/shapes/actor.ts	0.00% <0.00%> (ø)
... and 2 more

... and 1 file with indirect coverage changes

[argos-ci]

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

Build	Status	Details	Updated (UTC)
default (Inspect)	⚠️ Changes detected (Review)	339 added, 339 removed, 4 failures	Jan 3, 2025, 2:30 AM