web_plsql 1.0.0 → 1.3.0

package/src/bin/load-test.js

@@ -1,202 +0,0 @@
-/**
- * @file Load testing CLI tool for web_plsql.
- * This tool simulates parallel traffic to the middleware and provides real-time statistics.
- */
-
-import {performance} from 'node:perf_hooks';
-
-/**
- * @typedef {object} Metrics
- * @property {number} total Total requests made.
- * @property {number} success Number of successful requests (2xx).
- * @property {number} error Number of failed requests.
- * @property {number} minLatency Minimum latency in milliseconds.
- * @property {number} maxLatency Maximum latency in milliseconds.
- * @property {number} sumLatency Sum of all latencies for average calculation.
- * @property {Map<string|number, number>} statusCodes Frequency of status codes.
- */
-
-/** @type {Metrics} */
-const metrics = {
-	total: 0,
-	success: 0,
-	error: 0,
-	minLatency: Number.MAX_SAFE_INTEGER,
-	maxLatency: 0,
-	sumLatency: 0,
-	statusCodes: new Map(),
-};
-
-let stopped = false;
-
-/**
- * Parse CLI arguments.
- * @returns {{ url: string, concurrency: number, duration: number }} Options object.
- */
-function parseArgs() {
-	const args = process.argv.slice(2);
-	const options = {
-		url: '',
-		concurrency: 10,
-		duration: 30,
-	};
-
-	for (let i = 0; i < args.length; i++) {
-		const arg = args[i];
-		const nextArg = args[i + 1] ?? '';
-
-		if (arg === '--url' || arg === '-u') {
-			options.url = nextArg;
-			i++;
-		} else if (arg === '--concurrency' || arg === '-c') {
-			options.concurrency = parseInt(nextArg, 10);
-			i++;
-		} else if (arg === '--duration' || arg === '-d') {
-			options.duration = parseInt(nextArg, 10);
-			i++;
-		}
-	}
-
-	if (!options.url) {
-		console.error('Usage: node src/bin/load-test.js --url <url> [-c concurrency] [-d duration]');
-		process.exit(1);
-	}
-
-	return options;
-}
-
-/**
- * Record a single request's result.
- * @param {boolean} ok Whether the request succeeded.
- * @param {number} latency Latency in milliseconds.
- * @param {number|string} status Status code or error string.
- */
-function recordMetrics(ok, latency, status) {
-	metrics.total++;
-	if (ok) {
-		metrics.success++;
-	} else {
-		metrics.error++;
-	}
-
-	metrics.minLatency = Math.min(metrics.minLatency, latency);
-	metrics.maxLatency = Math.max(metrics.maxLatency, latency);
-	metrics.sumLatency += latency;
-
-	const count = metrics.statusCodes.get(status) ?? 0;
-	metrics.statusCodes.set(status, count + 1);
-}
-
-/**
- * Clear the console and move cursor to the top.
- */
-function clearConsole() {
-	process.stdout.write('\x1b[2J\x1b[0;0H');
-}
-
-/**
- * Render the dashboard.
- * @param {number} elapsed Elapsed time in seconds.
- * @param {number} duration Total duration in seconds.
- * @param {string} url Target URL.
- * @param {number} concurrency Concurrency level.
- */
-function renderDashboard(elapsed, duration, url, concurrency) {
-	clearConsole();
-	const rps = elapsed > 0 ? (metrics.total / elapsed).toFixed(1) : '0.0';
-	const avgLatency = metrics.total > 0 ? (metrics.sumLatency / metrics.total).toFixed(1) : '0.0';
-	const progress = Math.min(100, (elapsed / duration) * 100).toFixed(1);
-	const barWidth = 30;
-	const filledWidth = Math.floor((barWidth * parseFloat(progress)) / 100);
-	const bar = '='.repeat(filledWidth) + '>'.padEnd(barWidth - filledWidth, ' ');
-
-	console.log('\x1b[1m\x1b[36mWeb PL/SQL Load Test\x1b[0m');
-	console.log('='.repeat(40));
-	console.log(`\x1b[33mURL:\x1b[0m         ${url}`);
-	console.log(`\x1b[33mConcurrency:\x1b[0m ${concurrency}`);
-	console.log(`\x1b[33mDuration:\x1b[0m    ${duration}s`);
-	console.log('='.repeat(40));
-	console.log(`\x1b[32mProgress:\x1b[0m    [${bar}] ${progress}% (${elapsed.toFixed(1)}s)`);
-	console.log(`\x1b[32mRPS:\x1b[0m         ${rps}`);
-	console.log(`\x1b[32mTotal:\x1b[0m       ${metrics.total}`);
-	console.log(`\x1b[32mSuccess:\x1b[0m     ${metrics.success}`);
-	console.log(`\x1b[31mErrors:\x1b[0m      ${metrics.error}`);
-	console.log('='.repeat(40));
-	console.log('\x1b[1mLatency (ms)\x1b[0m');
-	console.log(`\x1b[34mAvg:\x1b[0m ${avgLatency.padStart(8)}`);
-	console.log(`\x1b[34mMin:\x1b[0m ${(metrics.minLatency === Number.MAX_SAFE_INTEGER ? 0 : metrics.minLatency).toFixed(1).padStart(8)}`);
-	console.log(`\x1b[34mMax:\x1b[0m ${metrics.maxLatency.toFixed(1).padStart(8)}`);
-	console.log('='.repeat(40));
-
-	if (metrics.statusCodes.size > 0) {
-		console.log('\x1b[1mStatus Codes\x1b[0m');
-		for (const [code, count] of metrics.statusCodes.entries()) {
-			const numericCode = typeof code === 'number' ? code : 0;
-			const color = numericCode >= 200 && numericCode < 300 ? '\x1b[32m' : '\x1b[31m';
-			console.log(`${color}${code}\x1b[0m: ${count}`);
-		}
-	}
-}
-
-/**
- * Worker function to maintain concurrency.
- * @param {string} url The target URL.
- * @param {number} endTime The end time in milliseconds.
- */
-async function runWorker(url, endTime) {
-	while (performance.now() < endTime && !stopped) {
-		const start = performance.now();
-		try {
-			const res = await fetch(url, {
-				signal: AbortSignal.timeout(10000), // 10s timeout
-			});
-			const latency = performance.now() - start;
-			recordMetrics(res.ok, latency, res.status);
-			// Consume body to free up connection
-			await res.arrayBuffer();
-		} catch (err) {
-			const latency = performance.now() - start;
-			const errorName = err instanceof Error ? err.name : 'UnknownError';
-			recordMetrics(false, latency, errorName === 'TimeoutError' ? 'Timeout' : 'NetworkErr');
-		}
-	}
-}
-
-/**
- * Main function.
- */
-async function main() {
-	const options = parseArgs();
-	const startTime = performance.now();
-	const endTime = startTime + options.duration * 1000;
-
-	console.log(`Starting load test on ${options.url}...`);
-
-	// Start workers
-	const workers = Array.from({length: options.concurrency}, () => runWorker(options.url, endTime));
-
-	// Dashboard refresh interval
-	const uiInterval = setInterval(() => {
-		const elapsed = (performance.now() - startTime) / 1000;
-		renderDashboard(elapsed, options.duration, options.url, options.concurrency);
-	}, 200);
-
-	// Handle Ctrl+C
-	process.on('SIGINT', () => {
-		stopped = true;
-		console.log('\nStopping...');
-	});
-
-	await Promise.all(workers);
-	clearInterval(uiInterval);
-
-	// Final render
-	const finalElapsed = (performance.now() - startTime) / 1000;
-	renderDashboard(finalElapsed, options.duration, options.url, options.concurrency);
-	console.log('\n\x1b[1m\x1b[32mTest Complete!\x1b[0m\n');
-}
-
-main().catch((/** @type {unknown} */ err) => {
-	console.error('Fatal error:', err);
-	process.exit(1);
-});

package/src/handler/handlerAdmin.js

@@ -1,198 +0,0 @@
-import express from 'express';
-import fs from 'node:fs';
-import readline from 'node:readline';
-import {AdminContext} from '../server/server.js';
-import {getVersion} from '../version.js';
-
-const version = getVersion();
-import {forceShutdown} from '../util/shutdown.js';
-
-/**
- * @typedef {import('express').Request} Request
- * @typedef {import('express').Response} Response
- * @typedef {import('express').NextFunction} NextFunction
- */
-
-export const handlerAdmin = express.Router();
-
-/**
- * Helper to read last N lines of a file
- * @param {string} filePath - Path to file
- * @param {number} n - Number of lines
- * @returns {Promise<string[]>} - The lines
- */
-const readLastLines = async (filePath, n = 100) => {
-	if (!fs.existsSync(filePath)) {
-		return [];
-	}
-
-	const fileStream = fs.createReadStream(filePath);
-	const rl = readline.createInterface({
-		input: fileStream,
-		crlfDelay: Infinity,
-	});
-
-	/** @type {string[]} */
-	const lines = [];
-	for await (const line of rl) {
-		lines.push(line);
-		if (lines.length > n) {
-			lines.shift();
-		}
-	}
-	return lines;
-};
-
-// GET /api/status
-handlerAdmin.get('/api/status', (_req, res) => {
-	const uptime = (new Date().getTime() - AdminContext.startTime.getTime()) / 1000;
-
-	const poolStats = AdminContext.pools.map((pool, index) => {
-		const name = AdminContext.caches[index]?.poolName ?? `pool-${index}`;
-		const p = /** @type {import('oracledb').Pool & {getStatistics?: () => Record<string, unknown>}} */ (pool);
-		return {
-			name,
-			stats: typeof p.getStatistics === 'function' ? p.getStatistics() : null,
-			connectionsOpen: pool.connectionsOpen,
-			connectionsInUse: pool.connectionsInUse,
-		};
-	});
-
-	const memUsage = process.memoryUsage();
-	const cpuUsage = process.cpuUsage();
-
-	res.json({
-		version,
-		status: AdminContext.paused ? 'paused' : 'running',
-		uptime,
-		startTime: AdminContext.startTime,
-		metrics: {
-			...AdminContext.metrics,
-			avgResponseTime: AdminContext.metrics.requestCount > 0 ? AdminContext.metrics.totalDuration / AdminContext.metrics.requestCount : 0,
-		},
-		pools: poolStats,
-		system: {
-			nodeVersion: process.version,
-			platform: process.platform,
-			arch: process.arch,
-			memory: {
-				rss: memUsage.rss,
-				heapTotal: memUsage.heapTotal,
-				heapUsed: memUsage.heapUsed,
-				external: memUsage.external,
-			},
-			cpu: {
-				user: cpuUsage.user,
-				system: cpuUsage.system,
-			},
-		},
-		config: AdminContext.config
-			? {
-					...AdminContext.config,
-					adminPassword: AdminContext.config.adminPassword ? '********' : undefined,
-					routePlSql: AdminContext.config.routePlSql.map((p) => ({
-						...p,
-						password: '********',
-					})),
-				}
-			: null,
-	});
-});
-
-// GET /api/logs/error
-handlerAdmin.get('/api/logs/error', async (req, res) => {
-	try {
-		const limit = Number(req.query.limit) || 100;
-		const logFile = 'error.json.log';
-		const lines = await readLastLines(logFile, limit);
-
-		/** @type {Record<string, unknown>[]} */
-		const logs = [];
-		for (const line of lines) {
-			try {
-				const parsed = /** @type {unknown} */ (JSON.parse(line));
-				if (parsed && typeof parsed === 'object') {
-					logs.push(/** @type {Record<string, unknown>} */ (parsed));
-				}
-			} catch (e) {
-				// ignore
-			}
-		}
-
-		res.json(logs.reverse());
-	} catch (err) {
-		res.status(500).json({error: String(err)});
-	}
-});
-
-// GET /api/logs/access
-handlerAdmin.get('/api/logs/access', async (req, res) => {
-	try {
-		const limit = Number(req.query.limit) || 100;
-		const logFile = AdminContext.config?.loggerFilename ?? 'access.log';
-
-		if (!AdminContext.config?.loggerFilename) {
-			res.json({message: 'Access logging not enabled'});
-			return;
-		}
-
-		const lines = await readLastLines(logFile, limit);
-		res.json(lines.reverse());
-	} catch (err) {
-		res.status(500).json({error: String(err)});
-	}
-});
-
-// GET /api/cache
-handlerAdmin.get('/api/cache', (_req, res) => {
-	const caches = AdminContext.caches.map((c) => ({
-		poolName: c.poolName,
-		procedureNameCache: {
-			size: c.procedureNameCache.keys().length,
-			stats: c.procedureNameCache.getStats(),
-		},
-		argumentCache: {
-			size: c.argumentCache.keys().length,
-			stats: c.argumentCache.getStats(),
-		},
-	}));
-	res.json(caches);
-});
-
-// POST /api/cache/clear
-handlerAdmin.post('/api/cache/clear', (req, res) => {
-	const body = /** @type {unknown} */ (req.body);
-	const poolName = body && typeof body === 'object' && 'poolName' in body && typeof body.poolName === 'string' ? body.poolName : undefined;
-
-	let cleared = 0;
-	AdminContext.caches.forEach((c) => {
-		if (!poolName || c.poolName === poolName) {
-			c.procedureNameCache.clear();
-			cleared++;
-			c.argumentCache.clear();
-			cleared++;
-		}
-	});
-
-	res.json({message: `Cleared ${cleared} caches`});
-});
-
-// POST /api/server/:action
-handlerAdmin.post('/api/server/:action', (req, res) => {
-	const action = req.params.action;
-
-	if (action === 'stop') {
-		res.json({message: 'Server shutting down...'});
-		setTimeout(() => {
-			forceShutdown();
-		}, 100);
-	} else if (action === 'pause') {
-		AdminContext.paused = true;
-		res.json({message: 'Server paused', status: 'paused'});
-	} else if (action === 'resume') {
-		AdminContext.paused = false;
-		res.json({message: 'Server resumed', status: 'running'});
-	} else {
-		res.status(400).json({error: 'Invalid action'});
-	}
-});

package/src/handler/handlerLogger.js

@@ -1,21 +0,0 @@
-import debugModule from 'debug';
-const debug = debugModule('webplsql:handlerLogger');
-
-import fs from 'node:fs';
-import path from 'node:path';
-import morgan from 'morgan';
-
-/**
- * @typedef {import('express').RequestHandler} RequestHandler
- */
-
-/**
- * Create the upload middleware.
- * @param {string} filename - Output filename.
- * @returns {RequestHandler} - Request handler.
- */
-export const handlerLogger = (filename) => {
-	debug('register');
-
-	return morgan('combined', {stream: fs.createWriteStream(path.join(process.cwd(), filename), {flags: 'a'})});
-};

package/src/handler/handlerMetrics.js

@@ -1,68 +0,0 @@
-import debugModule from 'debug';
-const debug = debugModule('webplsql:handlerMetrics');
-
-/**
- * @typedef {import('express').RequestHandler} RequestHandler
- */
-
-/**
- * @typedef {object} metricsType
- * @property {Date} started - When was the server started.
- * @property {number} totalRequests - Total number of requests.
- * @property {number} totalRequestDuration - Total amount of time in ms in request.
- * @property {number} minRequestDuration - Min amount of time in ms in request.
- * @property {number} maxRequestDuration - Max amount of time in ms in request.
- */
-
-/**
- * Convert hrtime to ms.
- * @param {[number, number]} hrtime - Time
- * @returns {number} Millisecoinds.
- */
-const hrtime2ms = (hrtime) => hrtime[0] * 1000 + hrtime[1] / 1_000_000;
-
-/**
- * metrics initializer.
- * @returns {metricsType} The metrics.
- */
-export const initMetrics = () => {
-	return {
-		started: new Date(),
-		totalRequests: 0,
-		totalRequestDuration: 0,
-		minRequestDuration: -1,
-		maxRequestDuration: -1,
-	};
-};
-
-/**
- * The metrics handler.
- * @param {metricsType} metrics - the nmetrics.
- * @returns {RequestHandler} - Request handler.
- */
-export const handlerMetrics = (metrics) => {
-	debug('register');
-
-	return (req, res, next) => {
-		metrics.totalRequests++;
-
-		const start = hrtime2ms(process.hrtime());
-		res.on('finish', () => {
-			const duration = hrtime2ms(process.hrtime()) - start;
-
-			metrics.totalRequestDuration += duration;
-			if (metrics.minRequestDuration < 0 || duration < metrics.minRequestDuration) {
-				metrics.minRequestDuration = duration;
-			}
-			if (metrics.maxRequestDuration < 0 || duration > metrics.maxRequestDuration) {
-				metrics.maxRequestDuration = duration;
-			}
-
-			if (debug.enabled) {
-				debug(`Request to ${req.params?.name} ${req.url} took ${duration.toFixed(3)}ms`);
-			}
-		});
-
-		next();
-	};
-};

package/src/handler/handlerUpload.js

@@ -1,26 +0,0 @@
-import multer from 'multer';
-
-/**
- * @typedef {import('express').RequestHandler} RequestHandler
- * @typedef {import('express').Response} Response
- * @typedef {import('express').NextFunction} NextFunction
- * @typedef {import('oracledb').Pool} Pool
- * @typedef {import('../types.js').environmentType} environmentType
- * @typedef {import('../types.js').configType} configType
- */
-
-/**
- * Create the upload middleware.
- * @param {number} [uploadFileSizeLimit] - Maximum size of each uploaded file in bytes or no limit if omitted.
- * @returns {RequestHandler} - Request handler.
- */
-export const handlerUpload = (uploadFileSizeLimit = Infinity) => {
-	const upload = multer({
-		storage: multer.diskStorage({}),
-		limits: {
-			fileSize: uploadFileSizeLimit,
-		},
-	});
-
-	return upload.any();
-};

package/src/handler/plsql/cgi.js

@@ -1,131 +0,0 @@
-/*
- *	Prepare the CGI information
- */
-
-import os from 'node:os';
-import {URL} from 'node:url';
-import debugModule from 'debug';
-const debug = debugModule('webplsql:cgi');
-
-/**
- * @typedef {import('express').Request} Request
- * @typedef {import('../../types.js').environmentType} environmentType
- * @typedef {import('../../types.js').configPlSqlType} configPlSqlType
- */
-
-/** @type {environmentType} */
-const DEFAULT_CGI = {
-	PLSQL_GATEWAY: 'WebDb',
-	GATEWAY_IVERSION: '2',
-	SERVER_SOFTWARE: 'web_plsql',
-	GATEWAY_INTERFACE: 'CGI/1.1',
-	SERVER_PORT: '',
-	SERVER_NAME: os.hostname(),
-	REQUEST_METHOD: '',
-	PATH_INFO: '',
-	SCRIPT_NAME: '',
-	REMOTE_ADDR: '',
-	SERVER_PROTOCOL: '',
-	REQUEST_PROTOCOL: '',
-	REMOTE_USER: '',
-	HTTP_COOKIE: '',
-	HTTP_USER_AGENT: '',
-	HTTP_HOST: '',
-	HTTP_ACCEPT: '',
-	HTTP_ACCEPT_ENCODING: '',
-	HTTP_ACCEPT_LANGUAGE: '',
-	HTTP_REFERER: '',
-	HTTP_X_FORWARDED_FOR: '',
-	WEB_AUTHENT_PREFIX: '',
-	DAD_NAME: '',
-	DOC_ACCESS_PATH: 'doc',
-	DOCUMENT_TABLE: '',
-	PATH_ALIAS: '',
-	REQUEST_CHARSET: 'UTF8',
-	REQUEST_IANA_CHARSET: 'UTF-8',
-	SCRIPT_PREFIX: '',
-};
-
-/**
- * Create the HTTP_COOKIE string
- *
- * @param {Request} req - The req object represents the HTTP request.
- * @returns {string} - The string representation of the cookies.
- */
-const getCookieString = (req) => {
-	let cookieString = '';
-
-	for (const propName in req.cookies) {
-		cookieString += `${propName}=${req.cookies[propName]};`;
-	}
-
-	debug('getCookieString', req.cookies, cookieString);
-
-	return cookieString;
-};
-
-/**
- * Get the script name and DAD name from a URL
- *
- * @param {Request} req - The req object represents the HTTP request.
- * @returns {{script: string; prefix: string; dad: string}} - The DAD structure.
- */
-const getPath = (req) => {
-	// create a valid url
-	const validUrl = `${req.protocol}://${os.hostname()}${req.originalUrl}`;
-
-	// get the pathname from the url (new URL('https://example.org/abc/xyz?123').pathname => /abc/xyz)
-	const pathname = new URL(validUrl).pathname;
-
-	const tmp = trimPath(pathname.substring(0, pathname.lastIndexOf('/') + 1));
-	const script = `/${tmp}`;
-	const prefix = `/${tmp.substring(0, tmp.lastIndexOf('/'))}`;
-	const dad = tmp.substring(tmp.indexOf('/') + 1);
-
-	return {script, prefix, dad};
-};
-
-/**
- * Get a path that is not enclodes in slashes
- *
- * @param {string} value - The value to trim.
- * @returns {string} - The trimmed value.
- */
-const trimPath = (value) => value.replace(/^\/+|\/+$/g, '');
-
-/**
- * Create a CGI object
- *
- * @param {Request} req - The req object represents the HTTP request.
- * @param {string} doctable - The document table.
- * @param {environmentType} cgi - The additional cgi.
- * @returns {environmentType} CGI object
- */
-export const getCGI = (req, doctable, cgi) => {
-	const PROTOCOL = req.protocol ? req.protocol.toUpperCase() : '';
-	const PATH = getPath(req);
-
-	/** @type {environmentType} */
-	const CGI = {
-		SERVER_PORT: typeof req.socket.localPort === 'number' ? req.socket.localPort.toString() : '',
-		REQUEST_METHOD: req.method,
-		PATH_INFO: Array.isArray(req.params.name) ? (req.params.name[0] ?? '') : (req.params.name ?? ''),
-		SCRIPT_NAME: PATH.script,
-		REMOTE_ADDR: (req.ip ?? '').replace('::ffff:', ''),
-		SERVER_PROTOCOL: `${PROTOCOL}/${req.httpVersion}`,
-		REQUEST_PROTOCOL: PROTOCOL,
-		HTTP_COOKIE: getCookieString(req),
-		HTTP_USER_AGENT: req.get('user-agent') ?? '',
-		HTTP_HOST: req.get('host') ?? '',
-		HTTP_ACCEPT: req.get('accept') ?? '',
-		HTTP_ACCEPT_ENCODING: req.get('accept-encoding') ?? '',
-		HTTP_ACCEPT_LANGUAGE: req.get('accept-language') ?? '',
-		HTTP_REFERER: req.get('referer') ?? '',
-		HTTP_X_FORWARDED_FOR: req.get('x-forwarded-for') ?? '',
-		DAD_NAME: PATH.dad,
-		DOCUMENT_TABLE: doctable,
-		SCRIPT_PREFIX: PATH.prefix,
-	};
-
-	return Object.assign({}, DEFAULT_CGI, CGI, cgi);
-};