refactor!: rename useHandleCallback → useHandleAuthCallback and HandleCallback → HandleAuthCallback (#358)

ryanbonial · web-flow · commit 014dc6953202 · 2025-03-24T10:54:52.000-06:00
diff --git a/packages/core/src/_exports/index.ts b/packages/core/src/_exports/index.ts
@@ -23,7 +23,7 @@ export {
   type LoggingInAuthState,
 } from '../auth/authStore'
 export {fetchLoginUrls} from '../auth/fetchLoginUrls'
-export {handleCallback} from '../auth/handleCallback'
+export {handleAuthCallback} from '../auth/handleAuthCallback'
 export {logout} from '../auth/logout'
 export type {ClientState} from '../client/clientStore'
 export {type ClientOptions, getClient, getClientState} from '../client/clientStore'
diff --git a/packages/core/src/auth/handleAuthCallback.test.ts b/packages/core/src/auth/handleAuthCallback.test.ts
@@ -4,15 +4,15 @@ import {createSanityInstance} from '../instance/sanityInstance'
 import {createResourceState} from '../resources/createResource'
 import {AuthStateType} from './authStateType'
 import {authStore} from './authStore'
-import {handleCallback} from './handleCallback'
+import {handleAuthCallback} from './handleAuthCallback'
 import {getAuthCode, getTokenFromStorage} from './utils'
 
 vi.mock('./utils', async (importOriginal) => {
   const original = await importOriginal<typeof import('./utils')>()
   return {...original, getTokenFromStorage: vi.fn(), getAuthCode: vi.fn()}
 })
 
-describe('handleCallback', () => {
+describe('handleAuthCallback', () => {
   beforeEach(() => {
     vi.clearAllMocks()
   })
@@ -37,7 +37,7 @@ describe('handleCallback', () => {
     const state = createResourceState(authStore.getInitialState(instance))
     expect(state.get()).toMatchObject({authState: {isExchangingToken: false}})
 
-    const resultPromise = handleCallback(
+    const resultPromise = handleAuthCallback(
       {instance, state},
       'https://example.com/callback?foo=bar#withSid=code',
     )
@@ -79,7 +79,7 @@ describe('handleCallback', () => {
     })
 
     const state = createResourceState(authStore.getInitialState(instance))
-    const result = await handleCallback(
+    const result = await handleAuthCallback(
       {instance, state},
       'https://example.com/callback?foo=bar#withSid=code',
     )
@@ -106,7 +106,7 @@ describe('handleCallback', () => {
     state.set('setAlreadyExchanging', {
       authState: {type: AuthStateType.LOGGING_IN, isExchangingToken: true},
     })
-    const result = await handleCallback(
+    const result = await handleAuthCallback(
       {instance, state},
       'https://example.com/callback?foo=bar#withSid=code',
     )
@@ -131,7 +131,7 @@ describe('handleCallback', () => {
     vi.mocked(getAuthCode).mockReturnValue(null)
 
     const state = createResourceState(authStore.getInitialState(instance))
-    const result = await handleCallback(
+    const result = await handleAuthCallback(
       {instance, state},
       'https://example.com/callback?foo=bar#withSid=code',
     )
@@ -160,7 +160,7 @@ describe('handleCallback', () => {
     })
 
     const state = createResourceState(authStore.getInitialState(instance))
-    const result = await handleCallback(
+    const result = await handleAuthCallback(
       {instance, state},
       'https://example.com/callback?foo=bar#withSid=code',
     )
diff --git a/packages/core/src/auth/handleAuthCallback.ts b/packages/core/src/auth/handleAuthCallback.ts
@@ -7,7 +7,7 @@ import {getAuthCode, getDefaultLocation} from './utils'
 /**
  * @public
  */
-export const handleCallback = createAction(authStore, ({state}) => {
+export const handleAuthCallback = createAction(authStore, ({state}) => {
   const {providedToken, callbackUrl, clientFactory, apiHost, storageArea, storageKey} =
     state.get().options
 
diff --git a/packages/react-internal/src/components/auth/LoginCallback.test.tsx b/packages/react-internal/src/components/auth/LoginCallback.test.tsx
@@ -3,12 +3,12 @@ import {afterAll, beforeAll, beforeEach, describe, expect, it, vi} from 'vitest'
 
 import {renderWithWrappers} from './authTestHelpers'
 
-// Mock `useHandleCallback`
+// Mock `useHandleAuthCallback`
 vi.mock('@sanity/sdk-react', async (importOriginal) => {
   const actual = await importOriginal<typeof import('@sanity/sdk-react')>()
   return {
     ...actual,
-    useHandleCallback: vi.fn(() => async (url: string) => {
+    useHandleAuthCallback: vi.fn(() => async (url: string) => {
       const parsedUrl = new URL(url)
       const sid = new URLSearchParams(parsedUrl.hash.slice(1)).get('sid')
       if (sid === 'valid') {
diff --git a/packages/react-internal/src/components/auth/LoginCallback.tsx b/packages/react-internal/src/components/auth/LoginCallback.tsx
@@ -1,4 +1,4 @@
-import {useHandleCallback} from '@sanity/sdk-react'
+import {useHandleAuthCallback} from '@sanity/sdk-react'
 import {Flex, Heading, Spinner} from '@sanity/ui'
 import {useEffect} from 'react'
 
@@ -13,18 +13,18 @@ import {LoginLayout, type LoginLayoutProps} from './LoginLayout'
  * @alpha
  */
 export function LoginCallback({header, footer}: LoginLayoutProps): React.ReactNode {
-  const handleCallback = useHandleCallback()
+  const handleAuthCallback = useHandleAuthCallback()
 
   useEffect(() => {
     const url = new URL(location.href)
-    handleCallback(url.toString()).then((replacementLocation) => {
+    handleAuthCallback(url.toString()).then((replacementLocation) => {
       if (replacementLocation) {
         // history API with `replaceState` is used to prevent a reload but still
         // remove the short-lived token from the URL
         history.replaceState(null, '', replacementLocation)
       }
     })
-  }, [handleCallback])
+  }, [handleAuthCallback])
 
   return (
     <LoginLayout header={header} footer={footer}>
diff --git a/packages/react/src/_exports/index.ts b/packages/react/src/_exports/index.ts
@@ -7,7 +7,7 @@ export {useAuthState} from '../hooks/auth/useAuthState'
 export {useAuthToken} from '../hooks/auth/useAuthToken'
 export {useCurrentUser} from '../hooks/auth/useCurrentUser'
 export {useDashboardOrganizationId} from '../hooks/auth/useDashboardOrganizationId'
-export {useHandleCallback} from '../hooks/auth/useHandleCallback'
+export {useHandleAuthCallback} from '../hooks/auth/useHandleAuthCallback'
 export {useLoginUrls} from '../hooks/auth/useLoginUrls'
 export {useLogOut} from '../hooks/auth/useLogOut'
 export {useClient} from '../hooks/client/useClient'
diff --git a/packages/react/src/components/Login/LoginLinks.test.tsx b/packages/react/src/components/Login/LoginLinks.test.tsx
@@ -36,8 +36,8 @@ vi.mock('../../hooks/auth/useAuthState', () => ({
   useAuthState: vi.fn(() => 'logged-out'),
 }))
 
-vi.mock('../../hooks/auth/useHandleCallback', () => ({
-  useHandleCallback: vi.fn(),
+vi.mock('../../hooks/auth/useHandleAuthCallback', () => ({
+  useHandleAuthCallback: vi.fn(),
 }))
 
 describe('LoginLinks', () => {
diff --git a/packages/react/src/components/Login/LoginLinks.tsx b/packages/react/src/components/Login/LoginLinks.tsx
@@ -1,7 +1,7 @@
 import {type ReactElement} from 'react'
 
 import {useAuthState} from '../../hooks/auth/useAuthState'
-import {useHandleCallback} from '../../hooks/auth/useHandleCallback'
+import {useHandleAuthCallback} from '../../hooks/auth/useHandleAuthCallback'
 import {useLoginUrls} from '../../hooks/auth/useLoginUrls'
 
 /**
@@ -26,7 +26,7 @@ import {useLoginUrls} from '../../hooks/auth/useLoginUrls'
 export const LoginLinks = (): ReactElement => {
   const loginUrls = useLoginUrls()
   const authState = useAuthState()
-  useHandleCallback()
+  useHandleAuthCallback()
 
   if (authState.type === 'logging-in') {
     return <div className="sc-login-links__logging-in">Logging in...</div>
diff --git a/packages/react/src/components/auth/AuthBoundary.test.tsx b/packages/react/src/components/auth/AuthBoundary.test.tsx
@@ -13,8 +13,8 @@ vi.mock('../../hooks/auth/useAuthState', () => ({
 vi.mock('../../hooks/auth/useLoginUrls', () => ({
   useLoginUrls: vi.fn(() => [{title: 'Provider A', url: 'https://provider-a.com/auth'}]),
 }))
-vi.mock('../../hooks/auth/useHandleCallback', () => ({
-  useHandleCallback: vi.fn(() => async () => {}),
+vi.mock('../../hooks/auth/useHandleAuthCallback', () => ({
+  useHandleAuthCallback: vi.fn(() => async () => {}),
 }))
 vi.mock('../../hooks/auth/useLogOut', () => ({
   useLogOut: vi.fn(() => async () => {}),
diff --git a/packages/react/src/components/auth/LoginCallback.test.tsx b/packages/react/src/components/auth/LoginCallback.test.tsx
@@ -3,9 +3,9 @@ import {afterAll, beforeAll, beforeEach, describe, expect, it, vi} from 'vitest'
 
 import {renderWithWrappers} from './authTestHelpers'
 
-// Mock `useHandleCallback`
-vi.mock('../../hooks/auth/useHandleCallback', () => ({
-  useHandleCallback: vi.fn(() => async (url: string) => {
+// Mock `useHandleAuthCallback`
+vi.mock('../../hooks/auth/useHandleAuthCallback', () => ({
+  useHandleAuthCallback: vi.fn(() => async (url: string) => {
     const parsedUrl = new URL(url)
     const sid = new URLSearchParams(parsedUrl.hash.slice(1)).get('sid')
     if (sid === 'valid') {
diff --git a/packages/react/src/components/auth/LoginCallback.tsx b/packages/react/src/components/auth/LoginCallback.tsx
@@ -1,6 +1,6 @@
 import {useEffect} from 'react'
 
-import {useHandleCallback} from '../../hooks/auth/useHandleCallback'
+import {useHandleAuthCallback} from '../../hooks/auth/useHandleAuthCallback'
 import {LoginLayout, type LoginLayoutProps} from './LoginLayout'
 
 /**
@@ -12,18 +12,18 @@ import {LoginLayout, type LoginLayoutProps} from './LoginLayout'
  * @alpha
  */
 export function LoginCallback({header, footer}: LoginLayoutProps): React.ReactNode {
-  const handleCallback = useHandleCallback()
+  const handleAuthCallback = useHandleAuthCallback()
 
   useEffect(() => {
     const url = new URL(location.href)
-    handleCallback(url.toString()).then((replacementLocation) => {
+    handleAuthCallback(url.toString()).then((replacementLocation) => {
       if (replacementLocation) {
         // history API with `replaceState` is used to prevent a reload but still
         // remove the short-lived token from the URL
         history.replaceState(null, '', replacementLocation)
       }
     })
-  }, [handleCallback])
+  }, [handleAuthCallback])
 
   return (
     <LoginLayout header={header} footer={footer}>
diff --git a/packages/react/src/hooks/auth/useHandleAuthCallback.test.tsx b/packages/react/src/hooks/auth/useHandleAuthCallback.test.tsx
@@ -0,0 +1,16 @@
+import {handleAuthCallback} from '@sanity/sdk'
+import {identity} from 'rxjs'
+import {describe, it} from 'vitest'
+
+import {createCallbackHook} from '../helpers/createCallbackHook'
+
+vi.mock('../helpers/createCallbackHook', () => ({createCallbackHook: vi.fn(identity)}))
+vi.mock('@sanity/sdk', () => ({handleAuthCallback: vi.fn()}))
+
+describe('useHandleAuthCallback', () => {
+  it('calls `createCallbackHook` with `handleAuthCallback`', async () => {
+    const {useHandleAuthCallback} = await import('./useHandleAuthCallback')
+    expect(createCallbackHook).toHaveBeenCalledWith(handleAuthCallback)
+    expect(useHandleAuthCallback).toBe(handleAuthCallback)
+  })
+})
diff --git a/packages/react/src/hooks/auth/useHandleAuthCallback.tsx b/packages/react/src/hooks/auth/useHandleAuthCallback.tsx
@@ -1,4 +1,4 @@
-import {handleCallback} from '@sanity/sdk'
+import {handleAuthCallback} from '@sanity/sdk'
 
 import {createCallbackHook} from '../helpers/createCallbackHook'
 
@@ -10,21 +10,21 @@ import {createCallbackHook} from '../helpers/createCallbackHook'
  * This hook provides access to the authentication store's callback handler,
  * which processes auth redirects by extracting the session ID and fetching the
  * authentication token. If fetching the long-lived token is successful,
- * `handleCallback` will return a Promise that resolves a new location that
+ * `handleAuthCallback` will return a Promise that resolves a new location that
  * removes the short-lived token from the URL. Use this in combination with
  * `history.replaceState` or your own router's `replace` function to update the
  * current location without triggering a reload.
  *
  * @example
  * ```tsx
  * function AuthCallback() {
- *   const handleCallback = useHandleCallback()
+ *   const handleAuthCallback = useHandleAuthCallback()
  *   const router = useRouter() // Example router
  *
  *   useEffect(() => {
  *     async function processCallback() {
  *       // Handle the callback and get the cleaned URL
- *       const newUrl = await handleCallback(window.location.href)
+ *       const newUrl = await handleAuthCallback(window.location.href)
  *
  *       if (newUrl) {
  *         // Replace URL without triggering navigation
@@ -33,7 +33,7 @@ import {createCallbackHook} from '../helpers/createCallbackHook'
  *     }
  *
  *     processCallback().catch(console.error)
- *   }, [handleCallback, router])
+ *   }, [handleAuthCallback, router])
  *
  *   return <div>Completing login...</div>
  * }
@@ -42,4 +42,4 @@ import {createCallbackHook} from '../helpers/createCallbackHook'
  * @returns A callback handler function that processes OAuth redirects
  * @public
  */
-export const useHandleCallback = createCallbackHook(handleCallback)
+export const useHandleAuthCallback = createCallbackHook(handleAuthCallback)
diff --git a/packages/react/src/hooks/auth/useHandleCallback.test.tsx b/packages/react/src/hooks/auth/useHandleCallback.test.tsx
diff --git a/packages/react/src/hooks/auth/useLogOut.test.tsx b/packages/react/src/hooks/auth/useLogOut.test.tsx
@@ -7,8 +7,8 @@ import {createCallbackHook} from '../helpers/createCallbackHook'
 vi.mock('../helpers/createCallbackHook', () => ({createCallbackHook: vi.fn(identity)}))
 vi.mock('@sanity/sdk', () => ({logout: vi.fn()}))
 
-describe('useHandleCallback', () => {
-  it('calls `createCallbackHook` with `handleCallback`', async () => {
+describe('useLogOut', () => {
+  it('calls `createCallbackHook` with `logout`', async () => {
     const {useLogOut} = await import('./useLogOut')
     expect(createCallbackHook).toHaveBeenCalledWith(logout)
     expect(useLogOut).toBe(logout)
