Skip to content
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.

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

fix: Add support for ~test Array~string~ back in Class #4805

Merged
merged 2 commits into from Sep 6, 2023
Merged

Conversation

sidharthv96
Copy link
Member

@sidharthv96 sidharthv96 commented Sep 3, 2023

📑 Summary

Add back support for ~test Array~string~

Context: #4534 (comment)

📏 Design Decisions

We cannot remove that support as it would be a breaking change.

Also, if ~test Int is supported, ~test Array~string~ should be too.

📋 Tasks

Make sure you

@sidharthv96 sidharthv96 mentioned this pull request Sep 3, 2023
4 tasks
@codecov
Copy link

codecov bot commented Sep 3, 2023

Codecov Report

Merging #4805 (4944694) into develop (69b4b48) will increase coverage by 29.91%.
The diff coverage is 28.57%.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##           develop    #4805       +/-   ##
============================================
+ Coverage    45.34%   75.26%   +29.91%     
============================================
  Files           53      146       +93     
  Lines         6669    14504     +7835     
  Branches        32      614      +582     
============================================
+ Hits          3024    10916     +7892     
+ Misses        3644     3462      -182     
- Partials         1      126      +125     
Flag Coverage Δ
e2e 81.68% <41.66%> (?)
unit 45.25% <9.52%> (-0.09%) ⬇️

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

Files Changed Coverage Δ
packages/mermaid/src/diagrams/common/common.ts 68.02% <28.57%> (+12.47%) ⬆️

... and 141 files with indirect coverage changes

@sidharthv96 sidharthv96 changed the base branch from UpdateClassMemberHandling to develop September 3, 2023 06:32
* develop:
  chore: Align with convention
  chore(deps): update all patch dependencies
  chore(deps): update all minor dependencies
@netlify
Copy link

netlify bot commented Sep 3, 2023

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 4944694
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/64f42e606adf8300079dda4b
😎 Deploy Preview https://deploy-preview-4805--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 site configuration.

@Yokozuna59
Copy link
Member

I think the PR title is misleading. Originally, I thought we're adding ~ also as a possible keyword to class name. But it appears you're just re-add the ability to have ~ (package) as a visibility when we have generic class.

@sidharthv96 sidharthv96 changed the title fix: Add support for ~test Array~string~ fix: Add support for ~test Array~string~ back Sep 3, 2023
@sidharthv96 sidharthv96 self-assigned this Sep 3, 2023
Copy link
Member

@aloisklink aloisklink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's awesome to fix a breaking change, but I'm struggling to see what the breaking change this PR fixes actually is.

What is ~test Array~string~? Can you give an example of a Mermaid diagram that has it (maybe also showing a screenshot, if the diagram only worked in an very old version of Mermaid)?

It would also be helpful if you could point to when support for ~test Array~string~ was broken (ideally to a specific commit or PR).

@sidharthv96
Copy link
Member Author

@aloisklink this PR was actually targeted at #4534

The test case was removed in that PR.

Context: #4534 (comment)

@sidharthv96 sidharthv96 changed the title fix: Add support for ~test Array~string~ back fix: Add support for ~test Array~string~ back in Class Sep 4, 2023
@sidharthv96 sidharthv96 added Type: Bug / Error Something isn't working or is incorrect Graph: Class Area: Development labels Sep 5, 2023
Copy link
Collaborator

@knsv knsv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Some small thing in the review but I see now show stoppers!

@knsv knsv enabled auto-merge September 5, 2023 12:33
Copy link
Member

@aloisklink aloisklink left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aloisklink this PR was actually targeted at #4534

The test case was removed in that PR.

Context: #4534 (comment)

Ahh, awesome! 👍 Great catch on getting it fixed while it was still in the develop branch.

Btw, is it worth labeling this PR with Skip changelog? Since this bug has never been released to users (it's just on the develop branch), there's less of a need to put it in the Release notes (maybe current users of ~test Array~string~ might get confused if they see this PR in the release notes).

@knsv knsv added this pull request to the merge queue Sep 6, 2023
Merged via the queue into develop with commit abcf2a2 Sep 6, 2023
25 of 26 checks passed
@jgreywolf
Copy link
Contributor

Im not sure where my comment went - but this was by design. any leading ~ characters are stripped before the string is even sent to this method

fuxingloh pushed a commit to fuxingloh/contented that referenced this pull request Oct 3, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [mermaid](https://togithub.com/mermaid-js/mermaid) | [`10.4.0` ->
`10.5.0`](https://renovatebot.com/diffs/npm/mermaid/10.4.0/10.5.0) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/mermaid/10.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/mermaid/10.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/mermaid/10.4.0/10.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/mermaid/10.4.0/10.5.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>mermaid-js/mermaid (mermaid)</summary>

###
[`v10.5.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.5.0):
10.5.0

[Compare
Source](https://togithub.com/mermaid-js/mermaid/compare/v10.4.0...v10.5.0)

#### What's Changed

##### Features

- feat(er): add entity name alias by
[@&#8203;tomperr](https://togithub.com/tomperr) in
[mermaid-js/mermaid#4758

##### Bugfixes

- Fix Twitter fontawesome class in flowchart.md by
[@&#8203;GingerNinjaNicko](https://togithub.com/GingerNinjaNicko) in
[mermaid-js/mermaid#4723
- fix(pie): align slices and legend orders by
[@&#8203;Yokozuna59](https://togithub.com/Yokozuna59) in
[mermaid-js/mermaid#4774
- Update class member handling by
[@&#8203;jgreywolf](https://togithub.com/jgreywolf) in
[mermaid-js/mermaid#4534
- fix(er): allow underscore as leading char by
[@&#8203;tomperr](https://togithub.com/tomperr) in
[mermaid-js/mermaid#4776
- Align arrows on sequence diagram by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4804
- fix: Allow hollow markers on edges by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4788
- fix: Fix for vulnerability making it possible to add javascript in
class names by [@&#8203;knsv](https://togithub.com/knsv)

##### Documentation

- Docs/2910 Remove n00b and fix some docs by
[@&#8203;nirname](https://togithub.com/nirname) in
[mermaid-js/mermaid#4767
- fix: typos by [@&#8203;omahs](https://togithub.com/omahs) in
[mermaid-js/mermaid#4801
- "CSS" instead of "css" in flowchart.md by
[@&#8203;jakeboone02](https://togithub.com/jakeboone02) in
[mermaid-js/mermaid#4797
- fix(docs): Correct repeated text in flowchart.md by
[@&#8203;andriy-koz](https://togithub.com/andriy-koz) in
[mermaid-js/mermaid#4810
- Update link to Discourse theme component by
[@&#8203;gschlager](https://togithub.com/gschlager) in
[mermaid-js/mermaid#4811
- New Mermaid Live Editor for Confluence Cloud by
[@&#8203;zhifeiyue](https://togithub.com/zhifeiyue) in
[mermaid-js/mermaid#4814
- Update classDiagram.md by
[@&#8203;jgreywolf](https://togithub.com/jgreywolf) in
[mermaid-js/mermaid#4781
- Support member definition to initialize class by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4786
- fix: Add support for `~test Array~string~` back in Class by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4805
- Added support for millisecond and second to gantt tickInterval by
[@&#8203;vertxxyz](https://togithub.com/vertxxyz) in
[mermaid-js/mermaid#4778
- Add directive support to all diagrams by preprocessing by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4759
- Update README.md by
[@&#8203;jgreywolf](https://togithub.com/jgreywolf) in
[mermaid-js/mermaid#4780

##### Chores

- chore(deps): update all minor dependencies (minor) by
[@&#8203;renovate](https://togithub.com/renovate) in
[mermaid-js/mermaid#4783
- chore(deps): update all patch dependencies (patch) by
[@&#8203;renovate](https://togithub.com/renovate) in
[mermaid-js/mermaid#4782
- chore(deps): update all patch dependencies (patch) by
[@&#8203;renovate](https://togithub.com/renovate) in
[mermaid-js/mermaid#4809
- chore: move `commonDb` into `diagrams/common/commonDb` by
[@&#8203;Yokozuna59](https://togithub.com/Yokozuna59) in
[mermaid-js/mermaid#4802
- Use utf8 encoding in Jupyter example by
[@&#8203;jonashaag](https://togithub.com/jonashaag) in
[mermaid-js/mermaid#4701
- Update flowchart.md by [@&#8203;Ogglas](https://togithub.com/Ogglas)
in
[mermaid-js/mermaid#4792
- Update flowchart.md by [@&#8203;dsblank](https://togithub.com/dsblank)
in
[mermaid-js/mermaid#4798
- Refactor `cypress/helpers/util.ts` by
[@&#8203;RohanHandore](https://togithub.com/RohanHandore) in
[mermaid-js/mermaid#4340
- refactor: Fix typings in utils.ts by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4826
- Support ClassDefs in external diagrams by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4819
- Fix: flowchartElk Arrow overlap by
[@&#8203;sidharthv96](https://togithub.com/sidharthv96) in
[mermaid-js/mermaid#4830
- Give markers unique id's per graph by
[@&#8203;chadfawcett](https://togithub.com/chadfawcett) in
[mermaid-js/mermaid#4825

#### New Contributors

- [@&#8203;GingerNinjaNicko](https://togithub.com/GingerNinjaNicko) made
their first contribution in
[mermaid-js/mermaid#4723
- [@&#8203;omahs](https://togithub.com/omahs) made their first
contribution in
[mermaid-js/mermaid#4801
- [@&#8203;jakeboone02](https://togithub.com/jakeboone02) made their
first contribution in
[mermaid-js/mermaid#4797
- [@&#8203;andriy-koz](https://togithub.com/andriy-koz) made their first
contribution in
[mermaid-js/mermaid#4810
- [@&#8203;gschlager](https://togithub.com/gschlager) made their first
contribution in
[mermaid-js/mermaid#4811
- [@&#8203;zhifeiyue](https://togithub.com/zhifeiyue) made their first
contribution in
[mermaid-js/mermaid#4814
- [@&#8203;vertxxyz](https://togithub.com/vertxxyz) made their first
contribution in
[mermaid-js/mermaid#4778
- [@&#8203;jonashaag](https://togithub.com/jonashaag) made their first
contribution in
[mermaid-js/mermaid#4701
- [@&#8203;Ogglas](https://togithub.com/Ogglas) made their first
contribution in
[mermaid-js/mermaid#4792
- [@&#8203;dsblank](https://togithub.com/dsblank) made their first
contribution in
[mermaid-js/mermaid#4798
- [@&#8203;RohanHandore](https://togithub.com/RohanHandore) made their
first contribution in
[mermaid-js/mermaid#4340
- [@&#8203;chadfawcett](https://togithub.com/chadfawcett) made their
first contribution in
[mermaid-js/mermaid#4825

**Full Changelog**:
mermaid-js/mermaid@v10.4.0...v10.5.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/levaintech/contented).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjMiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjMiLCJ0YXJnZXRCcmFuY2giOiJtYWluIn0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Development Graph: Class Type: Bug / Error Something isn't working or is incorrect
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants