Skip to content

πŸ™Œ OpenHands: AI-Driven Development

5.8 KB
Raw Blame
import { useQuery } from "@tanstack/react-query";
import { useRef } from "react";

import type { CommandResult } from "#/api/runtime-service/agent-server-runtime-service";
import { useActiveBackend } from "#/contexts/active-backend-context";
import { useActiveConversation } from "#/hooks/query/use-active-conversation";
import { useRuntimeIsReady } from "#/hooks/use-runtime-is-ready";
import { useBashCommandRunner } from "#/hooks/use-bash-command-runner";
import { Provider } from "#/types/settings";
import { parseGitRemoteUrl } from "#/utils/parse-git-remote-url";

export interface LocalGitInfo {
  repository: string | null;
  branch: string | null;
  provider: Provider | null;
  remoteUrl: string | null;
}

const EMPTY_LOCAL_GIT_INFO: LocalGitInfo = {
  repository: null,
  branch: null,
  provider: null,
  remoteUrl: null,
};

type RunCommand = (
  command: string,
  cwd: string,
  timeout: number,
) => Promise<CommandResult>;

// Single shell script that replaces the former probeGitInfoAtDir +
// probeNestedRepoInDir pair.  It runs as one bash WebSocket round-trip:
//   1. Read the origin remote URL and current branch at the workspace root.
//   2. If neither is set, search for exactly one nested git repo up to 4
//      levels deep and repeat the probe there.
// Output: two lines β€” <remote-url>\n<branch> β€” either may be empty.
const GIT_INFO_COMMAND = [
  "r=$(git remote get-url origin 2>/dev/null)",
  "b=$(git rev-parse --abbrev-ref HEAD 2>/dev/null)",
  'if [ -z "$r$b" ]; then',
  "n=$(find . -mindepth 2 -maxdepth 4 -name .git 2>/dev/null | cut -c3- | sed 's|/.git$||' | sort -u)",
  "c=$(printf '%s\\n' \"$n\" | grep -c '[^[:space:]]')",
  'if [ "$c" = "1" ] && [ -n "$n" ]; then',
  'r=$(git -C "$n" remote get-url origin 2>/dev/null)',
  'b=$(git -C "$n" rev-parse --abbrev-ref HEAD 2>/dev/null)',
  "fi",
  "fi",
  'printf \'%s\\n%s\' "$r" "$b"',
].join("\n");

async function probeGitInfo(
  run: RunCommand,
  directory: string,
): Promise<LocalGitInfo> {
  const result = await run(GIT_INFO_COMMAND, directory, 10);
  if (result.exit_code !== 0) return EMPTY_LOCAL_GIT_INFO;

  const nl = result.stdout.indexOf("\n");
  const remoteUrl = (
    nl >= 0 ? result.stdout.slice(0, nl) : result.stdout
  ).trim();
  const rawBranch = (nl >= 0 ? result.stdout.slice(nl + 1) : "").trim();
  const branch = rawBranch && rawBranch !== "HEAD" ? rawBranch : null;

  if (!remoteUrl && !branch) return EMPTY_LOCAL_GIT_INFO;

  const parsedRemote = parseGitRemoteUrl(remoteUrl);
  return {
    repository: parsedRemote?.repository ?? null,
    provider: parsedRemote?.provider ?? null,
    remoteUrl: remoteUrl || null,
    branch,
  };
}

/**
 * Probe git metadata for a **local** backend's workspace checkout by
 * shelling out via the agent server using a single consolidated bash
 * script (see `GIT_INFO_COMMAND`).
 *
 * Local-only by design. On cloud backends the conversation metadata
 * (`selected_repository`, `git_provider`, `selected_branch`) is the
 * source of truth, and probing via `/api/bash/execute_bash_command`
 * would (a) leak the user's local `getAgentServerWorkingDir()` path to
 * the cloud runtime when `workspace.working_dir` is missing, and
 * (b) hit a bash endpoint we don't want the frontend driving on cloud.
 *
 * On local, we keep the probe enabled until the active conversation
 * has a complete repo tuple so the control bar can recover from
 * partial metadata hydration after connect/clone flows.
 *
 * Returns `null` fields when the working dir is not a git checkout β€”
 * callers should treat that the same as "no repo detected".
 */
export const useLocalGitInfo = () => {
  const { data: conversation } = useActiveConversation();
  const runtimeIsReady = useRuntimeIsReady();
  const { backend } = useActiveBackend();
  const isLocalBackend = backend.kind === "local";

  const conversationId = conversation?.id;
  const conversationUrl = conversation?.conversation_url;
  const sessionApiKey = conversation?.session_api_key;
  const workingDir = conversation?.workspace?.working_dir?.trim();
  const hasConversationRepo = !!conversation?.selected_repository;
  const hasConversationProvider = !!conversation?.git_provider;
  const hasConversationBranch = !!conversation?.selected_branch;

  const queryEnabled =
    isLocalBackend &&
    runtimeIsReady &&
    !!conversationId &&
    !!workingDir &&
    (!hasConversationRepo ||
      !hasConversationProvider ||
      !hasConversationBranch);

  // The SDK owns command transport and scopes each probe to its conversation.
  const runCommand = useBashCommandRunner(
    conversationUrl,
    sessionApiKey,
    queryEnabled,
    conversationId,
  );

  // Keep a ref so queryFn can call the latest runner without capturing it
  // as a queryKey dependency (runCommand is stable but the linter can't
  // infer that).
  const runCommandRef = useRef(runCommand);
  runCommandRef.current = runCommand;

  // runCommandRef is a ref (always stable); the linter cannot infer this so
  // we disable the exhaustive-deps check here.

  return useQuery<LocalGitInfo>({
    queryKey: [
      "local-git-info",
      conversationId,
      conversationUrl,
      sessionApiKey,
      workingDir,
    ],
    queryFn: async () => {
      const run: RunCommand = (command, cwd, timeout) =>
        runCommandRef.current(command, cwd, timeout);
      // workingDir is guaranteed non-empty by the queryEnabled guard above.
      return probeGitInfo(run, workingDir!);
    },
    enabled: queryEnabled,
    retry: false,
    // Re-probe the workspace every 10s so the UI reflects branch/repo
    // changes (e.g. `git checkout`, adding a remote) without requiring a
    // manual refresh when there is no `selected_repository` recorded on
    // the conversation.
    staleTime: 10_000,
    refetchInterval: 10_000,
    gcTime: 1000 * 60 * 5,
    meta: { disableToast: true },
  });
};