Skip to content

The IDE you know, rebuilt in Rust. IntelliJ IDEA–style keymap, tool windows and search-everywhere in a fast native app: editor, code insight, debugger, Git, terminal, database and HTTP clients for 60+ languages.

10.8 KB
Raw Blame
/**
 * The Services tree (IDEA's Services view): the nodes every service provider
 * contributes (Docker connections, run configurations…) on the left, the
 * selected node's detail on the right, "Add Service" (+, ⌘N) on the toolbar.
 */
import { useEffect, useMemo, useRef } from "react";
import clsx from "clsx";
import { useTxTemplate, tx } from "@/platform/i18n";
import { shortcutLabel } from "@/platform/keymap";
import { useProject } from "@/platform/project";
import { projectLocation, useRemote } from "@/platform/remote";
import {
  EmptyState,
  Icon,
  IconButton,
  SplitGroup,
  SplitHandle,
  SplitPanel,
  Tree,
  showContextMenu,
  T,
  type TreeRowState,
  type TreeReorder,
} from "@/ui";
import {
  useServiceProviders,
  useToolWindowShown,
  serviceProviders,
  type ServiceProviderContribution,
  type ServiceTreeItem,
  type ServiceItemAction,
} from "@/workbench/contributions";
import {
  addServiceMenu,
  clearProviderRoots,
  expandableKeys,
  indexTree,
  orderedRoots,
  setProviderRoots,
  useServicesTree,
} from "./tree";
import styles from "./Services.module.css";
import { viewFilterMenu } from "./ops";
import { selectionActions, selectionMenu, selectedServices } from "./selection";

export const SERVICES_VIEW_FOCUS = "servicesViewFocus";

/** Reports one provider's roots into the tree store (hooks can't run in a loop over providers). */
function ProviderRoots({ provider }: { provider: ServiceProviderContribution }) {
  const roots = provider.useRoots();
  useEffect(() => setProviderRoots(provider.id, roots), [provider.id, roots]);
  useEffect(() => () => clearProviderRoots(provider.id), [provider.id]);
  useEffect(() => provider.watch?.(), [provider]);
  return null;
}

function useProviders(): ServiceProviderContribution[] {
  const map = useServiceProviders((s) => s.providers);
  return useMemo(() => serviceProviders(map), [map]);
}

/** Opens the "Add Service" menu below `anchor` (or at the selected row / top left). */
export function showAddServiceMenu(anchor?: Element | null) {
  const el = anchor ?? document.querySelector("[data-services-add]");
  const r = el?.getBoundingClientRect();
  showContextMenu({ x: r?.left ?? 100, y: (r?.bottom ?? 100) + 2 }, addServiceMenu());
}

function Row({ item, state }: { item: ServiceTreeItem; state: TreeRowState }) {
  const txTemplate = useTxTemplate();
  return (
    <span className={styles.row}>
      <Icon name={item.icon} size={16} className={styles.icon} />
      <span className={clsx(styles.label, state.selected && styles.selectedLabel, item.dim && styles.dim)}>
        {item.label}
      </span>
      {item.detail && <span className={styles.detail}>{txTemplate(item.detail)}</span>}
    </span>
  );
}

export function ServicesTreeView() {
  const root = useProject((s) => s.project?.root ?? null);
  useRemote((s) => s.session);
  const location = projectLocation(root);
  const providers = useProviders();
  const rootsByProvider = useServicesTree((s) => s.roots);
  const selectedKey = useServicesTree((s) => s.selectedKey);
  const selectedKeys = useServicesTree((s) => s.selectedKeys);
  const expanded = useServicesTree((s) => s.expanded);
  const addRef = useRef<HTMLButtonElement>(null);
  const filterRef = useRef<HTMLButtonElement>(null);

  const roots = useMemo(() => orderedRoots(rootsByProvider, providers), [rootsByProvider, providers]);
  const index = useMemo(() => indexTree(rootsByProvider), [rootsByProvider]);
  const selected = selectedKey ? (index.get(selectedKey) ?? null) : null;
  const owner = selected ? providers.find((p) => p.id === selected.provider) : undefined;
  const reorder: TreeReorder<ServiceTreeItem> = {
    canMove: (source, target) => {
      const from = index.get(source.key),
        to = index.get(target.key);
      return (
        !!from &&
        !!to &&
        source.key !== target.key &&
        from.provider === to.provider &&
        from.parent?.key === to.parent?.key &&
        !!providers.find((p) => p.id === from.provider)?.reorder?.canMove(source, target)
      );
    },
    move: (source, target, position) => {
      if (reorder.canMove(source, target))
        providers.find((p) => p.id === index.get(source.key)?.provider)?.reorder?.move(source, target, position);
    },
  };
  const moveActions = (item: ServiceTreeItem): ServiceItemAction[] => {
    const located = index.get(item.key);
    const siblings = located?.parent?.children;
    if (!located || !siblings || !providers.find((p) => p.id === located.provider)?.reorder) return [];
    const at = siblings.findIndex((s) => s.key === item.key);
    return ([-1, 1] as const).map((delta) => {
      const target = siblings[at + delta];
      return {
        id: delta < 0 ? "moveUp" : "moveDown",
        title: delta < 0 ? "Move Up" : "Move Down",
        icon: delta < 0 ? "arrow-up" : "arrow-down",
        disabled: !target || !reorder.canMove(item, target),
        run: () => {
          if (target) reorder.move(item, target, delta < 0 ? "before" : "after");
        },
      };
    });
  };
  const actions = [
    ...selectionActions(selectedServices(selectedKeys, index), providers),
    ...(selected && selectedKeys.size === 1 ? moveActions(selected.item) : []),
  ];

  /** Expands / collapses many nodes at once, telling their providers what changed. */
  const setExpanded = (next: Set<string>) => {
    useServicesTree.setState({ expanded: next });
    for (const key of new Set([...expanded, ...next])) {
      const at = index.get(key);
      if (!at || expanded.has(key) === next.has(key)) continue;
      providers.find((p) => p.id === at.provider)?.expand?.(at.item, next.has(key));
    }
  };

  const Detail = owner?.detail;
  // A hidden tool window stays mounted: drop the pane so a log it follows stops.
  const shown = useToolWindowShown();
  const add = shortcutLabel("services.addService");

  return (
    <div className={styles.view}>
      {providers.map((p) => (
        <ProviderRoots key={p.id} provider={p} />
      ))}
      <div className={styles.toolbar} role="toolbar" aria-label={tx("Services actions")}>
        <IconButton
          ref={addRef}
          data-services-add
          icon="plus"
          size="small"
          iconSize={16}
          action="services.addService"
          onClick={() => showAddServiceMenu(addRef.current)}
        />
        <span className={styles.sep} />
        <IconButton
          icon="expand-all"
          size="small"
          iconSize={16}
          title="Expand All"
          disabled={!roots.length}
          onClick={() => setExpanded(new Set(expandableKeys(roots)))}
        />
        <IconButton
          icon="collapse-all"
          size="small"
          iconSize={16}
          title="Collapse All"
          disabled={!roots.length}
          onClick={() => setExpanded(new Set())}
        />
        <IconButton
          ref={filterRef}
          icon="filter"
          size="small"
          iconSize={16}
          title="View Options"
          disabled={!roots.length}
          onClick={() => {
            const r = filterRef.current?.getBoundingClientRect();
            showContextMenu({ x: r?.left ?? 140, y: (r?.bottom ?? 100) + 2 }, viewFilterMenu());
          }}
        />
        {actions.length > 0 && <span className={styles.sep} />}
        {actions.map((a) => (
          <IconButton
            key={a.id}
            icon={a.icon}
            size="small"
            iconSize={16}
            title={a.title}
            disabled={a.disabled}
            onClick={a.run}
          />
        ))}
      </div>
      {providers.map((p) => p.banner && <p.banner key={p.id} />)}
      {!roots.length ? (
        <div className={styles.empty}>
          <T>No services configured.</T>
          <button type="button" className={styles.link} onClick={(e) => showAddServiceMenu(e.currentTarget)}>
            <Icon name="plus" size={14} />
            <T>Add service</T>
            {add && <span className={styles.shortcut}>{add}</span>}
          </button>
        </div>
      ) : (
        <SplitGroup orientation="horizontal" className={styles.split} storageKey="openidea.services.detailSplit">
          <SplitPanel id="services-items" defaultSize="40%" minSize="160px">
            <div className={styles.tree}>
              <Tree<ServiceTreeItem>
                key={location}
                focusContext={SERVICES_VIEW_FOCUS}
                reorder={reorder}
                roots={roots}
                getKey={(n) => n.key}
                getLabel={(n) => n.label}
                getChildren={(n) => n.children}
                isExpandable={(n) => !!n.children?.length || !!n.expandable}
                expanded={expanded}
                onExpandedChange={(next, node, open) => {
                  useServicesTree.setState({ expanded: next });
                  providers.find((p) => p.id === index.get(node.key)?.provider)?.expand?.(node, open);
                }}
                selected={selectedKeys}
                onSelectionChange={(keys, lead) => {
                  const selectedKey = keys.size ? (lead?.key ?? null) : null;
                  const changed = selectedKey !== useServicesTree.getState().selectedKey;
                  useServicesTree.setState({ selectedKeys: keys, selectedKey });
                  if (lead && changed) providers.find((p) => p.id === index.get(lead.key)?.provider)?.select?.(lead);
                }}
                renderNode={(n, state) => <Row item={n} state={state} />}
                onActivate={(n) => {
                  const p = index.get(n.key);
                  providers.find((x) => x.id === p?.provider)?.activate?.(n);
                }}
                onContextMenu={(n, keys, e) => {
                  e.preventDefault();
                  if (!n) {
                    showContextMenu({ x: e.clientX, y: e.clientY }, addServiceMenu(providers));
                    return;
                  }
                  useServicesTree.setState({ selectedKeys: keys, selectedKey: n.key });
                  const items = selectionMenu(selectedServices(keys, index), providers);
                  const moves = keys.size === 1 ? moveActions(n) : [];
                  if (moves.length)
                    items.push(
                      { kind: "separator" },
                      ...moves.map((a) => ({ label: a.title, icon: a.icon, disabled: a.disabled, run: a.run })),
                    );

                  if (items.length) showContextMenu({ x: e.clientX, y: e.clientY }, items);
                }}
                speedSearch
                aria-label="Services"
                className={styles.tree}
              />
            </div>
          </SplitPanel>
          <SplitHandle />
          <SplitPanel id="services-detail" minSize="200px">
            {selected && Detail && shown ? (
              <Detail key={selected.item.key} item={selected.item} />
            ) : (
              <EmptyState title="Select service to view details" />
            )}
          </SplitPanel>
        </SplitGroup>
      )}
    </div>
  );
}