web_plsql 0.17.1 → 0.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "web_plsql",
-	"version": "0.17.1",
+	"version": "0.18.0",
 	"author": "Dieter Oberkofler <dieter.oberkofler@gmail.com>",
 	"license": "MIT",
 	"description": "The Express Middleware for Oracle PL/SQL",
@@ -44,10 +44,11 @@
 	"type": "module",
 	"scripts": {
 		"lint": "prettier --check --experimental-cli . && eslint . && tsc --noEmit",
-		"test": "node --test --test-concurrency=1 \"./tests/**/*.test.js\"",
+		"test": "vitest run",
+		"test:coverage": "vitest run --coverage",
 		"types": "rm -rf types && tsc  --noEmit false --declaration true --declarationDir types --emitDeclarationOnly true --allowJs true --target es2020 --module es2020 --moduleResolution node --allowSyntheticDefaultImports true src/*.js",
 		"clean": "shx rm -f *.tgz && shx rm -f *.log",
-		"ci": "npm run clean && npm run version && npm run lint && npm run test && npm run types",
+		"ci": "npm run clean && npm run version && npm run types && npm run lint && npm run test:coverage",
 		"version": "node update-version.js",
 		"create-package": "shx rm -f *.tgz && npm pack",
 		"image-build": "docker build --no-cache --progress=plain --tag=web_plsql .",
@@ -73,16 +74,18 @@
 		"@types/debug": "4.1.12",
 		"@types/morgan": "1.9.10",
 		"@types/multer": "2.0.0",
-		"@types/node": "25.2.0",
+		"@types/node": "25.2.1",
 		"@types/oracledb": "6.10.1",
 		"@types/supertest": "6.0.3",
+		"@vitest/coverage-v8": "^4.0.18",
 		"eslint": "9.39.2",
-		"eslint-plugin-jsdoc": "62.5.1",
+		"eslint-plugin-jsdoc": "62.5.2",
 		"oracledb": "6.10.0",
 		"prettier": "3.8.1",
 		"shx": "0.4.0",
 		"supertest": "7.2.2",
 		"typescript": "5.9.3",
-		"typescript-eslint": "8.54.0"
+		"typescript-eslint": "8.54.0",
+		"vitest": "^4.0.18"
 	}
 }

package/src/handler/plsql/errorPage.js

@@ -36,30 +36,26 @@ const getError = (req, error) => {
 	// what type of Error did we receive
 	if (error instanceof ProcedureError) {
 		timestamp = error.timestamp;
-		/* istanbul ignore next */
 		message = error.stack ?? '';
 		environment = error.environment;
 		sql = error.sql;
 		bind = error.bind;
 	} else if (error instanceof RequestError) {
 		timestamp = error.timestamp;
-		/* istanbul ignore next */
 		message = error.stack ?? '';
 	} else if (error instanceof Error) {
-		/* istanbul ignore next */
 		message = errorToString(error);
 	} else {
 		if (typeof error === 'string') {
-			/* istanbul ignore next */
 			message = `${error}\n`;
 		}
+		/* v8 ignore start - unreachable code: creating Error without throwing */
 		try {
-			/* istanbul ignore next */
 			new Error();
 		} catch (err) {
-			/* istanbul ignore next */
 			message += errorToString(err);
 		}
+		/* v8 ignore stop */
 	}
 
 	return getFormattedMessage({type: 'error', timestamp, message, req, environment, sql, bind});

package/src/handler/plsql/parsePage.js

@@ -55,7 +55,7 @@ export const parsePage = (text) => {
 					{
 						const cookie = parseCookie(header.value);
 						debug(`oracle header "set-cookie" with value "${header.value}" was received has been parsed to ${JSON.stringify(cookie)}`);
-						/* istanbul ignore else */
+						/* v8 ignore else - parseCookie validation ensures non-null */
 						if (cookie !== null) {
 							page.head.cookies.push(cookie);
 						} else {
@@ -72,7 +72,7 @@ export const parsePage = (text) => {
 				case 'x-db-content-length':
 					{
 						const contentLength = parseInt(header.value, 10);
-						/* istanbul ignore else */
+						/* v8 ignore else - parseInt validation */
 						if (!Number.isNaN(contentLength)) {
 							page.head.contentLength = contentLength;
 							debug(`oracle header "x-db-content-length" with value "${page.head.contentLength}" was parsed`);
@@ -85,12 +85,12 @@ export const parsePage = (text) => {
 				case 'status':
 					{
 						const statusCode = parseInt(header.value, 10);
-						/* istanbul ignore else */
+						/* v8 ignore else - parseInt validation */
 						if (!Number.isNaN(statusCode)) {
 							page.head.statusCode = statusCode;
 							debug(`oracle header "status" with value "${page.head.statusCode}" was parsed`);
 							const index = header.value.indexOf(' ');
-							/* istanbul ignore else */
+							/* v8 ignore else - status code may not have description */
 							if (index !== -1) {
 								page.head.statusDescription = header.value.substring(index + 1);
 							}
@@ -143,7 +143,7 @@ const getHeader = (line) => {
  */
 const parseCookie = (text) => {
 	// validate
-	/* istanbul ignore next */
+	/* v8 ignore next - input validation */
 	if (typeof text !== 'string' || text.trim().length === 0) {
 		return null;
 	}
@@ -156,7 +156,7 @@ const parseCookie = (text) => {
 
 	// get name and value
 	const index = cookieElements[0].indexOf('=');
-	/* istanbul ignore next */
+	/* v8 ignore next - cookie format validation */
 	if (index <= 0) {
 		// if the index is -1, there is no equal sign and if it's 0 the name is empty
 		return null;
@@ -179,7 +179,7 @@ const parseCookie = (text) => {
 		} else if (element.toLowerCase().startsWith('domain=')) {
 			cookie.options.domain = element.substring(7);
 		} else if (element.toLowerCase().startsWith('secure=')) {
-			/* istanbul ignore next */
+			/* v8 ignore next - secure cookie attribute */
 			cookie.options.secure = true;
 		} else if (element.toLowerCase().startsWith('expires=')) {
 			const date = tryDecodeDate(element.substring(8));
@@ -203,7 +203,7 @@ const tryDecodeDate = (value) => {
 	try {
 		return new Date(value);
 	} catch (err) {
-		/* istanbul ignore next */
+		/* v8 ignore next - invalid date format */
 		return null;
 	}
 };

package/src/handler/plsql/procedure.js

@@ -9,7 +9,6 @@ import oracledb from 'oracledb';
 import stream from 'node:stream';
 import z from 'zod';
 
-import {streamToBuffer} from './stream.js';
 import {uploadFile} from './upload.js';
 import {getProcedureVariable} from './procedureVariable.js';
 import {getProcedureNamed} from './procedureNamed.js';
@@ -154,7 +153,7 @@ const procedureGetPage = async (test, databaseConnection) => {
 
 	// Make sure that we have retrieved all the rows
 	if (irows > MAX_IROWS) {
-		/* istanbul ignore next */
+		/* v8 ignore next - defensive check for row limit */
 		throw new ProcedureError(`procedureGetPage: error when retrieving rows. irows="${irows}"`, {}, sqlStatement, bindParameter);
 	}
 
@@ -274,35 +273,38 @@ export const invokeProcedure = async (req, res, argObj, cgiObj, filesToUpload, o
 
 	debug('invokeProcedure: download files');
 	const fileBlob = await databaseConnection.createLob(oracledb.BLOB);
-	const fileDownload = await procedureDownloadFiles(fileBlob, databaseConnection);
-	if (debug.enabled) {
-		debug(getBlock('fileDownload', inspect({fileType: fileDownload.fileType, fileSize: fileDownload.fileSize})));
-	}
 
-	// 7) parse the page
+	try {
+		const fileDownload = await procedureDownloadFiles(fileBlob, databaseConnection);
+		if (debug.enabled) {
+			debug(getBlock('fileDownload', inspect({fileType: fileDownload.fileType, fileSize: fileDownload.fileSize})));
+		}
 
-	debug('invokeProcedure: parse the page');
-	const pageComponents = parsePage(lines);
+		// 7) parse the page
 
-	// add "Server" header
-	pageComponents.head.server = cgiObj.SERVER_SOFTWARE;
+		debug('invokeProcedure: parse the page');
+		const pageComponents = parsePage(lines);
 
-	// add file download information
-	if (fileDownload.fileType !== '' && fileDownload.fileSize > 0 && fileDownload.fileBlob !== null) {
-		pageComponents.file.fileType = fileDownload.fileType;
-		pageComponents.file.fileSize = fileDownload.fileSize;
-		pageComponents.file.fileBlob = await streamToBuffer(fileDownload.fileBlob);
-	}
+		// add "Server" header
+		pageComponents.head.server = cgiObj.SERVER_SOFTWARE;
 
-	// 8) send the page to browser
+		// add file download information
+		if (fileDownload.fileType !== '' && fileDownload.fileSize > 0 && fileDownload.fileBlob !== null) {
+			pageComponents.file.fileType = fileDownload.fileType;
+			pageComponents.file.fileSize = fileDownload.fileSize;
+			pageComponents.file.fileBlob = fileDownload.fileBlob;
+		}
 
-	debug('invokeProcedure: send the page to browser');
-	sendResponse(req, res, pageComponents);
+		// 8) send the page to browser
 
-	// 9) cleanup
+		debug('invokeProcedure: send the page to browser');
+		await sendResponse(req, res, pageComponents);
+	} finally {
+		// 9) cleanup
 
-	debug('invokeProcedure: cleanup');
-	fileBlob.destroy();
+		debug('invokeProcedure: cleanup');
+		fileBlob.destroy();
+	}
 
 	debug('invokeProcedure: end');
 };

package/src/handler/plsql/procedureNamed.js

@@ -89,9 +89,7 @@ const loadArguments = async (procedure, databaseConnection) => {
 		result = await databaseConnection.execute(SQL_GET_ARGUMENT, bind);
 	} catch (err) {
 		debug('result', result);
-		/* istanbul ignore next */
 		const message = `Error when retrieving arguments\n${SQL_GET_ARGUMENT}\n${errorToString(err)}`;
-		/* istanbul ignore next */
 		throw new RequestError(message);
 	}
 
@@ -106,14 +104,11 @@ const loadArguments = async (procedure, databaseConnection) => {
 			.parse(result.outBinds);
 	} catch (err) {
 		debug('result.outBinds', result.outBinds);
-		/* istanbul ignore next */
 		const message = `Error when decoding arguments\n${SQL_GET_ARGUMENT}\n${errorToString(err)}`;
-		/* istanbul ignore next */
 		throw new RequestError(message);
 	}
 
 	if (data.names.length !== data.types.length) {
-		/* istanbul ignore next */
 		throw new RequestError('Error when decoding arguments. The number of names and types does not match');
 	}
 

package/src/handler/plsql/procedureSanitize.js

@@ -128,9 +128,7 @@ const loadRequestValid = async (procName, requestValidationFunction, databaseCon
 		result = await databaseConnection.execute(SQL, bind);
 	} catch (err) {
 		debug('result', result);
-		/* istanbul ignore next */
 		const message = `Error when validating procedure name "${procName}"\n${SQL}\n${errorToString(err)}`;
-		/* istanbul ignore next */
 		throw new RequestError(message);
 	}
 
@@ -139,9 +137,7 @@ const loadRequestValid = async (procName, requestValidationFunction, databaseCon
 		return data.valid === 1;
 	} catch (err) {
 		debug('result', result.outBinds);
-		/* istanbul ignore next */
 		const message = `Internal error when parsing ${result.outBinds}\n${errorToString(err)}`;
-		/* istanbul ignore next */
 		throw new Error(message);
 	}
 };

package/src/handler/plsql/request.js

@@ -98,16 +98,16 @@ const normalizeBody = (req) => {
 	/** @type {Record<string, string | string[]>} */
 	const args = {};
 
-	/* istanbul ignore else */
+	/* v8 ignore else - body validation */
 	if (typeof req.body === 'object' && req.body !== null) {
 		for (const key in req.body) {
 			// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
 			const value = req.body[key];
-			/* istanbul ignore else */
+			/* v8 ignore else - type validation */
 			if (isStringOrArrayOfString(value)) {
 				args[key] = value;
 			} else {
-				/* istanbul ignore next */
+				/* v8 ignore next - invalid body type */
 				throw new RequestError(
 					`The element "${key}" in the body is not a string or an array of strings!\n${util.inspect(req.body, {showHidden: false, depth: null, colors: false})}`,
 				);

package/src/handler/plsql/sendResponse.js

@@ -5,6 +5,7 @@
 import debugModule from 'debug';
 const debug = debugModule('webplsql:sendResponse');
 
+import stream from 'node:stream';
 import {getBlock} from '../../util/trace.js';
 
 /**
@@ -20,9 +21,9 @@ import {getBlock} from '../../util/trace.js';
  *	@param {Request} req - The req object represents the HTTP request.
  *	@param {Response} res - The res object represents the HTTP response that an Express app sends when it gets an HTTP request.
  *	@param {pageType} page - The page to send.
- *	@returns {void}
+ *	@returns {Promise<void>}
  */
-export const sendResponse = (req, res, page) => {
+export const sendResponse = async (req, res, page) => {
 	/** @type {string[]} */
 	const debugText = [];
 
@@ -57,20 +58,51 @@ export const sendResponse = (req, res, page) => {
 
 	// If this is a file download, we eventually set the "Content-Type" and the file content and then return.
 	if (page.file.fileType === 'B' || page.file.fileType === 'F') {
+		/** @type {Record<string, string>} */
+		const headers = {};
+
 		if (typeof page.head.contentType === 'string' && page.head.contentType.length > 0) {
-			if (debug.enabled) {
-				debugText.push(`res.writeHead("Content-Type", "${page.head.contentType}")`);
-			}
+			headers['Content-Type'] = page.head.contentType;
+		}
 
-			res.writeHead(200, {'Content-Type': page.head.contentType});
+		if (typeof page.file.fileSize === 'number' && page.file.fileSize > 0) {
+			headers['Content-Length'] = page.file.fileSize.toString();
 		}
 
-		if (debug.enabled) {
-			debugText.push(`res.end("${page.file.fileType}")`);
-			debug(getBlock('RESPONSE', debugText.join('\n')));
+		if (Object.keys(headers).length > 0) {
+			if (debug.enabled) {
+				debugText.push(`res.writeHead(200, ${JSON.stringify(headers)})`);
+			}
+			res.writeHead(200, headers);
 		}
 
-		res.end(page.file.fileBlob, 'binary');
+		// Check if fileBlob is a stream
+		if (page.file.fileBlob instanceof stream.Readable) {
+			if (debug.enabled) {
+				debugText.push(`res.pipe("${page.file.fileType}") - streaming`);
+				debug(getBlock('RESPONSE', debugText.join('\n')));
+			}
+
+			/** @type {Promise<void>} */
+			const streamComplete = new Promise((resolve, reject) => {
+				if (page.file.fileBlob instanceof stream.Readable) {
+					page.file.fileBlob.pipe(res);
+					page.file.fileBlob.on('end', () => resolve());
+					/* v8 ignore next - error handler */
+					page.file.fileBlob.on('error', (/** @type {Error} */ err) => reject(err));
+					/* v8 ignore next - error handler */
+					res.on('close', () => resolve());
+				}
+			});
+			await streamComplete;
+		} else {
+			if (debug.enabled) {
+				debugText.push(`res.end("${page.file.fileType}") - buffer`);
+				debug(getBlock('RESPONSE', debugText.join('\n')));
+			}
+
+			res.end(page.file.fileBlob, 'binary');
+		}
 		return;
 	}
 

package/src/handler/plsql/stream.js

@@ -21,7 +21,7 @@ export const streamToBuffer = async (readable) => {
 		});
 
 		readable.on('error', (err) => {
-			// istanbul ignore next
+			/* v8 ignore next - error handler */
 			reject(err);
 		});
 	});

package/src/handler/plsql/upload.js

@@ -70,7 +70,7 @@ export const getFiles = (req) => {
 export const uploadFile = async (file, doctable, databaseConnection) => {
 	debug(`uploadFile`, file, doctable);
 
-	/* istanbul ignore next */
+	/* v8 ignore next - defensive validation */
 	if (typeof doctable !== 'string' || doctable.length === 0) {
 		throw new Error(`Unable to upload file "${file.filename}" because the option ""doctable" has not been defined`);
 	}

package/src/types.js

@@ -140,5 +140,5 @@ export const z$configType = z.strictObject({
  * @property {object} file - The file.
  * @property {string | null} file.fileType - The file type.
  * @property {number | null} file.fileSize - The file size.
- * @property {Buffer | null} file.fileBlob - The file blob.
+ * @property {import('node:stream').Readable | Buffer | null} file.fileBlob - The file blob.
  */

package/src/util/file.js

@@ -10,7 +10,6 @@ export const readFileSyncUtf8 = (filePath) => {
 	try {
 		return readFileSync(filePath, 'utf8');
 	} catch (err) {
-		/* istanbul ignore next */
 		throw new Error(`Unable to read file "${filePath}"`);
 	}
 };
@@ -21,11 +20,10 @@ export const readFileSyncUtf8 = (filePath) => {
  * @param {string} filePath - File name.
  * @returns {Promise<Buffer>} The buffer.
  */
-export const readFile = (filePath) => {
+export const readFile = async (filePath) => {
 	try {
-		return fs.readFile(filePath);
+		return await fs.readFile(filePath);
 	} catch (err) {
-		/* istanbul ignore next */
 		throw new Error(`Unable to read file "${filePath}"`);
 	}
 };
@@ -36,11 +34,10 @@ export const readFile = (filePath) => {
  * @param {string} filePath - File name.
  * @returns {Promise<void>}.
  */
-export const removeFile = (filePath) => {
+export const removeFile = async (filePath) => {
 	try {
-		return fs.unlink(filePath);
+		return await fs.unlink(filePath);
 	} catch (err) {
-		/* istanbul ignore next */
 		throw new Error(`Unable to remove file "${filePath}"`);
 	}
 };
@@ -52,9 +49,8 @@ export const removeFile = (filePath) => {
  * @returns {unknown} The json object.
  */
 export const getJsonFile = (filePath) => {
-	const fileContent = readFileSync(filePath, 'utf8');
-
 	try {
+		const fileContent = readFileSync(filePath, 'utf8');
 		return JSON.parse(fileContent);
 	} catch (err) {
 		throw new Error(`Unable to load file "${filePath}"`);

package/src/version.js

@@ -2,4 +2,4 @@
  * Returns the current library version
  * @returns {string} - Version.
  */
-export const getVersion = () => '0.17.1';
+export const getVersion = () => '0.18.0';

package/types/handler/plsql/sendResponse.d.ts

@@ -1,4 +1,4 @@
-export function sendResponse(req: Request, res: Response, page: pageType): void;
+export function sendResponse(req: Request, res: Response, page: pageType): Promise<void>;
 export type Request = import("express").Request;
 export type Response = import("express").Response;
 export type CookieOptions = import("express").CookieOptions;

package/types/types.d.ts

@@ -304,7 +304,7 @@ export type pageType = {
     file: {
         fileType: string | null;
         fileSize: number | null;
-        fileBlob: Buffer | null;
+        fileBlob: import("node:stream").Readable | Buffer | null;
     };
 };
 import z from 'zod';

package/types/handler/plsql/stream.d.ts

@@ -1,2 +0,0 @@
-export function streamToBuffer(readable: stream.Readable): Promise<Buffer>;
-import stream from 'node:stream';