@uniai-fe/uds-templates 0.6.8 → 0.6.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniai-fe/uds-templates",
-  "version": "0.6.8",
+  "version": "0.6.9",
   "description": "UNIAI Design System; UI Templates Package",
   "type": "module",
   "private": false,

package/src/cctv/hooks/streamRegistry.ts

@@ -1,6 +1,11 @@
 "use client";
 
 import { startWhepStream, type WhepStreamHandle } from "@uniai-fe/util-rtc";
+import {
+  getCctvDebugKeyLabel,
+  getCctvDebugUrlLabel,
+  logCctvDebugEvent,
+} from "../utils/debug";
 
 interface CctvRtcStreamSnapshot {
   connectionState: RTCPeerConnectionState;
@@ -47,6 +52,18 @@ const notifyEntry = (entry: CctvRtcStreamEntry) => {
 };
 
 const closeEntry = (entry: CctvRtcStreamEntry) => {
+  logCctvDebugEvent({
+    event: "entry:close",
+    payload: {
+      attachedVideoCount: entry.attachedVideos.size,
+      connectionState: entry.connectionState,
+      identityKey: getCctvDebugKeyLabel(entry.identityKey),
+      isStreaming: entry.isStreaming,
+      streamKey: getCctvDebugKeyLabel(entry.streamKey),
+      streamTrackCount: entry.stream?.getTracks().length ?? 0,
+    },
+    source: "streamRegistry",
+  });
   entry.controller?.abort();
   entry.controller = null;
   entry.handle?.close();
@@ -110,6 +127,15 @@ export function createCctvRtcStreamRegistry(): CctvRtcStreamRegistry {
       entries.clear();
     },
     closeByIdentity(identityKey, exceptStreamKey) {
+      logCctvDebugEvent({
+        event: "identity:close",
+        payload: {
+          entryCount: entries.size,
+          exceptStreamKey: getCctvDebugKeyLabel(exceptStreamKey),
+          identityKey: getCctvDebugKeyLabel(identityKey),
+        },
+        source: "streamRegistry",
+      });
       entries.forEach(entry => {
         if (
           entry.identityKey === identityKey &&
@@ -124,9 +150,22 @@ export function createCctvRtcStreamRegistry(): CctvRtcStreamRegistry {
     },
     start({ endpoint, identityKey, streamKey, token, video }) {
       const existingEntry = entries.get(streamKey);
-      if (existingEntry) return;
+      if (existingEntry) {
+        logCctvDebugEvent({
+          event: "start:reuse-existing",
+          payload: {
+            connectionState: existingEntry.connectionState,
+            identityKey: getCctvDebugKeyLabel(identityKey),
+            isStreaming: existingEntry.isStreaming,
+            streamKey: getCctvDebugKeyLabel(streamKey),
+          },
+          source: "streamRegistry",
+        });
+        return;
+      }
 
       const controller = new AbortController();
+      const startedAt = Date.now();
       const entry: CctvRtcStreamEntry = {
         attachedVideos: new Set([video]),
         connectionState: "connecting",
@@ -142,6 +181,16 @@ export function createCctvRtcStreamRegistry(): CctvRtcStreamRegistry {
 
       entries.set(streamKey, entry);
       attachVideo(video, null);
+      logCctvDebugEvent({
+        event: "start:create-entry",
+        payload: {
+          attachedVideoCount: entry.attachedVideos.size,
+          endpoint: getCctvDebugUrlLabel(endpoint),
+          identityKey: getCctvDebugKeyLabel(identityKey),
+          streamKey: getCctvDebugKeyLabel(streamKey),
+        },
+        source: "streamRegistry",
+      });
 
       startWhepStream({
         endpoint,
@@ -150,10 +199,33 @@ export function createCctvRtcStreamRegistry(): CctvRtcStreamRegistry {
         signal: controller.signal,
         onConnectionStateChange: state => {
           entry.connectionState = state;
+          logCctvDebugEvent({
+            event: "connection-state:change",
+            payload: {
+              elapsedMs: Date.now() - startedAt,
+              identityKey: getCctvDebugKeyLabel(identityKey),
+              state,
+              streamKey: getCctvDebugKeyLabel(streamKey),
+            },
+            source: "streamRegistry",
+          });
           notifyEntry(entry);
         },
         onTrack: event => {
           entry.stream = event.streams[0] ?? null;
+          logCctvDebugEvent({
+            event: "track:received",
+            payload: {
+              elapsedMs: Date.now() - startedAt,
+              identityKey: getCctvDebugKeyLabel(identityKey),
+              streamId: entry.stream?.id ?? null,
+              streamKey: getCctvDebugKeyLabel(streamKey),
+              trackId: event.track.id,
+              trackKind: event.track.kind,
+              trackReadyState: event.track.readyState,
+            },
+            source: "streamRegistry",
+          });
           entry.attachedVideos.forEach(attachedVideo =>
             attachVideo(attachedVideo, entry.stream),
           );
@@ -163,6 +235,16 @@ export function createCctvRtcStreamRegistry(): CctvRtcStreamRegistry {
         .then(handle => {
           entry.handle = handle;
           entry.isStreaming = false;
+          logCctvDebugEvent({
+            event: "start:resolved",
+            level: "info",
+            payload: {
+              elapsedMs: Date.now() - startedAt,
+              identityKey: getCctvDebugKeyLabel(identityKey),
+              streamKey: getCctvDebugKeyLabel(streamKey),
+            },
+            source: "streamRegistry",
+          });
           notifyEntry(entry);
         })
         .catch(error => {
@@ -174,6 +256,17 @@ export function createCctvRtcStreamRegistry(): CctvRtcStreamRegistry {
             error instanceof Error
               ? error.message
               : "스트림 연결에 실패했습니다.";
+          logCctvDebugEvent({
+            event: "start:rejected",
+            level: "error",
+            payload: {
+              elapsedMs: Date.now() - startedAt,
+              errorMessage: entry.streamError,
+              identityKey: getCctvDebugKeyLabel(identityKey),
+              streamKey: getCctvDebugKeyLabel(streamKey),
+            },
+            source: "streamRegistry",
+          });
           entry.attachedVideos.forEach(attachedVideo =>
             attachVideo(attachedVideo, null),
           );

package/src/cctv/hooks/useRtcStream.ts

@@ -19,6 +19,11 @@ import type {
   UseCctvRtcStreamReturn,
 } from "../types";
 import { cctvRtcLiveRegistryAtom } from "../jotai/rtc";
+import {
+  getCctvDebugKeyLabel,
+  getCctvDebugStackTrace,
+  logCctvDebugEvent,
+} from "../utils/debug";
 import { getIsLive } from "../utils/video-state";
 import { useFormContext, useWatch } from "react-hook-form";
 
@@ -236,9 +241,23 @@ export function useCctvRtcStream({
     return [tokenUsername, cam.company_id, cam.cam_id, endpoint].join("|");
   }, [cam?.cam_id, cam?.company_id, endpoint, tokenUsername]);
 
+  const debugBasePayload = useMemo(
+    () => ({
+      camId: cam?.cam_id,
+      companyId: cam?.company_id,
+      streamIdentityKey: getCctvDebugKeyLabel(streamIdentityKey),
+    }),
+    [cam?.cam_id, cam?.company_id, streamIdentityKey],
+  );
+
   useEffect(() => {
+    logCctvDebugEvent({
+      event: "identity:reset-has-connected",
+      payload: debugBasePayload,
+      source: "useRtcStream",
+    });
     setHasConnected(false);
-  }, [streamIdentityKey]);
+  }, [debugBasePayload, streamIdentityKey]);
 
   const reconnectReason = useMemo(
     () =>
@@ -264,20 +283,49 @@ export function useCctvRtcStream({
     }
 
     setPostConnectedReconnectReady(false);
+    const reconnectDelayMs = getPostConnectedReconnectDelayMs(
+      `${streamIdentityKey}|${reconnectReason}`,
+    );
 
-    const timeout = setTimeout(
-      () => {
-        setPostConnectedReconnectReady(true);
+    logCctvDebugEvent({
+      event: "reconnect-gate:timer-start",
+      payload: {
+        ...debugBasePayload,
+        isStreaming,
+        isTokenLoading,
+        reconnectDelayMs,
+        reconnectReason,
       },
-      getPostConnectedReconnectDelayMs(
-        `${streamIdentityKey}|${reconnectReason}`,
-      ),
-    );
+      source: "useRtcStream",
+    });
+
+    const timeout = setTimeout(() => {
+      setPostConnectedReconnectReady(true);
+      logCctvDebugEvent({
+        event: "reconnect-gate:ready",
+        payload: {
+          ...debugBasePayload,
+          reconnectDelayMs,
+          reconnectReason,
+        },
+        source: "useRtcStream",
+      });
+    }, reconnectDelayMs);
 
     return () => {
       clearTimeout(timeout);
+      logCctvDebugEvent({
+        event: "reconnect-gate:timer-cancel",
+        payload: {
+          ...debugBasePayload,
+          reconnectDelayMs,
+          reconnectReason,
+        },
+        source: "useRtcStream",
+      });
     };
   }, [
+    debugBasePayload,
     hasConnected,
     isStreaming,
     isTokenLoading,
@@ -343,12 +391,23 @@ export function useCctvRtcStream({
     }
 
     staleTokenRefreshKeyRef.current = streamKeyCandidate;
+    logCctvDebugEvent({
+      event: "token:stale-refetch",
+      payload: {
+        ...debugBasePayload,
+        dataUpdatedAt: tokenQuery.dataUpdatedAt,
+        streamKey: getCctvDebugKeyLabel(streamKeyCandidate),
+      },
+      source: "useRtcStream",
+    });
     void refetchRtcToken();
   }, [
     canUseTokenForStream,
+    debugBasePayload,
     refetchRtcToken,
     streamKeyCandidate,
     tokenQuery.data?.token,
+    tokenQuery.dataUpdatedAt,
     tokenQuery.isError,
     tokenQuery.isFetching,
   ]);
@@ -359,6 +418,15 @@ export function useCctvRtcStream({
 
     // 토큰/카메라 에러로 전환되면 직전 MediaStream이 화면에 남지 않도록 비운다.
     if (tokenQuery.isError || !cam?.cam_online) {
+      logCctvDebugEvent({
+        event: "stream-effect:cleanup-token-or-offline",
+        payload: {
+          ...debugBasePayload,
+          camOnline: cam?.cam_online,
+          isTokenError: tokenQuery.isError,
+        },
+        source: "useRtcStream",
+      });
       if (streamIdentityKey) {
         streamRegistry.closeByIdentity(streamIdentityKey);
       }
@@ -377,12 +445,30 @@ export function useCctvRtcStream({
       activeStreamIdentityKeyRef.current === streamIdentityKey &&
       activeStreamKeyRef.current !== streamKey
     ) {
+      logCctvDebugEvent({
+        event: "stream-effect:close-previous-identity",
+        payload: {
+          ...debugBasePayload,
+          activeStreamKey: getCctvDebugKeyLabel(activeStreamKeyRef.current),
+          nextStreamKey: getCctvDebugKeyLabel(streamKey),
+        },
+        source: "useRtcStream",
+      });
       streamRegistry.closeByIdentity(streamIdentityKey, streamKey);
     }
 
     activeStreamKeyRef.current = streamKey;
     activeStreamIdentityKeyRef.current = streamIdentityKey;
 
+    logCctvDebugEvent({
+      event: "stream-effect:start",
+      payload: {
+        ...debugBasePayload,
+        streamKey: getCctvDebugKeyLabel(streamKey),
+      },
+      source: "useRtcStream",
+    });
+
     streamRegistry.start({
       streamKey,
       identityKey: streamIdentityKey,
@@ -396,7 +482,17 @@ export function useCctvRtcStream({
       setConnectionState(snapshot.connectionState);
       setStreamError(snapshot.streamError);
       setStreaming(snapshot.isStreaming);
-      if (snapshot.connectionState === "connected") setHasConnected(true);
+      if (snapshot.connectionState === "connected") {
+        logCctvDebugEvent({
+          event: "stream-effect:has-connected",
+          payload: {
+            ...debugBasePayload,
+            streamKey: getCctvDebugKeyLabel(streamKey),
+          },
+          source: "useRtcStream",
+        });
+        setHasConnected(true);
+      }
       if (snapshot.stream && currentVideo.srcObject !== snapshot.stream) {
         currentVideo.srcObject = snapshot.stream;
       }
@@ -413,10 +509,19 @@ export function useCctvRtcStream({
 
     // effect cleanup: current video attach만 해제하고 registry stream은 유지한다.
     return () => {
+      logCctvDebugEvent({
+        event: "stream-effect:detach-video",
+        payload: {
+          ...debugBasePayload,
+          streamKey: getCctvDebugKeyLabel(streamKey),
+        },
+        source: "useRtcStream",
+      });
       unsubscribe();
       detachVideo();
     };
   }, [
+    debugBasePayload,
     endpoint,
     streamIdentityKey,
     streamKey,
@@ -426,10 +531,56 @@ export function useCctvRtcStream({
     cam?.cam_online,
   ]);
 
+  const debugReconnectStateRef = useRef({
+    connectionState,
+    debugBasePayload,
+    isPostConnectedReconnectReady,
+    reconnectReason,
+    streamError,
+  });
+  debugReconnectStateRef.current = {
+    connectionState,
+    debugBasePayload,
+    isPostConnectedReconnectReady,
+    reconnectReason,
+    streamError,
+  };
+
   const reconnectStream = useCallback<CctvRtcReconnectTrigger>(
     async options => {
+      const debugState = debugReconnectStateRef.current;
+      logCctvDebugEvent({
+        event: "reconnect-stream:start",
+        payload: {
+          ...debugState.debugBasePayload,
+          connectionState: debugState.connectionState,
+          callerStack: getCctvDebugStackTrace(),
+          isPostConnectedReconnectReady:
+            debugState.isPostConnectedReconnectReady,
+          reconnectReason: debugState.reconnectReason,
+          streamError: debugState.streamError,
+        },
+        source: "useRtcStream",
+      });
       const result = await refetchRtcToken(options);
+      const resultDebugState = debugReconnectStateRef.current;
+      logCctvDebugEvent({
+        event: "reconnect-stream:token-result",
+        level: result.isSuccess ? "info" : "warn",
+        payload: {
+          ...resultDebugState.debugBasePayload,
+          isError: result.isError,
+          isSuccess: result.isSuccess,
+          status: result.status,
+        },
+        source: "useRtcStream",
+      });
       if (result.isSuccess && streamIdentityKey) {
+        logCctvDebugEvent({
+          event: "reconnect-stream:close-identity",
+          payload: resultDebugState.debugBasePayload,
+          source: "useRtcStream",
+        });
         streamRegistry.closeByIdentity(streamIdentityKey);
       }
       return result;
@@ -469,6 +620,16 @@ export function useCctvRtcStream({
         return;
 
       lastAutoReconnectAtRef.current = now;
+      logCctvDebugEvent({
+        event: "focus:auto-reconnect",
+        payload: {
+          ...debugBasePayload,
+          canReconnect,
+          connectionState,
+          reconnectReason,
+        },
+        source: "useRtcStream",
+      });
       void reconnectStream();
     };
 
@@ -479,7 +640,13 @@ export function useCctvRtcStream({
       window.removeEventListener("focus", reconnectOnFocus);
       document.removeEventListener("visibilitychange", reconnectOnFocus);
     };
-  }, [canReconnect, reconnectStream]);
+  }, [
+    canReconnect,
+    connectionState,
+    debugBasePayload,
+    reconnectReason,
+    reconnectStream,
+  ]);
 
   const liveState = useMemo(
     () =>
@@ -503,6 +670,40 @@ export function useCctvRtcStream({
     ],
   );
 
+  useEffect(() => {
+    logCctvDebugEvent({
+      event: "hook-state:update",
+      payload: {
+        ...debugBasePayload,
+        canReconnect,
+        connectionState,
+        displayConnectionState,
+        hasConnected,
+        isPostConnectedReconnectReady,
+        isStreaming,
+        isTokenError,
+        isTokenLoading,
+        liveState,
+        reconnectReason,
+        streamError,
+      },
+      source: "useRtcStream",
+    });
+  }, [
+    canReconnect,
+    connectionState,
+    debugBasePayload,
+    displayConnectionState,
+    hasConnected,
+    isPostConnectedReconnectReady,
+    isStreaming,
+    isTokenError,
+    isTokenLoading,
+    liveState,
+    reconnectReason,
+    streamError,
+  ]);
+
   useEffect(() => {
     const camId = cam?.cam_id;
     if (!camId) return;

package/src/cctv/utils/debug.ts

@@ -0,0 +1,179 @@
+"use client";
+
+export type CctvDebugEventLevel = "debug" | "info" | "warn" | "error";
+
+export interface CctvDebugEvent {
+  at: string;
+  event: string;
+  level: CctvDebugEventLevel;
+  payload?: Record<string, unknown>;
+  seq: number;
+  source: string;
+}
+
+export interface CctvDebugBuffer {
+  clear: () => void;
+  dump: () => CctvDebugEvent[];
+  enabled: true;
+  events: CctvDebugEvent[];
+  limit: number;
+  sequence: number;
+}
+
+declare global {
+  interface Window {
+    __UDS_CCTV_DEBUG__?: CctvDebugBuffer;
+  }
+}
+
+const DEBUG_QUERY_KEYS = ["udsCctvDebug", "cctvDebug"] as const;
+const DEBUG_STORAGE_KEYS = ["uds:cctv:debug", "UDS_CCTV_DEBUG"] as const;
+const DEBUG_ENABLED_VALUES = new Set(["1", "true", "yes", "on", "debug"]);
+const DEBUG_BUFFER_LIMIT = 1000;
+
+const isBrowser = (): boolean =>
+  typeof window !== "undefined" && typeof document !== "undefined";
+
+const isDebugValueEnabled = (value: string | null): boolean =>
+  value === "" ||
+  (typeof value === "string" && DEBUG_ENABLED_VALUES.has(value));
+
+/**
+ * identity/stream key를 원문 대신 추적 가능한 hash label로 바꾼다.
+ */
+export const getCctvDebugKeyLabel = (
+  value: string | null | undefined,
+): string | null => {
+  if (!value) return null;
+
+  let hash = 0;
+  for (let i = 0; i < value.length; i += 1) {
+    hash = (hash * 31 + value.charCodeAt(i)) >>> 0;
+  }
+
+  return `hash:${hash.toString(36)}|len:${value.length}`;
+};
+
+/**
+ * endpoint는 query string을 제거한 origin/path만 기록한다.
+ */
+export const getCctvDebugUrlLabel = (
+  value: string | null | undefined,
+): string | null => {
+  if (!value) return null;
+
+  try {
+    const url = new URL(value);
+    return `${url.origin}${url.pathname}`;
+  } catch {
+    return value.split("?")[0] ?? null;
+  }
+};
+
+/**
+ * CCTV debug logging 활성화 여부를 확인한다.
+ * @desc
+ * production default는 off다. `?udsCctvDebug=1` 또는
+ * `localStorage.setItem("uds:cctv:debug", "1")`로 runtime에서 켤 수 있다.
+ */
+export const isCctvDebugEnabled = (): boolean => {
+  if (!isBrowser()) return false;
+
+  const query = new URLSearchParams(window.location.search);
+  for (const key of DEBUG_QUERY_KEYS) {
+    if (query.has(key) && isDebugValueEnabled(query.get(key))) return true;
+  }
+
+  for (const key of DEBUG_STORAGE_KEYS) {
+    try {
+      if (isDebugValueEnabled(window.localStorage.getItem(key))) return true;
+    } catch {
+      return false;
+    }
+  }
+
+  return false;
+};
+
+/**
+ * reconnect 호출 주체를 좁히기 위한 stack trace 일부를 만든다.
+ */
+export const getCctvDebugStackTrace = (): string[] | null => {
+  if (!isCctvDebugEnabled()) return null;
+
+  const stack = new Error().stack;
+  if (!stack) return null;
+
+  return stack
+    .split("\n")
+    .slice(2, 8)
+    .map(line => line.trim());
+};
+
+const getCctvDebugBuffer = (): CctvDebugBuffer | null => {
+  if (!isCctvDebugEnabled()) return null;
+
+  const existingBuffer = window.__UDS_CCTV_DEBUG__;
+  if (existingBuffer) return existingBuffer;
+
+  const buffer: CctvDebugBuffer = {
+    enabled: true,
+    events: [],
+    limit: DEBUG_BUFFER_LIMIT,
+    sequence: 0,
+    clear: () => {
+      buffer.events.splice(0, buffer.events.length);
+      buffer.sequence = 0;
+    },
+    dump: () => [...buffer.events],
+  };
+
+  window.__UDS_CCTV_DEBUG__ = buffer;
+  return buffer;
+};
+
+/**
+ * CCTV runtime 진단 이벤트를 ring buffer와 console에 남긴다.
+ * @desc
+ * 토큰 값은 payload에 넣지 않는다. 이 logger는 debug flag가 켜진 경우에만 동작한다.
+ */
+export const logCctvDebugEvent = ({
+  event,
+  level = "debug",
+  payload,
+  source,
+}: {
+  event: string;
+  level?: CctvDebugEventLevel;
+  payload?: Record<string, unknown>;
+  source: string;
+}): void => {
+  const buffer = getCctvDebugBuffer();
+  if (!buffer) return;
+
+  const entry: CctvDebugEvent = {
+    at: new Date().toISOString(),
+    event,
+    level,
+    payload,
+    seq: buffer.sequence + 1,
+    source,
+  };
+
+  buffer.sequence = entry.seq;
+  buffer.events.push(entry);
+  if (buffer.events.length > buffer.limit) {
+    buffer.events.splice(0, buffer.events.length - buffer.limit);
+  }
+
+  const logger =
+    level === "error"
+      ? console.error
+      : level === "warn"
+        ? console.warn
+        : level === "info"
+          ? console.info
+          : console.debug;
+
+  logger.call(console, "[UDS:CCTV]", entry);
+};