socketduct 0.1.15

package/src/edge/tcp-edge.js

@@ -0,0 +1,82 @@
+import {createServer} from "node:net"
+
+import {SocketductSocket} from "../client/socketduct-socket.js"
+
+/**
+ * @typedef {import('../spool/spool-file.js').SessionSpool} SessionSpool
+ * @typedef {import('../client/socketduct-socket.js').SocketductTlsOptions} SocketductTlsOptions
+ * @typedef {object} TcpEdgeOptions
+ * @property {string} [host] - Edge listen host.
+ * @property {number} [port] - Edge listen port.
+ * @property {string} relayHost - Relay host.
+ * @property {number} relayPort - Relay port.
+ * @property {string} token - Auth token.
+ * @property {string} sessionName - Human-readable session name.
+ * @property {{host: string, port: number}} target - Target requested for this session.
+ * @property {SessionSpool} spool - Spool storage.
+ * @property {number} [reconnectDelayMs] - Reconnect delay.
+ * @property {SocketductTlsOptions} [tls] - TLS client options.
+ * @typedef {object} TcpEdgeHandle
+ * @property {import('node:net').Server} server - Edge server.
+ * @property {number} port - Bound edge port.
+ * @property {() => Promise<void>} close - Close function.
+ */
+
+/**
+ * @param {TcpEdgeOptions} options - Edge options.
+ * @returns {Promise<TcpEdgeHandle>} - Started edge server.
+ */
+export async function startTcpEdge(options) {
+  /** @type {Set<SocketductSocket>} */
+  const connections = new Set()
+  const server = createServer((appSocket) => {
+    const socketductSocket = new SocketductSocket(options)
+    connections.add(socketductSocket)
+
+    const closeBoth = () => {
+      connections.delete(socketductSocket)
+      socketductSocket.destroy()
+      appSocket.destroy()
+    }
+
+    appSocket.on("close", closeBoth)
+    appSocket.on("error", closeBoth)
+    socketductSocket.on("close", closeBoth)
+    socketductSocket.on("error", closeBoth)
+
+    appSocket.pipe(socketductSocket).pipe(appSocket)
+    socketductSocket.connect()
+  })
+
+  await new Promise((resolve, reject) => {
+    server.once("error", reject)
+    server.listen(options.port ?? 0, options.host ?? "127.0.0.1", () => {
+      server.off("error", reject)
+      resolve(undefined)
+    })
+  })
+
+  const address = server.address()
+  if (address === null || typeof address === "string") {
+    throw new Error("Edge did not bind to a TCP port")
+  }
+
+  return {
+    server,
+    port: address.port,
+    close: async () => {
+      for (const connection of connections) {
+        connection.destroy()
+      }
+      await new Promise((resolve, reject) => {
+        server.close((error) => {
+          if (error) {
+            reject(error)
+            return
+          }
+          resolve(undefined)
+        })
+      })
+    }
+  }
+}

package/src/index.js

@@ -0,0 +1,101 @@
+import {loadEnvironmentConfig} from "./config/environment.js"
+import {createJsonlFileLogger} from "./logging/structured-logger.js"
+import {startRelayRuntime} from "./server/relay-runtime.js"
+import {startOutboundReverseGatewayRuntime, startReverseHubRuntime} from "./reverse/runtime.js"
+
+export {createSocketductConnectionFactory} from "./client/connect.js"
+export {createJsonlFileLogger, createStructuredLogger} from "./logging/structured-logger.js"
+export {SocketductHttpAgent} from "./client/http-agent.js"
+export {connectSocketduct, SocketductRelayError, SocketductSocket} from "./client/socketduct-socket.js"
+export {createMultiplexedSocketductConnection, MultiplexedSocketductConnection} from "./client/multiplexed-connection.js"
+export {createMultiplexedSocketductTransportSet, MultiplexedSocketductTransportSet, SocketductTransportSetLimitError, SocketductTransportSetNotReadyError, SocketductTransportSetTerminalError} from "./client/multiplexed-transport-set.js"
+export {SocketductSessionLostError, SocketductStreamError, VirtualSocket} from "./client/virtual-socket.js"
+export {createOutboundReverseGateway, createReverseGatewayConnection, OutboundReverseGateway, ReverseGatewayConnection, startReverseGatewayHub} from "./reverse/index.js"
+
+/**
+ * @typedef {object} StartupSummary
+ * @property {'Socketduct'} name - name value.
+ * @property {'node'} runtime - runtime value.
+ * @property {'single-worker'} mode - mode value.
+ */
+
+/** @returns {StartupSummary} - Startup summary. */
+export function getStartupSummary() {
+  return {
+    name: "Socketduct",
+    runtime: "node",
+    mode: "single-worker"
+  }
+}
+
+/**
+ * @returns {Promise<void>} Startup completion promise.
+ */
+async function main() {
+  const config = loadEnvironmentConfig()
+  const logger = config.fileLogging === undefined ? undefined : createJsonlFileLogger({...config.fileLogging, role: config.mode})
+  if (config.mode === "summary") {
+    const summary = getStartupSummary()
+    console.log(`${summary.name} starting in ${summary.mode} mode on ${summary.runtime}`)
+    logger?.log("process.started", {runtimeMode: config.mode})
+    return
+  }
+
+  /** @type {{status: () => object, port?: number}} */
+  let service
+  /** @type {() => Promise<void>} */
+  let closeRuntime
+  if (config.mode === "relay") {
+    const runtime = await startRelayRuntime(config)
+    service = runtime.relay
+    closeRuntime = runtime.close
+  } else if (config.mode === "reverse-hub") {
+    const runtime = await startReverseHubRuntime(config)
+    service = runtime.hub
+    closeRuntime = runtime.close
+  } else {
+    const runtime = await startOutboundReverseGatewayRuntime(config, logger)
+    service = runtime.gateway
+    closeRuntime = runtime.close
+  }
+  const tlsStatus = config.mode === "relay" && config.relayTls === undefined ? "plaintext" : "TLS"
+  console.log(JSON.stringify({
+    event: `${config.mode}.started`,
+    ...(config.mode === "reverse-gateway" ? {gatewayId: config.reverseGatewayId} : {host: config.relayHost, port: service.port}),
+    transportSecurity: tlsStatus,
+    compression: config.mode.startsWith("reverse-") ? "zstd" : config.compression
+  }))
+  logger?.log("process.started", {
+    runtimeMode: config.mode,
+    transportSecurity: tlsStatus,
+    compression: config.mode.startsWith("reverse-") ? "zstd" : config.compression
+  })
+  const statusIntervalMs = config.statusIntervalMs ?? 30_000
+  const statusTimer = statusIntervalMs > 0
+    ? setInterval(() => {
+      const status = service.status()
+      console.log(JSON.stringify({event: `${config.mode}.status`, ...status}))
+      logger?.log("runtime.status", /** @type {Record<string, unknown>} */ (status))
+    }, statusIntervalMs)
+    : undefined
+  statusTimer?.unref()
+
+  const shutdown = () => {
+    if (statusTimer !== undefined) clearInterval(statusTimer)
+    closeRuntime()
+      .then(() => process.exit(0))
+      .catch((error) => {
+        console.error(error)
+        process.exit(1)
+      })
+  }
+  process.once("SIGINT", shutdown)
+  process.once("SIGTERM", shutdown)
+}
+
+if (import.meta.url === `file://${process.argv[1]}`) {
+  main().catch((error) => {
+    console.error(error)
+    process.exit(1)
+  })
+}