Function useOpenTerminal

src/browser/hooks/useOpenTerminal.ts:23–64

()

 * For local workspaces in browser: Opens a web-based xterm.js terminal in a popup window.
 */
export function useOpenTerminal() {
  const { api } = useAPI();

  return useCallback(
    async (
      workspaceId: string,
      runtimeConfig?: RuntimeConfig,
      options?: TerminalSessionCreateOptions
    ) => {
      if (!api) return;

      // Check if running in browser mode
      // window.api is only available in Electron (set by preload.ts)
      // If window.api exists, we're in Electron; if not, we're in browser mode
      const isBrowser = !window.api;
      const isSSH = isSSHRuntime(runtimeConfig);
      const isDevcontainer = isDevcontainerRuntime(runtimeConfig);

      // SSH/Devcontainer workspaces always use web terminal (in browser popup or Electron window)
      // because the PTY service handles the SSH/container connection.
      //
      // Callers (e.g. WorkspaceMenuBar, the markdown Run button's mobile path) discard the
      // returned promise via `void`, so we must catch rejections here to avoid an unhandled
      // promise rejection that the user perceives as the app silently freezing/crashing.
      try {
        if (isBrowser || isSSH || isDevcontainer) {
          // Create terminal session first - window needs sessionId to connect.
          const session = await createTerminalSession(api, workspaceId, options);
          // Awaited so a rejected `terminal.openWindow` (e.g., Electron
          // terminalWindowManager failure) is observed by this try/catch instead of
          // becoming an unhandled rejection that looks like a silent freeze.
          await openTerminalPopout(api, workspaceId, session.sessionId);
        } else {
          await api.terminal.openNative({ workspaceId });
        }
      } catch (err) {
        console.error("[useOpenTerminal] Failed to open terminal:", err);
      }
    },
    [api]
  );
}