b6a962ff73
Currently, all error boundaries close audio and Apollo connections once an error is caught. This is not the correct behavior as not all error boundaries are critical, e.g.: the presentation crashing should _not_ break the whole client. It also deviates from how error boundaries worked in 2.7 Add a new prop to the ErrorBoundary/LocatedErrorBoundary components called isCritical that flags an error boundary instance as critical. If true, it'll close Apollo/audio. The default behavior is isCritical=false, and the only critical error boundaries are the ones located in the app's root (/client/main.tsx).
117 lines
3.3 KiB
JavaScript
117 lines
3.3 KiB
JavaScript
import React, { Component } from 'react';
|
|
import PropTypes from 'prop-types';
|
|
import logger, { generateLoggerStreams } from '/imports/startup/client/logger';
|
|
import apolloContextHolder from '/imports/ui/core/graphql/apolloContextHolder/apolloContextHolder';
|
|
import { ApolloLink } from '@apollo/client';
|
|
|
|
const propTypes = {
|
|
children: PropTypes.element.isRequired,
|
|
Fallback: PropTypes.func,
|
|
errorMessage: PropTypes.string,
|
|
logMetadata: PropTypes.shape({
|
|
logCode: PropTypes.string,
|
|
logMessage: PropTypes.string,
|
|
}),
|
|
// isCritical: flags this error boundary as critical for the app's lifecycle,
|
|
// which means that the app should not continue to run if this error boundary
|
|
// is triggered. If true, terminates RTC audio connections and the Apollo client.
|
|
isCritical: PropTypes.bool,
|
|
};
|
|
|
|
const defaultProps = {
|
|
Fallback: null,
|
|
errorMessage: 'Something went wrong',
|
|
logMetadata: {
|
|
logCode: 'Error_Boundary_wrapper',
|
|
logMessage: 'generic error boundary logger',
|
|
},
|
|
isCritical: false,
|
|
};
|
|
|
|
class ErrorBoundary extends Component {
|
|
constructor(props) {
|
|
super(props);
|
|
this.state = { error: '', errorInfo: null };
|
|
}
|
|
|
|
componentDidMount() {
|
|
const data = window.meetingClientSettings.public;
|
|
const logConfig = data?.clientLog;
|
|
if (logConfig && logger?.streams.length === 0) {
|
|
generateLoggerStreams(logConfig).forEach((stream) => {
|
|
logger.addStream(stream);
|
|
});
|
|
}
|
|
}
|
|
|
|
componentDidUpdate() {
|
|
const { error, errorInfo } = this.state;
|
|
const { logMetadata: { logCode, logMessage } } = this.props;
|
|
if (error || errorInfo) {
|
|
logger.error({
|
|
logCode,
|
|
extraInfo: {
|
|
errorMessage: error?.message,
|
|
errorStack: error?.stack,
|
|
errorInfo,
|
|
},
|
|
}, logMessage);
|
|
}
|
|
}
|
|
|
|
componentDidCatch(error, errorInfo) {
|
|
const { isCritical } = this.props;
|
|
|
|
if (isCritical) {
|
|
window.dispatchEvent(new Event('StopAudioTracks'));
|
|
const data = window.meetingClientSettings.public.media;
|
|
const mediaElement = document.querySelector(data?.mediaTag || '#remote-media');
|
|
if (mediaElement) {
|
|
mediaElement.pause();
|
|
mediaElement.srcObject = null;
|
|
}
|
|
const apolloClient = apolloContextHolder.getClient();
|
|
|
|
if (apolloClient) {
|
|
apolloClient.stop();
|
|
}
|
|
|
|
const ws = apolloContextHolder.getLink();
|
|
if (ws) {
|
|
// delay to termintate the connection, for user receive the end eject message
|
|
setTimeout(() => {
|
|
apolloClient.setLink(ApolloLink.empty());
|
|
ws.terminate();
|
|
}, 5000);
|
|
}
|
|
}
|
|
|
|
this.setState({
|
|
error,
|
|
errorInfo,
|
|
});
|
|
}
|
|
|
|
render() {
|
|
const { error, errorInfo } = this.state;
|
|
const { children, Fallback, errorMessage } = this.props;
|
|
|
|
const fallbackElement = Fallback && error
|
|
? <Fallback error={error || {}} errorInfo={errorInfo} /> : <div>{errorMessage}</div>;
|
|
return (error
|
|
? fallbackElement
|
|
: children);
|
|
}
|
|
}
|
|
|
|
ErrorBoundary.propTypes = propTypes;
|
|
ErrorBoundary.defaultProps = defaultProps;
|
|
|
|
export default ErrorBoundary;
|
|
|
|
export const withErrorBoundary = (WrappedComponent, FallbackComponent) => (props) => (
|
|
<ErrorBoundary Fallback={FallbackComponent}>
|
|
<WrappedComponent {...props} />
|
|
</ErrorBoundary>
|
|
);
|