web_plsql 0.15.1 → 0.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "web_plsql",
-	"version": "0.15.1",
+	"version": "0.17.0",
 	"author": "Dieter Oberkofler <dieter.oberkofler@gmail.com>",
 	"license": "MIT",
 	"description": "The Express Middleware for Oracle PL/SQL",
@@ -60,33 +60,29 @@
 		"compression": "1.8.1",
 		"cookie-parser": "1.4.7",
 		"debug": "4.4.3",
-		"escape-html": "1.0.3",
-		"express": "5.1.0",
-		"fs-extra": "11.3.2",
+		"express": "5.2.1",
 		"http-parser-js": "0.5.10",
 		"morgan": "1.10.1",
 		"multer": "2.0.2",
 		"rotating-file-stream": "3.2.7",
-		"zod": "4.1.13"
+		"zod": "4.3.6"
 	},
 	"devDependencies": {
 		"@types/basic-auth": "1.1.8",
 		"@types/compression": "1.8.1",
 		"@types/cookie-parser": "1.4.10",
 		"@types/debug": "4.1.12",
-		"@types/escape-html": "1.0.4",
-		"@types/fs-extra": "11.0.4",
 		"@types/morgan": "1.9.10",
 		"@types/multer": "2.0.0",
-		"@types/node": "24.10.1",
-		"@types/oracledb": "6.10.0",
+		"@types/node": "25.0.10",
+		"@types/oracledb": "6.10.1",
 		"@types/supertest": "6.0.3",
-		"eslint": "9.39.1",
-		"eslint-plugin-jsdoc": "61.4.1",
-		"prettier": "3.7.1",
+		"eslint": "9.39.2",
+		"eslint-plugin-jsdoc": "62.4.1",
+		"prettier": "3.8.1",
 		"shx": "0.4.0",
-		"supertest": "7.1.4",
+		"supertest": "7.2.2",
 		"typescript": "5.9.3",
-		"typescript-eslint": "8.48.0"
+		"typescript-eslint": "8.53.1"
 	}
 }

package/src/handler/plsql/errorPage.js

@@ -2,12 +2,11 @@
  *	Error handling
  */
 
-import util from 'node:util';
-import escape from 'escape-html';
 import {ProcedureError} from './procedureError.js';
 import {RequestError} from './requestError.js';
-import {inspectRequest, logToFile} from '../../util/trace.js';
+import {getFormattedMessage, logToFile} from '../../util/trace.js';
 import {errorToString} from '../../util/errorToString.js';
+import {getHtmlPage} from '../../util/html.js';
 
 /**
  * @typedef {import('express').Request} Request
@@ -18,86 +17,6 @@ import {errorToString} from '../../util/errorToString.js';
  * @typedef {{html: string; text: string}} outputType
  */
 
-/**
- *	Convert value to string
- *	@param {unknown} value - The value to convert.
- *	@returns {string} - The string representation of the value.
- */
-const inspect = (value) => util.inspect(value, {showHidden: false, depth: null, colors: false});
-
-/**
- *	Convert LF and/or CR to <br>
- *	@param {string} text - The text to convert.
- *	@returns {string} - The converted text.
- */
-const convertToHtml = (text) => {
-	let html = escape(text);
-
-	html = html.replace(/(?:\r\n|\r|\n)/g, '<br />');
-	html = html.replace(/\t/g, '&nbsp;&nbsp;&nbsp;');
-
-	return html;
-};
-
-/**
- *	Get html
- *	@param {string} text - The text to convert.
- *	@returns {string} - The converted text.
- */
-const getHtml = (text) => `<p>${convertToHtml(text)}</p>`;
-
-/**
- *	Get text header
- *	@param {string} text - The text to convert.
- *	@returns {string} - The converted text.
- */
-const getHeaderText = (text) => `\n${text}\n${'='.repeat(text.length)}\n`;
-
-/**
- *	Get html header
- *	@param {string} text - The text to convert.
- *	@returns {string} - The converted text.
- */
-const getHeaderHtml = (text) => `<h1>${text}</h1>`;
-
-/**
- *	Get text
- *	@param {string} text - The text to convert.
- *	@returns {string} - The converted text.
- */
-const getText = (text) => `${text}\n`;
-
-/**
- * Get evnironment
- *	@param {outputType} output - The output.
- *	@param {environmentType} environment - The environment.
- */
-const getEnvironment = (output, environment) => {
-	let html = '<table>';
-	let text = '';
-
-	try {
-		for (const key in environment) {
-			html += `<tr><td>${key}:</td><td>${environment[key]}</td></tr>`;
-			text += `${key}=${environment[key]}\n`;
-		}
-	} catch (err) {
-		/* istanbul ignore next */
-		output.html += errorToString(err);
-
-		/* istanbul ignore next */
-		output.text += errorToString(err);
-
-		/* istanbul ignore next */
-		return;
-	}
-
-	html += '</table>';
-
-	output.html += html;
-	output.text += text;
-};
-
 /**
  *	Show an error page
  *	@param {Request} req - The req object represents the HTTP request.
@@ -111,8 +30,8 @@ const getError = (req, error) => {
 	let environment = null;
 	/** @type {string | null} */
 	let sql = null;
-	/** @type {BindParameterConfig} */
-	let bind = {};
+	/** @type {BindParameterConfig | null} */
+	let bind = null;
 
 	// what type of Error did we receive
 	if (error instanceof ProcedureError) {
@@ -143,113 +62,9 @@ const getError = (req, error) => {
 		}
 	}
 
-	/** @type {outputType} */
-	const output = {
-		html: '',
-		text: '',
-	};
-
-	// timestamp
-	let header = 'TIMESTAMP';
-	output.html += getHeaderHtml(header);
-	output.html += getHtml(timestamp.toUTCString());
-
-	// error
-	header = 'ERROR';
-	output.html += getHeaderHtml(header);
-	output.html += getHtml(message);
-	output.text += getHeaderText(header);
-	output.text += getText(message);
-
-	// request
-	header = 'REQUEST';
-	output.text += getHeaderText(header);
-	output.text += getText(inspectRequest(req));
-
-	// parameters
-	if (typeof sql === 'string' && bind) {
-		header = 'PROCEDURE';
-		output.html += getHeaderHtml(header);
-		output.text += getHeaderText(header);
-		getProcedure(output, sql, bind);
-	}
-
-	// environment
-	if (environment) {
-		header = 'ENVIRONMENT';
-		output.html += getHeaderHtml(header);
-		output.text += getHeaderText(header);
-		getEnvironment(output, environment);
-	}
-
-	return output;
+	return getFormattedMessage({type: 'error', timestamp, message, req, environment, sql, bind});
 };
 
-/**
- *	Get procedure
- *	@param {outputType} output - The output.
- *	@param {string} sql - The SQL to execute.
- *	@param {BindParameterConfig} bind - The bind parameters.
- */
-const getProcedure = (output, sql, bind) => {
-	let html = '<table>';
-	let text = '';
-
-	text += `PROCEDURE: ${sql}\n`;
-	html += `<tr><td>PROCEDURE:</td><td>${sql}</td></tr>`;
-
-	try {
-		/* istanbul ignore else */
-		for (const key in bind) {
-			const value = inspect(bind[key].val);
-
-			html += `<tr><td>${key}:</td><td>${value}</td></tr>`;
-			text += `${key}: ${value}\n`;
-		}
-	} catch (err) {
-		/* istanbul ignore next */
-		output.html += err instanceof Error ? err.toString() : 'ERROR';
-
-		/* istanbul ignore next */
-		output.text += err instanceof Error ? err.toString() : 'ERROR';
-		/* istanbul ignore next */
-		return;
-	}
-
-	html += '</table>';
-
-	output.html += html;
-	output.text += text;
-};
-
-/**
- *	getHtmlPage
- *	@param {string} body - The body.
- *	@returns {string} - The html page.
- */
-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>
-`;
-
 /**
  * Show an error page
  *
@@ -259,38 +74,19 @@ ${body}
  * @param {unknown} error - The error.
  */
 export const errorPage = (req, res, options, error) => {
-	let output = {
-		html: '',
-		text: '',
-	};
-
-	// get the error description
-	try {
-		output = getError(req, error);
-	} catch (err) {
-		/* istanbul ignore next */
-		const header = 'ERROR';
-
-		/* istanbul ignore next */
-		const message = errorToString(err);
-
-		/* istanbul ignore next */
-		output.html += getHeaderHtml(header) + getHtml(message);
-
-		/* istanbul ignore next */
-		output.text += getHeaderHtml(header) + getHtml(message);
-	}
+	// get error message
+	const {html, text} = getError(req, error);
 
 	// trace to file
-	logToFile(output.text);
+	logToFile(text);
 
 	// console
-	console.error(output.text);
+	console.error(text);
 
 	// show page
 	if (options.errorStyle === 'basic') {
 		res.status(404).send('Page not found');
 	} else {
-		res.status(404).send(getHtmlPage(output.html));
+		res.status(404).send(getHtmlPage(html));
 	}
 };

package/src/handler/plsql/handlerPlSql.js

@@ -37,7 +37,6 @@ const requestHandler = async (req, res, next, connectionPool, options) => {
 				debug(`Redirect to the url "${newUrl}"`);
 				res.redirect(newUrl);
 			} else {
-				/* istanbul ignore next */
 				errorPage(req, res, options, new RequestError('No procedure name given and no default page has been specified'));
 			}
 		} else {
@@ -45,7 +44,6 @@ const requestHandler = async (req, res, next, connectionPool, options) => {
 			await processRequest(req, res, options, connectionPool);
 		}
 	} catch (err) {
-		/* istanbul ignore next */
 		errorPage(req, res, options, err);
 	}
 };