Skip to content

fix(react-utilities): avoid calling requestAnimationFrame when in SSR #29015

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
marcosmoura merged 11 commits into from
Aug 30, 2023
Merged

fix(react-utilities): avoid calling requestAnimationFrame when in SSR #29015

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
b600f45
fix: use timeout instead of requestAnimationFrame for ssr
marcosmoura Aug 29, 2023
e297826
fix: add missing changefile
marcosmoura Aug 29, 2023
271a3d7
test: add SSR tests for useAnimationFrame
marcosmoura Aug 30, 2023
97119fa
Merge branch 'master' into fix/useAnimationFrame-on-ssr
marcosmoura Aug 30, 2023
f4d0c17
fix: add blank content
marcosmoura Aug 30, 2023
ae491d7
fix: move stories to a dedicated folder
marcosmoura Aug 30, 2023
63893a5
fix: use noop instead of timeout
marcosmoura Aug 30, 2023
c9950fe
fix: move fn to outside scope of hook
marcosmoura Aug 30, 2023
9d01ebe
fix: call callback passed by requestAnimationFrame
marcosmoura Aug 30, 2023
ef7c381
Merge branch 'master' into fix/useAnimationFrame-on-ssr
marcosmoura Aug 30, 2023
0b18813
Merge branch 'master' into fix/useAnimationFrame-on-ssr
marcosmoura Aug 30, 2023
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
3 changes: 2 additions & 1 deletion apps/ssr-tests-v9/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
"test-ssr": "test-ssr \"./src/stories/**/*.stories.tsx\""
},
"dependencies": {
"@fluentui/react-components": "*"
"@fluentui/react-components": "*",
"@fluentui/react-utilities": "*"
},
"devDependencies": {
"@fluentui/eslint-plugin": "*",
Expand Down
5 changes: 5 additions & 0 deletions apps/ssr-tests-v9/src/stories/Utilitites/index.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export { Default } from './useAnimationFrame.stories';

export default {
title: 'Utilities/useAnimationFrame',
};
15 changes: 15 additions & 0 deletions apps/ssr-tests-v9/src/stories/Utilitites/useAnimationFrame.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import * as React from 'react';
import { useAnimationFrame } from '@fluentui/react-utilities';

export const Default = () => {
const [setAnimationFrame, clearAnimationFrame] = useAnimationFrame();
const [visible, setVisible] = React.useState(false);

React.useEffect(() => {
setAnimationFrame(() => setVisible(true));

return () => clearAnimationFrame();
}, [setAnimationFrame]);

return visible ? <div>Test the renderization</div> : null;
};
7 changes: 7 additions & 0 deletions change/@fluentui-react-utilities-b4af8469-27c7-4b29-a6a9-13ef542e6779.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "fix: use timeout instead of requestAnimationFrame for ssr",
"packageName": "@fluentui/react-utilities",
"email": "marcosvmmoura@gmail.com",
"dependentChangeType": "patch"
}
14 changes: 13 additions & 1 deletion packages/react-components/react-utilities/src/hooks/useAnimationFrame.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
import { canUseDOM } from '../ssr/canUseDOM';
import { useBrowserTimer } from './useBrowserTimer';

const setAnimationFrameNoop = (callback: FrameRequestCallback) => {
callback(0);
return 0;
};
const cancelAnimationFrameNoop = (handle: number) => handle;

/**
* @internal
* Helper to manage a browser requestAnimationFrame.
Expand All @@ -9,6 +16,11 @@ import { useBrowserTimer } from './useBrowserTimer';
* @returns A pair of [requestAnimationFrame, cancelAnimationFrame] that are stable between renders.
*/
export function useAnimationFrame() {
const isDOM = canUseDOM();

// TODO: figure it out a way to not call global.requestAnimationFrame and instead infer window from some context
return useBrowserTimer(requestAnimationFrame, cancelAnimationFrame);
const setAnimationFrame = isDOM ? requestAnimationFrame : setAnimationFrameNoop;
const clearAnimationFrame = isDOM ? cancelAnimationFrame : cancelAnimationFrameNoop;

return useBrowserTimer(setAnimationFrame, clearAnimationFrame);
}