web_plsql 1.2.0 → 1.3.1

package/src/handler/plsql/request.js

@@ -1,124 +0,0 @@
-/*
- *	Process the http request
- */
-
-import debugModule from 'debug';
-const debug = debugModule('webplsql:request');
-
-import util from 'node:util';
-import {invokeProcedure} from './procedure.js';
-import {getCGI} from './cgi.js';
-import {getFiles} from './upload.js';
-import {RequestError} from './requestError.js';
-import {isStringOrArrayOfString} from '../../util/type.js';
-
-/**
- * @typedef {import('express').Request} Request
- * @typedef {import('express').Response} Response
- * @typedef {import('oracledb').Pool} Pool
- * @typedef {import('oracledb').Connection} Connection
- * @typedef {import('../../types.js').argObjType} argObjType
- * @typedef {import('../../types.js').configPlSqlHandlerType} configPlSqlHandlerType
- * @typedef {import('../../util/cache.js').Cache<string>} ProcedureNameCache
- * @typedef {import('../../util/cache.js').Cache<import('./procedureNamed.js').argsType>} ArgumentCache
- */
-
-/**
- * Execute the request
- *
- * @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 options for the middleware.
- * @param {Pool} connectionPool - The connection pool.
- * @param {ProcedureNameCache} procedureNameCache - The procedure name cache.
- * @param {ArgumentCache} argumentCache - The argument cache.
- * @returns {Promise<void>} - Promise resolving to th page
- */
-export const processRequest = async (req, res, options, connectionPool, procedureNameCache, argumentCache) => {
-	debug('processRequest: ENTER');
-
-	//
-	if (Array.isArray(req.params.name)) {
-		console.warn(`processRequest: WARNING: the req.params.name is not a string but an array of string: ${req.params.name.join(',')}`);
-	}
-
-	// open database connection
-	const connection = await connectionPool.getConnection();
-
-	// Get the CGI
-	const cgiObj = getCGI(req, options.documentTable ?? '', options.cgi ?? {});
-	debug('processRequest: cgiObj=', cgiObj);
-
-	// Does the request contain any files
-	const filesToUpload = getFiles(req);
-	debug('processRequest: filesToUpload=', filesToUpload);
-
-	// Add the query properties
-	/** @type {argObjType} */
-	const argObj = {};
-	Object.assign(argObj, req.query);
-
-	// For add the files that must be uploaded, we now copy the actual filename to the appropriate parameter to the invoked procedure.
-	filesToUpload.reduce((aggregator, file) => {
-		aggregator[file.fieldname] = file.filename;
-		return aggregator;
-	}, argObj);
-
-	// Does the request contain a body
-	Object.assign(argObj, normalizeBody(req));
-	debug('processRequest: argObj=', argObj);
-
-	// invoke the Oracle procedure and get the page contenst
-	await invokeProcedure(req, res, argObj, cgiObj, filesToUpload, options, connection, procedureNameCache, argumentCache);
-
-	// transaction mode
-	if (options.transactionMode === 'rollback') {
-		debug('transactionMode: rollback');
-		await connection.rollback();
-	} else if (typeof options.transactionMode === 'function') {
-		debug('transactionMode: callback');
-		const procName = Array.isArray(req.params.name) ? req.params.name[0] : req.params.name;
-		const result = options.transactionMode(connection, procName ?? '');
-		debug('transactionMode: callback restult', result);
-		if (result && typeof result.then === 'function') {
-			await result;
-		}
-	} else {
-		debug('transactionMode: commit');
-		await connection.commit();
-	}
-
-	// close database connection
-	await connection.release();
-
-	debug('processRequest: EXIT');
-};
-
-/**
- *	Normalize the body by making sure that only "simple" parameters and no nested objects are submitted
- *	@param {Request} req - The req object represents the HTTP request.
- *	@returns {Record<string, string | string[]>} - The normalized body.
- */
-const normalizeBody = (req) => {
-	/** @type {Record<string, string | string[]>} */
-	const args = {};
-
-	/* 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];
-			/* v8 ignore else - type validation */
-			if (isStringOrArrayOfString(value)) {
-				args[key] = value;
-			} else {
-				/* 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})}`,
-				);
-			}
-		}
-	}
-
-	return args;
-};

package/src/handler/plsql/requestError.js

@@ -1,23 +0,0 @@
-/*
- *	RequestError
- */
-
-export class RequestError extends Error {
-	/** @type {Date} */
-	timestamp;
-
-	/**
-	 * @param {string} message - The error message.
-	 */
-	constructor(message) {
-		super(message);
-
-		// Maintains proper stack trace for where our error was thrown (only available on V8)
-		if (Error.captureStackTrace) {
-			Error.captureStackTrace(this, RequestError);
-		}
-
-		// Custom debugging information
-		this.timestamp = new Date();
-	}
-}

package/src/handler/plsql/sendResponse.js

@@ -1,174 +0,0 @@
-/*
- *	Page the raw page content and return the content to the client
- */
-
-import debugModule from 'debug';
-const debug = debugModule('webplsql:sendResponse');
-
-import stream from 'node:stream';
-import {getBlock} from '../../util/trace.js';
-
-/**
- * @typedef {import('express').Request} Request
- * @typedef {import('express').Response} Response
- * @typedef {import('express').CookieOptions} CookieOptions
- * @typedef {import('../../types.js').pageType} pageType
- * @typedef {import('../../types.js').cookieType} cookieType
- */
-
-/**
- *	Send "default" response to the browser
- *	@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 {Promise<void>}
- */
-export const sendResponse = async (_req, res, page) => {
-	/** @type {string[]} */
-	const debugText = [];
-
-	// Send the "cookies"
-	page.head.cookies.forEach((cookie) => {
-		/* v8 ignore start */
-		if (debug.enabled) {
-			debugText.push(`res.cookie: name="${cookie.name}" value="${cookie.value}" options=${JSON.stringify(cookie.options)}`);
-		}
-		/* v8 ignore stop */
-
-		res.cookie(cookie.name, cookie.value, cookie.options);
-	});
-
-	// If there is a "redirectLocation" header, we immediately redirect and return
-	if (typeof page.head.redirectLocation === 'string' && page.head.redirectLocation.length > 0) {
-		/* v8 ignore start */
-		if (debug.enabled) {
-			debugText.push(`res.redirect(302, "${page.head.redirectLocation}")`);
-			debug(getBlock('RESPONSE', debugText.join('\n')));
-		}
-		/* v8 ignore stop */
-
-		res.redirect(302, page.head.redirectLocation);
-		return;
-	}
-
-	// Send all the "otherHeaders"
-	for (const key in page.head.otherHeaders) {
-		/* v8 ignore start */
-		if (debug.enabled) {
-			debugText.push(`res.set("${key}", "${page.head.otherHeaders[key]}")`);
-		}
-		/* v8 ignore stop */
-
-		res.set(key, page.head.otherHeaders[key]);
-	}
-
-	// 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) {
-			headers['Content-Type'] = page.head.contentType;
-		}
-
-		if (typeof page.file.fileSize === 'number' && page.file.fileSize > 0) {
-			headers['Content-Length'] = page.file.fileSize.toString();
-		}
-
-		if (Object.keys(headers).length > 0) {
-			/* v8 ignore start */
-			if (debug.enabled) {
-				debugText.push(`res.writeHead(200, ${JSON.stringify(headers)})`);
-			}
-			/* v8 ignore stop */
-
-			res.writeHead(200, headers);
-		}
-
-		// Check if fileBlob is a stream
-		if (page.file.fileBlob instanceof stream.Readable) {
-			/* v8 ignore start */
-			if (debug.enabled) {
-				debugText.push(`res.pipe("${page.file.fileType}") - streaming`);
-				debug(getBlock('RESPONSE', debugText.join('\n')));
-			}
-			/* v8 ignore stop */
-
-			/** @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 {
-			/* v8 ignore start */
-			if (debug.enabled) {
-				debugText.push(`res.end("${page.file.fileType}") - buffer`);
-				debug(getBlock('RESPONSE', debugText.join('\n')));
-			}
-			/* v8 ignore stop */
-
-			res.end(page.file.fileBlob, 'binary');
-		}
-		return;
-	}
-
-	// Is the a "contentType" header
-	if (typeof page.head.contentType === 'string' && page.head.contentType.length > 0) {
-		/* v8 ignore start */
-		if (debug.enabled) {
-			debugText.push(`res.set("Content-Type", "${page.head.contentType}")`);
-		}
-		/* v8 ignore stop */
-
-		res.set('Content-Type', page.head.contentType);
-	}
-
-	// If we have a "Status" header, we send the header and then return.
-	if (typeof page.head.statusCode === 'number') {
-		/* v8 ignore start */
-		if (debug.enabled) {
-			debugText.push(`res.status(page.head.statusCode).send("${page.head.statusDescription}")`);
-			debug(getBlock('RESPONSE', debugText.join('\n')));
-		}
-		/* v8 ignore stop */
-
-		res.status(page.head.statusCode).send(page.head.statusDescription);
-		return;
-	}
-
-	// Send the body
-	/* v8 ignore start */
-	if (debug.enabled) {
-		if (page.body instanceof stream.Readable) {
-			debugText.push(`${'-'.repeat(60)}\n[Stream Body]`);
-		} else {
-			debugText.push(`${'-'.repeat(60)}\n${page.body}`);
-		}
-		debug(getBlock('RESPONSE', debugText.join('\n')));
-	}
-	/* v8 ignore stop */
-
-	if (page.body instanceof stream.Readable) {
-		/** @type {Promise<void>} */
-		const streamComplete = new Promise((resolve, reject) => {
-			if (page.body instanceof stream.Readable) {
-				page.body.pipe(res);
-				page.body.on('end', () => resolve());
-				/* v8 ignore next - error handler */
-				page.body.on('error', (/** @type {Error} */ err) => reject(err));
-				/* v8 ignore next - error handler */
-				res.on('close', () => resolve());
-			}
-		});
-		await streamComplete;
-	} else {
-		res.send(page.body);
-	}
-};

package/src/handler/plsql/stream.js

@@ -1,28 +0,0 @@
-import stream from 'node:stream';
-
-/**
- *	Convert a readable stream to a buffer.
- *
- * @param {stream.Readable} readable - The readable stream.
- * @returns {Promise<Buffer>} The buffer.
- */
-export const streamToBuffer = async (readable) => {
-	return new Promise((resolve, reject) => {
-		/** @type {Buffer[]} */
-		const buffers = [];
-
-		readable.on('data', (buffer) => {
-			// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-			buffers.push(buffer);
-		});
-
-		readable.on('end', () => {
-			resolve(Buffer.concat(buffers));
-		});
-
-		readable.on('error', (err) => {
-			/* v8 ignore next - error handler */
-			reject(err);
-		});
-	});
-};

package/src/handler/plsql/upload.js

@@ -1,109 +0,0 @@
-/*
- *	Process file uploads
- */
-
-// eslint-disable @typescript-eslint/no-unused-vars
-
-import debugModule from 'debug';
-const debug = debugModule('webplsql:fileUpload');
-
-import {readFile, removeFile} from '../../util/file.js';
-import {errorToString} from '../../util/errorToString.js';
-import oracledb from 'oracledb';
-import z from 'zod';
-
-const z$reqFiles = z.array(
-	z.looseObject({
-		fieldname: z.string(),
-		originalname: z.string(),
-		encoding: z.string(),
-		mimetype: z.string(),
-		destination: z.string(),
-		filename: z.string(),
-		path: z.string(),
-		size: z.number(),
-	}),
-);
-
-/**
- * @typedef {import('express').Request} Request
- * @typedef {import('oracledb').Connection} Connection
- * @typedef {import('../../types.js').fileUploadType} fileUploadType
- */
-
-/**
- * Get the files
- *
- * @param {Request} req - The req object represents the HTTP request.
- * @returns {fileUploadType[]} - Promise that resolves with an array of files to be uploaded.
- */
-export const getFiles = (req) => {
-	if (!('files' in req)) {
-		debug('getFiles: no files');
-		return [];
-	}
-
-	if (typeof req.files === 'object' && req.files !== null && Object.keys(req.files).length === 0) {
-		debug('getFiles: no files');
-		return [];
-	}
-
-	const files = z$reqFiles.parse(req.files);
-
-	for (const file of files) {
-		file.filename += `/${file.originalname}`;
-	}
-
-	debug('getFiles', files);
-
-	return files;
-};
-
-/**
- * Upload the given file and return a promise.
- *
- * @param {fileUploadType} file - The file to upload.
- * @param {string} doctable - The file to upload.
- * @param {Connection} databaseConnection - The file to upload.
- * @returns {Promise<void>} - Promise that resolves when uploaded.
- */
-export const uploadFile = async (file, doctable, databaseConnection) => {
-	debug(`uploadFile`, file, doctable);
-
-	/* 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`);
-	}
-
-	// read file
-	let blobContent;
-	try {
-		blobContent = await readFile(file.path);
-	} catch (err) {
-		throw new Error(`Unable to load file "${file.path}".\n${errorToString(err)}`);
-	}
-
-	// insert file in document table
-	const sql = `INSERT INTO ${doctable} (name, mime_type, doc_size, dad_charset, last_updated, content_type, blob_content) VALUES (:name, :mime_type, :doc_size, 'ascii', SYSDATE, 'BLOB', :blob_content)`;
-	const bind = {
-		name: file.filename,
-		mime_type: file.mimetype,
-		doc_size: file.size,
-		blob_content: {
-			val: blobContent,
-			type: oracledb.BUFFER,
-		},
-	};
-	try {
-		await databaseConnection.execute(sql, bind, {autoCommit: true});
-	} catch (err) {
-		throw new Error(`Unable to insert file "${file.filename}".\n${errorToString(err)}`);
-	}
-
-	// remove the file
-	try {
-		await removeFile(file.path);
-	} catch (err) {
-		throw new Error(`Unable to remove file "${file.filename}".\n${errorToString(err)}`);
-	}
-};

package/src/index.js

@@ -1,19 +0,0 @@
-// libraries
-import oracledb from 'oracledb';
-export {oracledb};
-
-// server
-export {getVersion} from './version.js';
-export {createServer, startServer, loadConfig, startServerConfig} from './server/server.js';
-export * from './util/shutdown.js';
-
-// handler
-export {handlerWebPlSql} from './handler/plsql/handlerPlSql.js';
-export {handlerLogger} from './handler/handlerLogger.js';
-export {handlerUpload} from './handler/handlerUpload.js';
-
-// oracle
-export * from './util/oracle.js';
-
-// util
-export * from './util/file.js';

package/src/server/adminContext.js

@@ -1,23 +0,0 @@
-import {StatsManager} from '../util/statsManager.js';
-
-/**
- * @typedef {import('oracledb').Pool} Pool
- * @typedef {import('../types.js').configType} configType
- * @typedef {import('../handler/plsql/procedureNamed.js').argsType} argsType
- * @typedef {import('../util/cache.js').Cache<unknown>} Cache
- */
-
-/**
- * Global Admin Context
- */
-export const AdminContext = {
-	startTime: new Date(),
-	/** @type {configType | null} */
-	config: null,
-	/** @type {Pool[]} */
-	pools: [],
-	/** @type {Array<{poolName: string, procedureNameCache: Cache, argumentCache: Cache}>} */
-	caches: [],
-	paused: false,
-	statsManager: new StatsManager(),
-};

package/src/server/config.js

@@ -1,57 +0,0 @@
-import {getVersion} from '../version.js';
-
-/**
- * @typedef {import('../types.js').configType} configType
- */
-
-/**
- * Show configuration.
- * @param {configType} config - The config.
- * @returns {void}
- */
-export const showConfig = (config) => {
-	const LINE = '-'.repeat(80);
-
-	console.log(LINE);
-	console.log(`NODE PL/SQL SERVER version ${getVersion()}`);
-	console.log(LINE);
-
-	console.log(`Server port:            ${config.port}`);
-	console.log(`Admin route:            ${config.adminRoute ?? '/admin'}${config.adminUser ? ' (authenticated)' : ''}`);
-	console.log(`Access log:             ${config.loggerFilename.length > 0 ? config.loggerFilename : ''}`);
-	console.log(`Upload file size limit: ${typeof config.uploadFileSizeLimit === 'number' ? `${config.uploadFileSizeLimit} bytes` : 'any'}`);
-
-	if (config.routeStatic.length > 0) {
-		console.log(LINE);
-		config.routeStatic.forEach((e) => {
-			console.log(`Static route:           ${e.route}`);
-			console.log(`Directory path:         ${e.directoryPath}`);
-		});
-	}
-
-	if (config.routePlSql.length > 0) {
-		console.log(LINE);
-		config.routePlSql.forEach((e) => {
-			let transactionMode = '';
-			if (typeof e.transactionMode === 'string') {
-				transactionMode = e.transactionMode;
-			} else if (typeof e.transactionMode === 'function') {
-				transactionMode = 'custom callback';
-			}
-
-			console.log(`Route:                  http://localhost:${config.port}${e.route}`);
-			console.log(`Oracle user:            ${e.user}`);
-			console.log(`Oracle server:          ${e.connectString}`);
-			console.log(`Oracle document table:  ${e.documentTable}`);
-			console.log(`Default page:           ${e.defaultPage}`);
-			console.log(`Path alias:             ${e.pathAlias}`);
-			console.log(`Path alias procedure:   ${e.pathAliasProcedure}`);
-			console.log(`Exclution list:         ${e.exclusionList?.join(', ')}`);
-			console.log(`Validation function:    ${e.requestValidationFunction}`);
-			console.log(`After request handler:  ${transactionMode}`);
-			console.log(`Error style:            ${e.errorStyle}`);
-		});
-	}
-
-	console.log(LINE);
-};

package/src/server/connections.js

@@ -1,40 +0,0 @@
-/**
- * @typedef {import('node:net').Socket} Socket
- */
-
-/**
- * @param {string} id - id
- * @param {string} ip - address
- * @param {string} port - port
- * @param {string} read - bytes read
- * @param {string} written - bytes written
- */
-const line = (id, ip, port, read, written) => {
-	console.log(`${id.padStart(3)}  ${ip.padEnd(15)}  ${port.padStart(5)}  ${read.padStart(10)}  ${written.padStart(10)}`);
-};
-
-/**
- * Show connections.
- * @param {Set<Socket>} connections - The connections.
- * @returns {void}
- */
-export const showConnections = (connections) => {
-	if (connections.size === 0) {
-		console.log('No open connections.');
-		return;
-	}
-
-	// Print header
-	line('ID', 'IP', 'Port', 'Read', 'Written');
-
-	let i = 0;
-	for (const socket of connections) {
-		line(
-			(i++).toString(),
-			socket.remoteAddress ?? '',
-			typeof socket.remotePort === 'number' ? socket.remotePort.toFixed() : '',
-			socket.bytesRead.toFixed(),
-			socket.bytesWritten.toFixed(),
-		);
-	}
-};