bigbluebutton-Github/bigbluebutton-html5/imports/ui/components/common/error-boundary/component.jsx
Ramón Souza 96085110a5
refactor: fix sonarcloud alerts (#20604)
* remove unused argument

* fix Do not use "Error" to declare a variable

* fix Do not use "Array" to declare a parameter

* fix React component names must start with an uppercase letter

* adjust error boundary prop type

* add default values for lock settings
2024-06-28 15:58:38 -04:00

107 lines
2.9 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,
}),
};
const defaultProps = {
Fallback: null,
errorMessage: 'Something went wrong',
logMetadata: {
logCode: 'Error_Boundary_wrapper',
logMessage: 'generic error boundary logger',
},
};
class ErrorBoundary extends Component {
constructor(props) {
super(props);
this.state = { error: '', errorInfo: null };
}
componentDidMount() {
const data = JSON.parse((sessionStorage.getItem('clientStartupSettings')) || {});
const logConfig = data?.clientLog;
if (logConfig) {
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) {
window.dispatchEvent(new Event('StopAudioTracks'));
const data = JSON.parse((sessionStorage.getItem('clientStartupSettings')) || '{}');
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>
);