Sanitize style attribute in DrawControl.js for data attribute serialization
#1133
Conversation
This file contains 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
…tream serialization. - Fix for jupyter-widgets#1119 - The main issue is that a `style()` function is added to the GeoJSON object in `create_obj()`, which triggers an error at serialization time: https://github.com/jupyter-widgets/ipywidgets/blob/e1718c2b3bf0b143580ef87f71c55fbc6ed50a77/packages/base/src/widget.ts#L587 - This is because `structuredClone` throws an error for functions: https://web.dev/structured-clone/#features-and-limitations. While the article mentions drawbacks for using `JSON.parse(JSON.stringify(...))`, I believe that this component does not produce any non-primitive properties, so will remove any offending lines. - Tested by placing a breakpoint and testing directly on the browser.
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.
Fixes Draw control can't stop drawing after draw more than one shape #1119 1119
The main issue is that a
style()function is added to the GeoJSON objectstyleproperty increate_obj(), which triggers an error when thedataattribute is serialized here: https://github.com/jupyter-widgets/ipywidgets/blob/e1718c2b3bf0b143580ef87f71c55fbc6ed50a77/packages/base/src/widget.ts#L587This is because
structuredClonethrows an error for functions: https://web.dev/structured-clone/#features-and-limitations. While the article mentions drawbacks for usingJSON.parse(JSON.stringify(...)), I believe that this component does not produce any non-primitive properties, so this is a valid strategy for removing offending properties.Tested by placing a breakpoint and testing directly on the browser and then building a local ipyleaflet in Jupyter Lab.