web_plsql 1.2.0 → 1.3.1

package/src/handler/plsql/errorPage.js

@@ -1,113 +0,0 @@
-/*
- *	Error handling
- */
-
-import {ProcedureError} from './procedureError.js';
-import {RequestError} from './requestError.js';
-import {getFormattedMessage, logToFile} from '../../util/trace.js';
-import {errorToString} from '../../util/errorToString.js';
-import {getHtmlPage} from '../../util/html.js';
-import {jsonLogger} from '../../util/jsonLogger.js';
-
-/**
- * @typedef {import('express').Request} Request
- * @typedef {import('express').Response} Response
- * @typedef {import('../../types.js').BindParameterConfig} BindParameterConfig
- * @typedef {import('../../types.js').environmentType} environmentType
- * @typedef {import('../../types.js').configPlSqlHandlerType} configPlSqlHandlerType
- * @typedef {{html: string; text: string}} outputType
- * @typedef {import('../../util/trace.js').messageType} messageType
- */
-
-/**
- *	Get error data
- *	@param {Request} req - The req object represents the HTTP request.
- *	@param {unknown} error - The error.
- *	@returns {messageType} - The output.
- */
-const getErrorData = (req, error) => {
-	let timestamp = new Date();
-	let message = '';
-	/** @type {environmentType | null} */
-	let environment = null;
-	/** @type {string | null} */
-	let sql = null;
-	/** @type {BindParameterConfig | null} */
-	let bind = null;
-
-	// what type of Error did we receive
-	if (error instanceof ProcedureError) {
-		timestamp = error.timestamp;
-		message = error.stack ?? '';
-		environment = error.environment;
-		sql = error.sql;
-		bind = error.bind;
-	} else if (error instanceof RequestError) {
-		timestamp = error.timestamp;
-		message = error.stack ?? '';
-	} else if (error instanceof Error) {
-		message = errorToString(error);
-	} else {
-		if (typeof error === 'string') {
-			message = `${error}\n`;
-		}
-		/* v8 ignore start - unreachable code: creating Error without throwing */
-		try {
-			new Error();
-		} catch (err) {
-			message += errorToString(err);
-		}
-		/* v8 ignore stop */
-	}
-
-	return {type: 'error', timestamp, message, req, environment, sql, bind};
-};
-
-/**
- * Show an error page
- *
- * @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 {configPlSqlHandlerType} options - The configuration options.
- * @param {unknown} error - The error.
- */
-export const errorPage = (req, res, options, error) => {
-	// get error data
-	const errorData = getErrorData(req, error);
-
-	// get formatted message
-	const {html, text} = getFormattedMessage(errorData);
-
-	// trace to file
-	logToFile(text);
-
-	// json log
-	const firstLine = errorData.message.split('\n')[0];
-	jsonLogger.log({
-		timestamp: errorData.timestamp?.toISOString() ?? new Date().toISOString(),
-		type: 'error',
-		message: firstLine ?? '',
-		req: {
-			method: req.method,
-			url: req.originalUrl,
-			ip: req.ip ?? '',
-			userAgent: req.get('user-agent') ?? '',
-		},
-		details: {
-			fullMessage: errorData.message,
-			sql: errorData.sql,
-			bind: errorData.bind,
-			environment: errorData.environment,
-		},
-	});
-
-	// console
-	console.error(text);
-
-	// show page
-	if (options.errorStyle === 'basic') {
-		res.status(404).send('Page not found');
-	} else {
-		res.status(404).send(getHtmlPage(html));
-	}
-};

package/src/handler/plsql/handlerPlSql.js

@@ -1,90 +0,0 @@
-/*
- *	Express middleware for Oracle PL/SQL
- */
-
-import debugModule from 'debug';
-const debug = debugModule('webplsql:handlerPlSql');
-
-import url from 'node:url';
-import {processRequest} from './request.js';
-import {RequestError} from './requestError.js';
-import {errorPage} from './errorPage.js';
-import {Cache} from '../../util/cache.js';
-
-/**
- * @typedef {import('express').RequestHandler} RequestHandler
- * @typedef {import('express').Request} Request
- * @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').configPlSqlHandlerType} configPlSqlHandlerType
- */
-
-/**
- * express.Request handler
- * @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 {NextFunction} _next - The next function.
- * @param {Pool} connectionPool - The connection pool.
- * @param {configPlSqlHandlerType} options - the options for the middleware.
- * @param {Cache<string>} procedureNameCache - The procedure name cache.
- * @param {Cache<import('./procedureNamed.js').argsType>} argumentCache - The argument cache.
- */
-const requestHandler = async (req, res, _next, connectionPool, options, procedureNameCache, argumentCache) => {
-	try {
-		// should we switch to the default page if there is one defined
-		if (typeof req.params.name !== 'string' || req.params.name.length === 0) {
-			if (typeof options.defaultPage === 'string' && options.defaultPage.length > 0) {
-				const newUrl = url.resolve(`${req.originalUrl}/${options.defaultPage}`, '');
-				debug(`Redirect to the url "${newUrl}"`);
-				res.redirect(newUrl);
-			} else {
-				errorPage(req, res, options, new RequestError('No procedure name given and no default page has been specified'));
-			}
-		} else {
-			// request handler
-			await processRequest(req, res, options, connectionPool, procedureNameCache, argumentCache);
-		}
-	} catch (err) {
-		errorPage(req, res, options, err);
-	}
-};
-
-/**
- * @typedef {import('express').RequestHandler & {
- *   procedureNameCache: Cache<string>;
- *   argumentCache: Cache<import('./procedureNamed.js').argsType>;
- * }} WebPlSqlRequestHandler
- */
-
-/**
- * Express middleware.
- *
- * @param {Pool} connectionPool - The connection pool.
- * @param {configPlSqlHandlerType} config - The configuration options.
- * @returns {WebPlSqlRequestHandler} - The handler.
- */
-export const handlerWebPlSql = (connectionPool, config) => {
-	debug('options', config);
-
-	/** @type {Cache<string>} */
-	const procedureNameCache = new Cache();
-	/** @type {Cache<import('./procedureNamed.js').argsType>} */
-	const argumentCache = new Cache();
-
-	/**
-	 * @param {Request} req - The request.
-	 * @param {Response} res - The response.
-	 * @param {NextFunction} next - The next function.
-	 */
-	const handler = (req, res, next) => {
-		void requestHandler(req, res, next, connectionPool, config, procedureNameCache, argumentCache);
-	};
-
-	// Expose caches for Admin Console
-	handler.procedureNameCache = procedureNameCache;
-	handler.argumentCache = argumentCache;
-
-	return handler;
-};

package/src/handler/plsql/owaPageStream.js

@@ -1,93 +0,0 @@
-import {Readable} from 'node:stream';
-import oracledb from 'oracledb';
-import z from 'zod';
-import debugModule from 'debug';
-import {ProcedureError} from './procedureError.js';
-import {errorToString} from '../../util/errorToString.js';
-
-const debug = debugModule('webplsql:owaPageStream');
-
-/**
- * @typedef {import('oracledb').Connection} Connection
- * @typedef {import('../../types.js').BindParameterConfig} BindParameterConfig
- */
-
-export class OWAPageStream extends Readable {
-	/**
-	 * @param {Connection} databaseConnection - The database connection.
-	 */
-	constructor(databaseConnection) {
-		super({highWaterMark: 16384}); // 16KB buffer
-		this.databaseConnection = databaseConnection;
-		this.chunkSize = 1000;
-		this.isDone = false;
-	}
-
-	/**
-	 * Fetch a chunk of the page from the database.
-	 * @returns {Promise<string[]>} The array of lines fetched.
-	 */
-	async fetchChunk() {
-		if (this.isDone) return [];
-
-		/** @type {BindParameterConfig} */
-		const bindParameter = {
-			lines: {dir: oracledb.BIND_OUT, type: oracledb.STRING, maxArraySize: this.chunkSize},
-			irows: {dir: oracledb.BIND_INOUT, type: oracledb.NUMBER, val: this.chunkSize},
-		};
-
-		const sqlStatement = 'BEGIN owa.get_page(thepage=>:lines, irows=>:irows); END;';
-
-		try {
-			const result = await this.databaseConnection.execute(sqlStatement, bindParameter);
-			const {lines, irows} = z.object({irows: z.number(), lines: z.array(z.string())}).parse(result.outBinds);
-
-			debug(`fetched ${lines.length} lines (irows=${irows})`);
-
-			// If we got fewer lines than requested, OR if we got 0 lines, we are done
-			if (lines.length < this.chunkSize) {
-				this.isDone = true;
-			}
-
-			return lines;
-		} catch (err) {
-			if (err instanceof ProcedureError) {
-				throw err;
-			}
-			throw new ProcedureError(`OWAPageStream: error when getting page\n${errorToString(err)}`, {}, sqlStatement, bindParameter);
-		}
-	}
-
-	/**
-	 * @override
-	 * @param {number} _size - The size hint (unused).
-	 * @returns {void}
-	 */
-	_read(_size) {
-		this.fetchChunk()
-			.then((lines) => {
-				if (lines.length > 0) {
-					this.push(lines.join(''));
-				}
-
-				// After fetching, check if we're done
-				if (this.isDone) {
-					this.push(null);
-				}
-			})
-			.catch((/** @type {unknown} */ err) => {
-				this.destroy(err instanceof Error ? err : new Error(String(err)));
-			});
-	}
-
-	/**
-	 * Add initial body content to the stream.
-	 * @param {string} content - The initial content to prepend.
-	 * @returns {void}
-	 */
-	addBody(content) {
-		if (content && content.length > 0) {
-			this.push(content);
-		}
-	}
-}

package/src/handler/plsql/parsePage.js

@@ -1,213 +0,0 @@
-import debugModule from 'debug';
-const debug = debugModule('webplsql:parsePage');
-
-/**
- * @typedef {import('../../types.js').pageType} pageType
- * @typedef {import('../../types.js').cookieType} cookieType
- */
-
-/**
- *	Parse the header and split it up into the individual components
- *
- * @param {string} text - The text returned from the PL/SQL procedure.
- * @returns {pageType} - The parsed page.
- */
-export const parsePage = (text) => {
-	/** @type {pageType} */
-	const page = {
-		body: '',
-		head: {
-			cookies: [],
-			otherHeaders: {},
-		},
-		file: {
-			fileType: null,
-			fileSize: null,
-			fileBlob: null,
-		},
-	};
-
-	//
-	//	1)	Split up the text in header and body
-	//
-
-	// Find the end of the header identified by \n\n
-	let head = '';
-	const headerEndPosition = text.indexOf('\n\n');
-	if (headerEndPosition === -1) {
-		head = text;
-	} else {
-		head = text.substring(0, headerEndPosition + 2);
-		page.body = text.substring(headerEndPosition + 2);
-	}
-
-	//
-	//	2)	parse the headers
-	//
-
-	debug('parsing the headers received from PL/SQL');
-	head.split('\n').forEach((line) => {
-		const header = getHeader(line);
-
-		if (header) {
-			switch (header.name.toLowerCase()) {
-				case 'set-cookie':
-					{
-						const cookie = parseCookie(header.value);
-						debug(`oracle header "set-cookie" with value "${header.value}" was received has been parsed to ${JSON.stringify(cookie)}`);
-						/* v8 ignore else - parseCookie validation ensures non-null */
-						if (cookie !== null) {
-							page.head.cookies.push(cookie);
-						} else {
-							throw new Error(`Unable to parse header "set-cookie" with value "${header.value}" received from PL/SQL`);
-						}
-					}
-					break;
-
-				case 'content-type':
-					page.head.contentType = header.value;
-					debug(`oracle header "content-type" with value "${page.head.contentType}" was parsed`);
-					break;
-
-				case 'x-db-content-length':
-					{
-						const contentLength = parseInt(header.value, 10);
-						/* 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`);
-						} else {
-							throw new Error(`Unable to parse header "x-db-content-length" with value "${header.value}" received from PL/SQL`);
-						}
-					}
-					break;
-
-				case 'status':
-					{
-						const statusCode = parseInt(header.value, 10);
-						/* 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(' ');
-							/* v8 ignore else - status code may not have description */
-							if (index !== -1) {
-								page.head.statusDescription = header.value.substring(index + 1);
-							}
-						} else {
-							throw new Error(`Unable to parse header "status" with value "${header.value}" received from PL/SQL`);
-						}
-					}
-					break;
-
-				case 'location':
-					page.head.redirectLocation = header.value;
-					debug(`oracle header "location" with value "${page.head.statusCode}" was parsed`);
-					break;
-
-				case 'x-oracle-ignore':
-					break;
-
-				default:
-					page.head.otherHeaders[header.name] = header.value;
-					break;
-			}
-		}
-	});
-
-	return page;
-};
-
-/**
- *	Get a header line
- *	@param {string} line - The line
- *	@returns {{name: string, value: string} | null} - The header.
- */
-const getHeader = (line) => {
-	const index = line.indexOf(':');
-
-	if (index !== -1) {
-		return {
-			name: line.substring(0, index).trim(),
-			value: line.substring(index + 1).trim(),
-		};
-	}
-
-	return null;
-};
-
-/**
- *	Parses a cookie string
- *	@param {string} text - The cookie string.
- *	@returns {cookieType | null} - The parsed cookie.
- */
-const parseCookie = (text) => {
-	// validate
-	/* v8 ignore next - input validation */
-	if (typeof text !== 'string' || text.trim().length === 0) {
-		return null;
-	}
-
-	// split the cookie into it's parts
-	let cookieElements = text.split(';');
-
-	// trim cookie elements
-	cookieElements = cookieElements.map((element) => element.trim());
-
-	// get name and value
-	const firstElement = cookieElements[0];
-	if (!firstElement) {
-		return null;
-	}
-	const index = firstElement.indexOf('=');
-	/* 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;
-	}
-
-	/** @type {cookieType} */
-	const cookie = {
-		name: firstElement.substring(0, index).trim(),
-		value: firstElement.substring(index + 1).trim(),
-		options: {},
-	};
-
-	// remove the first element
-	cookieElements.shift();
-
-	// get the other options
-	cookieElements.forEach((element) => {
-		if (element.startsWith('path=')) {
-			cookie.options.path = element.substring(5);
-		} else if (element.toLowerCase().startsWith('domain=')) {
-			cookie.options.domain = element.substring(7);
-		} else if (element.toLowerCase().startsWith('secure=')) {
-			/* v8 ignore next - secure cookie attribute */
-			cookie.options.secure = true;
-		} else if (element.toLowerCase().startsWith('expires=')) {
-			const date = tryDecodeDate(element.substring(8));
-			if (date) {
-				cookie.options.expires = date;
-			}
-		} else if (element.toLowerCase().startsWith('httponly')) {
-			cookie.options.httpOnly = true;
-		}
-	});
-
-	return cookie;
-};
-
-/**
- * Try to decode a date
- * @param {string} value - The value to decode.
- * @returns {Date | null} - The decoded date or null.
- */
-const tryDecodeDate = (value) => {
-	try {
-		return new Date(value);
-	} catch (err) {
-		/* v8 ignore next - invalid date format */
-		return null;
-	}
-};