fix(map): don't crash when remounting with a broken cached map instance#984
Merged
Merged
Conversation
When the initial map creation fails (e.g. the Maps JavaScript API didn't load), the cached map instance can return a non-Node from getDiv(). The reuse path then called container.appendChild() with that value and threw. Validate the cached div before reusing the instance, and fall back to creating a fresh map otherwise. Fixes visgl#982
Collaborator
|
"Don't crash" is my favourite kind of external contributions :D Thanks a lot for that. I'll review it and we can probably push it to the 1.9.0 release. |
Collaborator
|
@SAY-5 Thanks for this! I reproduced the issue and validated the fix. Looking good and viable :) |
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
3 participants
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 #982
When the initial map creation fails (for example because the Maps JavaScript API didn't load correctly), the cached map instance ends up in a broken state where
getDiv()no longer returns a usable DOM node. On the next mount withreuseMaps, the reuse path calledcontainer.appendChild(map.getDiv())with that value, throwingFailed to execute 'appendChild' on 'Node': parameter 1 is not of type 'Node'.This validates the cached map's div (
instanceof Node) before reusing the instance. If it is not a usable node, the broken instance is discarded and a fresh map is created instead.Added a regression test under
map instance cachingthat fails onmainand passes with this change. Full test suite, lint, prettier and tsc pass.