Initial commit: DashCaddy v1.0
Full codebase including API server (32 modules + routes), dashboard frontend, DashCA certificate distribution, installer script, and deployment skills.
This commit is contained in:
209
dashcaddy-api/startup-validator.js
Normal file
209
dashcaddy-api/startup-validator.js
Normal file
@@ -0,0 +1,209 @@
|
||||
/**
|
||||
* Startup Validation Module
|
||||
* Extracts startup configuration validation and health checker sync from server.js
|
||||
* (Phase 3 refactoring)
|
||||
*/
|
||||
|
||||
const fs = require('fs');
|
||||
const fsp = require('fs').promises;
|
||||
const path = require('path');
|
||||
const http = require('http');
|
||||
const https = require('https');
|
||||
const { exists, isAccessible } = require('./fs-helpers');
|
||||
|
||||
/**
|
||||
* Validate startup configuration and environment.
|
||||
* Fail fast with clear error messages if critical issues are found.
|
||||
*
|
||||
* @param {Object} deps
|
||||
* @param {Function} deps.log - structured logger
|
||||
* @param {string} deps.CADDYFILE_PATH
|
||||
* @param {string} deps.SERVICES_FILE
|
||||
* @param {string} deps.CONFIG_FILE
|
||||
* @param {string} deps.CADDY_ADMIN_URL
|
||||
* @param {number} deps.PORT
|
||||
*/
|
||||
async function validateStartupConfig({ log, CADDYFILE_PATH, SERVICES_FILE, CONFIG_FILE, CADDY_ADMIN_URL, PORT }) {
|
||||
const errors = [];
|
||||
const warnings = [];
|
||||
|
||||
log.info('startup', 'Validating startup configuration...');
|
||||
|
||||
// 1. Check if Caddyfile exists and is writable
|
||||
try {
|
||||
if (await exists(CADDYFILE_PATH)) {
|
||||
if (!(await isAccessible(CADDYFILE_PATH, fs.constants.R_OK | fs.constants.W_OK))) {
|
||||
errors.push(`Caddyfile is not readable/writable: ${CADDYFILE_PATH}`);
|
||||
} else {
|
||||
log.info('startup', 'Caddyfile is accessible', { path: CADDYFILE_PATH });
|
||||
}
|
||||
} else {
|
||||
warnings.push(`Caddyfile does not exist: ${CADDYFILE_PATH} (will be created if needed)`);
|
||||
}
|
||||
} catch (error) {
|
||||
errors.push(`Caddyfile is not readable/writable: ${CADDYFILE_PATH}`);
|
||||
}
|
||||
|
||||
// 2. Check if services file exists or can be created
|
||||
const servicesDir = path.dirname(SERVICES_FILE);
|
||||
try {
|
||||
if (await exists(SERVICES_FILE)) {
|
||||
// Validate it's valid JSON
|
||||
try {
|
||||
const content = await fsp.readFile(SERVICES_FILE, 'utf8');
|
||||
JSON.parse(content);
|
||||
log.info('startup', 'Services file is valid JSON', { path: SERVICES_FILE });
|
||||
} catch (parseError) {
|
||||
errors.push(`Services file exists but contains invalid JSON: ${SERVICES_FILE}`);
|
||||
}
|
||||
} else {
|
||||
// Check if parent directory exists and is writable
|
||||
if (await exists(servicesDir)) {
|
||||
if (!(await isAccessible(servicesDir, fs.constants.W_OK))) {
|
||||
errors.push(`Cannot access services file or directory: ${SERVICES_FILE}`);
|
||||
} else {
|
||||
log.info('startup', 'Services file directory is writable', { path: servicesDir });
|
||||
}
|
||||
} else {
|
||||
errors.push(`Services file directory does not exist: ${servicesDir}`);
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
errors.push(`Cannot access services file or directory: ${SERVICES_FILE}`);
|
||||
}
|
||||
|
||||
// 3. Check if port is available
|
||||
const net = require('net');
|
||||
const portCheckServer = net.createServer();
|
||||
try {
|
||||
portCheckServer.listen(PORT, '0.0.0.0');
|
||||
portCheckServer.close();
|
||||
log.info('startup', `Port ${PORT} is available`);
|
||||
} catch (error) {
|
||||
errors.push(`Port ${PORT} is already in use or cannot be bound`);
|
||||
}
|
||||
|
||||
// 4. Check if config file is valid JSON (if exists)
|
||||
try {
|
||||
if (await exists(CONFIG_FILE)) {
|
||||
const content = await fsp.readFile(CONFIG_FILE, 'utf8');
|
||||
JSON.parse(content);
|
||||
log.info('startup', 'Config file is valid JSON', { path: CONFIG_FILE });
|
||||
} else {
|
||||
log.warn('startup', 'Config file does not exist (will use defaults)', { path: CONFIG_FILE });
|
||||
}
|
||||
} catch (error) {
|
||||
errors.push(`Config file exists but contains invalid JSON: ${CONFIG_FILE}`);
|
||||
}
|
||||
|
||||
// 5. Check Caddy admin API reachability (warning only, not critical)
|
||||
const checkCaddyAdmin = () => {
|
||||
return new Promise((resolve) => {
|
||||
const urlObj = new URL(CADDY_ADMIN_URL);
|
||||
const client = urlObj.protocol === 'https:' ? https : http;
|
||||
|
||||
const req = client.request({
|
||||
hostname: urlObj.hostname,
|
||||
port: urlObj.port,
|
||||
path: '/config/',
|
||||
method: 'GET',
|
||||
timeout: 2000
|
||||
}, (res) => {
|
||||
resolve(res.statusCode >= 200 && res.statusCode < 500);
|
||||
});
|
||||
|
||||
req.on('error', () => resolve(false));
|
||||
req.on('timeout', () => {
|
||||
req.destroy();
|
||||
resolve(false);
|
||||
});
|
||||
req.end();
|
||||
});
|
||||
};
|
||||
|
||||
// Run async Caddy check (don't block startup)
|
||||
checkCaddyAdmin().then(isReachable => {
|
||||
if (isReachable) {
|
||||
log.info('startup', 'Caddy admin API is reachable', { url: CADDY_ADMIN_URL });
|
||||
} else {
|
||||
log.warn('startup', 'Caddy admin API is not reachable (may start later)', { url: CADDY_ADMIN_URL });
|
||||
}
|
||||
});
|
||||
|
||||
// Print warnings
|
||||
if (warnings.length > 0) {
|
||||
warnings.forEach(warning => log.warn('startup', warning));
|
||||
}
|
||||
|
||||
// Fail fast if there are critical errors
|
||||
if (errors.length > 0) {
|
||||
errors.forEach(err => log.error('startup', err));
|
||||
log.error('startup', 'Cannot start server — fix the above errors and try again');
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
log.info('startup', 'Startup configuration validation passed');
|
||||
}
|
||||
|
||||
/**
|
||||
* Auto-configure health checker from services.json + top-card services.
|
||||
*
|
||||
* @param {Object} deps
|
||||
* @param {Function} deps.log - structured logger
|
||||
* @param {string} deps.SERVICES_FILE
|
||||
* @param {Object} deps.servicesStateManager - StateManager instance
|
||||
* @param {Object} deps.healthChecker - health checker module
|
||||
* @param {Function} deps.buildDomain - builds domain from subdomain
|
||||
* @param {Object} deps.APP - app constants (USER_AGENTS)
|
||||
*/
|
||||
async function syncHealthCheckerServices({ log, SERVICES_FILE, servicesStateManager, healthChecker, buildDomain, APP }) {
|
||||
try {
|
||||
const topCardServices = [
|
||||
{ id: 'dns1', name: 'DNS1' },
|
||||
{ id: 'dns2', name: 'DNS2' },
|
||||
{ id: 'internet', name: 'Internet' },
|
||||
];
|
||||
|
||||
let appServices = [];
|
||||
if (await exists(SERVICES_FILE)) {
|
||||
const data = await servicesStateManager.read();
|
||||
appServices = Array.isArray(data) ? data : data.services || [];
|
||||
}
|
||||
|
||||
const allServices = [...topCardServices, ...appServices];
|
||||
const configuredIds = new Set(Object.keys(healthChecker.config.services || {}));
|
||||
let added = 0;
|
||||
|
||||
for (const svc of allServices) {
|
||||
const id = svc.id || svc.name?.toLowerCase();
|
||||
if (!id || configuredIds.has(id)) continue;
|
||||
|
||||
let url;
|
||||
if (id === 'internet') {
|
||||
url = 'https://www.google.com';
|
||||
} else if (svc.isExternal && svc.externalUrl) {
|
||||
url = svc.externalUrl;
|
||||
} else {
|
||||
url = `https://${buildDomain(id)}`;
|
||||
}
|
||||
|
||||
healthChecker.configureService(id, {
|
||||
name: svc.name || id,
|
||||
url,
|
||||
method: 'HEAD',
|
||||
timeout: 5000,
|
||||
expectedStatusCodes: [200, 201, 204, 301, 302, 303, 307, 308, 401, 403],
|
||||
headers: { 'User-Agent': APP.USER_AGENTS.HEALTH },
|
||||
});
|
||||
added++;
|
||||
}
|
||||
|
||||
if (added > 0) {
|
||||
log.info('health', 'Auto-configured services from services.json', { count: added });
|
||||
}
|
||||
} catch (error) {
|
||||
log.error('health', 'Error syncing services', { error: error.message });
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { validateStartupConfig, syncHealthCheckerServices };
|
||||
Reference in New Issue
Block a user