web_plsql 0.3.2 → 0.5.0

package/src/trace.ts

@@ -1,193 +1,194 @@
-/*
-*	Trace utilities
-*/
-
-import fs from 'fs';
-import path from 'path';
-import mkdirp from 'mkdirp';
-import util from 'util';
-import express from 'express';
-
-const TRACE_ROOT_DIRECTORY = 'trace';
-const SEPARATOR_LINE = '*'.repeat(132);
-
-export class Trace {
-	_enabled: boolean;
-	_directory: string;
-	_filename: string;
-	_id: number;
-
-	/**
-	* Instantiate a new trace object.
-	*
-	* @param {'on' | 'off' | 'test'} trace - Tracing.
-	*/
-	constructor(trace: 'on' | 'off' | 'test') {
-		this._enabled = trace !== 'off';
-		this._directory = getTimestampDirectory();
-		this._filename = '';
-		this._id = 0;
-
-		// istanbul ignore if
-		if (!this._enabled) {
-			return;
-		}
-
-		// create the trace directory
-		try {
-			mkdirp.sync(this._directory);
-			if (trace === 'on') {
-				// istanbul ignore next
-				console.log(`Tracing to the directory "${this._directory}" is enabled.`);
-			}
-		} catch (e) {
-			// istanbul ignore next
-			console.error(`Unable to create new trace directory "${this._directory}"`, e);
-		}
-	}
-
-	/**
-	* Start a new trace session for a new request.
-	* This adds a trace line to the trace.log file and creating a new request trace file.
-	*
-	* @param {express.Request} req - The req object represents the HTTP request.
-	*/
-	start(req: express.Request) {
-		// istanbul ignore if
-		if (!this._enabled) {
-			return;
-		}
-
-		interface TCustomRequest extends express.Request {
-			uniqueRequestID: number;
-		}
-		const customRequest = req as TCustomRequest;
-
-		// Create the next unique request id
-		customRequest.uniqueRequestID = ++this._id;
-
-		// append to the trace index
-		appendSync(path.join(this._directory, 'trace.log'), `${customRequest.uniqueRequestID.toString().padEnd(10)} - ${getTimestamp()} - ${customRequest.originalUrl}\n`);
-
-		// compute the trace filename
-		this._filename = path.join(this._directory, customRequest.uniqueRequestID.toString() + '.log');
-
-		// write the initial request information
-		this.append(SEPARATOR_LINE +
-			getSection('TIMESTAMP', getTimestamp()) +
-			getSection('REQUEST ID', customRequest.uniqueRequestID.toString()) +
-			getSection('REQUEST', Trace.inspectRequest(req)) +
-			SEPARATOR_LINE +
-			'\n');
-	}
-
-	/**
-	* Write new message to the trace file.
-	*
-	* @param {string} text - Text to append.
-	*/
-	write(text: string): void {
-		// istanbul ignore else
-		if (this._enabled) {
-			this.append(`${getTimestamp()}:\n${trimRight(text)}\n${SEPARATOR_LINE}\n`);
-		}
-	}
-
-	/**
-	* Append text to the trace file.
-	*
-	* @param {string} text - Text to append.
-	*/
-	append(text: string): void {
-		// istanbul ignore else
-		if (this._enabled) {
-			appendSync(this._filename, text);
-		}
-	}
-
-	/**
-	* Return a string representation of the value.
-	*
-	* @param {*} value - Any value.
-	* @returns {string} - The string representation.
-	*/
-	static inspect(value: any): string {
-		return util.inspect(value, {showHidden: false, depth: null, colors: false});
-	}
-
-	/**
-	* Return a string representation of the request.
-	*
-	* @param {any} req - express.Request.
-	* @param {boolean} simple - Set to false to see all public properties of the request.
-	* @returns {string} - The string representation.
-	*/
-	static inspectRequest(req: any, simple: boolean = true): string {
-		const simpleRequest: any = {};
-
-		// istanbul ignore else
-		if (simple) {
-			['originalUrl', 'params', 'query', 'url', 'method', 'body', 'files', 'secret', 'cookies'].forEach(key => {
-				if (req[key]) {
-					simpleRequest[key] = req[key];
-				}
-			});
-		} else {
-			Object.keys(req).filter(key => typeof key === 'string' && key.length > 1 && key[0] !== '_').forEach(key => {
-				simpleRequest[key] = req[key];
-			});
-		}
-
-		return util.inspect(simpleRequest, {showHidden: false, depth: null, colors: false});
-	}
-}
-
-/**
-* Append text to the trace file.
-*
-* @param {string} filename - Trace file name.
-* @param {string} text - Text to append.
-*/
-function appendSync(filename: string, text: string): void {
-	try {
-		fs.appendFileSync(filename, text);
-	} catch (e) {
-		// istanbul ignore next
-		console.error(`Unable to write to trace file "${filename}"`, e, text);
-	}
-}
-
-/*
-*	get a section of a trace message
-*/
-function getSection(section: string, text: string): string {
-	return `\n${section}\n${'='.repeat(section.length)}\n${text}\n`;
-}
-
-/*
-*	get a timestamp
-*/
-function getTimestamp(): string {
-	return new Date().toISOString();
-}
-
-/*
-*	get a new directory name based on the current timestamp
-*/
-function getTimestampDirectory(): string {
-	return path.join(TRACE_ROOT_DIRECTORY, getTimestamp().replace(/(-|:)/g, ''));
-}
-
-/*
-*	trim any cr/lf at the end of the string
-*/
-function trimRight(text: string): string {
-	let s = text;
-
-	while (s[s.length] === '\n' || s[s.length] === '\r') {
-		// istanbul ignore next
-		s = s.slice(0, -1);
-	}
-
-	return s;
-}
+/*
+*	Trace utilities
+*/
+
+import fs from 'fs';
+import path from 'path';
+import mkdirp from 'mkdirp';
+import util from 'util';
+import express from 'express';
+
+const TRACE_ROOT_DIRECTORY = 'trace';
+const SEPARATOR_LINE = '*'.repeat(132);
+
+export class Trace {
+	_enabled: boolean;
+	_directory: string;
+	_filename: string;
+	_id: number;
+
+	/**
+	* Instantiate a new trace object.
+	*
+	* @param {'on' | 'off' | 'test'} trace - Tracing.
+	*/
+	constructor(trace: 'on' | 'off' | 'test') {
+		this._enabled = trace !== 'off';
+		this._directory = getTimestampDirectory();
+		this._filename = '';
+		this._id = 0;
+
+		// istanbul ignore if
+		if (!this._enabled) {
+			return;
+		}
+
+		// create the trace directory
+		try {
+			mkdirp.sync(this._directory);
+			if (trace === 'on') {
+				// istanbul ignore next
+				console.log(`Tracing to the directory "${this._directory}" is enabled.`);
+			}
+		} catch (e) {
+			// istanbul ignore next
+			console.error(`Unable to create new trace directory "${this._directory}"`, e);
+		}
+	}
+
+	/**
+	* Start a new trace session for a new request.
+	* This adds a trace line to the trace.log file and creating a new request trace file.
+	*
+	* @param {express.Request} req - The req object represents the HTTP request.
+	*/
+	start(req: express.Request): void {
+		// istanbul ignore if
+		if (!this._enabled) {
+			return;
+		}
+
+		interface TCustomRequest extends express.Request {
+			uniqueRequestID: number;
+		}
+		const customRequest = req as TCustomRequest;
+
+		// Create the next unique request id
+		customRequest.uniqueRequestID = ++this._id;
+
+		// append to the trace index
+		appendSync(path.join(this._directory, 'trace.log'), `${customRequest.uniqueRequestID.toString().padEnd(10)} - ${getTimestamp()} - ${customRequest.originalUrl}\n`);
+
+		// compute the trace filename
+		this._filename = path.join(this._directory, customRequest.uniqueRequestID.toString() + '.log');
+
+		// write the initial request information
+		this.append(SEPARATOR_LINE +
+			getSection('TIMESTAMP', getTimestamp()) +
+			getSection('REQUEST ID', customRequest.uniqueRequestID.toString()) +
+			getSection('REQUEST', Trace.inspectRequest(req)) +
+			SEPARATOR_LINE +
+			'\n');
+	}
+
+	/**
+	* Write new message to the trace file.
+	*
+	* @param {string} text - Text to append.
+	*/
+	write(text: string): void {
+		// istanbul ignore else
+		if (this._enabled) {
+			this.append(`${getTimestamp()}:\n${trimRight(text)}\n${SEPARATOR_LINE}\n`);
+		}
+	}
+
+	/**
+	* Append text to the trace file.
+	*
+	* @param {string} text - Text to append.
+	*/
+	append(text: string): void {
+		// istanbul ignore else
+		if (this._enabled) {
+			appendSync(this._filename, text);
+		}
+	}
+
+	/**
+	* Return a string representation of the value.
+	*
+	* @param {unknown} value - Any value.
+	* @returns {string} - The string representation.
+	*/
+	static inspect(value: unknown): string {
+		return util.inspect(value, {showHidden: false, depth: null, colors: false});
+	}
+
+	/**
+	* Return a string representation of the request.
+	*
+	* @param {express.Request} req - express.Request.
+	* @param {boolean} simple - Set to false to see all public properties of the request.
+	* @returns {string} - The string representation.
+	*/
+	static inspectRequest(req: express.Request, simple: boolean = true): string {
+		type RequestKeysType = keyof express.Request;
+		const simpleRequest: any = {};
+
+		// istanbul ignore else
+		if (simple) {
+			['originalUrl', 'params', 'query', 'url', 'method', 'body', 'files', 'secret', 'cookies'].forEach(key => {
+				if (req[key as RequestKeysType]) {
+					simpleRequest[key] = req[key as RequestKeysType];
+				}
+			});
+		} else {
+			Object.keys(req).filter(key => typeof key === 'string' && key.length > 1 && key[0] !== '_').forEach(key => {
+				simpleRequest[key] = req[key as RequestKeysType];
+			});
+		}
+
+		return util.inspect(simpleRequest, {showHidden: false, depth: null, colors: false});
+	}
+}
+
+/**
+* Append text to the trace file.
+*
+* @param {string} filename - Trace file name.
+* @param {string} text - Text to append.
+*/
+function appendSync(filename: string, text: string): void {
+	try {
+		fs.appendFileSync(filename, text);
+	} catch (e) {
+		// istanbul ignore next
+		console.error(`Unable to write to trace file "${filename}"`, e, text);
+	}
+}
+
+/*
+*	get a section of a trace message
+*/
+function getSection(section: string, text: string): string {
+	return `\n${section}\n${'='.repeat(section.length)}\n${text}\n`;
+}
+
+/*
+*	get a timestamp
+*/
+function getTimestamp(): string {
+	return new Date().toISOString();
+}
+
+/*
+*	get a new directory name based on the current timestamp
+*/
+function getTimestampDirectory(): string {
+	return path.join(TRACE_ROOT_DIRECTORY, getTimestamp().replace(/(-|:)/g, ''));
+}
+
+/*
+*	trim any cr/lf at the end of the string
+*/
+function trimRight(text: string): string {
+	let s = text;
+
+	while (s[s.length] === '\n' || s[s.length] === '\r') {
+		// istanbul ignore next
+		s = s.slice(0, -1);
+	}
+
+	return s;
+}

package/test/.eslintrc.json

@@ -1,5 +1,5 @@
-{
-    "env": {
-        "mocha": true
-    }
-}
+{
+    "env": {
+        "mocha": true
+    }
+}

package/test/{cgi.ts → __tests__/cgi.ts}

@@ -1,95 +1,96 @@
-import {assert} from 'chai';
-import {getCGI} from '../src/cgi';
-import os from 'os';
-
-describe('cgi', () => {
-	it('with a proper configuration object and request', () => {
-		const PORT = 4711;
-		const ORIGINAL_URL = '/pls/base/package.procedure?p=1#1';
-		const DOCUMENT_TABLE_NAME = 'doc-table';
-		const REMOTE_ADDRESS = '127.0.0.1';
-
-		const req = {
-			protocol: 'http',
-			originalUrl: ORIGINAL_URL,
-			method: 'GET',
-			params: {
-				name: 'index.html'
-			},
-			httpVersion: '1.1',
-			ip: REMOTE_ADDRESS,
-			get(name: string) {
-				switch (name.toLowerCase())	{
-					case 'port':
-						return PORT.toString();
-					case 'host':
-						return 'HOST';
-					case 'user-agent':
-						return 'USER-AGENT';
-					case 'accept':
-						return 'ACCEPT';
-					case 'accept-encoding':
-						return 'ACCEPT-ENCODING';
-					case 'accept-language':
-						return 'ACCEPT-LANGUAGE';
-					case 'referer':
-					case 'referrer':
-						return 'HTTP-REFERER';
-					default:
-						return null;
-				}
-			},
-			cookies: {
-				cookie1: 'value1',
-				cookie2: 'value2'
-			},
-			connection: {
-				remoteAddress: REMOTE_ADDRESS
-			},
-			socket: {
-				localPort: PORT
-			}
-		};
-
-		const options = {
-			doctable: DOCUMENT_TABLE_NAME
-		};
-
-		//@ts-ignore
-		const cgi = getCGI(req, options);
-
-		assert.strictEqual(Object.keys(cgi).length, 29);
-
-		assert.deepEqual(cgi, {
-			'PLSQL_GATEWAY': 'WebDb',
-			'GATEWAY_IVERSION': '2',
-			'SERVER_SOFTWARE': 'web_plsql',
-			'GATEWAY_INTERFACE': 'CGI/1.1',
-			'SERVER_PORT': PORT.toString(),
-			'SERVER_NAME': os.hostname(),
-			'REQUEST_METHOD': 'GET',
-			'PATH_INFO': 'index.html',
-			'SCRIPT_NAME': '/pls/base',
-			'REMOTE_ADDR': REMOTE_ADDRESS,
-			'SERVER_PROTOCOL': 'HTTP/1.1',
-			'REQUEST_PROTOCOL': 'HTTP',
-			'REMOTE_USER': '',
-			'HTTP_USER_AGENT': 'USER-AGENT',
-			'HTTP_X_FORWARDED_FOR': '',
-			'HTTP_HOST': 'HOST',
-			'HTTP_ACCEPT': 'ACCEPT',
-			'HTTP_ACCEPT_ENCODING': 'ACCEPT-ENCODING',
-			'HTTP_ACCEPT_LANGUAGE': 'ACCEPT-LANGUAGE',
-			'HTTP_REFERER': 'HTTP-REFERER',
-			'WEB_AUTHENT_PREFIX': '',
-			'DAD_NAME': 'base',
-			'DOC_ACCESS_PATH': 'doc',
-			'DOCUMENT_TABLE': DOCUMENT_TABLE_NAME,
-			'PATH_ALIAS': '',
-			'REQUEST_CHARSET': 'UTF8',
-			'REQUEST_IANA_CHARSET': 'UTF-8',
-			'SCRIPT_PREFIX': '/pls',
-			'HTTP_COOKIE': 'cookie1=value1;cookie2=value2;'
-		});
-	});
-});
+import {describe, it, expect} from '@jest/globals';
+import {getCGI} from '../../src/cgi';
+import express from 'express';
+import os from 'os';
+import type {oracleExpressMiddleware$options} from '../../src/config';
+
+describe('cgi', () => {
+	it('with a proper configuration object and request', () => {
+		const PORT = 4711;
+		const ORIGINAL_URL = '/pls/base/package.procedure?p=1#1';
+		const DOCUMENT_TABLE_NAME = 'doc-table';
+		const REMOTE_ADDRESS = '127.0.0.1';
+
+		const req = {
+			protocol: 'http',
+			originalUrl: ORIGINAL_URL,
+			method: 'GET',
+			params: {
+				name: 'index.html'
+			},
+			httpVersion: '1.1',
+			ip: REMOTE_ADDRESS,
+			get(name: string) {
+				switch (name.toLowerCase())	{
+					case 'port':
+						return PORT.toString();
+					case 'host':
+						return 'HOST';
+					case 'user-agent':
+						return 'USER-AGENT';
+					case 'accept':
+						return 'ACCEPT';
+					case 'accept-encoding':
+						return 'ACCEPT-ENCODING';
+					case 'accept-language':
+						return 'ACCEPT-LANGUAGE';
+					case 'referer':
+					case 'referrer':
+						return 'HTTP-REFERER';
+					default:
+						return null;
+				}
+			},
+			cookies: {
+				cookie1: 'value1',
+				cookie2: 'value2'
+			},
+			connection: {
+				remoteAddress: REMOTE_ADDRESS
+			},
+			socket: {
+				localPort: PORT
+			}
+		};
+
+		const options = {
+			doctable: DOCUMENT_TABLE_NAME
+		};
+
+		const cgi = getCGI(req as unknown as express.Request, options as unknown as oracleExpressMiddleware$options);
+
+		expect(Object.keys(cgi)).toHaveLength(29);
+
+		expect(cgi).toStrictEqual({
+			'PLSQL_GATEWAY': 'WebDb',
+			'GATEWAY_IVERSION': '2',
+			'SERVER_SOFTWARE': 'web_plsql',
+			'GATEWAY_INTERFACE': 'CGI/1.1',
+			'SERVER_PORT': PORT.toString(),
+			'SERVER_NAME': os.hostname(),
+			'REQUEST_METHOD': 'GET',
+			'PATH_INFO': 'index.html',
+			'SCRIPT_NAME': '/pls/base',
+			'REMOTE_ADDR': REMOTE_ADDRESS,
+			'SERVER_PROTOCOL': 'HTTP/1.1',
+			'REQUEST_PROTOCOL': 'HTTP',
+			'REMOTE_USER': '',
+			'HTTP_USER_AGENT': 'USER-AGENT',
+			'HTTP_X_FORWARDED_FOR': '',
+			'HTTP_HOST': 'HOST',
+			'HTTP_ACCEPT': 'ACCEPT',
+			'HTTP_ACCEPT_ENCODING': 'ACCEPT-ENCODING',
+			'HTTP_ACCEPT_LANGUAGE': 'ACCEPT-LANGUAGE',
+			'HTTP_REFERER': 'HTTP-REFERER',
+			'WEB_AUTHENT_PREFIX': '',
+			'DAD_NAME': 'base',
+			'DOC_ACCESS_PATH': 'doc',
+			'DOCUMENT_TABLE': DOCUMENT_TABLE_NAME,
+			'PATH_ALIAS': '',
+			'REQUEST_CHARSET': 'UTF8',
+			'REQUEST_IANA_CHARSET': 'UTF-8',
+			'SCRIPT_PREFIX': '/pls',
+			'HTTP_COOKIE': 'cookie1=value1;cookie2=value2;'
+		});
+	});
+});