refactor cypress/helper/util.ts

[Yokozuna59]

📑 Summary

Brief description about the content of your PR.

• closes Refactor cypress/helpers/util.ts #4340

📏 Design Decisions

• reorder functions declarations
• rename mermaidUrl into createMermaidUrl
• remove renderGraph and use imgSnapshotTest instead
• rename openURLAndVerifyRendering into openUrlAndVerifyRendering
• rename Utf8ToB64 to convertUtf8ToBase64
• partially add JSDoc
• combine imgSnapshotTest options assigment
• change parameter default value into optional field
• remove cy.get(svg) and {}

📋 Tasks

Make sure you

• 📖 have read the contribution guidelines
• 💻 have added unit/e2e tests (if appropriate)
• 📓 have added documentation (if appropriate)
• 🔖 targeted develop branch

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 44.79%. Comparing base (be1270d) to head (27cc5d3).

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #4651   +/-   ##
========================================
  Coverage    44.79%   44.79%           
========================================
  Files           25       25           
  Lines         5353     5353           
  Branches        27       27           
========================================
  Hits          2398     2398           
  Misses        2954     2954           
  Partials         1        1           

Flag	Coverage Δ
unit	44.79% <ø> (ø)

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

[Yokozuna59]

The only thing left is JSDoc, I'm not really sure what to type, we could discuss it here.

[sidharthv96]

@Yokozuna59 is this blocked by anything? Can we finish this off before new PRs? Otherwise it'll conflict and it'll be more work for you.

[sidharthv96]

You can remove all the @params without any valid descriptions.

[Yokozuna59]

I added them as a placeholder so we could discuss what should we add.

[sidharthv96]

The only thing left is JSDoc, I'm not really sure what to type, we could discuss it here.

You can remove all the JSDocs that didn't have any existing comments.

But there are E2E tests failing. Those needs to be fixed.

[Yokozuna59]

@Yokozuna59 is this blocked by anything?

@sidharthv96 Because E2E tests are failing. Not Really sure why but the options assignment isn't working as expected, for example: https://github.com/mermaid-js/mermaid/actions/runs/5796633792/job/15710598026?pr=4651#step:5:7346

TypeError: Cannot read properties of undefined (reading 'fontFamily')

---

Can we finish this off before new PRs? Otherwise it'll conflict and it'll be more work for you.

I'll give it a try.

You can remove all the JSDocs that didn't have any existing comments.

#4651 (comment)

[Yokozuna59]

Because E2E tests are failing. Not Really sure why but the options assignment isn't working as expected, for example: https://github.com/mermaid-js/mermaid/actions/runs/5796633792/job/15710598026?pr=4651#step:5:7346

It should be resolved with this c74e55f

[sidharthv96]

@Yokozuna59 any clues why the tests are still failing? This has been open for a while, would love to merge this.

[netlify]

✅ Deploy Preview for mermaid-js ready!

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

[sidharthv96]

@Yokozuna59 can you resolve the conflict?

[sidharthv96]

Few tests with significant changes.
We should see if these are valid or not.