Skip to content

ServerSideRender: Colocate delayed spinner logic #70147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 20, 2025
Merged

ServerSideRender: Colocate delayed spinner logic #70147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cfc9299
ServerSideRender: Colocate delayed spinner logic
Mamaduka May 16, 2025
04a67df
Add changelog entry
Mamaduka May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/server-side-render/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

### Breaking Changes

- The `LoadingResponsePlaceholder` prop will no longer receive `showLoader`. The spinner rendering logic is now located in the same component ([#70147](https://github.com/WordPress/gutenberg/pull/70147)).

## 5.23.0 (2025-05-07)

### Bug Fixes
Expand Down
28 changes: 17 additions & 11 deletions packages/server-side-render/src/server-side-render.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,22 @@ function DefaultErrorResponsePlaceholder( { response, className } ) {
return <Placeholder className={ className }>{ errorMessage }</Placeholder>;
}

function DefaultLoadingResponsePlaceholder( { children, showLoader } ) {
function DefaultLoadingResponsePlaceholder( { children, isLoading } ) {
const [ showLoader, setShowLoader ] = useState( false );

useEffect( () => {
if ( ! isLoading ) {
setShowLoader( false );
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: This is just a safeguard for the future. Currently, the component will unmount when isLoading settles on false.

return;
}

// Schedule showing the Spinner after 1 second.
const timeout = setTimeout( () => {
setShowLoader( true );
}, 1000 );
return () => clearTimeout( timeout );
}, [ isLoading ] );

return (
<div style={ { position: 'relative' } }>
{ showLoader && (
Expand Down Expand Up @@ -101,7 +116,6 @@ export default function ServerSideRender( props ) {
} = props;

const isMountedRef = useRef( false );
const [ showLoader, setShowLoader ] = useState( false );
const fetchRequestRef = useRef();
const [ response, setResponse ] = useState( null );
const prevProps = usePrevious( props );
Expand All @@ -127,11 +141,6 @@ export default function ServerSideRender( props ) {

setIsLoading( true );

// Schedule showing the Spinner after 1 second.
const timeout = setTimeout( () => {
setShowLoader( true );
}, 1000 );

let sanitizedAttributes =
attributes &&
__experimentalSanitizeBlockAttributes( block, attributes );
Expand Down Expand Up @@ -185,9 +194,6 @@ export default function ServerSideRender( props ) {
fetchRequest === fetchRequestRef.current
) {
setIsLoading( false );
// Cancel the timeout to show the Spinner.
setShowLoader( false );
clearTimeout( timeout );
}
} ) );

Expand Down Expand Up @@ -221,7 +227,7 @@ export default function ServerSideRender( props ) {

if ( isLoading ) {
return (
<LoadingResponsePlaceholder { ...props } showLoader={ showLoader }>
<LoadingResponsePlaceholder { ...props } isLoading={ isLoading }>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor, but if we're worried about back-compat, I can revert the prop name, or just add a changelog entry about it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this component is rendered when isLoading is true, so won't the value of the isLoading prop always be true?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's true, mostly passing the value as a safeguard for future changes. Same as here - #70147 (comment).

{ hasResponse && ! hasError && (
<RawHTML className={ className }>{ response }</RawHTML>
) }
Expand Down
Loading