index.js
167 lines
| 1 | /** |
| 2 | * NOTE: This is a fork of the original ServerSideRenderX component. |
| 3 | * You can find more about that project here: https://github.com/dgwyer/server-side-render-x |
| 4 | * |
| 5 | * Changes: |
| 6 | * - some minor clean up was done to remove references to variables which were never actually used. |
| 7 | */ |
| 8 | |
| 9 | /** |
| 10 | * External dependencies |
| 11 | */ |
| 12 | import { isEqual, debounce } from 'lodash'; |
| 13 | |
| 14 | /** |
| 15 | * WordPress dependencies |
| 16 | */ |
| 17 | const { Component, RawHTML, Fragment } = wp.element; |
| 18 | const { __, sprintf } = wp.i18n; |
| 19 | const apiFetch = wp.apiFetch; |
| 20 | const { addQueryArgs } = wp.url; |
| 21 | const { Placeholder } = wp.components; |
| 22 | |
| 23 | export function rendererPath( block, attributes = null, urlQueryArgs = {} ) { |
| 24 | return addQueryArgs( `/wp/v2/block-renderer/${ block }`, { |
| 25 | context: 'edit', |
| 26 | ...( null !== attributes ? { attributes } : {} ), |
| 27 | ...urlQueryArgs, |
| 28 | } ); |
| 29 | } |
| 30 | |
| 31 | export class ServerSideRenderX extends Component { |
| 32 | constructor( props ) { |
| 33 | super( props ); |
| 34 | this.state = { |
| 35 | response: null, |
| 36 | prevResponse: null, |
| 37 | }; |
| 38 | } |
| 39 | |
| 40 | componentDidMount() { |
| 41 | this.isStillMounted = true; |
| 42 | this.fetch( this.props ); |
| 43 | // Only debounce once the initial fetch occurs to ensure that the first |
| 44 | // renders show data as soon as possible. |
| 45 | this.fetch = debounce( this.fetch, 500 ); |
| 46 | } |
| 47 | |
| 48 | componentWillUnmount() { |
| 49 | this.isStillMounted = false; |
| 50 | } |
| 51 | |
| 52 | componentDidUpdate( prevProps ) { |
| 53 | if ( ! isEqual( prevProps, this.props ) ) { |
| 54 | this.fetch( this.props ); |
| 55 | } |
| 56 | } |
| 57 | |
| 58 | fetch( props ) { |
| 59 | if ( ! this.isStillMounted ) { |
| 60 | return; |
| 61 | } |
| 62 | if ( null !== this.state.response ) { |
| 63 | this.setState( state => ( |
| 64 | { |
| 65 | response: null, |
| 66 | prevResponse: state.response, |
| 67 | } |
| 68 | ) ); |
| 69 | } |
| 70 | const { block, attributes = null, urlQueryArgs = {} } = props; |
| 71 | |
| 72 | const path = rendererPath( block, attributes, urlQueryArgs ); |
| 73 | // Store the latest fetch request so that when we process it, we can |
| 74 | // check if it is the current request, to avoid race conditions on slow networks. |
| 75 | const fetchRequest = ( this.currentFetchRequest = apiFetch( { path } ) |
| 76 | .then( ( response ) => { |
| 77 | if ( |
| 78 | this.isStillMounted && |
| 79 | fetchRequest === this.currentFetchRequest && |
| 80 | response |
| 81 | ) { |
| 82 | this.setState( { response: response.rendered } ); |
| 83 | } |
| 84 | } ) |
| 85 | .catch( ( error ) => { |
| 86 | if ( |
| 87 | this.isStillMounted && |
| 88 | fetchRequest === this.currentFetchRequest |
| 89 | ) { |
| 90 | this.setState( { |
| 91 | response: { |
| 92 | error: true, |
| 93 | errorMsg: error.message, |
| 94 | }, |
| 95 | } ); |
| 96 | } |
| 97 | } ) ); |
| 98 | return fetchRequest; |
| 99 | } |
| 100 | |
| 101 | render() { |
| 102 | const { right, top, unit } = this.props.spinnerLocation; |
| 103 | const response = this.state.response; |
| 104 | const prevResponse = this.state.prevResponse; |
| 105 | let prevResponseHTML = ''; |
| 106 | if ( prevResponse !== null ) { |
| 107 | prevResponseHTML = `<div style="position:relative;"><div style="position:absolute;right:${ right }${ unit };top:${ top }${ unit };z-index:1"><span class="components-spinner"></span></div>${ prevResponse }</div>`; |
| 108 | } |
| 109 | |
| 110 | const { |
| 111 | className, |
| 112 | EmptyResponsePlaceholder, |
| 113 | ErrorResponsePlaceholder, |
| 114 | } = this.props; |
| 115 | |
| 116 | if ( response === '' ) { |
| 117 | return ( |
| 118 | <EmptyResponsePlaceholder |
| 119 | response={ response } |
| 120 | { ...this.props } |
| 121 | /> |
| 122 | ); |
| 123 | } else if ( ! response ) { |
| 124 | return ( |
| 125 | <Fragment> |
| 126 | <RawHTML key="html" className={ className }> |
| 127 | { prevResponseHTML } |
| 128 | </RawHTML> |
| 129 | </Fragment> |
| 130 | ); |
| 131 | } else if ( response.error ) { |
| 132 | return ( |
| 133 | <ErrorResponsePlaceholder |
| 134 | response={ response } |
| 135 | { ...this.props } |
| 136 | /> |
| 137 | ); |
| 138 | } |
| 139 | |
| 140 | return ( |
| 141 | <RawHTML key="html" className={ className }> |
| 142 | { response } |
| 143 | </RawHTML> |
| 144 | ); |
| 145 | } |
| 146 | } |
| 147 | |
| 148 | ServerSideRenderX.defaultProps = { |
| 149 | EmptyResponsePlaceholder: ( { className } ) => ( |
| 150 | <Placeholder className={ className }> |
| 151 | { __( 'Block rendered as empty.' ) } |
| 152 | </Placeholder> |
| 153 | ), |
| 154 | ErrorResponsePlaceholder: ( { response, className } ) => { |
| 155 | const errorMessage = sprintf( |
| 156 | // translators: %s: error message describing the problem |
| 157 | __( 'Error loading block: %s' ), |
| 158 | response.errorMsg |
| 159 | ); |
| 160 | return ( |
| 161 | <Placeholder className={ className }>{ errorMessage }</Placeholder> |
| 162 | ); |
| 163 | }, |
| 164 | }; |
| 165 | |
| 166 | export default ServerSideRenderX; |
| 167 |