Files

943 lines
36 KiB
TypeScript
Raw Permalink Normal View History

import { useCallback, useEffect, useMemo, useRef } from "react";
import {
Host,
Identity,
SftpFilenameEncoding,
SSHKey,
} from "../../domain/models";
import {
createEmptyPane,
SftpStateOptions,
} from "./sftp/types";
import {
formatDate,
formatFileSize,
getFileExtension,
getFileName,
getParentPath,
joinPath,
} from "./sftp/utils";
import { useSftpTabsState } from "./sftp/useSftpTabsState";
import { useSftpBrowseConnectionLifecycle } from "./sftp/useSftpBrowseConnectionLifecycle";
import { isSessionError } from "./sftp/errors";
import { useSftpExternalOperations } from "./sftp/useSftpExternalOperations";
import { useSftpTransfers } from "./sftp/useSftpTransfers";
import { useSftpPaneActions } from "./sftp/useSftpPaneActions";
import {
closeSftpTabLifecycle,
releaseSftpConnectionMetadata,
useSftpConnections,
} from "./sftp/useSftpConnections";
import { buildSftpHostCredentials } from "./sftp/useSftpHostCredentials";
import { useSftpFileWatch } from "./sftp/useSftpFileWatch";
import { useSftpSessionCleanup } from "./sftp/useSftpSessionCleanup";
import { useSftpSessionErrors } from "./sftp/useSftpSessionErrors";
import { ensureRemoteSftpSession, probeSftpSession } from "./sftp/ensureRemoteSftpSession";
import { openTransferSftpSession } from "./sftp/dedicatedTransferResume";
import {
createTransferPoolKeyCache,
getSharedTransferConnectionPool,
} from "./sftp/transferConnectionPool";
import {
shouldParkBrowseSessions,
shouldRestoreBrowseSessions,
takeBrowseSessionsForClose,
} from "./sftp/browseSessionLifecycle";
import { sftpTransferCenterStore } from "./sftpTransferCenterStore";
import { netcattyBridge } from "../../infrastructure/services/netcattyBridge";
import { logger } from "../../lib/logger";
import type { DirectoryListingCache } from "./sftp/directoryListingCache";
// types + utils now live in ./sftp/*
export async function releaseSftpTabConnection(params: {
connectionId: string;
isLocal: boolean;
sftpSessions: Map<string, string>;
connectionCacheKeys: Map<string, string>;
clearCacheForConnection: (connectionId: string) => void;
closeSftp: (sftpId: string) => Promise<unknown>;
onRemoteSessionClosed?: (sftpId: string) => void;
}): Promise<void> {
await releaseSftpConnectionMetadata(params);
}
export const useSftpState = (
hosts: Host[],
keys: SSHKey[],
identities: Identity[],
options?: SftpStateOptions
) => {
const transferOwnerIdRef = useRef(options?.transferOwnerId ?? crypto.randomUUID());
const forgetExternalEditTempsForSftpRef = useRef<(sftpId: string) => void>(() => {});
const createPane = useCallback(
(id?: string, showHiddenFiles = options?.defaultShowHiddenFiles ?? false) =>
createEmptyPane(id, showHiddenFiles),
[options?.defaultShowHiddenFiles],
);
const tabsState = useSftpTabsState({
defaultShowHiddenFiles: options?.defaultShowHiddenFiles,
});
const {
leftTabs,
rightTabs,
leftTabsRef,
rightTabsRef,
setLeftTabs,
setRightTabs,
leftPane,
rightPane,
getActivePane,
updateTab,
updateActiveTab,
clearSelectionsExcept,
setTabShowHiddenFiles,
addTab,
closeTab,
selectTab,
reorderTabs,
moveTabToOtherSide,
getTabsInfo,
getActiveTabId,
} = tabsState;
// SFTP session refs
const sftpSessionsRef = useRef<Map<string, string>>(new Map()); // connectionId -> sftpId
// Getter for sftpId from connectionId (for stream transfers)
const getSftpIdForConnection = useCallback((connectionId: string) => {
return sftpSessionsRef.current.get(connectionId);
}, []);
// Directory listing cache (connectionId + path)
const DIR_CACHE_TTL_MS = 10_000;
const dirCacheRef = useRef<DirectoryListingCache>(new Map());
// Navigation sequence per pane, used to ignore stale async results
const navSeqRef = useRef<{ left: number; right: number }>({
left: 0,
right: 0,
});
const makeCacheKey = useCallback(
(connectionId: string, path: string, encoding?: SftpFilenameEncoding) =>
`${connectionId}::${encoding || "auto"}::${path}`,
[],
);
const clearCacheForConnection = useCallback((connectionId: string) => {
for (const key of dirCacheRef.current.keys()) {
if (key.startsWith(`${connectionId}::`)) {
dirCacheRef.current.delete(key);
}
}
}, []);
const clearDirCacheEntry = useCallback((connectionId: string, path: string) => {
// Remove all encoding variants of this path from the cache
for (const key of dirCacheRef.current.keys()) {
if (key.startsWith(`${connectionId}::`) && key.endsWith(`::${path}`)) {
dirCacheRef.current.delete(key);
}
}
}, []);
const getPaneByConnectionId = useCallback((connectionId: string) => {
for (const tab of leftTabsRef.current.tabs) {
if (tab.connection?.id === connectionId) return tab;
}
for (const tab of rightTabsRef.current.tabs) {
if (tab.connection?.id === connectionId) return tab;
}
return null;
}, [leftTabsRef, rightTabsRef]);
const getPaneByTabId = useCallback((tabId: string) => {
for (const tab of leftTabsRef.current.tabs) {
if (tab.id === tabId) return tab;
}
for (const tab of rightTabsRef.current.tabs) {
if (tab.id === tabId) return tab;
}
return null;
}, [leftTabsRef, rightTabsRef]);
const getSideByTabId = useCallback((tabId: string): "left" | "right" | null => {
if (leftTabsRef.current.tabs.some((tab) => tab.id === tabId)) return "left";
if (rightTabsRef.current.tabs.some((tab) => tab.id === tabId)) return "right";
return null;
}, [leftTabsRef, rightTabsRef]);
const getTabByConnectionId = useCallback((connectionId: string) => {
for (const tab of leftTabsRef.current.tabs) {
if (tab.connection?.id === connectionId) {
return { side: "left" as const, tabId: tab.id, pane: tab };
}
}
for (const tab of rightTabsRef.current.tabs) {
if (tab.connection?.id === connectionId) {
return { side: "right" as const, tabId: tab.id, pane: tab };
}
}
return null;
}, [leftTabsRef, rightTabsRef]);
// Map connectionId → cache key, set at connect time so each tab's
// navigateTo can use the correct cache key even when multiple tabs
// share the same hostId with different session-time overrides.
const connectionCacheKeyMapRef = useRef<Map<string, string>>(new Map());
// Full Host used when each tab connected (includes session-time overrides).
// Tab ids are stable across reconnect; connection ids are not.
const connectedHostByTabIdRef = useRef<Map<string, Host | "local">>(new Map());
const connectInFlightRef = useRef<Map<string, Promise<void>>>(new Map());
const connectRequestByTabIdRef = useRef<Map<string, symbol>>(new Map());
// Full endpoint key captured at connect time (hostId:hostname:port:…).
const getConnectionCacheKey = useCallback((connectionId: string) => {
return connectionCacheKeyMapRef.current.get(connectionId) ?? null;
}, []);
// Store last connected host info for reconnection
const lastConnectedHostRef = useRef<{
left: Host | "local" | null;
right: Host | "local" | null;
}>({
left: null,
right: null,
});
// Keep reconnect metadata in sync when auto-connect reuses an existing tab
// without calling connect() (selectTab alone does not update this ref).
// Callers that selectTab then setLastConnectedHost must pass tabId explicitly:
// selectTab only schedules a state update, so activeTabId on the ref is still
// the previous tab until the next render.
const setLastConnectedHost = useCallback((
side: "left" | "right",
host: Host | "local" | null,
tabId?: string | null,
) => {
lastConnectedHostRef.current[side] = host;
const resolvedTabId =
tabId
?? (side === "left" ? leftTabsRef : rightTabsRef).current.activeTabId;
if (!resolvedTabId) return;
if (host) {
connectedHostByTabIdRef.current.set(resolvedTabId, host);
} else {
connectedHostByTabIdRef.current.delete(resolvedTabId);
}
}, [leftTabsRef, rightTabsRef]);
const closeTabAndClearHost = useCallback(async (side: "left" | "right", tabId: string) => {
const pane = getPaneByTabId(tabId);
await closeSftpTabLifecycle({
requestedSide: side,
tabId,
leftTabs: leftTabsRef.current.tabs,
rightTabs: rightTabsRef.current.tabs,
connectRequests: connectRequestByTabIdRef.current,
connectInFlight: connectInFlightRef.current,
connectedHosts: connectedHostByTabIdRef.current,
closeTab: (liveSide) => closeTab(liveSide, tabId),
releaseConnection: async () => {
if (!pane?.connection) return;
await releaseSftpTabConnection({
connectionId: pane.connection.id,
isLocal: pane.connection.isLocal,
sftpSessions: sftpSessionsRef.current,
connectionCacheKeys: connectionCacheKeyMapRef.current,
clearCacheForConnection,
closeSftp: async (sftpId) => netcattyBridge.get()?.closeSftp(sftpId),
onRemoteSessionClosed: (sftpId) => forgetExternalEditTempsForSftpRef.current(sftpId),
});
},
});
}, [clearCacheForConnection, closeTab, getPaneByTabId, leftTabsRef, rightTabsRef]);
const releaseConnection = useCallback(async (connectionId: string) => {
await releaseSftpConnectionMetadata({
connectionId,
sftpSessions: sftpSessionsRef.current,
connectionCacheKeys: connectionCacheKeyMapRef.current,
clearCacheForConnection,
closeSftp: async (sftpId) => netcattyBridge.get()?.closeSftp(sftpId),
onRemoteSessionClosed: (sftpId) => forgetExternalEditTempsForSftpRef.current(sftpId),
});
}, [clearCacheForConnection]);
const handleSessionError = useSftpSessionErrors({
getActivePane,
leftTabsRef,
rightTabsRef,
updateActiveTab,
navSeqRef,
lastConnectedHostRef,
releaseConnection,
});
const sftpDisposedRef = useSftpSessionCleanup(sftpSessionsRef);
useSftpFileWatch(options);
// Transfer channel pool (max concurrent sftpIds per host, short idle reuse).
// Physical SSH transport ownership remains in the main-process registry.
const transferPoolRef = useRef(
getSharedTransferConnectionPool({
retainSession: async (sftpId, leaseId) => {
const bridge = netcattyBridge.get();
if (!bridge?.retainSftpTransferSession) {
throw new Error("SFTP transfer session retention is unavailable");
}
const result = await bridge.retainSftpTransferSession(sftpId, leaseId);
if (!result?.success) {
throw new Error(result?.reason || "Could not retain SFTP transfer session");
}
},
releaseSession: async (sftpId, leaseId) => {
await netcattyBridge.get()?.releaseSftpTransferSession?.(sftpId, leaseId);
},
closeSession: async (sftpId) => {
try {
await netcattyBridge.get()?.closeSftp?.(sftpId);
} catch {
// best-effort channel cleanup (returns transport lease)
}
},
}),
);
const transferKnownHosts = options?.knownHosts;
const transferTerminalSettings = options?.terminalSettings;
// The cache is scoped to every input that can change resolved credentials.
const transferPoolKeyCache = useMemo(
() => createTransferPoolKeyCache(),
// eslint-disable-next-line react-hooks/exhaustive-deps
[hosts, identities, keys, transferKnownHosts, transferTerminalSettings],
);
const resolveTransferSourceSessionId = options?.resolveTransferSourceSessionId;
const resolveBrowseSourceSessionId = options?.resolveBrowseSourceSessionId;
const openPoolSftpSession = useCallback(
async (host: Host) => {
// Prefer borrowing the live (or parked) terminal SSH transport so MFA is
// not repeated. Transport leases keep the shared conn alive after the
// terminal tab closes until the transfer SFTP lease is returned.
const sourceSessionId = resolveTransferSourceSessionId?.(host.id, host);
if (sourceSessionId) {
try {
logger.info(
`[SFTP] Opening transfer connection via shared transport for ${host.label || host.hostname}`,
);
return await openTransferSftpSession(
host,
{
hosts,
keys,
identities,
knownHosts: transferKnownHosts,
terminalSettings: transferTerminalSettings,
},
{ dedicated: false, sourceSessionId },
);
} catch (err) {
logger.debug(
"[SFTP] Source-session transfer open failed; retrying through the pooled endpoint",
err,
);
}
}
// No live terminal is required: open through the unified transport
// registry so the first file authenticates and later files/operations on
// the same endpoint reuse that transport. Restart resume remains the only
// dedicated path because it has a different lifecycle contract.
logger.info(`[SFTP] Opening pooled transfer connection for ${host.label || host.hostname}`);
return openTransferSftpSession(
host,
{
hosts,
keys,
identities,
knownHosts: transferKnownHosts,
terminalSettings: transferTerminalSettings,
},
{ dedicated: false },
);
},
[hosts, identities, keys, resolveTransferSourceSessionId, transferKnownHosts, transferTerminalSettings],
);
const acquireTransferSession = useCallback(
async (hostId: string, transferId: string, connectHost?: Host) => {
// Prefer the connect-time Host (terminal session overrides) so pooled
// uploads open the same endpoint as the browse tab, not the vault entry.
const host = connectHost && connectHost.id === hostId
? connectHost
: hosts.find((candidate) => candidate.id === hostId);
if (!host) {
throw new Error(`Host not found for transfer session: ${hostId}`);
}
if (connectHost && connectHost.id !== hostId) {
throw new Error(
`Transfer connect host id mismatch: expected ${hostId}, got ${connectHost.id}`,
);
}
const poolKey = await transferPoolKeyCache.get(host, () => ({
hostId: host.id,
hostname: host.hostname,
port: host.port,
username: host.username,
protocol: host.protocol,
sftpSudo: host.sftpSudo,
connectionOptions: buildSftpHostCredentials({
host,
hosts,
keys,
identities,
knownHosts: transferKnownHosts,
terminalSettings: transferTerminalSettings,
}),
}));
return transferPoolRef.current.acquire(poolKey, transferId, () => openPoolSftpSession(host));
},
[hosts, identities, keys, openPoolSftpSession, transferKnownHosts, transferPoolKeyCache, transferTerminalSettings],
);
/** True after browse channels were soft-closed while this owner stayed mounted. */
const interactive = options?.interactive !== false;
const browseConnectionLifecycleRef = useSftpBrowseConnectionLifecycle(interactive);
const browseParkedRef = useRef(false);
const browseLifecycleGenRef = useRef(0);
const {
connect,
disconnect,
listLocalFiles,
listRemoteFiles,
hostKeyVerification,
rejectHostKeyVerification,
acceptHostKeyVerification,
acceptAndSaveHostKeyVerification,
} = useSftpConnections({
hosts,
keys,
identities,
knownHosts: options?.knownHosts,
onAddKnownHost: options?.onAddKnownHost,
terminalSettings: options?.terminalSettings,
leftTabsRef,
rightTabsRef,
leftTabs,
rightTabs,
leftPane,
rightPane,
setLeftTabs,
setRightTabs,
getActivePane,
updateTab,
navSeqRef,
dirCacheRef,
sftpSessionsRef,
disposedRef: sftpDisposedRef,
browseConnectionLifecycleRef,
lastConnectedHostRef,
connectionCacheKeyMapRef,
connectedHostByTabIdRef,
connectInFlightRef,
connectRequestByTabIdRef,
makeCacheKey,
clearCacheForConnection,
createEmptyPane: createPane,
autoConnectLocalOnMount: options?.autoConnectLocalOnMount,
onRemoteSessionClosed: (sftpId) => forgetExternalEditTempsForSftpRef.current(sftpId),
});
const {
navigateTo,
refresh,
navigateUp,
openEntry,
setFilter,
toggleSelection,
rangeSelect,
clearSelection,
selectAll,
getFilteredFiles,
createDirectory,
createDirectoryAtPath,
createFile,
createFileAtPath,
deleteFiles,
deleteFilesAtPath,
renameFile,
renameFileAtPath,
moveEntriesToPath,
changePermissions,
} = useSftpPaneActions({
hosts,
getActivePane,
updateTab,
updateActiveTab,
leftTabsRef,
rightTabsRef,
navSeqRef,
dirCacheRef,
sftpSessionsRef,
lastConnectedHostRef,
connectionCacheKeyMapRef,
makeCacheKey,
clearCacheForConnection,
listLocalFiles,
listRemoteFiles,
handleSessionError,
releaseConnection,
isSessionError,
clearSelectionsExcept,
dirCacheTtlMs: DIR_CACHE_TTL_MS,
});
const setFilenameEncoding = useCallback(
(side: "left" | "right", encoding: SftpFilenameEncoding) => {
updateActiveTab(side, (prev) => ({
...prev,
filenameEncoding: encoding,
}));
const pane = getActivePane(side);
if (pane?.connection && !pane.connection.isLocal) {
clearCacheForConnection(pane.connection.id);
// Defer refresh so state update lands before we read filenameEncoding in navigateTo.
setTimeout(() => {
const refreshedPane = getActivePane(side);
if (refreshedPane?.connection) {
navigateTo(side, refreshedPane.connection.currentPath, { force: true });
}
}, 0);
}
},
[clearCacheForConnection, getActivePane, navigateTo, updateActiveTab],
);
const setShowHiddenFiles = useCallback(
(side: "left" | "right", tabId: string, showHiddenFiles: boolean) => {
setTabShowHiddenFiles(side, tabId, showHiddenFiles);
},
[setTabShowHiddenFiles],
);
const {
transfers,
conflicts: transferConflicts,
activeTransfersCount,
startTransfer,
downloadToLocal,
cancelTransfer,
pauseTransfer,
resumeTransfer,
prioritizeTransfer,
isTransferCancelled,
retryTransfer,
clearCompletedTransfers,
dismissTransfer,
resolveConflict: resolveTransferConflict,
} = useSftpTransfers({
ownerId: transferOwnerIdRef.current,
canPrepareAdoption: options?.canPrepareTransferAdoption,
surfaceVisible: options?.surfaceVisible ?? true,
getActivePane,
getPaneByConnectionId,
getTabByConnectionId,
updateTab,
refresh,
clearCacheForConnection,
sftpSessionsRef,
connectionCacheKeyMapRef,
listLocalFiles,
listRemoteFiles,
handleSessionError,
acquireTransferSession,
});
const {
readTextFile,
readBinaryFile,
writeTextFile,
writeTextFileByConnection,
downloadToTempAndOpen,
openWithSystemDefault,
uploadExternalFiles,
uploadExternalFileList,
uploadExternalFolderPath,
uploadExternalEntries,
cancelExternalUpload,
selectApplication,
activeFileWatchCountRef,
activeExternalEditCount,
forgetExternalEditTempsForSftp,
releaseExternalFileWatches,
uploadConflicts,
resolveUploadConflict,
} = useSftpExternalOperations({
ownerId: transferOwnerIdRef.current,
getActivePane,
getPaneByConnectionId,
getPaneByTabId,
getTabByConnectionId,
getSideByTabId,
refresh,
sftpSessionsRef,
connectionCacheKeyMapRef,
ensureRemoteSftpId: async (side, ensureOptions) => {
const bridge = netcattyBridge.get();
const connectionId = ensureOptions?.connectionId;
// Tab ids survive reconnect; connection ids are regenerated by connect().
const tabId =
ensureOptions?.tabId
?? (connectionId ? getTabByConnectionId(connectionId)?.tabId : undefined);
// Prefer live side when the pinned tab was dragged left↔right mid-upload.
const reconnectSide = tabId ? (getSideByTabId(tabId) ?? side) : side;
const pinnedGetActivePane = tabId
? (_side: "left" | "right") => {
const pane = getPaneByTabId(tabId);
if (!pane) {
throw new Error("Upload target connection is no longer available");
}
return pane;
}
: getActivePane;
return ensureRemoteSftpSession({
side: reconnectSide,
getActivePane: pinnedGetActivePane,
sftpSessionsRef,
lastConnectedHostRef,
connect,
resolveConnectedHost: (id) => connectedHostByTabIdRef.current.get(id) ?? null,
resolveHostById: (hostId) => hosts.find((host) => host.id === hostId) ?? null,
forceReconnect: ensureOptions?.forceReconnect,
releaseConnection,
tabId,
probeSession: (sftpId) => probeSftpSession(bridge, sftpId),
});
},
resolveConnectedHost: (tabId) => connectedHostByTabIdRef.current.get(tabId) ?? null,
acquireTransferSession,
clearDirCacheEntry,
useCompressedUpload: options?.useCompressedUpload,
isTransferCancelled,
});
forgetExternalEditTempsForSftpRef.current = forgetExternalEditTempsForSftp;
const conflicts = useMemo(
() => [...transferConflicts, ...uploadConflicts],
[transferConflicts, uploadConflicts],
);
const resolveAnyConflict = useCallback(
(...args: Parameters<typeof resolveTransferConflict>) => {
const [conflictId] = args;
if (uploadConflicts.some((conflict) => conflict.transferId === conflictId)) {
return resolveUploadConflict(...args);
}
return resolveTransferConflict(...args);
},
[resolveTransferConflict, resolveUploadConflict, uploadConflicts],
);
// FileZilla-style: when the side panel is closed (not merely showing another
// tool), soft-close browse SFTP channels. Defer park while this owner still
// has unfinished transfers so pre-lease prep (conflict/stat) cannot race a
// hard-close of the browse id. In-flight streams also soft-close via leases;
// pool handles bulk I/O.
useEffect(() => {
const gen = ++browseLifecycleGenRef.current;
const parkBrowse = async () => {
// Include global-center rows owned by this panel so we never soft-close
// browse sessions while bulk work is still arming/running.
// Match retain semantics: paused/interrupted folder walks still need the
// browse (or work) session until resume finishes — do not hard-park them.
const centerActive = sftpTransferCenterStore.getSnapshot().tasks.some((task) => (
task.ownerId === transferOwnerIdRef.current
&& !task.parentTaskId
&& task.status !== "completed"
&& task.status !== "cancelled"
));
if (!shouldParkBrowseSessions({
interactive,
browseParked: browseParkedRef.current,
activeTransfersCount: Math.max(activeTransfersCount, centerActive ? 1 : 0),
activeExternalEditCount,
})) {
return;
}
const entries = takeBrowseSessionsForClose(sftpSessionsRef.current);
if (entries.length === 0) {
browseParkedRef.current = true;
return;
}
browseParkedRef.current = true;
logger.info(`[SFTP] Parking ${entries.length} browse session(s) (transfers keep pool leases)`);
await Promise.all(entries.map(async ({ connectionId, sftpId }) => {
clearCacheForConnection(connectionId);
try {
// closeSftp soft-closes when transfer leases still hold the id.
await netcattyBridge.get()?.closeSftp?.(sftpId);
} catch {
// best-effort — session may already be gone
}
forgetExternalEditTempsForSftpRef.current(sftpId);
}));
};
const restoreBrowse = async () => {
if (!shouldRestoreBrowseSessions({
interactive,
browseParked: browseParkedRef.current,
})) {
return;
}
browseParkedRef.current = false;
const sides: Array<"left" | "right"> = ["left", "right"];
for (const side of sides) {
if (gen !== browseLifecycleGenRef.current) return;
const pane = getActivePane(side);
if (!pane?.connection || pane.connection.isLocal) continue;
if (sftpSessionsRef.current.has(pane.connection.id)) continue;
const connectedHost = connectedHostByTabIdRef.current.get(pane.id) ?? null;
const vaultHost = hosts.find((host) => host.id === pane.connection?.hostId) ?? null;
const targetHost = connectedHost && connectedHost !== "local" ? connectedHost : vaultHost;
const resolvedSourceSessionId = targetHost
? resolveBrowseSourceSessionId?.(targetHost.id, targetHost)
: undefined;
try {
await ensureRemoteSftpSession({
side,
getActivePane,
sftpSessionsRef,
lastConnectedHostRef,
connect,
resolveConnectedHost: (id) => connectedHostByTabIdRef.current.get(id) ?? null,
resolveHostById: (hostId) => hosts.find((host) => host.id === hostId) ?? null,
resolveSourceSessionId: resolvedSourceSessionId
? () => resolvedSourceSessionId
: resolveBrowseSourceSessionId,
probeSession: (sftpId) => probeSftpSession(netcattyBridge.get(), sftpId),
releaseConnection,
});
logger.info(`[SFTP] Restored browse session on ${side}`);
} catch (err) {
logger.warn(`[SFTP] Failed to restore browse session on ${side}`, err);
}
}
};
if (!interactive) {
void parkBrowse();
} else {
void restoreBrowse();
}
}, [
interactive,
activeTransfersCount,
activeExternalEditCount,
clearCacheForConnection,
connect,
getActivePane,
hosts,
lastConnectedHostRef,
resolveBrowseSourceSessionId,
sftpSessionsRef,
releaseConnection,
]);
// Store methods in a ref to create stable wrapper functions
// This prevents callback reference changes from causing re-renders in consumers
const currentMethods = {
getFilteredFiles,
addTab,
closeTab: closeTabAndClearHost,
selectTab,
reorderTabs,
moveTabToOtherSide,
getTabsInfo,
getActiveTabId,
getActivePane,
connect,
disconnect,
navigateTo,
navigateUp,
refresh,
openEntry,
toggleSelection,
rangeSelect,
clearSelection,
clearSelectionsExcept,
selectAll,
setFilter,
setFilenameEncoding,
setShowHiddenFiles,
createDirectory,
createDirectoryAtPath,
createFile,
createFileAtPath,
deleteFiles,
deleteFilesAtPath,
renameFile,
renameFileAtPath,
moveEntriesToPath,
changePermissions,
readTextFile,
readBinaryFile,
writeTextFile,
writeTextFileByConnection,
downloadToTempAndOpen,
openWithSystemDefault,
uploadExternalFiles,
uploadExternalFileList,
uploadExternalFolderPath,
uploadExternalEntries,
cancelExternalUpload,
selectApplication,
releaseExternalFileWatches,
startTransfer,
downloadToLocal,
cancelTransfer,
pauseTransfer,
resumeTransfer,
prioritizeTransfer,
retryTransfer,
clearCompletedTransfers,
dismissTransfer,
resolveConflict: resolveAnyConflict,
getSftpIdForConnection,
getConnectionCacheKey,
setLastConnectedHost,
reportSessionError: handleSessionError,
rejectHostKeyVerification,
acceptHostKeyVerification,
acceptAndSaveHostKeyVerification,
};
const methodsRef = useRef(currentMethods);
methodsRef.current = currentMethods;
// Create stable method wrappers that call through methodsRef
// These are created once and never change reference
const stableMethods = useMemo(() => ({
getFilteredFiles: (...args: Parameters<typeof getFilteredFiles>) => methodsRef.current.getFilteredFiles(...args),
addTab: (...args: Parameters<typeof addTab>) => methodsRef.current.addTab(...args),
closeTab: (...args: Parameters<typeof closeTabAndClearHost>) => methodsRef.current.closeTab(...args),
selectTab: (...args: Parameters<typeof selectTab>) => methodsRef.current.selectTab(...args),
reorderTabs: (...args: Parameters<typeof reorderTabs>) => methodsRef.current.reorderTabs(...args),
moveTabToOtherSide: (...args: Parameters<typeof moveTabToOtherSide>) => methodsRef.current.moveTabToOtherSide(...args),
getTabsInfo: (...args: Parameters<typeof getTabsInfo>) => methodsRef.current.getTabsInfo(...args),
getActiveTabId: (...args: Parameters<typeof getActiveTabId>) => methodsRef.current.getActiveTabId(...args),
getActivePane: (...args: Parameters<typeof getActivePane>) => methodsRef.current.getActivePane(...args),
connect: (...args: Parameters<typeof connect>) => methodsRef.current.connect(...args),
disconnect: (...args: Parameters<typeof disconnect>) => methodsRef.current.disconnect(...args),
navigateTo: (...args: Parameters<typeof navigateTo>) => methodsRef.current.navigateTo(...args),
navigateUp: (...args: Parameters<typeof navigateUp>) => methodsRef.current.navigateUp(...args),
refresh: (...args: Parameters<typeof refresh>) => methodsRef.current.refresh(...args),
openEntry: (...args: Parameters<typeof openEntry>) => methodsRef.current.openEntry(...args),
toggleSelection: (...args: Parameters<typeof toggleSelection>) => methodsRef.current.toggleSelection(...args),
rangeSelect: (...args: Parameters<typeof rangeSelect>) => methodsRef.current.rangeSelect(...args),
clearSelection: (...args: Parameters<typeof clearSelection>) => methodsRef.current.clearSelection(...args),
clearSelectionsExcept: (...args: Parameters<typeof clearSelectionsExcept>) =>
methodsRef.current.clearSelectionsExcept(...args),
selectAll: (...args: Parameters<typeof selectAll>) => methodsRef.current.selectAll(...args),
setFilter: (...args: Parameters<typeof setFilter>) => methodsRef.current.setFilter(...args),
setFilenameEncoding: (...args: Parameters<typeof setFilenameEncoding>) =>
methodsRef.current.setFilenameEncoding(...args),
setShowHiddenFiles: (...args: Parameters<typeof setShowHiddenFiles>) =>
methodsRef.current.setShowHiddenFiles(...args),
createDirectory: (...args: Parameters<typeof createDirectory>) => methodsRef.current.createDirectory(...args),
createDirectoryAtPath: (...args: Parameters<typeof createDirectoryAtPath>) =>
methodsRef.current.createDirectoryAtPath(...args),
createFile: (...args: Parameters<typeof createFile>) => methodsRef.current.createFile(...args),
createFileAtPath: (...args: Parameters<typeof createFileAtPath>) =>
methodsRef.current.createFileAtPath(...args),
deleteFiles: (...args: Parameters<typeof deleteFiles>) => methodsRef.current.deleteFiles(...args),
deleteFilesAtPath: (...args: Parameters<typeof deleteFilesAtPath>) =>
methodsRef.current.deleteFilesAtPath(...args),
renameFile: (...args: Parameters<typeof renameFile>) => methodsRef.current.renameFile(...args),
renameFileAtPath: (...args: Parameters<typeof renameFileAtPath>) => methodsRef.current.renameFileAtPath(...args),
moveEntriesToPath: (...args: Parameters<typeof moveEntriesToPath>) => methodsRef.current.moveEntriesToPath(...args),
changePermissions: (...args: Parameters<typeof changePermissions>) => methodsRef.current.changePermissions(...args),
readTextFile: (...args: Parameters<typeof readTextFile>) => methodsRef.current.readTextFile(...args),
readBinaryFile: (...args: Parameters<typeof readBinaryFile>) => methodsRef.current.readBinaryFile(...args),
writeTextFile: (...args: Parameters<typeof writeTextFile>) => methodsRef.current.writeTextFile(...args),
writeTextFileByConnection: (...args: Parameters<typeof writeTextFileByConnection>) =>
methodsRef.current.writeTextFileByConnection(...args),
downloadToTempAndOpen: (...args: Parameters<typeof downloadToTempAndOpen>) => methodsRef.current.downloadToTempAndOpen(...args),
openWithSystemDefault: (...args: Parameters<typeof openWithSystemDefault>) =>
methodsRef.current.openWithSystemDefault(...args),
uploadExternalFiles: (...args: Parameters<typeof uploadExternalFiles>) => methodsRef.current.uploadExternalFiles(...args),
uploadExternalFileList: (...args: Parameters<typeof uploadExternalFileList>) =>
methodsRef.current.uploadExternalFileList(...args),
uploadExternalFolderPath: (...args: Parameters<typeof uploadExternalFolderPath>) =>
methodsRef.current.uploadExternalFolderPath(...args),
uploadExternalEntries: (...args: Parameters<typeof uploadExternalEntries>) =>
methodsRef.current.uploadExternalEntries(...args),
cancelExternalUpload: (taskId?: string) => methodsRef.current.cancelExternalUpload(taskId),
selectApplication: () => methodsRef.current.selectApplication(),
releaseExternalFileWatches: (...args: Parameters<typeof releaseExternalFileWatches>) =>
methodsRef.current.releaseExternalFileWatches(...args),
startTransfer: (...args: Parameters<typeof startTransfer>) => methodsRef.current.startTransfer(...args),
downloadToLocal: (...args: Parameters<typeof downloadToLocal>) => methodsRef.current.downloadToLocal(...args),
cancelTransfer: (...args: Parameters<typeof cancelTransfer>) => methodsRef.current.cancelTransfer(...args),
pauseTransfer: (...args: Parameters<typeof pauseTransfer>) => methodsRef.current.pauseTransfer(...args),
resumeTransfer: (...args: Parameters<typeof resumeTransfer>) => methodsRef.current.resumeTransfer(...args),
prioritizeTransfer: (...args: Parameters<typeof prioritizeTransfer>) => methodsRef.current.prioritizeTransfer(...args),
retryTransfer: (...args: Parameters<typeof retryTransfer>) => methodsRef.current.retryTransfer(...args),
clearCompletedTransfers: () => methodsRef.current.clearCompletedTransfers(),
dismissTransfer: (...args: Parameters<typeof dismissTransfer>) => methodsRef.current.dismissTransfer(...args),
resolveConflict: (...args: Parameters<typeof resolveAnyConflict>) => methodsRef.current.resolveConflict(...args),
getSftpIdForConnection: (...args: Parameters<typeof getSftpIdForConnection>) => methodsRef.current.getSftpIdForConnection(...args),
getConnectionCacheKey: (...args: Parameters<typeof getConnectionCacheKey>) => methodsRef.current.getConnectionCacheKey(...args),
setLastConnectedHost: (...args: Parameters<typeof setLastConnectedHost>) => methodsRef.current.setLastConnectedHost(...args),
reportSessionError: (...args: Parameters<typeof handleSessionError>) => methodsRef.current.reportSessionError(...args),
rejectHostKeyVerification: () => methodsRef.current.rejectHostKeyVerification(),
acceptHostKeyVerification: () => methodsRef.current.acceptHostKeyVerification(),
acceptAndSaveHostKeyVerification: () => methodsRef.current.acceptAndSaveHostKeyVerification(),
activeFileWatchCountRef,
}), [activeFileWatchCountRef]); // activeFileWatchCountRef is a stable ref
// Return object with stable method references but reactive state
// State changes will cause re-renders, but method references stay stable
return useMemo(() => ({
// Reactive state - changes trigger re-renders
leftPane,
rightPane,
leftTabs,
rightTabs,
transfers,
activeTransfersCount,
activeExternalEditCount,
conflicts,
hostKeyVerification,
// Stable methods - never change reference
...stableMethods,
// Pure helper functions (these are defined at module level, always stable)
formatFileSize,
formatDate,
getFileExtension,
joinPath,
getParentPath,
getFileName,
}), [
// Only state in deps - methods come from stableMethods which is stable
leftPane,
rightPane,
leftTabs,
rightTabs,
transfers,
activeTransfersCount,
activeExternalEditCount,
conflicts,
hostKeyVerification,
stableMethods,
]);
};
export type SftpStateApi = ReturnType<typeof useSftpState>;