web_plsql 1.0.0 → 1.3.0

package/src/util/cache.js

@@ -1,123 +0,0 @@
-/**
- * @template T
- * @typedef {{hitCount: number, value: T}} cacheEntryType
- */
-
-/**
- * Generic Cache class with LFU (Least Frequently Used) eviction policy.
- * @template T
- */
-export class Cache {
-	/**
-	 * @param {number} maxSize - Maximum number of entries in the cache.
-	 */
-	constructor(maxSize = 10000) {
-		/** @type {Map<string, cacheEntryType<T>>} */
-		this.cache = new Map();
-		this.maxSize = maxSize;
-		this.hits = 0;
-		this.misses = 0;
-	}
-
-	/**
-	 * Get an entry from the cache.
-	 * @param {string} key - The key.
-	 * @returns {T | undefined} - The value or undefined if not found.
-	 */
-	get(key) {
-		const entry = this.cache.get(key);
-		if (entry) {
-			entry.hitCount++;
-			this.hits++;
-			return entry.value;
-		}
-		this.misses++;
-		return undefined;
-	}
-
-	/**
-	 * Set an entry in the cache.
-	 * @param {string} key - The key.
-	 * @param {T} value - The value.
-	 */
-	set(key, value) {
-		// If updating an existing key, preserve its hitCount?
-		// Typically LFU implies resetting or keeping.
-		// For simplicity and avoiding complex aging, if we set it again, we reset hitCount or keep it?
-		// The requirement is "cache invalidation" (delete) or "cache loading" (set).
-		// If we overwrite, it's usually a new value. Let's reset hitCount to 0 for a fresh start or 1.
-
-		// Ensure we have space
-		if (this.cache.size >= this.maxSize && !this.cache.has(key)) {
-			this.prune();
-		}
-
-		this.cache.set(key, {hitCount: 0, value});
-	}
-
-	/**
-	 * Delete an entry from the cache.
-	 * @param {string} key - The key.
-	 */
-	delete(key) {
-		this.cache.delete(key);
-	}
-
-	/**
-	 * Clear the cache.
-	 */
-	clear() {
-		this.cache.clear();
-		this.hits = 0;
-		this.misses = 0;
-	}
-
-	/**
-	 * Prune the cache by removing the least frequently used entries.
-	 * Removes 10% of the cache size.
-	 */
-	prune() {
-		// Convert cache entries to an array
-		const entries = Array.from(this.cache.entries());
-
-		// Sort entries by hitCount in ascending order
-		entries.sort((a, b) => a[1].hitCount - b[1].hitCount);
-
-		// Remove the bottom 10%
-		const removeCount = Math.max(1, Math.floor(this.maxSize * 0.1));
-		const keysToRemove = entries.slice(0, removeCount).map(([key]) => key);
-
-		for (const key of keysToRemove) {
-			this.cache.delete(key);
-		}
-	}
-
-	/**
-	 * Get the size of the cache.
-	 * @returns {number} - The size.
-	 */
-	get size() {
-		return this.cache.size;
-	}
-
-	/**
-	 * Get all keys in the cache.
-	 * @returns {string[]} - The keys.
-	 */
-	keys() {
-		return Array.from(this.cache.keys());
-	}
-
-	/**
-	 * Get cache statistics.
-	 * @returns {{size: number, maxSize: number, hits: number, misses: number}} - The statistics.
-	 */
-	getStats() {
-		return {
-			size: this.cache.size,
-			maxSize: this.maxSize,
-			hits: this.hits,
-			misses: this.misses,
-		};
-	}
-}

package/src/util/errorToString.js

@@ -1,24 +0,0 @@
-import {inspect} from './trace.js';
-
-/**
- * Convert Error to a string.
- *
- * @param {unknown} error - The error.
- * @returns {string} The string representation.
- */
-export const errorToString = (error) => {
-	if (typeof error === 'string') {
-		return error;
-	} else if (error instanceof Error) {
-		const parts = [error.name];
-		if (typeof error.message === 'string' && error.message.length > 0) {
-			parts.push(error.message);
-		}
-		if (typeof error.stack === 'string' && error.stack.length > 0) {
-			parts.push(error.stack);
-		}
-		return parts.join('\n');
-	} else {
-		return inspect(error);
-	}
-};

package/src/util/file.js

@@ -1,91 +0,0 @@
-import {promises as fs, readFileSync} from 'node:fs';
-
-/**
- * Read file.
- *
- * @param {string} filePath - File name.
- * @returns {string} The string.
- */
-export const readFileSyncUtf8 = (filePath) => {
-	try {
-		return readFileSync(filePath, 'utf8');
-	} catch (err) {
-		throw new Error(`Unable to read file "${filePath}"`);
-	}
-};
-
-/**
- * Read file.
- *
- * @param {string} filePath - File name.
- * @returns {Promise<Buffer>} The buffer.
- */
-export const readFile = async (filePath) => {
-	try {
-		return await fs.readFile(filePath);
-	} catch (err) {
-		throw new Error(`Unable to read file "${filePath}"`);
-	}
-};
-
-/**
- * Remove file.
- *
- * @param {string} filePath - File name.
- * @returns {Promise<void>}.
- */
-export const removeFile = async (filePath) => {
-	try {
-		return await fs.unlink(filePath);
-	} catch (err) {
-		throw new Error(`Unable to remove file "${filePath}"`);
-	}
-};
-
-/**
- * Load a json file.
- *
- * @param {string} filePath - File name.
- * @returns {unknown} The json object.
- */
-export const getJsonFile = (filePath) => {
-	try {
-		const fileContent = readFileSync(filePath, 'utf8');
-		return JSON.parse(fileContent);
-	} catch (err) {
-		throw new Error(`Unable to load file "${filePath}"`);
-	}
-};
-
-/**
- * Is this a directory.
- * @param {unknown} directoryPath - Directory name.
- * @returns {Promise<boolean>} - Return true if it is a directory.
- */
-export const isDirectory = async (directoryPath) => {
-	if (typeof directoryPath !== 'string') {
-		return false;
-	}
-
-	const stats = await fs.stat(directoryPath);
-
-	return stats.isDirectory();
-};
-
-/**
- * Is this a file.
- * @param {unknown} filePath - File name.
- * @returns {Promise<boolean>} - Return true if it is a file.
- */
-export const isFile = async (filePath) => {
-	if (typeof filePath !== 'string') {
-		return false;
-	}
-
-	try {
-		const stats = await fs.stat(filePath);
-		return stats.isFile();
-	} catch {
-		return false;
-	}
-};

package/src/util/html.js

@@ -1,53 +0,0 @@
-/*
- *	Html utilities
- */
-
-/**
- * Escape html string.
- *
- * @param {string} value - The value.
- * @returns {string} - The escaped value.
- */
-export const escapeHtml = (value) => value.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&#39;');
-
-/**
- *	Convert LF and/or CR to <br>
- *	@param {string} text - The text to convert.
- *	@returns {string} - The converted text.
- */
-export const convertAsciiToHtml = (text) => {
-	let html = escapeHtml(text);
-
-	html = html.replace(/(?:\r\n|\r|\n)/g, '<br />');
-	html = html.replace(/\t/g, '&nbsp;&nbsp;&nbsp;');
-
-	return html;
-};
-
-/**
- *	get a minimal html page.
- *	@param {string} body - The body.
- *	@returns {string} - The html page.
- */
-export const getHtmlPage = (body) => `<!DOCTYPE html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<title>web_plsql error page</title>
-<style type="text/css">
-html {
-	font-family: monospace, sans-serif;
-	font-size: 12px;
-}
-h1 {
-	font-size: 16px;
-	padding: 2px;
-	background-color: #cc0000;
-}
-</style>
-</head>
-<body>
-${body}
-</body>
-</html>
-`;

package/src/util/jsonLogger.js

@@ -1,47 +0,0 @@
-import * as rotatingFileStream from 'rotating-file-stream';
-
-/**
- * @typedef {object} LogEntry
- * @property {string} timestamp - ISO string
- * @property {'error'|'info'|'warning'} type - Log level
- * @property {string} message - Error message
- * @property {object} [req] - Request details
- * @property {object} [details] - Additional details (stack, sql, etc)
- */
-
-export class JsonLogger {
-	constructor(filename = 'error.json.log') {
-		this.stream = rotatingFileStream.createStream(filename, {
-			size: '10M', // rotate every 10 MegaBytes written
-			interval: '1d', // rotate daily
-			maxFiles: 10, // maximum number of rotated files to keep
-			compress: 'gzip', // compress rotated files
-		});
-	}
-
-	/**
-	 * Log an entry as NDJSON.
-	 * @param {LogEntry} entry - The entry to log.
-	 */
-	log(entry) {
-		try {
-			// Ensure timestamp exists
-			if (!entry.timestamp) {
-				entry.timestamp = new Date().toISOString();
-			}
-			const line = JSON.stringify(entry);
-			this.stream.write(line + '\n');
-		} catch (err) {
-			console.error('JsonLogger: Failed to write log', err);
-		}
-	}
-
-	/**
-	 * Close the stream.
-	 */
-	close() {
-		this.stream.end();
-	}
-}
-
-export const jsonLogger = new JsonLogger();

package/src/util/oracle.js

@@ -1,80 +0,0 @@
-import debugModule from 'debug';
-const debug = debugModule('webplsql:oracle');
-
-import oracledb from 'oracledb';
-
-/**
- * @typedef {import('oracledb').Pool} Pool
- */
-
-/**
- * Test is the connection is valid.
- * @param {Pool} connectionPool - database connection
- * @returns {Promise<boolean>} - success
- */
-export const connectionValid = async (connectionPool) => {
-	let connection;
-	try {
-		connection = await connectionPool.getConnection();
-		debug('connection valid');
-		return true;
-	} catch (err) {
-		debug('connection broken', err);
-		return false;
-	} finally {
-		if (connection) {
-			await connection.release();
-		}
-	}
-};
-
-/**
- * Allocate the Oracle database pool.
- * @param {string} user - The database user name.
- * @param {string} password - The password of the database user.
- * @param {string} connectString - The Oracle database instance to connect to. The string can be an Easy Connect string, or a Net Service Name from a tnsnames.ora file, or the name of a local Oracle database instance.
- * @param {number} poolMin - The minimum number of connections a connection pool maintains.
- * @param {number} poolMax - The maximum number of connections to which a connection pool can grow.
- * @returns {Promise<Pool>} - The connection pool.
- */
-export const poolCreate = async (user, password, connectString, poolMin = 10, poolMax = 1000) => {
-	const pool = await oracledb.createPool({
-		user, // The database user name.
-		password, // The password of the database user.
-		connectString, // The Oracle database instance to connect to. The string can be an Easy Connect string, or a Net Service Name from a tnsnames.ora file, or the name of a local Oracle database instance.
-		poolMin, // The minimum number of connections a connection pool maintains, even when there is no activity to the target database.
-		poolMax, // The maximum number of connections to which a connection pool can grow.
-		poolIncrement: 10, // The number of connections that are opened whenever a connection request exceeds the number of currently open connections.
-		queueTimeout: 1000, // The number of milliseconds after which connection requests waiting in the connection request queue are terminated. If queueTimeout is 0, then queued connection requests are never terminated.
-	});
-
-	const valid = await connectionValid(pool);
-	if (!valid) {
-		await poolClose(pool);
-		throw new Error(`Unable to connect with Oracle Database as ${user}@${connectString}`);
-	}
-
-	return pool;
-};
-
-/**
- * Close the Oracle database pool.
- * @param {Pool} pool - The connection pool.
- * @returns {Promise<void>}
- */
-export const poolClose = async (pool) => {
-	try {
-		await pool.close(0);
-	} catch (err) {
-		debug('Cannot close pool', err);
-	}
-};
-
-/**
- * Close the Oracle database pools.
- * @param {Pool[]} pools - The connection pools.
- * @returns {Promise<void>}
- */
-export const poolsClose = async (pools) => {
-	await Promise.all(pools.map(poolClose));
-};

package/src/util/shutdown.js

@@ -1,44 +0,0 @@
-import debugModule from 'debug';
-const debug = debugModule('webplsql:shutdown');
-
-/**
- * Install a shutdown handler.
- * @param {() => Promise<void>} handler - Shutdown handler
- * @returns {void}
- */
-export const installShutdown = (handler) => {
-	debug('installShutdown');
-
-	/*
-	 *	The 'unhandledRejection' event is emitted whenever a Promise is rejected and no error handler is attached to the promise within a turn of the event loop.
-	 */
-	process.on('unhandledRejection', (reason) => {
-		if (reason instanceof Error) {
-			console.error(`\n${reason.message}. Graceful shutdown...`);
-		} else {
-			console.error('\nUnhandled promise rejection. Graceful shutdown...', reason);
-		}
-		void handler();
-	});
-
-	// install signal event handler
-	process.on('SIGTERM', function sigterm() {
-		console.log('\nGot SIGINT (aka ctrl-c in docker). Graceful shutdown...');
-		void handler();
-	});
-
-	process.on('SIGINT', function sigint() {
-		console.log('\nGot SIGTERM (aka docker container stop). Graceful shutdown...');
-		void handler();
-	});
-};
-
-/**
- * Force a shutdown.
- * @returns {void}
- */
-export const forceShutdown = () => {
-	debug('forceShutdown');
-
-	process.kill(process.pid, 'SIGTERM');
-};