fix(core): make getConnectedDataURL opts optional - #21736
Open
SEPURI-SAI-KRISHNA wants to merge 1 commit into
Open
fix(core): make getConnectedDataURL opts optional#21736SEPURI-SAI-KRISHNA wants to merge 1 commit into
SEPURI-SAI-KRISHNA wants to merge 1 commit into
Conversation
|
Thanks for your contribution! Please DO NOT commit the files in dist, i18n, and ssr/client/dist folders in a non-release pull request. These folders are for release use only. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brief Information
This pull request is in the type of:
What does this PR do?
Makes the
optsargument ofechartsInstance.getConnectedDataURLactually optional, as the rest of the method already assumes.Fixed issues
Details
Before: What was the problem?
Calling the documented public API with no argument always threw:
optsis declared optional and every other read of it inside the method is writtendefensively, but the very first read is not:
So the method is internally inconsistent: the
opts &&guards further down and thedelegation to
getDataURL(which normalizesoptsitself) are unreachable for ano-argument call, because line 1026 has already thrown. The failure does not depend
on whether the chart is connected, on the renderer, or on the environment.
After: How does it behave after the fixing?
optsis normalized once at the top, mirroringgetDataURL:getConnectedDataURL(),getConnectedDataURL(undefined)andgetConnectedDataURL({...})all behave as documented. The existingopts && ...reads are left alone — they are now simply redundant rather than load-bearing.
Document Info
One of the following should be checked.
Misc
Security Checking
ZRender Changes
Related test cases or examples to use the new APIs
Added
test/ut/spec/api/getConnectedDataURL.test.ts: no argument, explicitundefined, and an explicit options object. The first two fail onmaster; thethird passes before and after and is kept as a control.
npm run test,npx tsc --noEmitandeslinton the changed file all pass.Merging options
Other information
This is a different problem from #19278, which is about the SVG branch of the same
method; this PR does not address that issue.