web_plsql 0.5.0 → 0.6.0

package/src/trace.ts

@@ -1,194 +0,0 @@
-/*
-*	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 +0,0 @@
-{
-    "env": {
-        "mocha": true
-    }
-}

package/test/__tests__/cgi.ts

@@ -1,96 +0,0 @@
-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;'
-		});
-	});
-});

package/test/__tests__/config.ts

@@ -1,41 +0,0 @@
-import {describe, it, expect} from '@jest/globals';
-import {validate} from '../../src/config';
-
-describe('configuration options', () => {
-	it('should allow the following options', () => {
-		[
-			undefined, // eslint-disable-line no-undefined
-			{},
-			{cgi: {fast: 'on'}},
-			{pathAlias: {alias: 'r', procedure: 'p'}},
-			{errorStyle: 'debug'}
-		].forEach(options => {
-			expect(typeof validate(options as unknown as Record<string, unknown>)).toBe('object');
-		});
-	});
-});
-
-describe('configuration errors', () => {
-	[
-		{config: null, error: 'Invalid configuration object was given'},
-		{config: {invalid: ''}, error: 'Invalid configuration options "invalid"'},
-		{config: {defaultPage: 1}, error: 'The option "defaultPage" must be of type string and cannot be empty'},
-		{config: {defaultPage: ''}, error: 'The option "defaultPage" must be of type string and cannot be empty'},
-		{config: {doctable: 1}, error: 'The option "doctable" must be of type string and cannot be empty'},
-		{config: {doctable: ''}, error: 'The option "doctable" must be of type string and cannot be empty'},
-		{config: {cgi: ''}, error: 'The option "cgi" must be an object where all keys and values are of type string'},
-		{config: {cgi: {a: 1}}, error: 'The option "cgi" must be an object where all keys and values are of type string'},
-		{config: {pathAlias: {alias: 'r', procedure: ''}}, error: 'The option "pathAlias" must be an object with the non-empty string properties "alias" and "procedure"'},
-		{config: {errorStyle: ''}, error: 'The optional option "errorStyle" must be "basic" or "debug"'},
-		{config: {errorStyle: 'on'}, error: 'The optional option "errorStyle" must be "basic" or "debug"'},
-		{config: {trace: true}, error: 'The optional option "trace" must be "on" or "off"'},
-		{config: {trace: ''}, error: 'The optional option "trace" must be "on" or "off"'},
-		{config: {trace: 'enabled'}, error: 'The optional option "trace" must be "on" or "off"'},
-	].forEach(test => {
-		it(`should throw the exception "${test.error}"`, () => {
-			expect(() => {
-				validate(test.config as unknown as Record<string, unknown>);
-			}).toThrow(test.error);
-		});
-	});
-});

package/test/__tests__/errorPage.ts

@@ -1,101 +0,0 @@
-import {describe, beforeAll, afterAll, it, expect} from '@jest/globals';
-import {errorPage} from '../../src/errorPage';
-import {RequestError} from '../../src/requestError';
-import {ProcedureError} from '../../src/procedureError';
-import {oracleExpressMiddleware$options} from '../../src/config';
-
-describe('errorPage', () => {
-	let errorSave: any;
-
-	beforeAll(() => {
-		errorSave = console.error;
-		console.error = () => {}; // eslint-disable-line @typescript-eslint/no-empty-function
-	});
-
-	afterAll(() => {
-		console.error = errorSave;
-	});
-
-	let errorText = '';
-	let errorHtml = '';
-
-	const options: oracleExpressMiddleware$options = {
-		errorStyle: 'debug',
-		trace: 'off'
-	};
-
-	const req: any = {};
-	const res: any = {
-		status() {
-			return this;
-		},
-		send(error: string) {
-			errorHtml = error;
-			return this;
-		}
-	};
-	const trace: any = {
-		write(error: string) {
-			errorText = error;
-		}
-	};
-
-	it('should report a "error message" in text and html format', () => {
-		errorPage(req, res, options, trace, new Error('error message'));
-
-		expect(/error message/.test(errorText)).toBeTruthy();
-		expect(/ERROR/.test(errorText)).toBeTruthy();
-		expect(/REQUEST/.test(errorText)).toBeTruthy();
-		expect(/error message/.test(errorHtml)).toBeTruthy();
-		expect(/TIMESTAMP/.test(errorHtml)).toBeTruthy();
-		expect(/ERROR/.test(errorHtml)).toBeTruthy();
-	});
-
-	it('should report a "Error" in text and html format', () => {
-		errorPage(req, res, options, trace, new Error('throw Error'));
-
-		expect(/throw Error/.test(errorText)).toBeTruthy();
-		expect(/ERROR/.test(errorText)).toBeTruthy();
-		expect(/REQUEST/.test(errorText)).toBeTruthy();
-		expect(/throw Error/.test(errorHtml)).toBeTruthy();
-		expect(/TIMESTAMP/.test(errorHtml)).toBeTruthy();
-		expect(/ERROR/.test(errorHtml)).toBeTruthy();
-	});
-
-	it('should report a "RequestError" in text and html format', () => {
-		errorPage(req, res, options, trace, new RequestError('throw RequestError'));
-
-		expect(/throw RequestError/.test(errorText)).toBeTruthy();
-		expect(/ERROR/.test(errorText)).toBeTruthy();
-		expect(/REQUEST/.test(errorText)).toBeTruthy();
-		expect(/throw RequestError/.test(errorHtml)).toBeTruthy();
-		expect(/TIMESTAMP/.test(errorHtml)).toBeTruthy();
-		expect(/ERROR/.test(errorHtml)).toBeTruthy();
-	});
-
-	it('should report a "ProcedureError" in text and html format', () => {
-		const environment = {dad: 'dad'};
-		const sql = 'sql';
-		const bind = {p1: '1'};
-
-		errorPage(req, res, options, trace, new ProcedureError('throw ProcedureError', environment, sql, bind));
-
-		expect(/throw ProcedureError/.test(errorText)).toBeTruthy();
-		expect(/ERROR/.test(errorText)).toBeTruthy();
-		expect(/REQUEST/.test(errorText)).toBeTruthy();
-		expect(/PROCEDURE/.test(errorText)).toBeTruthy();
-		expect(/ENVIRONMENT/.test(errorText)).toBeTruthy();
-		expect(/throw ProcedureError/.test(errorHtml)).toBeTruthy();
-		expect(/TIMESTAMP/.test(errorHtml)).toBeTruthy();
-		expect(/ERROR/.test(errorHtml)).toBeTruthy();
-		expect(/PROCEDURE/.test(errorHtml)).toBeTruthy();
-		expect(/ENVIRONMENT/.test(errorHtml)).toBeTruthy();
-	});
-
-	it('should only report a "404" error when in basic mode', () => {
-		options.errorStyle = 'basic';
-		errorPage(req, res, options, trace, new Error('error message'));
-
-		expect(/error message/.test(errorText)).toBeTruthy();
-	});
-});

package/test/__tests__/oracledb_mock.ts

@@ -1,98 +0,0 @@
-import {describe, beforeEach, it, expect} from '@jest/globals';
-import {setExecuteCallback, createPool, Connection, getConnection, ConnectionPool, Lob, BLOB} from '../mock/oracledb';
-
-describe('oracledb', () => {
-	it('createPool', async () => {
-		const connectionPool = await _createPool();
-		expect(connectionPool).toBeInstanceOf(ConnectionPool);
-		return connectionPool;
-	});
-
-	it('getConnection', async () => {
-		const connection = await _getConnection();
-		expect(connection).toBeInstanceOf(Connection);
-		return connection;
-	});
-});
-
-describe('ConnectionPool', () => {
-	it('getConnection', async () => {
-		const connectionPool = await _createPool();
-		const connection = await connectionPool.getConnection();
-
-		expect(connection).toBeInstanceOf(Connection);
-
-		return connection;
-	});
-
-	it('close', async () => {
-		const connectionPool = await _createPool();
-		await connectionPool.close();
-	});
-});
-
-describe('Connection', () => {
-	it('getConnection', async () => {
-		const connection = await _getConnection();
-		expect(connection).toBeInstanceOf(Connection);
-		return connection;
-	});
-
-	it('createLob', async () => {
-		const connection = await _getConnection();
-		const lob = await connection.createLob(BLOB);
-		expect(lob).toBeInstanceOf(Lob);
-		return lob;
-	});
-
-	it('release', async () => {
-		const connection = await _getConnection();
-		return connection.release();
-	});
-});
-
-describe('Connection.execute', () => {
-	beforeEach(() => {
-		setExecuteCallback();
-	});
-
-	it('execute', async () => {
-		const connection = await _getConnection();
-		expect(await connection.execute('select * from dual')).toStrictEqual({});
-	});
-
-	it('execute with execution callback', async () => {
-		const connection = await _getConnection();
-		const SQL = 'select * from dual';
-
-		// register an execute callback
-		setExecuteCallback((sql: string) => {
-			expect(sql).toBe(SQL);
-			return {sql: SQL};
-		});
-
-		expect(await connection.execute(SQL)).toStrictEqual({sql: SQL});
-	});
-});
-
-/*
-*	get connection pool
-*/
-function _createPool() {
-	return createPool({
-		user: 'sample',
-		password: 'sample',
-		connectString: 'localhost:1521/TEST'
-	});
-}
-
-/*
-*	get connection
-*/
-function _getConnection() {
-	return getConnection({
-		user: 'sample',
-		password: 'sample',
-		connectString: 'localhost:1521/TEST'
-	});
-}