Merge pull request #1361 from authts/fix-1357

memoize context value in auth-provider
authts · Sep 17, 2024 · 94fa698 · 94fa698
2 parents 2d20f6a + 167b9cb
commit 94fa698
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 7 deletions.
diff --git a/src/AuthProvider.tsx b/src/AuthProvider.tsx
@@ -290,14 +290,16 @@ export const AuthProvider = (props: AuthProviderProps): JSX.Element => {
         onRemoveUser && await onRemoveUser();
     }, [userManager, onRemoveUser]);
 
+    const contextValue = React.useMemo(() => {
+        return {
+            ...state,
+            ...userManagerContext,
+            removeUser,
+        };
+    }, [state, userManagerContext, removeUser]);
+
     return (
-        <AuthContext.Provider
-            value={{
-                ...state,
-                ...userManagerContext,
-                removeUser,
-            }}
-        >
+        <AuthContext.Provider value={contextValue}>
             {children}
         </AuthContext.Provider>
     );

diff --git a/test/AuthProvider.test.tsx b/test/AuthProvider.test.tsx
@@ -356,4 +356,22 @@ describe("AuthProvider", () => {
 
         mockSigninPopup.mockRestore();
     });
+
+    it("should not update context value after rerender without state changes", async () => {
+        // arrange
+        const wrapper = createWrapper({ ...settingsStub });
+        const { result, rerender } = await act(async () => {
+            const { result, rerender } = renderHook(() => useAuth(), {
+                wrapper,
+            });
+            return { result, rerender };
+        });
+        const memoized = result.current;
+
+        // act
+        rerender();
+
+        // assert
+        expect(result.current).toBe(memoized);
+    });
 });