All files / kernel-ui/src/context PanelContext.tsx

91.3% Statements 42/46
88.88% Branches 8/9
88.88% Functions 8/9
91.11% Lines 41/45

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142                                                                          3x         3x 17x 17x             17x 17x 17x 17x       17x   14x         17x 1x     17x 6x 6x 13x 13x     13x 13x 13x 13x 12x 1x   11x   2x 2x     6x 6x     17x   13x 13x 13x 6x 6x                         17x   17x                                       3x 31x 31x 4x   27x    
import { stringify } from '@metamask/kernel-utils';
import type { KernelStatus } from '@metamask/ocap-kernel';
import { isJsonRpcFailure } from '@metamask/utils';
import {
  createContext,
  useCallback,
  useContext,
  useState,
  useRef,
} from 'react';
import type { ReactNode } from 'react';
 
import { useStatusPolling } from '../hooks/useStatusPolling.ts';
import { logger } from '../services/logger.ts';
import type { CallKernelMethod } from '../services/stream.ts';
import type { ObjectRegistry } from '../types.ts';
 
export type OutputType = 'sent' | 'received' | 'error' | 'success';
 
type PanelLog = {
  message: string;
  type: OutputType;
};
 
export type PanelContextType = {
  callKernelMethod: CallKernelMethod;
  status: KernelStatus | undefined;
  logMessage: (message: string, type?: OutputType) => void;
  messageContent: string;
  setMessageContent: (content: string) => void;
  panelLogs: PanelLog[];
  clearLogs: () => void;
  isLoading: boolean;
  objectRegistry: ObjectRegistry | null;
  setObjectRegistry: (objectRegistry: ObjectRegistry | null) => void;
};
 
const PanelContext = createContext<PanelContextType | undefined>(undefined);
 
export const PanelProvider: React.FC<{
  children: ReactNode;
  callKernelMethod: CallKernelMethod;
}> = ({ children, callKernelMethod }) => {
  const isRequestInProgress = useRef(false);
  const pendingRequests = useRef<
    {
      payload: Parameters<CallKernelMethod>[0];
      resolve: (value: Awaited<ReturnType<CallKernelMethod>>) => void;
      reject: (reason: unknown) => void;
    }[]
  >([]);
  const [isLoading, setIsLoading] = useState(false);
  const [panelLogs, setPanelLogs] = useState<PanelLog[]>([]);
  const [messageContent, setMessageContent] = useState<string>('');
  const [objectRegistry, setObjectRegistry] = useState<ObjectRegistry | null>(
    null,
  );
 
  const logMessage = useCallback(
    (message: string, type: OutputType = 'received'): void => {
      setPanelLogs((prevLogs) => [...prevLogs, { message, type }]);
    },
    [],
  );
 
  const clearLogs = useCallback(() => {
    setPanelLogs([]);
  }, []);
 
  const processRequests = useCallback(async (): Promise<void> => {
    setIsLoading(true);
    while (pendingRequests.current.length > 0) {
      const request = pendingRequests.current.shift();
      Iif (!request) {
        break;
      }
      const { payload, resolve, reject } = request;
      try {
        logMessage(stringify(payload), 'sent');
        const response = await callKernelMethod(payload);
        if (isJsonRpcFailure(response)) {
          throw new Error(stringify((response as { error: unknown }).error, 0));
        }
        resolve(response);
      } catch (error) {
        logger.error(String(error), 'error');
        reject(error);
      }
    }
    isRequestInProgress.current = false;
    setIsLoading(false);
  }, [callKernelMethod, logMessage]);
 
  const sendMessageWrapper: CallKernelMethod = useCallback(
    async (payload) => {
      return new Promise((resolve, reject) => {
        pendingRequests.current.push({ payload, resolve, reject });
        if (!isRequestInProgress.current) {
          isRequestInProgress.current = true;
          processRequests().catch((error) => {
            // This should never happen as processRequests handles errors internally
            // but if it does, log it and reset the state
            logger.error('Unexpected error in processRequests', error);
            isRequestInProgress.current = false;
            setIsLoading(false);
          });
        }
      });
    },
    [processRequests],
  );
 
  const status = useStatusPolling(callKernelMethod, isRequestInProgress);
 
  return (
    <PanelContext.Provider
      value={{
        callKernelMethod: sendMessageWrapper,
        status,
        logMessage,
        messageContent,
        setMessageContent,
        panelLogs,
        clearLogs,
        isLoading,
        objectRegistry,
        setObjectRegistry,
      }}
    >
      {children}
    </PanelContext.Provider>
  );
};
 
export const usePanelContext = (): PanelContextType => {
  const context = useContext(PanelContext);
  if (!context) {
    throw new Error('usePanelContext must be used within a PanelProvider');
  }
  return context;
};