Harden mobile navigation history so reopened task detail surfaces remain dismissible after stale back events. - Reconcile duplicate navigation entries with replaceState while preserving existing history state. - Treat stale or desynced popstate navIndex values as a top-entry dismiss instead of a no-op. - Cover close-and-quick-reopen swipe-back races across the hook, task-detail modal, and app navigation tests. - Add the navigation history tests to the dashboard quality test allowlists and include a patch changeset. Files changed: .changeset/fn-7275-swipe-back-reliability.md | 7 ++ .../__tests__/TaskDetail.swipe-back.test.tsx | 14 +++- .../__tests__/navigation-history.test.tsx | 18 +++-- .../hooks/__tests__/useNavigationHistory.test.ts | 43 +++++++++- .../dashboard/app/hooks/useNavigationHistory.ts | 92 ++++++++++++++-------- packages/dashboard/vitest.config.ts | 3 +- 6 files changed, 128 insertions(+), 49 deletions(-) Fusion-Task-Id: FN-7275 Fusion-Task-Lineage: f01e46c3-e6ad-45ef-a848-e8e2012ea3d1 Co-authored-by: Fusion (runfusion.ai) <noreply@runfusion.ai>
266 lines
8.9 KiB
TypeScript
266 lines
8.9 KiB
TypeScript
import {
|
|
createContext,
|
|
createElement,
|
|
useCallback,
|
|
useContext,
|
|
useEffect,
|
|
useRef,
|
|
type PropsWithChildren,
|
|
} from "react";
|
|
|
|
/**
|
|
* A navigation entry on the back-navigation stack.
|
|
*
|
|
* - `modal` entries wrap a close callback for dismissing a modal.
|
|
* - `view` entries wrap a revert callback for restoring a previous view.
|
|
*
|
|
* All callbacks MUST be idempotent — safe to call multiple times even if the
|
|
* underlying state has already changed (e.g., calling `setDetailTask(null)`
|
|
* when `detailTask` is already `null`). This handles edge cases where an
|
|
* auto-close side effect fires before a `popstate` event.
|
|
*/
|
|
export type NavEntry =
|
|
| { type: "modal"; close: () => void }
|
|
| { type: "view"; revert: () => void };
|
|
|
|
export interface UseNavigationHistoryOptions {
|
|
/** Only active on mobile. When false, pushNav/replaceCurrent are no-ops. */
|
|
enabled: boolean;
|
|
}
|
|
|
|
export interface UseNavigationHistoryResult {
|
|
/** Push a navigation entry onto the stack and call history.pushState. */
|
|
pushNav: (entry: NavEntry) => void;
|
|
/** Replace the top-of-stack entry and call history.replaceState. */
|
|
replaceCurrent: (entry: NavEntry) => void;
|
|
/**
|
|
* Remove a programmatically-dismissed entry and call history.back so the
|
|
* browser history entry created by pushNav is consumed as well.
|
|
*/
|
|
removeNav: (closeOrRevert: () => void) => void;
|
|
}
|
|
|
|
const SELF_POP_FALLBACK_CLEAR_MS = 1_000;
|
|
const FUSION_NATIVE_BACK_EVENT = "fusion:native-back";
|
|
|
|
export const NavigationHistoryContext = createContext<UseNavigationHistoryResult | null>(null);
|
|
|
|
export function NavigationHistoryProvider({
|
|
value,
|
|
children,
|
|
}: PropsWithChildren<{ value: UseNavigationHistoryResult }>) {
|
|
return createElement(NavigationHistoryContext.Provider, { value }, children);
|
|
}
|
|
|
|
export function useNavigationHistoryContext(): UseNavigationHistoryResult {
|
|
const context = useContext(NavigationHistoryContext);
|
|
if (!context) {
|
|
throw new Error("useNavigationHistoryContext must be used within a NavigationHistoryProvider");
|
|
}
|
|
return context;
|
|
}
|
|
|
|
/**
|
|
* Centralized back-navigation hook that integrates the browser History API
|
|
* (`pushState`/`popstate`) with modal and view state machines.
|
|
*
|
|
* Every modal open and view change pushes a history entry so that the
|
|
* browser back button dismisses the top modal or reverts to the previous
|
|
* view. Works on both desktop and mobile.
|
|
*
|
|
* When `enabled` is false, all operations are no-ops and no `popstate`
|
|
* listener is registered.
|
|
*/
|
|
function getEntryCallback(entry: NavEntry): () => void {
|
|
return entry.type === "modal" ? entry.close : entry.revert;
|
|
}
|
|
|
|
export function useNavigationHistory(
|
|
options: UseNavigationHistoryOptions,
|
|
): UseNavigationHistoryResult {
|
|
const { enabled } = options;
|
|
|
|
// Internal navigation stack. Each entry corresponds to one history entry.
|
|
const stackRef = useRef<NavEntry[]>([]);
|
|
|
|
// Guard flag: when popstate fires and calls a close/revert callback, the
|
|
// resulting state change (e.g. `setDetailTask(null)`) must NOT re-push a
|
|
// history entry. pushNav checks this flag and skips if true.
|
|
const isPoppingRef = useRef(false);
|
|
|
|
// Guard flag: removeNav calls history.back() to consume the matching browser
|
|
// history entry after the UI has already closed. The resulting popstate must
|
|
// be ignored so callbacks are not invoked twice.
|
|
const selfPopRef = useRef(false);
|
|
const selfPopClearTimerRef = useRef<number | null>(null);
|
|
|
|
// Keep enabled in a ref so the popstate handler can read the current value
|
|
// without needing to be re-registered on every change.
|
|
const enabledRef = useRef(enabled);
|
|
enabledRef.current = enabled;
|
|
|
|
const readExistingState = useCallback(() => {
|
|
if (typeof window === "undefined") return {};
|
|
return window.history.state && typeof window.history.state === "object"
|
|
? window.history.state
|
|
: {};
|
|
}, []);
|
|
|
|
const writeHistoryState = useCallback(
|
|
(mode: "push" | "replace", navIndex: number) => {
|
|
const nextState = {
|
|
...readExistingState(),
|
|
navIndex,
|
|
};
|
|
|
|
if (mode === "push") {
|
|
window.history.pushState(nextState, "");
|
|
return;
|
|
}
|
|
|
|
window.history.replaceState(nextState, "");
|
|
},
|
|
[readExistingState],
|
|
);
|
|
|
|
const pushNav = useCallback(
|
|
(entry: NavEntry) => {
|
|
if (!enabledRef.current) return;
|
|
|
|
// Prevent re-push during pop handling
|
|
if (isPoppingRef.current) return;
|
|
|
|
// Guard against duplicate consecutive pushes (rapid taps). If a stale
|
|
// top entry still uses the same callback, reconcile it in place instead
|
|
// of silently dropping the reopen and leaving history/stack out of sync.
|
|
const top = stackRef.current[stackRef.current.length - 1];
|
|
if (top && getEntryCallback(top) === getEntryCallback(entry)) {
|
|
stackRef.current[stackRef.current.length - 1] = entry;
|
|
writeHistoryState("replace", stackRef.current.length);
|
|
return;
|
|
}
|
|
|
|
stackRef.current.push(entry);
|
|
writeHistoryState("push", stackRef.current.length);
|
|
},
|
|
[writeHistoryState],
|
|
);
|
|
|
|
const replaceCurrent = useCallback(
|
|
(entry: NavEntry) => {
|
|
if (!enabledRef.current) return;
|
|
if (stackRef.current.length === 0) return;
|
|
|
|
stackRef.current[stackRef.current.length - 1] = entry;
|
|
writeHistoryState("replace", stackRef.current.length);
|
|
},
|
|
[writeHistoryState],
|
|
);
|
|
|
|
const removeNav = useCallback(
|
|
(closeOrRevert: () => void) => {
|
|
if (!enabledRef.current) return;
|
|
|
|
for (let i = stackRef.current.length - 1; i >= 0; i -= 1) {
|
|
const entry = stackRef.current[i];
|
|
if (getEntryCallback(entry) !== closeOrRevert) continue;
|
|
|
|
stackRef.current.splice(i, 1);
|
|
selfPopRef.current = true;
|
|
|
|
if (selfPopClearTimerRef.current !== null) {
|
|
window.clearTimeout(selfPopClearTimerRef.current);
|
|
}
|
|
selfPopClearTimerRef.current = window.setTimeout(() => {
|
|
selfPopRef.current = false;
|
|
selfPopClearTimerRef.current = null;
|
|
}, SELF_POP_FALLBACK_CLEAR_MS);
|
|
|
|
window.history.back();
|
|
return;
|
|
}
|
|
},
|
|
[], // stable — reads from refs
|
|
);
|
|
|
|
// Register popstate listener. Always registers in browser environments but
|
|
// the handler checks enabledRef.current to skip when disabled (desktop).
|
|
useEffect(() => {
|
|
if (typeof window === "undefined") return;
|
|
|
|
/*
|
|
FNXC:TaskDetailAndroidBack 2026-06-29-20:40:
|
|
The mobile shell dispatches a cancelable native Back event before applying its fallback. Prevent it only when Fusion owns at least one nav entry, then route through history.back() so modal, nested, snapshot-only, hydrated, and main-panel task-detail dismissals reuse the same popstate stack semantics as browser Back and swipe-back.
|
|
*/
|
|
const handleNativeBack = (event: Event) => {
|
|
if (!enabledRef.current) return;
|
|
if (stackRef.current.length === 0) return;
|
|
|
|
event.preventDefault();
|
|
window.history.back();
|
|
};
|
|
|
|
const handlePopState = (event: PopStateEvent) => {
|
|
if (!enabledRef.current) return;
|
|
|
|
if (selfPopRef.current) {
|
|
selfPopRef.current = false;
|
|
if (selfPopClearTimerRef.current !== null) {
|
|
window.clearTimeout(selfPopClearTimerRef.current);
|
|
selfPopClearTimerRef.current = null;
|
|
}
|
|
return;
|
|
}
|
|
|
|
const targetIndex = typeof event.state?.navIndex === "number" ? event.state.navIndex : null;
|
|
const currentLength = stackRef.current.length;
|
|
|
|
if (currentLength === 0) return;
|
|
|
|
const staleOrDesyncedIndex =
|
|
targetIndex === null ||
|
|
targetIndex < 0 ||
|
|
targetIndex >= currentLength;
|
|
|
|
/*
|
|
FNXC:TaskDetailSwipeBack 2026-06-30-09:40:
|
|
Mobile swipe-back must deterministically dismiss the top Fusion surface
|
|
even when browser history carries a stale navIndex from a close→reopen
|
|
race, remount, or interleaved non-Fusion pushState. Falling back to one
|
|
top-entry pop keeps the live stack authoritative instead of silently
|
|
no-oping on `targetIndex >= currentLength`.
|
|
*/
|
|
const poppedCount = staleOrDesyncedIndex ? 1 : currentLength - targetIndex;
|
|
|
|
if (poppedCount <= 0) return;
|
|
|
|
isPoppingRef.current = true;
|
|
|
|
try {
|
|
// Pop entries in reverse order (top of stack first)
|
|
for (let i = 0; i < poppedCount; i++) {
|
|
const entry = stackRef.current.pop();
|
|
if (entry) {
|
|
getEntryCallback(entry)();
|
|
}
|
|
}
|
|
} finally {
|
|
isPoppingRef.current = false;
|
|
}
|
|
};
|
|
|
|
window.addEventListener(FUSION_NATIVE_BACK_EVENT, handleNativeBack);
|
|
window.addEventListener("popstate", handlePopState);
|
|
return () => {
|
|
window.removeEventListener(FUSION_NATIVE_BACK_EVENT, handleNativeBack);
|
|
window.removeEventListener("popstate", handlePopState);
|
|
if (selfPopClearTimerRef.current !== null) {
|
|
window.clearTimeout(selfPopClearTimerRef.current);
|
|
selfPopClearTimerRef.current = null;
|
|
}
|
|
};
|
|
}, []);
|
|
|
|
return { pushNav, replaceCurrent, removeNav };
|
|
}
|