-
Notifications
You must be signed in to change notification settings - Fork 104
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'aperture/PluginPOCFeature' into jwesson/merge-master-in…
…to-POC
- Loading branch information
Showing
21 changed files
with
903 additions
and
63 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
'use client'; | ||
|
||
import React, { | ||
useEffect, useMemo, useState, | ||
} from 'react'; | ||
import PropTypes from 'prop-types'; | ||
import { ErrorBoundary } from 'react-error-boundary'; | ||
import { logError } from '@edx/frontend-platform/logging'; | ||
import { | ||
dispatchMountedEvent, dispatchReadyEvent, dispatchUnmountedEvent, useHostEvent, | ||
} from './data/hooks'; | ||
import { PLUGIN_RESIZE } from './data/constants'; | ||
|
||
// see example-plugin-app/src/PluginOne.jsx for example of customizing errorFallback | ||
function errorFallbackDefault() { | ||
return ( | ||
<div> | ||
<h2> | ||
Oops! An error occurred. Please refresh the screen to try again. | ||
</h2> | ||
</div> | ||
); | ||
} | ||
|
||
// eslint-disable-next-line react/function-component-definition | ||
export default function Plugin({ | ||
children, className, style, ready, errorFallbackProp, | ||
}) { | ||
const [dimensions, setDimensions] = useState({ | ||
width: null, | ||
height: null, | ||
}); | ||
|
||
const finalStyle = useMemo(() => ({ | ||
...dimensions, | ||
...style, | ||
}), [dimensions, style]); | ||
|
||
const errorFallback = errorFallbackProp || errorFallbackDefault; | ||
|
||
// Error logging function | ||
// Need to confirm: When an error is caught here, the logging will be sent to the child MFE's logging service | ||
const logErrorToService = (error, info) => { | ||
logError(error, { stack: info.componentStack }); | ||
}; | ||
|
||
useHostEvent(PLUGIN_RESIZE, ({ payload }) => { | ||
setDimensions({ | ||
width: payload.width, | ||
height: payload.height, | ||
}); | ||
}); | ||
|
||
useEffect(() => { | ||
dispatchMountedEvent(); | ||
|
||
return () => { | ||
dispatchUnmountedEvent(); | ||
}; | ||
}, []); | ||
|
||
useEffect(() => { | ||
if (ready) { | ||
dispatchReadyEvent(); | ||
} | ||
}, [ready]); | ||
|
||
return ( | ||
<div className={className} style={finalStyle}> | ||
<ErrorBoundary | ||
FallbackComponent={errorFallback} | ||
onError={logErrorToService} | ||
> | ||
{children} | ||
</ErrorBoundary> | ||
</div> | ||
); | ||
} | ||
|
||
Plugin.propTypes = { | ||
children: PropTypes.node.isRequired, | ||
className: PropTypes.string, | ||
errorFallbackProp: PropTypes.func, | ||
ready: PropTypes.bool, | ||
style: PropTypes.object, // eslint-disable-line | ||
}; | ||
|
||
Plugin.defaultProps = { | ||
className: null, | ||
errorFallbackProp: null, | ||
style: {}, | ||
ready: true, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
'use client'; | ||
|
||
import React from 'react'; | ||
|
||
// eslint-disable-next-line import/no-extraneous-dependencies | ||
import PluginContainerIframe from './PluginContainerIframe'; | ||
|
||
import { | ||
IFRAME_PLUGIN, | ||
} from './data/constants'; | ||
import { pluginConfigShape } from './data/shapes'; | ||
|
||
// eslint-disable-next-line react/function-component-definition | ||
export default function PluginContainer({ config, ...props }) { | ||
if (config === null) { | ||
return null; | ||
} | ||
|
||
// this will allow for future plugin types to be inserted in the PluginErrorBoundary | ||
let renderer = null; | ||
switch (config.type) { | ||
case IFRAME_PLUGIN: | ||
renderer = ( | ||
<PluginContainerIframe config={config} {...props} /> | ||
); | ||
break; | ||
// istanbul ignore next: default isn't meaningful, just satisfying linter | ||
default: | ||
} | ||
|
||
return ( | ||
renderer | ||
); | ||
} | ||
|
||
PluginContainer.propTypes = { | ||
config: pluginConfigShape, | ||
}; | ||
|
||
PluginContainer.defaultProps = { | ||
config: null, | ||
}; |
Oops, something went wrong.