openidea/src/features/remote-dev/index.ts

/**
 * Remote development: a window whose project lives on an SSH host or in a WSL distribution. The backend
 * (`openidea-server`) runs there and this window routes its commands to it
 * (platform/remote.ts).
 */
import { registerActions } from "@/platform/actions";
import { disconnectRemote, useRemote } from "@/platform/remote";
import { lazyComponent } from "@/ui";
import { maybeEditorService, registerOverlay, registerStatusItem, registerToolWindow } from "@/workbench/contributions";
import { confirmLeaveProject } from "@/platform/project";
import { ConnectHost } from "./ConnectDialog";
import { reloadEnvironment } from "./environment";
import { RemoteStatus } from "./RemoteStatus";
import { closeConnectDialog, openConnectDialog } from "./model";
import { restorePorts, usePorts } from "./ports";

/** SSH tunnels are available while this window is connected to an SSH host. */
function trackPortsWindow(): () => void {
  let off: (() => void) | null = null;
  const sync = (connected: boolean) => {
    if (connected && !off) {
      void restorePorts();
      off = registerToolWindow({
        id: "remote.ports",
        title: "Ports",
        icon: "web",
        anchor: "bottom",
        order: 40,
        stripe: "onUse",
        component: lazyComponent(() => import("./PortsView").then((m) => m.PortsView)),
      });
    } else if (!connected && off) {
      off();
      off = null;
      usePorts.setState({ ports: [] });
    }
  };
  sync(useRemote.getState().session?.target.kind === "ssh");
  const unsubscribe = useRemote.subscribe((s) => sync(s.session?.target.kind === "ssh"));
  return () => {
    unsubscribe();
    off?.();
  };
}

export function activate(): () => void {
  const disposers = [
    trackPortsWindow(),
    registerOverlay({ id: "remote.connect", component: ConnectHost }),
    registerStatusItem({
      id: "remote.location",
      title: "Remote Host",
      align: "left",
      priority: 100,
      component: RemoteStatus,
    }),
    registerActions([
      {
        id: "remote.connect",
        title: "Remote Development…",
        description: "Opens a project folder on an SSH host; the IDE backend runs on that host.",
        category: "File",
        icon: "folder",
        keywords: ["ssh", "remote", "server", "gateway", "connect", "host"],
        run: () => openConnectDialog(),
      },
      {
        id: "remote.disconnect",
        title: "Disconnect from Remote Host",
        category: "File",
        keywords: ["ssh", "remote", "close"],
        when: "projectOpen",
        run: async () => {
          if (!(await confirmLeaveProject())) return;
          try {
            await disconnectRemote();
          } catch (e) {
            maybeEditorService()?.cancelClose?.();
            throw e;
          }
        },
      },
      {
        id: "remote.reloadEnvironment",
        title: "Reload Environment",
        description:
          "Reads the login shell's environment (and devcontainer.json remoteEnv on a remote host) again for new terminals and processes.",
        category: "File",
        keywords: ["env", "environment", "variables", "path", "shell", "remoteEnv", "devcontainer", "reload"],
        when: "projectOpen",
        run: () => reloadEnvironment(),
      },
    ]),
  ];
  return () => {
    disposers.reverse().forEach((d) => d());
    closeConnectDialog();
  };
}