Skip to content
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

Render error boundary in Map #125

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
41 changes: 41 additions & 0 deletions src/error-boundary.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import React from 'react'

// Based on https://react.dev/reference/react/Component#catching-rendering-errors-with-an-error-boundary
const DEFAULT_ERROR = 'Your device doesn’t support rendering this map.'
class ErrorBoundary extends React.Component {
constructor(props) {
super(props)
this.state = { errorMessage: null }
}

static getDerivedStateFromError(error) {
// Update state so the next render will show the fallback UI.
return {
errorMessage: error.message ?? defaultError,
}
}

componentDidCatch(error, info) {
// Example "componentStack":
// in ComponentThatThrows (created by App)
// in ErrorBoundary (created by App)
// in div (created by App)
// in App
console.error(error, info.componentStack)
}

render() {
if (this.state.errorMessage) {
// You can render any custom fallback UI
return (
<div style={{ textAlign: 'center', padding: 24, marginTop: '56px' }}>
{this.props.showErrorTrace ? this.state.errorMessage : DEFAULT_ERROR}
</div>
)
}

return this.props.children
}
}

export default ErrorBoundary
58 changes: 31 additions & 27 deletions src/map.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import Mapbox from './mapbox'
import Regl from './regl'
import { RegionProvider } from './region/context'
import { LoadingProvider, LoadingUpdater } from './loading'
import ErrorBoundary from './error-boundary'

const Map = ({
id,
Expand All @@ -24,6 +25,7 @@ const Map = ({
setMetadataLoading,
/** Tracks any requests of new chunks by containing `Raster` layers */
setChunkLoading,
showErrorTrace = false,
}) => {
return (
<div
Expand All @@ -38,34 +40,36 @@ const Map = ({
...style,
}}
>
<Mapbox
zoom={zoom}
minZoom={minZoom}
maxZoom={maxZoom}
maxBounds={maxBounds}
center={center}
debug={debug}
glyphs={glyphs}
style={{ position: 'absolute' }}
>
<Regl
extensions={extensions}
style={{
position: 'absolute',
pointerEvents: 'none',
zIndex: -1,
}}
<ErrorBoundary showErrorTrace={showErrorTrace}>
<Mapbox
zoom={zoom}
minZoom={minZoom}
maxZoom={maxZoom}
maxBounds={maxBounds}
center={center}
debug={debug}
glyphs={glyphs}
style={{ position: 'absolute' }}
>
<LoadingProvider>
<LoadingUpdater
setLoading={setLoading}
setMetadataLoading={setMetadataLoading}
setChunkLoading={setChunkLoading}
/>
<RegionProvider>{children}</RegionProvider>
</LoadingProvider>
</Regl>
</Mapbox>
<Regl
extensions={extensions}
style={{
position: 'absolute',
pointerEvents: 'none',
zIndex: -1,
}}
>
<LoadingProvider>
<LoadingUpdater
setLoading={setLoading}
setMetadataLoading={setMetadataLoading}
setChunkLoading={setChunkLoading}
/>
<RegionProvider>{children}</RegionProvider>
</LoadingProvider>
</Regl>
</Mapbox>
</ErrorBoundary>
</div>
)
}
Expand Down
Loading