#5858 - fix: Timeline node width made dynamic

[afmireski]

📑 Summary

In timelineRenderer, the width of the timeline diagram nodes is hardcoded, making width configuration changes ineffective.

Resolves #5858

📏 Design Decisions

Extract the hardcoded value, defined here, into a constant and use it as the default if the node width is not specified in the timeline configuration.
I've added tests to verify the application of both the default and custom widths.

📋 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:.

[netlify]

✅ Deploy Preview for mermaid-js ready!

Name	Link
🔨 Latest commit	b264dbc
🔍 Latest deploy log	https://app.netlify.com/sites/mermaid-js/deploys/679fc5de06d5dc0008ed147a
😎 Deploy Preview	https://deploy-preview-6100--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@6100

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

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

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

commit: b264dbc

[codecov]

Codecov Report

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

Project coverage is 4.47%. Comparing base (cc29437) to head (b264dbc).
Report is 132 commits behind head on develop.

Files with missing lines	Patch %	Lines
.../mermaid/src/diagrams/timeline/timelineRenderer.ts	0.00%	24 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           develop   #6100      +/-   ##
==========================================
- Coverage     4.49%   4.47%   -0.03%     
==========================================
  Files          383     384       +1     
  Lines        53925   54194     +269     
  Branches       596     623      +27     
==========================================
  Hits          2425    2425              
- Misses       51500   51769     +269     

Flag	Coverage Δ
unit	4.47% <0.00%> (-0.03%)	⬇️

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

Files with missing lines	Coverage Δ
.../mermaid/src/diagrams/timeline/timelineRenderer.ts	0.00% <0.00%> (ø)

... and 22 files with indirect coverage changes

[afmireski]

Hello,

Looking at the test workflow failures, I noticed that the tests passed:

The error seems to be related to insufficient storage for saving Cypress screenshots:

Is there any correction I need to make?

I also noticed that Codecov reported a lack of coverage, but my integration tests appear to be running correctly. I would greatly appreciate any suggestions or feedback you can provide. I'm a newbie in open-source.

[afmireski]

Hi @jgreywolf, I hope you're doing well! When you have some time, could you kindly take a look at my PR? Let me know if anything needs adjustment. Thanks!

[chriscconte]

Hello, I believe this is almost there, but as is, it's not functioning as intended. Below is the screenshot of a current simple test:

source

In order to fix this, we will need to also adjust the section and task width alongside the event width. It's all configured in the same file.

I've done an implementation here, but since you've already PR'd feel free to adapt/grab what I've done.

Nit: I think that we should consider re-naming this config property to taskWidth or eventWidth, in order to increase readability. And update the timelineConfig page to reflect that, and potentially remove all of the non-functional config variables.

[changeset-bot]

⚠️ No Changeset found

Latest commit: b264dbc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[afmireski]

Thanks for your feedback, @chriscconte ! I’ve applied your suggestions, and the timeline rendering looks much better now.

[chriscconte]

looks good!