openchamber/packages/web/server/lib/dev-servers/parse.js

/**
 * Parsers for listening-socket enumeration.
 *
 * Two platforms, two formats, one shape out. Both parsers are pure so the
 * fiddly parts — grouped records, IPv6 brackets, wildcard binds — are covered
 * by tests instead of by running the tools.
 */

/** Hosts that mean "this machine" when a socket reports its bind address. */
const LOOPBACK_TOKENS = new Set(['127.0.0.1', 'localhost', '[::1]', '::1']);
/** Wildcard binds are reachable over loopback too. */
const WILDCARD_TOKENS = new Set(['*', '0.0.0.0', '[::]', '::']);

/**
 * Ports that are listening but are never the thing a user wants to preview.
 * Kept deliberately short: guessing too aggressively hides real dev servers.
 */
const IGNORED_PORTS = new Set([
  22,    // ssh
  53,    // dns
  445,   // smb
  631,   // cups
  5432,  // postgres
  3306,  // mysql
  6379,  // redis
  27017, // mongodb
  9229,  // node inspector
]);

const splitHostPort = (value) => {
  const raw = String(value || '').trim();
  if (!raw) return null;

  // IPv6 arrives bracketed: [::1]:5173
  if (raw.startsWith('[')) {
    const close = raw.indexOf(']');
    if (close === -1) return null;
    const host = raw.slice(0, close + 1);
    const rest = raw.slice(close + 1);
    if (!rest.startsWith(':')) return null;
    return { host, port: rest.slice(1) };
  }

  const separator = raw.lastIndexOf(':');
  if (separator === -1) return null;
  return { host: raw.slice(0, separator), port: raw.slice(separator + 1) };
};

const toPort = (value) => {
  const port = Number.parseInt(String(value || '').trim(), 10);
  return Number.isInteger(port) && port > 0 && port <= 65535 ? port : null;
};

/**
 * True when a bind address can be reached from this machine over loopback.
 * A socket bound to a specific LAN address only is intentionally excluded:
 * `http://localhost:<port>` would not reach it.
 */
export const isLocallyReachableHost = (host) => {
  const value = String(host || '').trim().toLowerCase();
  return LOOPBACK_TOKENS.has(value) || WILDCARD_TOKENS.has(value);
};

const isIgnoredDevPort = (port) => IGNORED_PORTS.has(port);

/**
 * Parses `lsof -iTCP -sTCP:LISTEN -P -n -F pcn`.
 *
 * The `-F` format emits one field per line, prefixed by a letter, and is
 * stateful: `p`/`c` lines open a process record and every following `n` line
 * belongs to it until the next `p`. A single process commonly reports the same
 * port twice (IPv4 and IPv6), so results are de-duplicated by port.
 */
export const parseLsofListeners = (output) => {
  const byPort = new Map();
  let pid = null;
  let command = '';

  for (const line of String(output || '').split('\n')) {
    if (!line) continue;
    const tag = line[0];
    const value = line.slice(1);

    if (tag === 'p') {
      const parsedPid = Number.parseInt(value, 10);
      pid = Number.isInteger(parsedPid) ? parsedPid : null;
      command = '';
      continue;
    }
    if (tag === 'c') {
      command = value.trim();
      continue;
    }
    if (tag !== 'n') continue;

    // `n` values look like `*:5173`, `127.0.0.1:5173`, or `[::1]:5173`.
    // Established sockets contain `->`; LISTEN filtering should exclude them,
    // but the guard keeps a mixed invocation honest.
    if (value.includes('->')) continue;

    const parsed = splitHostPort(value);
    if (!parsed) continue;
    const port = toPort(parsed.port);
    if (port === null) continue;
    if (!isLocallyReachableHost(parsed.host)) continue;

    const existing = byPort.get(port);
    if (existing && existing.pid !== null) continue;
    byPort.set(port, { port, pid, command });
  }

  return [...byPort.values()].sort((left, right) => left.port - right.port);
};

/**
 * Parses `netstat -ano -p TCP` on Windows, where no per-process command name is
 * available without a second call; `command` stays empty and callers fall back
 * to the port alone.
 */
export const parseNetstatListeners = (output) => {
  const byPort = new Map();

  for (const line of String(output || '').split('\n')) {
    const parts = line.trim().split(/\s+/);
    if (parts.length < 4) continue;
    if (!/^tcp$/i.test(parts[0])) continue;
    if (!/^LISTENING$/i.test(parts[3])) continue;

    const parsed = splitHostPort(parts[1]);
    if (!parsed) continue;
    const port = toPort(parsed.port);
    if (port === null) continue;
    if (!isLocallyReachableHost(parsed.host)) continue;

    const pid = Number.parseInt(parts[4] ?? '', 10);
    if (byPort.has(port)) continue;
    byPort.set(port, { port, pid: Number.isInteger(pid) ? pid : null, command: '' });
  }

  return [...byPort.values()].sort((left, right) => left.port - right.port);
};

/**
 * Narrows raw listeners to the ones worth offering as a preview target.
 *
 * `ownPorts` removes OpenChamber's own listeners — offering the user a preview
 * of the app they are already looking at is pure noise.
 */
export const selectDevServerCandidates = (listeners, { ownPorts = [], ownPids = [] } = {}) => {
  const excludedPorts = new Set(ownPorts.filter((port) => Number.isInteger(port)));
  const excludedPids = new Set(ownPids.filter((pid) => Number.isInteger(pid)));

  return listeners.filter((entry) => {
    if (excludedPorts.has(entry.port)) return false;
    if (entry.pid !== null && excludedPids.has(entry.pid)) return false;
    if (isIgnoredDevPort(entry.port)) return false;
    return true;
  });
};

/** Linux reports LISTEN as state 0A in /proc/net/tcp. */
const PROC_STATE_LISTEN = '0A';
/** Wildcard binds, as /proc writes them: IPv4 0.0.0.0 and IPv6 :: */
const PROC_WILDCARD_ADDRESSES = new Set(['00000000', '00000000000000000000000000000000']);
/** Loopback: 127.0.0.1 (little-endian per word) and ::1 */
const PROC_LOOPBACK_ADDRESSES = new Set(['0100007F', '00000000000000000000000001000000']);

/**
 * Parses `/proc/net/tcp` and `/proc/net/tcp6`.
 *
 * The fallback for hosts without `lsof`, which is most containers — and a
 * deployed OpenChamber is exactly where a dev server needs discovering. Reads a
 * kernel file rather than shelling out, so it cannot be defeated by a missing
 * binary or a stripped PATH.
 *
 * No process name or pid: mapping a socket to its owner means walking every
 * /proc/<pid>/fd, which is far more work than the label is worth.
 */
export const parseProcNetTcpListeners = (output) => {
  const byPort = new Map();

  for (const line of String(output || '').split('\n')) {
    const parts = line.trim().split(/\s+/);
    // sl, local_address, rem_address, st, ...
    if (parts.length < 4) continue;
    if (parts[3] !== PROC_STATE_LISTEN) continue;

    const [address, portHex] = String(parts[1] || '').split(':');
    if (!address || !portHex) continue;

    const normalizedAddress = address.toUpperCase();
    if (!PROC_WILDCARD_ADDRESSES.has(normalizedAddress) && !PROC_LOOPBACK_ADDRESSES.has(normalizedAddress)) {
      continue;
    }

    const port = Number.parseInt(portHex, 16);
    if (!Number.isInteger(port) || port <= 0 || port > 65535) continue;
    if (byPort.has(port)) continue;
    byPort.set(port, { port, pid: null, command: '' });
  }

  return [...byPort.values()].sort((left, right) => left.port - right.port);
};