Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Add 401 auto-refresh to admin SDK and SPA

Damian Legawiec3045560a1f20
diff --git a/packages/admin-sdk/src/client.ts b/packages/admin-sdk/src/client.ts
index 4698343cc2..5393e0f47d 100644
--- a/packages/admin-sdk/src/client.ts
+++ b/packages/admin-sdk/src/client.ts
@@ -1,4 +1,4 @@
-import { createRequestFn, resolveRetryConfig } from '@spree/sdk-core';
+import { createRequestFn, resolveRetryConfig, SpreeError } from '@spree/sdk-core';
import type { RetryConfig, RequestConfig, RequestFn, InternalRequestOptions } from '@spree/sdk-core';
import { AdminClient } from './admin-client';
@@ -22,30 +22,14 @@ export interface Client extends AdminClient {
setStore(storeId: string): void;
/** Set JWT token for authenticated admin sessions */
setToken(token: string): void;
+ /**
+ * Register a callback that fires on 401 responses.
+ * Return `true` to retry the original request (after refreshing the token via setToken).
+ * Return `false` to let the error propagate.
+ */
+ onUnauthorized(handler: () => Promise<boolean>): void;
}
-/**
- * Create a new Spree Admin SDK client.
- *
- * Supports two authentication modes:
- * - **Secret key**: For server-to-server integrations (e.g., backend scripts, CI/CD)
- * - **JWT token**: For admin SPA sessions (e.g., custom admin dashboards)
- *
- * ```ts
- * // Server integration with secret key
- * const admin = createAdminClient({
- * baseUrl: 'https://api.mystore.com',
- * secretKey: 'spree_sk_xxx',
- * })
- *
- * // Admin SPA with JWT
- * const admin = createAdminClient({
- * baseUrl: 'https://api.mystore.com',
- * jwtToken: 'eyJ...',
- * storeId: 'store_k5nR8xLq',
- * })
- * ```
- */
export function createAdminClient(config: AdminClientConfig): Client {
if (!config.secretKey && config.jwtToken === undefined) {
throw new Error('Admin client requires either secretKey or jwtToken');
@@ -56,24 +40,17 @@ export function createAdminClient(config: AdminClientConfig): Client {
const retryConfig = resolveRetryConfig(config.retry);
const requestConfig: RequestConfig = { baseUrl, fetchFn, retryConfig };
- // Mutable state for token and store switching
let currentToken = config.jwtToken;
let currentStoreId = config.storeId;
+ let unauthorizedHandler: (() => Promise<boolean>) | null = null;
const basePath = '/api/v3/admin';
- // Dynamic request function that reads current token/storeId on each call
const dynamicRequestFn: RequestFn = async <T>(
method: string,
path: string,
options: InternalRequestOptions = {}
): Promise<T> => {
- const authValue = config.secretKey
- ? `Bearer ${config.secretKey}`
- : currentToken
- ? `Bearer ${currentToken}`
- : '';
-
const extraHeaders: Record<string, string> = {};
if (currentStoreId) {
extraHeaders['X-Spree-Store-Id'] = currentStoreId;
@@ -87,13 +64,32 @@ export function createAdminClient(config: AdminClientConfig): Client {
},
};
- const requestFn = createRequestFn(
- requestConfig,
- basePath,
- { headerName: 'Authorization', headerValue: authValue },
- );
+ const makeRequest = () => {
+ const requestFn = createRequestFn(
+ requestConfig,
+ basePath,
+ { headerName: 'Authorization', headerValue: config.secretKey ? `Bearer ${config.secretKey}` : currentToken ? `Bearer ${currentToken}` : '' },
+ );
+ return requestFn<T>(method, path, mergedOptions);
+ };
- return requestFn<T>(method, path, mergedOptions);
+ try {
+ return await makeRequest();
+ } catch (error) {
+ // On 401, try the unauthorized handler (token refresh) and retry once
+ if (
+ error instanceof SpreeError &&
+ error.status === 401 &&
+ unauthorizedHandler &&
+ !path.includes('/auth/') // Don't retry auth endpoints
+ ) {
+ const shouldRetry = await unauthorizedHandler();
+ if (shouldRetry) {
+ return makeRequest();
+ }
+ }
+ throw error;
+ }
};
const adminClient = new AdminClient(dynamicRequestFn);
@@ -107,5 +103,9 @@ export function createAdminClient(config: AdminClientConfig): Client {
currentToken = token;
};
+ client.onUnauthorized = (handler: () => Promise<boolean>) => {
+ unauthorizedHandler = handler;
+ };
+
return client;
}
diff --git a/packages/admin/src/providers/auth-provider.tsx b/packages/admin/src/providers/auth-provider.tsx
index e973126b2f..b504626f35 100644
--- a/packages/admin/src/providers/auth-provider.tsx
+++ b/packages/admin/src/providers/auth-provider.tsx
@@ -34,7 +34,15 @@ export function AuthProvider({ children }: { children: ReactNode }) {
})
const [isLoading, setIsLoading] = useState(false)
const refreshTimerRef = useRef<ReturnType<typeof setTimeout> | null>(null)
- const isRefreshingRef = useRef(false)
+ // Serialize all refresh calls — prevents double-rotation from StrictMode/HMR
+ const refreshPromiseRef = useRef<Promise<boolean> | null>(null)
+
+ const clearRefreshTimer = useCallback(() => {
+ if (refreshTimerRef.current) {
+ clearTimeout(refreshTimerRef.current)
+ refreshTimerRef.current = null
+ }
+ }, [])
const clearTokens = useCallback(() => {
setToken(null)
@@ -42,11 +50,8 @@ export function AuthProvider({ children }: { children: ReactNode }) {
localStorage.removeItem(TOKEN_KEY)
localStorage.removeItem(REFRESH_TOKEN_KEY)
localStorage.removeItem(USER_KEY)
- if (refreshTimerRef.current) {
- clearTimeout(refreshTimerRef.current)
- refreshTimerRef.current = null
- }
- }, [])
+ clearRefreshTimer()
+ }, [clearRefreshTimer])
const storeTokens = useCallback((accessToken: string, refreshToken: string, authUser: AuthUser) => {
adminClient.setToken(accessToken)
@@ -57,11 +62,10 @@ export function AuthProvider({ children }: { children: ReactNode }) {
localStorage.setItem(USER_KEY, JSON.stringify(authUser))
}, [])
- const refreshAccessToken = useCallback(async (): Promise<boolean> => {
+ const doRefresh = useCallback(async (): Promise<boolean> => {
const refreshToken = localStorage.getItem(REFRESH_TOKEN_KEY)
- if (!refreshToken || isRefreshingRef.current) return false
+ if (!refreshToken) return false
- isRefreshingRef.current = true
try {
const response = await adminClient.auth.refresh({ refresh_token: refreshToken })
if (response.refresh_token) {
@@ -71,23 +75,27 @@ export function AuthProvider({ children }: { children: ReactNode }) {
} catch {
clearTokens()
return false
- } finally {
- isRefreshingRef.current = false
}
}, [storeTokens, clearTokens])
+ // Serialize: if a refresh is already in-flight, return the same promise
+ const refreshAccessToken = useCallback((): Promise<boolean> => {
+ if (refreshPromiseRef.current) return refreshPromiseRef.current
+
+ const promise = doRefresh().finally(() => {
+ refreshPromiseRef.current = null
+ })
+ refreshPromiseRef.current = promise
+ return promise
+ }, [doRefresh])
+
const scheduleRefresh = useCallback(() => {
- if (refreshTimerRef.current) {
- clearTimeout(refreshTimerRef.current)
- }
+ clearRefreshTimer()
refreshTimerRef.current = setTimeout(async () => {
- await refreshAccessToken()
- // Reschedule on success (clearTokens stops the chain on failure)
- if (localStorage.getItem(REFRESH_TOKEN_KEY)) {
- scheduleRefresh()
- }
+ const success = await refreshAccessToken()
+ if (success) scheduleRefresh()
}, REFRESH_INTERVAL_MS)
- }, [refreshAccessToken])
+ }, [refreshAccessToken, clearRefreshTimer])
const login = useCallback(async (email: string, password: string) => {
setIsLoading(true)
@@ -104,26 +112,30 @@ export function AuthProvider({ children }: { children: ReactNode }) {
clearTokens()
}, [clearTokens])
+ // Register 401 handler: refresh token and retry the failed request
+ // biome-ignore lint/correctness/useExhaustiveDependencies: only run on mount
+ useEffect(() => {
+ adminClient.onUnauthorized(async () => {
+ const success = await refreshAccessToken()
+ if (success) scheduleRefresh()
+ return success
+ })
+ }, []) // eslint-disable-line react-hooks/exhaustive-deps
+
// On mount: refresh the token if we have a refresh token stored
// biome-ignore lint/correctness/useExhaustiveDependencies: only run on mount
useEffect(() => {
const refreshToken = localStorage.getItem(REFRESH_TOKEN_KEY)
if (!refreshToken) {
- // No refresh token — clear stale JWT-only sessions
if (token) clearTokens()
return
}
- // Refresh immediately on mount, then schedule periodic refresh
refreshAccessToken().then((success) => {
if (success) scheduleRefresh()
})
- return () => {
- if (refreshTimerRef.current) {
- clearTimeout(refreshTimerRef.current)
- }
- }
+ return clearRefreshTimer
}, []) // eslint-disable-line react-hooks/exhaustive-deps
return (