An open source, self-hosted, real-time port monitoring and discovery tool.
Feature/random generator (#66)
Mostafa Wahiedbab42c5148ce
diff --git a/CHANGELOG.md b/CHANGELOG.mdindex cbf369c..d358c61 100644--- a/CHANGELOG.md+++ b/CHANGELOG.md@@ -2,7 +2,7 @@All notable changes to portracker will be documented in this file.-## [Unreleased]+## [1.2.0] - 2025-11-20### Security@@ -14,6 +14,7 @@ All notable changes to portracker will be documented in this file.### Dashboard- **Auto-Refresh**: Added a toggle to auto-refresh ports and services every 30 seconds+- **Random Port Generator**: Generate an unused port with a single click## [1.1.1] - 2025-01-17diff --git a/backend/collectors/truenas_collector.js b/backend/collectors/truenas_collector.jsindex 87aa126..ee867f2 100644--- a/backend/collectors/truenas_collector.js+++ b/backend/collectors/truenas_collector.js@@ -65,6 +65,20 @@ class TrueNASCollector extends BaseCollector {};}+ /**+ * Return only ports (used for quick port generation flows)+ * @returns {Promise<Array>} List of port entries+ */+ async getPorts() {+ try {+ const full = await this.collect();+ return full?.ports || [];+ } catch (err) {+ this.logError("Error collecting ports in getPorts:", err.message, err.stack);+ throw err;+ }+ }+/*** Initialize Docker API (async initialization)* @privatediff --git a/backend/index.js b/backend/index.jsindex f290eb1..a75b856 100644--- a/backend/index.js+++ b/backend/index.js@@ -18,6 +18,7 @@ const fetch = (...args) => (globalThis.fetch ? globalThis.fetch(...args) : imporconst { Logger } = require('./lib/logger');const DockerAPIClient = require('./lib/docker-api');const { createCollector, detectCollector } = require('./collectors');+const net = require('net');const db = require('./db');const https = require("https");const os = require("os");@@ -31,6 +32,10 @@ const dockerApi = new DockerAPIClient();const { SimpleTTLCache } = require('./utils/cache');const responseCache = new SimpleTTLCache();const RESP_TTL_PORTS = parseInt(process.env.ENDPOINT_CACHE_PORTS_TTL_MS || '3000', 10);+const PORT_SUGGEST_MIN = parseInt(process.env.GENERATE_PORT_MIN || '30000', 10);+const PORT_SUGGEST_MAX = parseInt(process.env.GENERATE_PORT_MAX || '60999', 10);+const PORT_SUGGEST_BIND_HOST = process.env.GENERATE_PORT_BIND_HOST || '0.0.0.0';+const PORT_SUGGEST_MAX_RANDOM_ATTEMPTS = 60;if (isAuthEnabled()) {logger.info('Authentication is ENABLED - Login required for dashboard access');@@ -744,6 +749,144 @@ async function getLocalPortsUsingCollectors(options = {}) {}}+function getPortRangeForSuggestion() {+ const floor = 1024;+ const ceiling = 65535;+ let min = Number.isInteger(PORT_SUGGEST_MIN) ? PORT_SUGGEST_MIN : 30000;+ let max = Number.isInteger(PORT_SUGGEST_MAX) ? PORT_SUGGEST_MAX : 60999;++ if (min < floor) min = floor;+ if (max > ceiling) max = ceiling;+ if (min >= max) {+ min = 30000;+ max = 60999;+ }+ return { min, max };+}++function buildReservedPortSet() {+ const reserved = new Set();+ Object.keys(WELL_KNOWN_PORTS).forEach((p) => {+ const num = parseInt(p, 10);+ if (!Number.isNaN(num)) reserved.add(num);+ });+ const appPort = parseInt(process.env.PORT || "3000", 10);+ if (!Number.isNaN(appPort)) reserved.add(appPort);+ [3000, 3001, 5173, 8080, 8443].forEach((p) => reserved.add(p));+ return reserved;+}++function getUsedPortsFromEntries(entries) {+ const set = new Set();+ (entries || []).forEach((entry) => {+ const hp = parseInt(entry.host_port, 10);+ if (!Number.isNaN(hp) && hp > 0) {+ set.add(hp);+ }+ });+ return set;+}++function testTcpPortAvailable(port, host = PORT_SUGGEST_BIND_HOST, timeoutMs = 750) {+ return new Promise((resolve) => {+ const server = net.createServer();+ let resolved = false;+ const finish = (result) => {+ if (resolved) return;+ resolved = true;+ server.close(() => resolve(result));+ };++ const timer = setTimeout(() => finish(false), timeoutMs);++ server.once("error", () => {+ clearTimeout(timer);+ finish(false);+ });++ server.listen({ port, host, exclusive: true }, () => {+ clearTimeout(timer);+ finish(true);+ });+ });+}++function reservePortsAndMerge(reserved, used) {+ for (const p of reserved) {+ used.add(p);+ }+}++async function generateUnusedPortWithSet(usedPortsInput, { bindCheck = false, method = "scan-only" } = {}) {+ const { min, max } = getPortRangeForSuggestion();+ const reservedPorts = buildReservedPortSet();+ const usedPorts = new Set(usedPortsInput || []);+ reservePortsAndMerge(reservedPorts, usedPorts);++ const rangeSize = max - min + 1;+ if (rangeSize <= 0) {+ throw new Error("Invalid port range for generation");+ }++ const seen = new Set();+ const attemptLimit = Math.min(rangeSize, PORT_SUGGEST_MAX_RANDOM_ATTEMPTS);++ const isCandidateFree = async (candidate) => {+ if (usedPorts.has(candidate)) return false;+ if (!bindCheck) return true;+ return testTcpPortAvailable(candidate);+ };++ for (let i = 0; i < attemptLimit; i++) {+ const candidate = min + Math.floor(Math.random() * rangeSize);+ if (seen.has(candidate)) continue;+ seen.add(candidate);++ if (await isCandidateFree(candidate)) {+ return {+ port: candidate,+ meta: {+ range: { min, max },+ attempts: i + 1,+ method,+ bindHost: PORT_SUGGEST_BIND_HOST,+ checkedPorts: Array.from(seen.values()),+ usedCount: usedPorts.size,+ },+ };+ }+ }++ for (let candidate = min; candidate <= max; candidate++) {+ if (await isCandidateFree(candidate)) {+ return {+ port: candidate,+ meta: {+ range: { min, max },+ attempts: attemptLimit + (candidate - min + 1),+ method,+ bindHost: PORT_SUGGEST_BIND_HOST,+ checkedPorts: Array.from(seen.values()).concat(candidate),+ usedCount: usedPorts.size,+ },+ };+ }+ }++ throw new Error("No available port found in the configured range");+}++async function generateUnusedPortLocal({ debug = false, bindCheck = true } = {}) {+ const ports = await getLocalPortsUsingCollectors({ debug });+ const usedPorts = getUsedPortsFromEntries(ports);+ return generateUnusedPortWithSet(usedPorts, { bindCheck, method: bindCheck ? "scan+bind" : "scan-only" });+}++async function generateUnusedPortFromPortList(portEntries, { bindCheck = false, method = "scan-only" } = {}) {+ const usedPorts = getUsedPortsFromEntries(portEntries || []);+ return generateUnusedPortWithSet(usedPorts, { bindCheck, method });+}+/*** New endpoint to scan a server with the appropriate collector*/@@ -901,6 +1044,99 @@ app.get("/api/servers/:id/scan", async (req, res) => {}});+/**+ * Generate an unused TCP port for the given server.+ * - For local: uses collectors to find used ports, excludes well-known/reserved, then validates with a TCP bind test.+ * - For peers: forwards the request to the peer's /api/servers/local/generate-port endpoint.+ */+app.post("/api/servers/:id/generate-port", async (req, res) => {+ const serverId = req.params.id;+ const currentDebug = req.query.debug === "true" || process.env.DEBUG === 'true';+ if (Object.prototype.hasOwnProperty.call(req.query, 'debug')) logger.setDebugEnabled(currentDebug);++ try {+ const server = db.prepare("SELECT * FROM servers WHERE id = ?").get(serverId);+ if (!server) {+ return res.status(404).json({ error: "Server not found" });+ }++ if (serverId === "local") {+ const suggestion = await generateUnusedPortLocal({ debug: currentDebug, bindCheck: true });+ return res.json({+ port: suggestion.port,+ meta: suggestion.meta,+ });+ }++ if (server.type === "peer" && server.url) {+ const peerUrl = new URL("/api/servers/local/generate-port", server.url).href;+ const controller = new AbortController();+ const timeoutId = setTimeout(() => controller.abort(), 15000);++ try {+ const peerResponse = await fetch(peerUrl, { method: "POST", signal: controller.signal });+ clearTimeout(timeoutId);++ if (peerResponse.ok) {+ const payload = await peerResponse.json();+ return res.json(payload);+ }++ if (peerResponse.status === 404 || peerResponse.status === 405 || peerResponse.status === 501) {+ logger.warn(`[generate-port] Peer ${server.label} missing generate endpoint, falling back to scan.`);+ try {+ const scanUrl = new URL("/api/servers/local/scan", server.url).href;+ const scanResponse = await fetch(scanUrl, { method: "GET", signal: controller.signal });++ if (scanResponse.ok) {+ const scanData = await scanResponse.json();+ const suggestion = await generateUnusedPortFromPortList(scanData?.ports || [], { bindCheck: false, method: "scan-only-peer-fallback" });+ return res.json({+ port: suggestion.port,+ meta: {+ ...suggestion.meta,+ fallbackUsed: true,+ fallbackReason: "peer-generate-port-missing",+ },+ });+ }+ } catch (fallbackError) {+ logger.warn(`[generate-port] Peer scan fallback failed for ${server.label}: ${fallbackError.message}`);+ }+ }++ const body = await peerResponse.text().catch(() => "");+ return res.status(peerResponse.status).json({+ error: "Peer port generation failed",+ details: body || `Status ${peerResponse.status}`,+ });+ } catch (err) {+ clearTimeout(timeoutId);+ const errMsg = err.name === "AbortError" ? "Peer request timed out" : err.message;+ logger.error(`[generate-port] Failed to reach peer ${server.label} (${server.url}): ${errMsg}`);+ return res.status(502).json({+ error: "Failed to reach peer for port generation",+ details: errMsg,+ });+ }+ }++ return res.status(501).json({+ error: "Port generation not supported for this server type",+ server_id: serverId,+ });+ } catch (error) {+ logger.error(`Error in POST /api/servers/${serverId}/generate-port: ${error.message}`);+ logger.debug("Stack trace:", error.stack || "");+ return res.status(500).json({+ error: "Failed to generate port",+ details: error.message,+ });+ } finally {+ if (Object.prototype.hasOwnProperty.call(req.query, 'debug')) logger.setDebugEnabled(BASE_DEBUG);+ }+});+function validateServerInput(req, res, next) {const { label, url, type, platform_type } = req.body;if (!label || typeof label !== "string" || label.trim().length === 0) {diff --git a/backend/package.json b/backend/package.jsonindex 62bed22..f19d6b2 100644--- a/backend/package.json+++ b/backend/package.json@@ -1,6 +1,6 @@{"name": "backend",- "version": "1.1.1",+ "version": "1.2.0","description": "","main": "index.js","scripts": {diff --git a/frontend/package.json b/frontend/package.jsonindex a47370a..51172bb 100644--- a/frontend/package.json+++ b/frontend/package.json@@ -1,7 +1,7 @@{"name": "frontend","private": true,- "version": "1.1.1",+ "version": "1.2.0","type": "module","scripts": {"dev": "vite",diff --git a/frontend/src/App.jsx b/frontend/src/App.jsxindex da5007c..b7202d5 100644--- a/frontend/src/App.jsx+++ b/frontend/src/App.jsx@@ -265,6 +265,7 @@ export default function App() {return false;}});+ const [portSuggestions, setPortSuggestions] = useState({});useEffect(() => {if (isDarkMode) {@@ -351,6 +352,46 @@ export default function App() {}}, [autoRefreshEnabled]);+ const generatePortForServer = useCallback(async (serverId) => {+ setPortSuggestions((prev) => ({+ ...prev,+ [serverId]: { ...(prev[serverId] || {}), loading: true, error: null },+ }));++ try {+ const response = await fetch(`/api/servers/${encodeURIComponent(serverId)}/generate-port`, {+ method: "POST",+ });++ if (!response.ok) {+ const text = await response.text().catch(() => "");+ throw new Error(text || `Failed to generate port (HTTP ${response.status})`);+ }++ const payload = await response.json();+ setPortSuggestions((prev) => ({+ ...prev,+ [serverId]: {+ port: payload.port,+ meta: payload.meta || null,+ generatedAt: Date.now(),+ loading: false,+ error: null,+ },+ }));+ } catch (error) {+ logger.error("Failed to generate unused port:", error);+ setPortSuggestions((prev) => ({+ ...prev,+ [serverId]: {+ ...(prev[serverId] || {}),+ loading: false,+ error: error.message || "Failed to generate port",+ },+ }));+ }+ }, []);+const handleSelectServer = useCallback((serverId) => {setSelectedServer(serverId);if (window.innerWidth < 768) {@@ -515,6 +556,7 @@ export default function App() {const fetchAll = useCallback(async () => {setLoading(true);setError(null);+ setPortSuggestions({});try {const serversResponse = await fetch("/api/servers");@@ -1779,14 +1821,16 @@ export default function App() {onToggleExpanded={() => toggleServerExpanded(server.id)}openAccordionItems={openAccordions[server.id] ?? ["system-info", "vms"]}onAccordionChange={(items) => handleAccordionChange(server.id, items)}- deepLinkContainerId={selectedServer === server.id ? deepLinkContainer : null}- onOpenContainerDetails={(containerId) => handleContainerOpen(server.id, containerId)}- onCloseContainerDetails={handleContainerClose}- selectionMode={selectionMode}- selectedPorts={selectedPorts}- onToggleSelection={togglePortSelection}- onToggleServerSelectionMode={() => toggleServerSelectionMode(server.id)}- onSelectAllPorts={(ports) => selectAllPortsForServer(server.id, ports)}+ deepLinkContainerId={selectedServer === server.id ? deepLinkContainer : null}+ onOpenContainerDetails={(containerId) => handleContainerOpen(server.id, containerId)}+ onCloseContainerDetails={handleContainerClose}+ selectionMode={selectionMode}+ selectedPorts={selectedPorts}+ onToggleSelection={togglePortSelection}+ onToggleServerSelectionMode={() => toggleServerSelectionMode(server.id)}+ onSelectAllPorts={(ports) => selectAllPortsForServer(server.id, ports)}+ portSuggestion={portSuggestions[server.id]}+ onGeneratePort={generatePortForServer}/>);}diff --git a/frontend/src/components/server/ServerSection.jsx b/frontend/src/components/server/ServerSection.jsxindex 1397d0b..e88df54 100644--- a/frontend/src/components/server/ServerSection.jsx+++ b/frontend/src/components/server/ServerSection.jsx@@ -1,4 +1,4 @@-import React, { useMemo, useEffect, useState } from "react";+import React, { useMemo, useEffect, useState, useCallback } from "react";import {ChevronDown,ChevronUp,@@ -14,6 +14,10 @@ import {Info,Lock,CheckSquare,+ Sparkles,+ RefreshCw,+ Copy,+ Check,} from "lucide-react";import { PortCard } from "./PortCard";import { PortGridItem } from "./PortGridItem";@@ -36,6 +40,15 @@ import {DropdownMenuTrigger,} from "@/components/ui/dropdown-menu";import { Tooltip, TooltipContent, TooltipProvider, TooltipTrigger } from "@/components/ui/tooltip";+import { useClipboard } from "@/lib/hooks/useClipboard";+import {+ Dialog,+ DialogContent,+ DialogFooter,+ DialogHeader,+ DialogTitle,+} from "@/components/ui/dialog";+import { Button } from "@/components/ui/button";/*** Renders a comprehensive server overview section, including system information, virtual machines, and port management with sorting, filtering, and multiple layout options.@@ -74,8 +87,15 @@ function ServerSectionComponent({onToggleSelection,onToggleServerSelectionMode,onSelectAllPorts,+ portSuggestion,+ onGeneratePort,}) {const logger = useMemo(() => new Logger('ServerSection'), []);+ const { copiedKey, copy } = useClipboard();+ const suggestionPort = portSuggestion?.port;+ const suggestionLoading = !!portSuggestion?.loading;+ const suggestionError = portSuggestion?.error;+ const [showPortModal, setShowPortModal] = useState(false);const [sortConfig, setSortConfig] = useState(() => {try {@@ -129,6 +149,20 @@ function ServerSectionComponent({return { internal, published, total: list.length };}, [data]);+ const portMood = useMemo(() => {+ const count = visiblePorts.length;+ if (count === 0) {+ return "It's empty in here.";+ }+ if (count < 10) {+ return `Feels lonely with ${count} service${count === 1 ? "" : "s"}.`;+ }+ if (count > 99) {+ return `Hoarder alert: Wow.. ${count} services.`;+ }+ return null;+ }, [visiblePorts.length]);+useEffect(() => {const validKeys = ["default", "host_port", "owner", "created"];let { key, direction } = sortConfig;@@ -146,18 +180,6 @@ function ServerSectionComponent({}, [sortConfig]);- const portMood = useMemo(() => {- const count = visiblePorts.length;- if (count === 0) return null;- if (count < 10) {- return `Feels a bit lonely here, only ${count} service${count === 1 ? "" : "s"} standing watch.`;- }- if (count > 100) {- return `Hoarder alert: ${count} services piled into this host.`;- }- return null;- }, [visiblePorts.length]);-const sortedPorts = useMemo(() => {let sortablePorts = [...visiblePorts];@@ -253,6 +275,22 @@ function ServerSectionComponent({}};+ const handleCopySuggestedPort = useCallback(async () => {+ if (!suggestionPort) return;+ await copy(`suggested-port-${id}`, suggestionPort.toString());+ }, [copy, id, suggestionPort]);++ const handleOpenPortModal = useCallback(() => {+ setShowPortModal(true);+ if (!suggestionPort && !suggestionLoading) {+ onGeneratePort?.(id);+ }+ }, [id, onGeneratePort, suggestionLoading, suggestionPort]);++ const handleRegenerate = useCallback(() => {+ onGeneratePort?.(id);+ }, [id, onGeneratePort]);+return (<div className="space-y-8"><div className="flex items-center gap-3">@@ -371,7 +409,20 @@ function ServerSectionComponent({<div className="p-4 sm:p-6 border-b border-slate-200 dark:border-slate-700/50"><div className="flex flex-col sm:flex-row items-start sm:items-center justify-between gap-4"><h2 className="text-lg font-semibold text-slate-900 dark:text-slate-100 flex items-center">- <Network className="h-5 w-5 mr-2 text-slate-600 dark:text-slate-400" />+ <TooltipProvider>+ <Tooltip>+ <TooltipTrigger asChild>+ <span className="inline-flex">+ <Network className="h-5 w-5 mr-2 text-slate-600 dark:text-slate-400" />+ </span>+ </TooltipTrigger>+ <TooltipContent side="bottom">+ {portMood+ ? portMood+ : `Published: ${counts.published}, Internal: ${counts.internal}${showInternal ? " (showing internal)" : " (hiding internal)"}`}+ </TooltipContent>+ </Tooltip>+ </TooltipProvider>Ports<TooltipProvider><Tooltip>@@ -387,6 +438,30 @@ function ServerSectionComponent({</TooltipProvider></h2><div className="flex items-center justify-start sm:justify-end flex-wrap gap-2">+ <TooltipProvider>+ <Tooltip>+ <TooltipTrigger asChild>+ <button+ onClick={handleOpenPortModal}+ disabled={suggestionLoading}+ className={`inline-flex items-center px-2 sm:px-3 py-2 border rounded-lg text-sm font-medium transition-colors ${+ suggestionLoading+ ? "bg-blue-50 dark:bg-slate-700/40 text-blue-700 dark:text-blue-300 border-blue-200 dark:border-blue-700 cursor-not-allowed"+ : "border-slate-300 dark:border-slate-700 text-slate-700 dark:text-slate-300 bg-white dark:bg-slate-800 hover:bg-slate-50 dark:hover:bg-slate-700"+ }`}+ >+ {suggestionLoading ? (+ <RefreshCw className="h-4 w-4 mr-2 animate-spin" />+ ) : (+ <Sparkles className="h-4 w-4 mr-2" />+ )}+ Generate port+ </button>+ </TooltipTrigger>+ <TooltipContent>Generate an unused port for this server</TooltipContent>+ </Tooltip>+ </TooltipProvider>+<TooltipProvider><Tooltip><TooltipTrigger asChild>@@ -638,11 +713,6 @@ function ServerSectionComponent({)}</div></div>- {portMood && (- <p className="mt-3 text-sm text-slate-500 dark:text-slate-400">- {portMood}- </p>- )}</div>{ok && visiblePorts.length > 0 && (@@ -845,6 +915,73 @@ function ServerSectionComponent({</div>)}+ <Dialog open={showPortModal} onOpenChange={setShowPortModal}>+ <DialogContent>+ <DialogHeader>+ <DialogTitle>Available Port Generator</DialogTitle>+ </DialogHeader>+ <div className="space-y-4 py-2">+ {suggestionLoading && (+ <div className="flex items-center gap-3 text-sm text-slate-600 dark:text-slate-300">+ <RefreshCw className="h-4 w-4 animate-spin" />+ Checking for an available port...+ </div>+ )}++ {suggestionError && !suggestionLoading && (+ <div className="text-sm text-red-600 dark:text-red-400 border border-red-200 dark:border-red-800/60 rounded-md px-3 py-2 bg-red-50 dark:bg-red-900/20">+ {suggestionError}+ </div>+ )}++ {suggestionPort && !suggestionLoading && (+ <div className="space-y-3">+ <div className="flex items-center justify-between gap-3 p-3 rounded-lg border border-slate-200 dark:border-slate-700 bg-slate-50 dark:bg-slate-800/50">+ <span className="text-2xl font-mono font-semibold text-slate-900 dark:text-slate-100">{suggestionPort}</span>+ <TooltipProvider>+ <Tooltip>+ <TooltipTrigger asChild>+ <button+ onClick={handleCopySuggestedPort}+ className="inline-flex items-center justify-center p-2 rounded-md bg-white dark:bg-slate-700 text-slate-600 dark:text-slate-200 border border-slate-200 dark:border-slate-600 hover:bg-slate-50 dark:hover:bg-slate-600 transition-colors"+ >+ {copiedKey === `suggested-port-${id}` ? (+ <Check className="h-4 w-4 text-green-600 dark:text-green-400" />+ ) : (+ <Copy className="h-4 w-4" />+ )}+ </button>+ </TooltipTrigger>+ <TooltipContent>{copiedKey === `suggested-port-${id}` ? "Copied!" : "Copy to clipboard"}</TooltipContent>+ </Tooltip>+ </TooltipProvider>+ </div>+ </div>+ )}+ </div>+ <DialogFooter className="flex flex-col sm:flex-row sm:justify-center sm:space-x-2 space-y-2 sm:space-y-0">+ <div className="flex gap-2">+ <Button variant="outline" onClick={() => setShowPortModal(false)}>+ Close+ </Button>+ <Button onClick={handleRegenerate} disabled={suggestionLoading}>+ {suggestionLoading ? (+ <span className="flex items-center gap-2">+ <RefreshCw className="h-4 w-4 animate-spin" />+ Generating...+ </span>+ ) : (+ <span className="flex items-center gap-2">+ <RefreshCw className="h-4 w-4" />+ Regenerate+ </span>+ )}+ </Button>+ </div>+ </DialogFooter>+ </DialogContent>+ </Dialog>+{hiddenPorts.length > 0 && (<div className="border-t border-slate-200 dark:border-slate-700/50"><HiddenPortsDrawerdiff --git a/frontend/src/index.css b/frontend/src/index.cssindex 5ad4c2e..bcfc06f 100644--- a/frontend/src/index.css+++ b/frontend/src/index.css@@ -3,6 +3,15 @@@custom-variant dark (&:is(.dark *));+button {+ cursor: pointer;+}++button:disabled,+button[aria-disabled="true"] {+ cursor: not-allowed;+}+@theme inline {--radius-sm: calc(var(--radius) - 4px);--radius-md: calc(var(--radius) - 2px);diff --git a/package.json b/package.jsonindex 3eb347f..3290491 100644--- a/package.json+++ b/package.json@@ -1,6 +1,6 @@{"name": "portracker",- "version": "1.1.1",+ "version": "1.2.0","description": "A multi-platform port-tracking dashboard","main": "backend/index.js","scripts": {