@nocobase/cli 2.1.0-alpha.20 → 2.1.0-alpha.21

package/dist/lib/prompt-validators.js

@@ -0,0 +1,184 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { spawn } from 'node:child_process';
+import net from 'node:net';
+const API_BASE_URL_EXAMPLE = 'http://localhost:13000/api';
+const ENV_KEY_PATTERN = /^[A-Za-z0-9]+$/;
+const TCP_PORT_EXAMPLE = '13000';
+export function validateApiBaseUrl(value) {
+    const raw = String(value ?? '').trim();
+    if (raw === '') {
+        return undefined;
+    }
+    let url;
+    try {
+        url = new URL(raw);
+    }
+    catch {
+        return `Enter a valid URL, for example ${API_BASE_URL_EXAMPLE}.`;
+    }
+    if (url.protocol !== 'http:' && url.protocol !== 'https:') {
+        return `URL must start with http:// or https://, for example ${API_BASE_URL_EXAMPLE}.`;
+    }
+    return undefined;
+}
+export function validateEnvKey(value) {
+    const raw = String(value ?? '').trim();
+    if (raw === '') {
+        return undefined;
+    }
+    if (!ENV_KEY_PATTERN.test(raw)) {
+        return 'Use letters and numbers only.';
+    }
+    return undefined;
+}
+function parseTcpPort(value) {
+    const raw = String(value ?? '').trim();
+    if (raw === '') {
+        return undefined;
+    }
+    if (!/^\d+$/.test(raw)) {
+        return undefined;
+    }
+    const port = Number(raw);
+    if (!Number.isInteger(port) || port < 1 || port > 65535) {
+        return undefined;
+    }
+    return port;
+}
+export function validateTcpPort(value) {
+    const raw = String(value ?? '').trim();
+    if (raw === '') {
+        return undefined;
+    }
+    const port = parseTcpPort(raw);
+    if (port === undefined) {
+        return `Enter a valid TCP port between 1 and 65535, for example ${TCP_PORT_EXAMPLE}.`;
+    }
+    return undefined;
+}
+async function canListenOnTcpPort(port) {
+    return await new Promise((resolve) => {
+        const server = net.createServer();
+        const resolveAndCleanup = (result) => {
+            server.removeAllListeners();
+            if (server.listening) {
+                server.close(() => resolve(result));
+            }
+            else {
+                resolve(result);
+            }
+        };
+        server.once('error', () => {
+            resolveAndCleanup(false);
+        });
+        server.once('listening', () => {
+            resolveAndCleanup(true);
+        });
+        server.listen(port, '127.0.0.1');
+    });
+}
+function parseDockerPublishedTcpPorts(output) {
+    const ports = new Set();
+    for (const line of output.split(/\r?\n/)) {
+        for (const segment of line.split(',')) {
+            const match = segment.trim().match(/^(?:.+:)?(\d+)->\d+(?:-\d+)?\/tcp$/i);
+            if (!match) {
+                continue;
+            }
+            const port = Number.parseInt(match[1], 10);
+            if (Number.isInteger(port) && port >= 1 && port <= 65535) {
+                ports.add(port);
+            }
+        }
+    }
+    return ports;
+}
+async function getDockerPublishedTcpPorts() {
+    return await new Promise((resolve) => {
+        let settled = false;
+        const stdoutChunks = [];
+        const finish = (ports) => {
+            if (settled) {
+                return;
+            }
+            settled = true;
+            resolve(ports);
+        };
+        const child = spawn('docker', ['ps', '--format', '{{.Ports}}']);
+        child.stdout?.on('data', (chunk) => {
+            stdoutChunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(String(chunk)));
+        });
+        child.once('error', () => {
+            finish(new Set());
+        });
+        child.once('close', (code) => {
+            if (code !== 0) {
+                finish(new Set());
+                return;
+            }
+            finish(parseDockerPublishedTcpPorts(Buffer.concat(stdoutChunks).toString('utf8')));
+        });
+    });
+}
+async function allocateAvailableTcpPort() {
+    return await new Promise((resolve, reject) => {
+        const server = net.createServer();
+        server.once('error', reject);
+        server.listen(0, '127.0.0.1', () => {
+            const address = server.address();
+            const port = address && typeof address === 'object'
+                ? address.port
+                : undefined;
+            if (!port) {
+                server.close(() => {
+                    reject(new Error('Failed to allocate an available TCP port.'));
+                });
+                return;
+            }
+            server.close((error) => {
+                if (error) {
+                    reject(error);
+                    return;
+                }
+                resolve(String(port));
+            });
+        });
+    });
+}
+export async function findAvailableTcpPort() {
+    const dockerPorts = await getDockerPublishedTcpPorts();
+    for (let attempt = 0; attempt < 10; attempt += 1) {
+        const candidate = await allocateAvailableTcpPort();
+        if (!dockerPorts.has(Number.parseInt(candidate, 10))) {
+            return candidate;
+        }
+    }
+    throw new Error('Failed to allocate an available TCP port that is not already published by Docker.');
+}
+export async function validateAvailableTcpPort(value) {
+    const raw = String(value ?? '').trim();
+    if (raw === '') {
+        return undefined;
+    }
+    const formatError = validateTcpPort(raw);
+    if (formatError) {
+        return formatError;
+    }
+    const port = parseTcpPort(raw);
+    const available = await canListenOnTcpPort(port);
+    if (!available) {
+        return `Port ${port} is already in use. Choose another port.`;
+    }
+    const dockerPorts = await getDockerPublishedTcpPorts();
+    if (dockerPorts.has(port)) {
+        return `Port ${port} is already in use by a Docker container. Choose another port.`;
+    }
+    return undefined;
+}