Implement "until" keyword in gantt charts

[fzag]

📑 Summary

Implement keyword until for tasks that should run until some specific other task or milestone starts.

Resolves #3173

📏 Design Decisions

The end date of a task could previously be defined either using a duration (e.g. 1d) or an absolute date (e.g. 2024-01-22) but not relatively to other tasks/milestones. This is useful in many cases, e.g.: to avoid repeating the end-date of multiple tasks which should end at the same time, rely on critical milestones with specified date, ...

📋 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.
• 🔖 targeted develop branch

[netlify]

✅ Deploy Preview for mermaid-js ready!

Name	Link
🔨 Latest commit	5fe9f9e
🔍 Latest deploy log	https://app.netlify.com/sites/mermaid-js/deploys/65dfeb1048bc6d0008d392fe
😎 Deploy Preview	https://deploy-preview-5224--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.

[codecov]

Codecov Report

Attention: Patch coverage is 89.74359% with 4 lines in your changes are missing coverage. Please review.

Project coverage is 79.23%. Comparing base (31a287b) to head (5fe9f9e).

Additional details and impacted files

@@             Coverage Diff              @@
##           develop    #5224       +/-   ##
============================================
+ Coverage    43.20%   79.23%   +36.03%     
============================================
  Files           23      175      +152     
  Lines         5115    14535     +9420     
  Branches        23      868      +845     
============================================
+ Hits          2210    11517     +9307     
+ Misses        2904     2815       -89     
- Partials         1      203      +202     

Flag	Coverage Δ
e2e	84.80% <75.00%> (?)
unit	43.37% <89.74%> (+0.16%)	⬆️

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

Files	Coverage Δ
packages/mermaid/src/diagrams/gantt/ganttDb.js	78.50% <89.74%> (+1.80%)	⬆️

... and 169 files with indirect coverage changes

[sidharthv96]

I've consolidated all the requested changes here.
I'm not sure if we should use the current date as a fallback, as the diagram would look different based on when it's opened. Either we should throw an error, or we should use a fixed date based on the other dates in the diagram.

  // Test for until
  const untilStatement = /^until\s+(?<ids>[\d\w- ]+)/.exec(str);
  if (untilStatement) {
    // check all until ids and take the earliest
    let earliestStartingTask = null;
    for (const id of untilStatement.groups.ids.split(' ')) {
      let task = findTaskById(id);
      if (!task) {
        continue;
      }
      if (earliestStartingTask === null || task.startTime < earliestStartingTask.startTime) {
        earliestStartingTask = task;
      }
    }

    if (earliestStartingTask) {
      return earliestStartingTask.startTime;
    }

    // TODO: Not sure if we should use a dynamic date here. 
    const dt = new Date();
    dt.setHours(0, 0, 0, 0);
    return dt;
  }

[sidharthv96]

There is one failing test. Can you please look into that?

[fzag]

Just fixed it!
The 2 remaining e2e errors are now due to the e2e test having being modified to test the new feature.

[sidharthv96]

Can you please separate the tests to new ones? And add a few more cases as well? Tests have helped catch numerous issues recently, and this feature is significant enough to warrant individual tests that specifically state the purpose of the test.

Otherwise, in the future, maintainers might not notice subtle failures, or if they do, it'll be difficult to figure out which area is affected.

[sidharthv96]

Awesome!

[mermaid-bot]

@fzag, Thank you for the contribution!
You are now eligible for a year of Premium account on MermaidChart.
Sign up with your GitHub account to activate.