Skip to content

fix(playground) app shouldn’t crash while user is typing #9316

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Jan 4, 2025
Merged

fix(playground) app shouldn’t crash while user is typing #9316

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4efb203
Update configuration.js
chrisgervang Dec 21, 2024
54abcf6
Update configuration.js
chrisgervang Dec 21, 2024
7817572
lint
chrisgervang Dec 21, 2024
266c80a
Merge branch 'master' into chrisgervang-patch-1
chrisgervang Dec 22, 2024
dc45214
Merge branch 'master' into chrisgervang-patch-1
chrisgervang Dec 23, 2024
31e877c
Merge branch 'master' into chrisgervang-patch-1
chrisgervang Jan 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion examples/playground/src/configuration.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

// This configuration object determines which deck.gl classes are accessible in Playground

import {MapView, FirstPersonView, OrbitView, OrthographicView} from '@deck.gl/core';
import {MapView, FirstPersonView, OrbitView, OrthographicView, View, Layer} from '@deck.gl/core';
import * as Layers from '@deck.gl/layers';
import * as AggregationLayers from '@deck.gl/aggregation-layers';
import * as GeoLayers from '@deck.gl/geo-layers';
Expand Down Expand Up @@ -57,5 +57,19 @@ export default {
constants: {
Tiles3DLoader,
CesiumIonLoader
},

postProcessConvertedJson: json => {
// Filter out invalid props. Typically, props will be invalid while the user is typing.
Copy link
Collaborator

@ibgreen ibgreen Dec 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are several ways to address this.
Perhaps we could make deck more resilient and not fail on one bad component...

Copy link
Collaborator Author

@chrisgervang chrisgervang Dec 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True. I figured it was for a bit of perf gains, and to keep things simpler. It could be argued that only something like this json module would need validation since here the end user is hooking into props directly whereas most apps have some abstraction in-between.

On the flip side, validation can be this simple.

if (json.layers) {
json.layers = json.layers.filter(layer => layer instanceof Layer);
}
if (json.widgets) {
json.widgets = json.widgets.filter(widget => typeof widget.onAdd === 'function');
}
if (json.views && !(json.views instanceof View)) {
json.views = json.views.filter(view => view instanceof View);
}
return json;
}
};
Loading