Ensure that if an agent connects after a timeout failure, the useSession status doesn't get stuck in "failed" (#1236)

Author: 1egoman

.changeset/true-moose-cheer.md

@@ -0,0 +1,5 @@
+---
+'@livekit/components-react': patch
+---
+
+Ensure that if an agent connects after a timeout failure, the status doesn't get stuck in "failed"

packages/react/src/hooks/useAgent.ts

@@ -280,6 +280,7 @@ export const useAgentTimeoutIdStore = (): {
   agentTimeoutFailureReason: string | null;
   startAgentTimeout: (agentConnectTimeoutMilliseconds?: number) => void;
   clearAgentTimeout: () => void;
+  clearAgentTimeoutFailureReason: () => void;
   updateAgentTimeoutState: (agentState: AgentState) => void;
   updateAgentTimeoutParticipantExists: (agentParticipantExists: boolean) => void;
 } => {
@@ -333,6 +334,9 @@ export const useAgentTimeoutIdStore = (): {
       agentStateRef.current = 'connecting';
       agentParticipantExistsRef.current = false;
     }, [agentTimeoutId]),
+    clearAgentTimeoutFailureReason: React.useCallback(() => {
+      setAgentTimeoutFailureReason(null);
+    }, []),
 
     updateAgentTimeoutState: React.useCallback((agentState: AgentState) => {
       agentStateRef.current = agentState;
@@ -479,6 +483,7 @@ export function useAgent(session?: SessionStub): UseAgentReturn {
       agentTimeoutFailureReason,
       startAgentTimeout,
       clearAgentTimeout,
+      clearAgentTimeoutFailureReason,
       updateAgentTimeoutState,
       updateAgentTimeoutParticipantExists,
     },
@@ -572,6 +577,15 @@ export function useAgent(session?: SessionStub): UseAgentReturn {
     };
   }, [room]);
 
+  // When the agent participant connects, reset the timeout failure state
+  React.useEffect(() => {
+    if (!agentParticipant) {
+      return;
+    }
+
+    clearAgentTimeoutFailureReason();
+  }, [agentParticipant]);
+
   // If the agent participant disconnects in the middle of a conversation unexpectedly, mark that as an explicit failure
   const [agentDisconnectedFailureReason, setAgentDisconnectedFailureReason] = React.useState<
     string | null

packages/react/src/hooks/useSession.ts

@@ -77,6 +77,7 @@ type SessionStateCommon = {
     agentTimeoutFailureReason: string | null;
     startAgentTimeout: (agentConnectTimeoutMilliseconds?: number) => void;
     clearAgentTimeout: () => void;
+    clearAgentTimeoutFailureReason: () => void;
     updateAgentTimeoutState: (agentState: AgentState) => void;
     updateAgentTimeoutParticipantExists: (agentParticipantExists: boolean) => void;
   };
@@ -391,6 +392,7 @@ export function useSession(
     agentTimeoutFailureReason,
     startAgentTimeout,
     clearAgentTimeout,
+    clearAgentTimeoutFailureReason,
     updateAgentTimeoutState,
     updateAgentTimeoutParticipantExists,
   } = useAgentTimeoutIdStore();
@@ -404,6 +406,7 @@ export function useSession(
       agentTimeoutFailureReason,
       startAgentTimeout,
       clearAgentTimeout,
+      clearAgentTimeoutFailureReason,
       updateAgentTimeoutState,
       updateAgentTimeoutParticipantExists,
     }),
@@ -414,6 +417,7 @@ export function useSession(
       agentTimeoutFailureReason,
       startAgentTimeout,
       clearAgentTimeout,
+      clearAgentTimeoutFailureReason,
       updateAgentTimeoutState,
       updateAgentTimeoutParticipantExists,
     ],