dsh-remote 0.8.45 → 0.8.47

package/lib/registry.js

@@ -1,95 +1,95 @@
-// Machine-registry pure logic for dsh-remote.
-//
-// Issue #13: a SAVED machine is only a standby connection — it must never
-// silently become the "active remote context" of every session. The registry
-// therefore keeps `currentId` as an EXPLICIT user choice:
-//   • loadMachines never falls back to the first saved machine,
-//   • a stale currentId (machine deleted meanwhile) resolves to null,
-//   • add/update never auto-activate; only an explicit "set current" does,
-//   • deleting the current machine leaves NO current (no auto-promotion).
-// Keeping this logic in one module makes the guarantee unit-testable and
-// shared between the HTTP routes and the tools (rw_connect).
-
-import { readFileSync, writeFileSync, mkdirSync } from 'node:fs'
-import path from 'node:path'
-
-/** Load { list, currentId, explicitNone } from the registry file. */
-export function loadMachines(file) {
-  try {
-    const j = JSON.parse(readFileSync(file, 'utf8'))
-    if (Array.isArray(j.list)) {
-      const list = j.list
-      // Explicit choice only — no fallback to the first machine, no activation
-      // of a stale/deleted id (issue #13).
-      const currentId = j.currentId && list.some((m) => m.id === j.currentId) ? j.currentId : null
-      // A persisted `currentId: null` is a deliberate "active remote = none"
-      // (the user cleared the current machine). It must survive restarts so a
-      // config-level default host cannot silently reactivate a context the user
-      // explicitly turned off. `explicitNone` is true when the file carries an
-      // explicit null (vs. a fresh file where currentId is simply absent).
-      const explicitNone = Object.prototype.hasOwnProperty.call(j, 'currentId') && j.currentId == null
-      return { list, currentId, explicitNone }
-    }
-  } catch {}
-  return { list: [], currentId: null, explicitNone: false }
-}
-
-/** Persist { list, currentId }. `currentId` may be null → active remote = none.
- *  Pass `keepCurrentKey: false` (add/update a machine without touching the
- *  current selection) to PRESERVE whatever `currentId` the file already holds
- *  — so merely saving a machine never flips a fresh registry into "explicit
- *  none", nor clears an explicit choice. When no previous file exists the
- *  `currentId` key is omitted entirely (fresh registry = "no choice yet"). */
-export function saveMachines(file, list, currentId, keepCurrentKey = true) {
-  try { mkdirSync(path.dirname(file), { recursive: true }) } catch {}
-  let stored = currentId
-  let hasStored = keepCurrentKey
-  if (!keepCurrentKey) {
-    try {
-      const prev = JSON.parse(readFileSync(file, 'utf8'))
-      if (prev && Object.prototype.hasOwnProperty.call(prev, 'currentId')) {
-        stored = prev.currentId
-        hasStored = true
-      }
-    } catch { /* no previous file → omit the key */ }
-  }
-  const payload = { list }
-  if (hasStored) payload.currentId = stored
-  writeFileSync(file, JSON.stringify(payload, null, 2))
-}
-
-/** Strip secrets before sending a machine to the client. */
-export function sanitizeMachine(m) {
-  if (!m) return m
-  const { password, proxy, ...rest } = m
-  const out = { ...rest, passwordSet: !!(m.password && m.password.length) }
-  if (proxy) out.proxy = { ...proxy, password: proxy.password ? '' : undefined, passwordSet: !!(proxy.password && proxy.password.length) }
-  return out
-}
-
-/** Apply a machine's fields onto the live config object (pool + tools read it). */
-export function applyMachine(config, m) {
-  if (!m) return
-  config.host = m.host
-  config.port = Number(m.port) || 22
-  config.username = m.username || ''
-  config.password = m.password || ''
-  config.privateKeyPath = m.privateKeyPath || ''
-  config.passphrase = m.passphrase || ''
-  config.workspace = m.workspace || (config.workspace || '')
-  if (m.hostKeyMode) config.hostKeyMode = m.hostKeyMode
-  if (typeof m.useAgent === 'boolean') config.useAgent = m.useAgent
-  if (typeof m.keyboardInteractive === 'boolean') config.keyboardInteractive = m.keyboardInteractive
-  // Issue #51: the transport backend is PER MACHINE. An enterprise box that only
-  // accepts Kerberos must go through the system OpenSSH backend while every
-  // other machine can stay on the native one, so this cannot be a purely global
-  // default.
-  if (m.backend) config.backend = m.backend
-  if (typeof m.sshBinary === 'string') config.sshBinary = m.sshBinary
-  config.proxy = m.proxy && m.proxy.host ? m.proxy : undefined
-}
-
-/** Mint a fresh machine id. */
-export function machineId() {
-  return 'm-' + Date.now().toString(36) + '-' + Math.random().toString(36).slice(2, 6)
-}
+// Machine-registry pure logic for dsh-remote.
+//
+// Issue #13: a SAVED machine is only a standby connection — it must never
+// silently become the "active remote context" of every session. The registry
+// therefore keeps `currentId` as an EXPLICIT user choice:
+//   • loadMachines never falls back to the first saved machine,
+//   • a stale currentId (machine deleted meanwhile) resolves to null,
+//   • add/update never auto-activate; only an explicit "set current" does,
+//   • deleting the current machine leaves NO current (no auto-promotion).
+// Keeping this logic in one module makes the guarantee unit-testable and
+// shared between the HTTP routes and the tools (rw_connect).
+
+import { readFileSync, writeFileSync, mkdirSync } from 'node:fs'
+import path from 'node:path'
+
+/** Load { list, currentId, explicitNone } from the registry file. */
+export function loadMachines(file) {
+  try {
+    const j = JSON.parse(readFileSync(file, 'utf8'))
+    if (Array.isArray(j.list)) {
+      const list = j.list
+      // Explicit choice only — no fallback to the first machine, no activation
+      // of a stale/deleted id (issue #13).
+      const currentId = j.currentId && list.some((m) => m.id === j.currentId) ? j.currentId : null
+      // A persisted `currentId: null` is a deliberate "active remote = none"
+      // (the user cleared the current machine). It must survive restarts so a
+      // config-level default host cannot silently reactivate a context the user
+      // explicitly turned off. `explicitNone` is true when the file carries an
+      // explicit null (vs. a fresh file where currentId is simply absent).
+      const explicitNone = Object.prototype.hasOwnProperty.call(j, 'currentId') && j.currentId == null
+      return { list, currentId, explicitNone }
+    }
+  } catch {}
+  return { list: [], currentId: null, explicitNone: false }
+}
+
+/** Persist { list, currentId }. `currentId` may be null → active remote = none.
+ *  Pass `keepCurrentKey: false` (add/update a machine without touching the
+ *  current selection) to PRESERVE whatever `currentId` the file already holds
+ *  — so merely saving a machine never flips a fresh registry into "explicit
+ *  none", nor clears an explicit choice. When no previous file exists the
+ *  `currentId` key is omitted entirely (fresh registry = "no choice yet"). */
+export function saveMachines(file, list, currentId, keepCurrentKey = true) {
+  try { mkdirSync(path.dirname(file), { recursive: true }) } catch {}
+  let stored = currentId
+  let hasStored = keepCurrentKey
+  if (!keepCurrentKey) {
+    try {
+      const prev = JSON.parse(readFileSync(file, 'utf8'))
+      if (prev && Object.prototype.hasOwnProperty.call(prev, 'currentId')) {
+        stored = prev.currentId
+        hasStored = true
+      }
+    } catch { /* no previous file → omit the key */ }
+  }
+  const payload = { list }
+  if (hasStored) payload.currentId = stored
+  writeFileSync(file, JSON.stringify(payload, null, 2))
+}
+
+/** Strip secrets before sending a machine to the client. */
+export function sanitizeMachine(m) {
+  if (!m) return m
+  const { password, proxy, ...rest } = m
+  const out = { ...rest, passwordSet: !!(m.password && m.password.length) }
+  if (proxy) out.proxy = { ...proxy, password: proxy.password ? '' : undefined, passwordSet: !!(proxy.password && proxy.password.length) }
+  return out
+}
+
+/** Apply a machine's fields onto the live config object (pool + tools read it). */
+export function applyMachine(config, m) {
+  if (!m) return
+  config.host = m.host
+  config.port = Number(m.port) || 22
+  config.username = m.username || ''
+  config.password = m.password || ''
+  config.privateKeyPath = m.privateKeyPath || ''
+  config.passphrase = m.passphrase || ''
+  config.workspace = m.workspace || (config.workspace || '')
+  if (m.hostKeyMode) config.hostKeyMode = m.hostKeyMode
+  if (typeof m.useAgent === 'boolean') config.useAgent = m.useAgent
+  if (typeof m.keyboardInteractive === 'boolean') config.keyboardInteractive = m.keyboardInteractive
+  // Issue #51: the transport backend is PER MACHINE. An enterprise box that only
+  // accepts Kerberos must go through the system OpenSSH backend while every
+  // other machine can stay on the native one, so this cannot be a purely global
+  // default.
+  if (m.backend) config.backend = m.backend
+  if (typeof m.sshBinary === 'string') config.sshBinary = m.sshBinary
+  config.proxy = m.proxy && m.proxy.host ? m.proxy : undefined
+}
+
+/** Mint a fresh machine id. */
+export function machineId() {
+  return 'm-' + Date.now().toString(36) + '-' + Math.random().toString(36).slice(2, 6)
+}

package/lib/remote-fs.js

@@ -1,143 +1,148 @@
-// Shared remote SFTP helpers used by both rw_* tools and the sidebar HTTP routes.
-import { joinRemotePath, normalizeRemotePath } from './paths.js'
-
-/** Structured listing: name + type + size + mtime + mode (SFTP protocol-level). */
-export async function listDirStructured(sftp, p) {
-  const target = normalizeRemotePath(p || '/')
-  let list
-  try {
-    list = await sftp.readdir(target)
-  } catch (err) {
-    const msg = String((err && err.message) || err)
-    if (/no such file|not found|does not exist|ENOENT/i.test(msg)) {
-      return { path: target, items: [], missing: true }
-    }
-    throw new Error('browse failed: ' + msg)
-  }
-  const items = []
-  const symIdx = []
-  for (const e of list) {
-    const name = String(e.filename)
-    if (name === '.' || name === '..' || !name) continue
-    const a = e.attrs || {}
-    let type
-    if (a.isSymbolicLink && a.isSymbolicLink()) {
-      type = 'symlink'
-      symIdx.push(items.length)
-    } else if (a.isDirectory && a.isDirectory()) {
-      type = 'dir'
-    } else {
-      type = 'file'
-    }
-    items.push({
-      type,
-      name,
-      size: typeof a.size === 'number' ? a.size : 0,
-      mtime: typeof a.mtime === 'number' ? a.mtime : 0,
-      mode: typeof a.mode === 'number' ? a.mode.toString(8) : '',
-    })
-  }
-  if (symIdx.length) {
-    await Promise.all(symIdx.map(async (i) => {
-      const full = joinRemotePath(target, items[i].name)
-      try {
-        const st = await sftp.lstat(full)
-        items[i].type = st && st.isDirectory && st.isDirectory() ? 'dir' : 'file'
-      } catch { /* degrade to file */ }
-    }))
-  }
-  return { path: target, items }
-}
-
-/** Windows drive letters as display-form dir entries ("This PC" root view). */
-export async function listRemoteDrives(sshPool) {
-  let letters = []
-  try {
-    const res = await sshPool.exec('cmd /c fsutil fsinfo drives', { timeoutMs: Math.min(sshPool.config.commandTimeoutMs || 8000, 8000) })
-    letters = [...String(res.stdout || '').matchAll(/([a-zA-Z]):\\?/g)].map((mm) => mm[1].toUpperCase())
-  } catch {}
-  if (!letters.length) {
-    try {
-      const res = await sshPool.exec('ls -d /[a-z] 2>/dev/null', { timeoutMs: Math.min(sshPool.config.commandTimeoutMs || 8000, 8000) })
-      letters = String(res.stdout || '')
-        .split(/\s+/)
-        .map((s) => s.replace(/^\/+|\/+$/g, ''))
-        .filter((s) => /^[a-zA-Z]$/.test(s))
-        .map((s) => s.toUpperCase())
-    } catch {}
-  }
-  return [...new Set(letters)].sort().map((l) => ({ name: l + ':\\', path: l + ':\\', type: 'dir', drive: true, size: 0, mtime: 0 }))
-}
-
-/** Recursive remote delete (bounded): unlink files bottom-up, then rmdir. */
-export async function removeRemoteTree(sftp, p, maxFiles = 2000) {
-  let removed = 0
-  const walk = async (dir) => {
-    if (removed >= maxFiles) return
-    let entries = []
-    try { entries = (await sftp.readdir(dir)) || [] } catch { return }
-    for (const e of entries) {
-      if (removed >= maxFiles) return
-      const name = String(e.filename)
-      if (name === '.' || name === '..') continue
-      const fp = joinRemotePath(dir, name)
-      const isDir = !!(e.attrs && e.attrs.isDirectory && e.attrs.isDirectory())
-      if (isDir) await walk(fp)
-      else {
-        try { await sftp.unlink(fp); removed++ } catch {}
-      }
-    }
-    try { await sftp.rmdir(dir); removed++ } catch { /* already gone or non-empty */ }
-  }
-  await walk(p)
-  return removed
-}
-
-function looksBinary(buf) {
-  const n = Math.min(buf.length, 8192)
-  for (let i = 0; i < n; i++) if (buf[i] === 0) return true
-  return false
-}
-
-/**
- * Read a remote file for the sidebar/editor. Oversized files use a range read
- * (`readPartial`) so we never `fastGet` the whole blob onto disk.
- */
-export async function previewRemoteFile(sftp, target, opts = {}) {
-  const {
-    maxBytes = 256 * 1024,
-    encoding = 'utf-8',
-    decodeBuf = (buf) => buf.toString('utf8'),
-  } = opts
-  const cap = Math.min(Math.max(Number(maxBytes) || 256 * 1024, 1024), 2 * 1024 * 1024)
-  const st = await sftp.stat(target)
-  const mtime = st && typeof st.mtime === 'number' ? st.mtime : 0
-  const size = st && typeof st.size === 'number' ? st.size : 0
-  let buf
-  let truncated = false
-  if (size > cap) {
-    truncated = true
-    if (typeof sftp.readPartial === 'function') {
-      buf = await sftp.readPartial(target, 0, cap)
-    } else {
-      const full = await sftp.readFile(target)
-      buf = full.subarray(0, cap)
-    }
-  } else {
-    buf = await sftp.readFile(target)
-  }
-  if (looksBinary(buf)) {
-    return {
-      ok: true, binary: true, size, mtime,
-      head: buf.slice(0, Math.min(buf.length, 4096)).toString('base64'),
-      truncated,
-    }
-  }
-  let content = decodeBuf(buf, encoding).replace(/\r\n/g, '\n')
-  if (!truncated && content.length > cap) {
-    truncated = true
-    content = content.slice(0, cap)
-  }
-  if (truncated) content += `\n…[truncated: ${Math.max(0, size - cap)} more bytes]`
-  return { ok: true, binary: false, content, truncated, size, mtime }
-}
+// Shared remote SFTP helpers used by both rw_* tools and the sidebar HTTP routes.
+import { joinRemotePath, normalizeRemotePath } from './paths.js'
+
+/** Structured listing: name + type + size + mtime + mode (SFTP protocol-level). */
+export async function listDirStructured(sftp, p) {
+  const target = normalizeRemotePath(p || '/')
+  let list
+  try {
+    list = await sftp.readdir(target)
+  } catch (err) {
+    const msg = String((err && err.message) || err)
+    if (/no such file|not found|does not exist|ENOENT/i.test(msg)) {
+      return { path: target, items: [], missing: true }
+    }
+    throw new Error('browse failed: ' + msg)
+  }
+  const items = []
+  const symIdx = []
+  for (const e of list) {
+    const name = String(e.filename)
+    if (name === '.' || name === '..' || !name) continue
+    const a = e.attrs || {}
+    let type
+    if (a.isSymbolicLink && a.isSymbolicLink()) {
+      type = 'symlink'
+      symIdx.push(items.length)
+    } else if (a.isDirectory && a.isDirectory()) {
+      type = 'dir'
+    } else {
+      type = 'file'
+    }
+    items.push({
+      type,
+      name,
+      size: typeof a.size === 'number' ? a.size : 0,
+      mtime: typeof a.mtime === 'number' ? a.mtime : 0,
+      mode: typeof a.mode === 'number' ? a.mode.toString(8) : '',
+    })
+  }
+  if (symIdx.length) {
+    // Resolve what each symlink POINTS TO. This must be stat (follows links),
+    // not lstat: lstat describes the link itself, so a symlink to a directory
+    // was misclassified as 'file' and the workspace picker refused to enter
+    // it (issue #59). A dangling link fails stat and degrades to 'file'.
+    await Promise.all(symIdx.map(async (i) => {
+      const full = joinRemotePath(target, items[i].name)
+      try {
+        const st = await sftp.stat(full)
+        items[i].type = st && st.isDirectory && st.isDirectory() ? 'dir' : 'file'
+        items[i].link = true
+      } catch { items[i].type = 'file' /* dangling link: degrade to file */ }
+    }))
+  }
+  return { path: target, items }
+}
+
+/** Windows drive letters as display-form dir entries ("This PC" root view). */
+export async function listRemoteDrives(sshPool) {
+  let letters = []
+  try {
+    const res = await sshPool.exec('cmd /c fsutil fsinfo drives', { timeoutMs: Math.min(sshPool.config.commandTimeoutMs || 8000, 8000) })
+    letters = [...String(res.stdout || '').matchAll(/([a-zA-Z]):\\?/g)].map((mm) => mm[1].toUpperCase())
+  } catch {}
+  if (!letters.length) {
+    try {
+      const res = await sshPool.exec('ls -d /[a-z] 2>/dev/null', { timeoutMs: Math.min(sshPool.config.commandTimeoutMs || 8000, 8000) })
+      letters = String(res.stdout || '')
+        .split(/\s+/)
+        .map((s) => s.replace(/^\/+|\/+$/g, ''))
+        .filter((s) => /^[a-zA-Z]$/.test(s))
+        .map((s) => s.toUpperCase())
+    } catch {}
+  }
+  return [...new Set(letters)].sort().map((l) => ({ name: l + ':\\', path: l + ':\\', type: 'dir', drive: true, size: 0, mtime: 0 }))
+}
+
+/** Recursive remote delete (bounded): unlink files bottom-up, then rmdir. */
+export async function removeRemoteTree(sftp, p, maxFiles = 2000) {
+  let removed = 0
+  const walk = async (dir) => {
+    if (removed >= maxFiles) return
+    let entries = []
+    try { entries = (await sftp.readdir(dir)) || [] } catch { return }
+    for (const e of entries) {
+      if (removed >= maxFiles) return
+      const name = String(e.filename)
+      if (name === '.' || name === '..') continue
+      const fp = joinRemotePath(dir, name)
+      const isDir = !!(e.attrs && e.attrs.isDirectory && e.attrs.isDirectory())
+      if (isDir) await walk(fp)
+      else {
+        try { await sftp.unlink(fp); removed++ } catch {}
+      }
+    }
+    try { await sftp.rmdir(dir); removed++ } catch { /* already gone or non-empty */ }
+  }
+  await walk(p)
+  return removed
+}
+
+function looksBinary(buf) {
+  const n = Math.min(buf.length, 8192)
+  for (let i = 0; i < n; i++) if (buf[i] === 0) return true
+  return false
+}
+
+/**
+ * Read a remote file for the sidebar/editor. Oversized files use a range read
+ * (`readPartial`) so we never `fastGet` the whole blob onto disk.
+ */
+export async function previewRemoteFile(sftp, target, opts = {}) {
+  const {
+    maxBytes = 256 * 1024,
+    encoding = 'utf-8',
+    decodeBuf = (buf) => buf.toString('utf8'),
+  } = opts
+  const cap = Math.min(Math.max(Number(maxBytes) || 256 * 1024, 1024), 2 * 1024 * 1024)
+  const st = await sftp.stat(target)
+  const mtime = st && typeof st.mtime === 'number' ? st.mtime : 0
+  const size = st && typeof st.size === 'number' ? st.size : 0
+  let buf
+  let truncated = false
+  if (size > cap) {
+    truncated = true
+    if (typeof sftp.readPartial === 'function') {
+      buf = await sftp.readPartial(target, 0, cap)
+    } else {
+      const full = await sftp.readFile(target)
+      buf = full.subarray(0, cap)
+    }
+  } else {
+    buf = await sftp.readFile(target)
+  }
+  if (looksBinary(buf)) {
+    return {
+      ok: true, binary: true, size, mtime,
+      head: buf.slice(0, Math.min(buf.length, 4096)).toString('base64'),
+      truncated,
+    }
+  }
+  let content = decodeBuf(buf, encoding).replace(/\r\n/g, '\n')
+  if (!truncated && content.length > cap) {
+    truncated = true
+    content = content.slice(0, cap)
+  }
+  if (truncated) content += `\n…[truncated: ${Math.max(0, size - cap)} more bytes]`
+  return { ok: true, binary: false, content, truncated, size, mtime }
+}