Use ErrorBoundary for attachment renderer #3761
Merged
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.
Changelog Entry
Fixed
<ErrorBoundary>
to wrap around attachment renderer, by @compulim in PR #3761Description
When rendering attachment, we should add an
<ErrorBoundary>
(or friendlier<UserlandBoundary>
) to catch all exceptions.Design
Attachment middleware is the only "legacy" middleware. Similar to "modern" middleware, we are adding
<ErrorBoundary>
to wrap around the rendering of middleware."Legacy" middleware has a signature of:
"Modern" middleware has a signature of:
The modern signature allow the renderer to know beforehand that if an element should be rendered or not. This help transcript and other containers to count how many elements it is going to render. This information is crucial for some operations, such as grouping activities.
If the middleware "agreed" to render, it must return a
React.Element
when we call its render function,(...renderArgs) => React.Element
.In future, we should move attachment middleware to use the modern middleware signature.
Specific Changes
applyMiddleware.forLegacyRenderer
for "legacy" middlewareapplyMiddleware()
is left as-is as it could be used by non-React middleware (where<ErrorBoundary>
should not be applied)applyMiddleware.forLegacyRenderer
for constructing the attachment rendererunknown activity
commandCHANGELOG.md
I have updated documentationReview Checklist
Accessibility reviewed (tab order, content readability, alt text, color contrast)Browser and platform compatibilities reviewedCSS styles reviewed (minimal rules, noz-index
)Documents reviewed (docs, samples, live demo)Internationalization reviewed (strings, unit formatting)package.json
andpackage-lock.json
reviewedSecurity reviewed (no data URIs, check for nonce leak)