-
-
Notifications
You must be signed in to change notification settings - Fork 6.3k
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
refactor cypress/helper/util.ts
#4651
base: develop
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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
Flags with carried forward coverage won't be shown. Click here to find out more. |
2ec255d
to
324986e
Compare
The only thing left is JSDoc, I'm not really sure what to type, we could discuss it here. |
207e597
to
5620e83
Compare
* reorder function 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
@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. |
* @param url - | ||
* @param options - | ||
* @param validation - |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can remove all the @params without any valid descriptions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added them as a placeholder so we could discuss what should we add.
You can remove all the JSDocs that didn't have any existing comments. But there are E2E tests failing. Those needs to be fixed. |
@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
I'll give it a try.
|
2c8cb42
to
2e91eaa
Compare
It should be resolved with this c74e55f |
@Yokozuna59 any clues why the tests are still failing? This has been open for a while, would love to merge this. |
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
6ff4489
to
10a96c3
Compare
10a96c3
to
781857b
Compare
@Yokozuna59 can you resolve the conflict? |
📑 Summary
Brief description about the content of your PR.
cypress/helpers/util.ts
#4340📏 Design Decisions
mermaidUrl
intocreateMermaidUrl
renderGraph
and useimgSnapshotTest
insteadopenURLAndVerifyRendering
intoopenUrlAndVerifyRendering
Utf8ToB64
toconvertUtf8ToBase64
imgSnapshotTest
options assigmentcy.get(svg)
and{}
📋 Tasks
Make sure you
develop
branch