web_plsql 0.5.1 → 0.6.0

package/jest.config.js

@@ -1,207 +0,0 @@
-/*
- * For a detailed explanation regarding each configuration property, visit:
- * https://jestjs.io/docs/configuration
- */
-
-module.exports = {
-  // All imported modules in your tests should be mocked automatically
-  // automock: false,
-
-  // Stop running tests after `n` failures
-  // bail: 0,
-
-  // The directory where Jest should store its cached dependency information
-  // cacheDirectory: "/private/var/folders/2y/kvrr5nws6xz4nx9vnwjxj17w0000gn/T/jest_dx",
-
-  // Automatically clear mock calls, instances, contexts and results before every test
-  // clearMocks: false,
-
-  // Indicates whether the coverage information should be collected while executing the test
-  collectCoverage: true,
-
-  // An array of glob patterns indicating a set of files for which coverage information should be collected
-  // collectCoverageFrom: undefined,
-  collectCoverageFrom: ['./src/**/*.{ts,js}'],
-
-  // The directory where Jest should output its coverage files
-  coverageDirectory: "coverage",
-
-  // An array of regexp pattern strings used to skip coverage collection
-  // coveragePathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // Indicates which provider should be used to instrument code for coverage
-  coverageProvider: "v8",
-
-  // A list of reporter names that Jest uses when writing coverage reports
-  // coverageReporters: [
-  //   "json",
-  //   "text",
-  //   "lcov",
-  //   "clover"
-  // ],
-
-  // An object that configures minimum threshold enforcement for coverage results
-  // coverageThreshold: undefined,
-
-  // A path to a custom dependency extractor
-  // dependencyExtractor: undefined,
-
-  // Make calling deprecated APIs throw helpful error messages
-  // errorOnDeprecated: false,
-
-  // The default configuration for fake timers
-  // fakeTimers: {
-  //   "enableGlobally": false
-  // },
-
-  // Force coverage collection from ignored files using an array of glob patterns
-  // forceCoverageMatch: [],
-
-  // A path to a module which exports an async function that is triggered once before all test suites
-  // globalSetup: undefined,
-
-  // A path to a module which exports an async function that is triggered once after all test suites
-  // globalTeardown: undefined,
-
-  // A set of global variables that need to be available in all test environments
-  // globals: {},
-
-  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
-  // maxWorkers: "50%",
-
-  // An array of directory names to be searched recursively up from the requiring module's location
-  // moduleDirectories: [
-  //   "node_modules"
-  // ],
-
-  // An array of file extensions your modules use
-  // moduleFileExtensions: [
-  //   "js",
-  //   "mjs",
-  //   "cjs",
-  //   "jsx",
-  //   "ts",
-  //   "tsx",
-  //   "json",
-  //   "node"
-  // ],
-
-  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-  // moduleNameMapper: {},
-
-  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-  // modulePathIgnorePatterns: [],
-
-  // Activates notifications for test results
-  // notify: false,
-
-  // An enum that specifies notification mode. Requires { notify: true }
-  // notifyMode: "failure-change",
-
-  // A preset that is used as a base for Jest's configuration
-  // preset: undefined,
-  preset: 'ts-jest',
-
-  // Run tests from one or more projects
-  // projects: undefined,
-
-  // Use this configuration option to add custom reporters to Jest
-  // reporters: undefined,
-
-  // Automatically reset mock state before every test
-  // resetMocks: false,
-
-  // Reset the module registry before running each individual test
-  // resetModules: false,
-
-  // A path to a custom resolver
-  // resolver: undefined,
-
-  // Automatically restore mock state and implementation before every test
-  // restoreMocks: false,
-
-  // The root directory that Jest should scan for tests and modules within
-  // rootDir: undefined,
-
-  // A list of paths to directories that Jest should use to search for files in
-  // roots: [
-  //   "<rootDir>"
-  // ],
-
-  // Allows you to use a custom runner instead of Jest's default test runner
-  // runner: "jest-runner",
-
-  // The paths to modules that run some code to configure or set up the testing environment before each test
-  // setupFiles: [],
-
-  // A list of paths to modules that run some code to configure or set up the testing framework before each test
-  // setupFilesAfterEnv: [],
-
-  // The number of seconds after which a test is considered as slow and reported as such in the results.
-  // slowTestThreshold: 5,
-
-  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
-  // snapshotSerializers: [],
-
-  // The test environment that will be used for testing
-  // testEnvironment: "jest-environment-node",
-
-  // Options that will be passed to the testEnvironment
-  // testEnvironmentOptions: {},
-
-  // Adds a location field to test results
-  // testLocationInResults: false,
-
-  // The glob patterns Jest uses to detect test files
-  // testMatch: [
-  //   "**/__tests__/**/*.[jt]s?(x)",
-  //   "**/?(*.)+(spec|test).[tj]s?(x)"
-  // ],
-
-  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-  // testPathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // The regexp pattern or array of patterns that Jest uses to detect test files
-  // testRegex: [],
-
-  // This option allows the use of a custom results processor
-  // testResultsProcessor: undefined,
-
-  // This option allows use of a custom test runner
-  // testRunner: "jest-circus/runner",
-
-  // A map from regular expressions to paths to transformers
-  // transform: undefined,
-	transform: {
-		'\\.[jt]sx?$': [
-			'ts-jest',
-			{
-				tsconfig: 'tsconfig.src.json',
-				diagnostics: true,
-				useESM: true,
-			},
-		],
-	},
-
-  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-  // transformIgnorePatterns: [
-  //   "/node_modules/",
-  //   "\\.pnp\\.[^\\/]+$"
-  // ],
-
-  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
-  // unmockedModulePathPatterns: undefined,
-
-  // Indicates whether each individual test should be reported during the run
-  // verbose: undefined,
-
-  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
-  // watchPathIgnorePatterns: [],
-
-  // Whether to use watchman for file crawling
-  // watchman: true,
-};

package/src/cgi.ts

@@ -1,95 +0,0 @@
-/*
-*	Prepare the CGI information
-*/
-
-import os from 'os';
-import {URL} from 'url';
-import express from 'express';
-export type environmentType = {[key: string]: string};
-import type {oracleExpressMiddleware$options} from './config';
-
-/**
-* Create a CGI object
-*
-* @param {express.Request} req - The req object represents the HTTP request.
-* @param {oracleExpressMiddleware$options} options - the options for the middleware.
-* @returns {string} CGI object
-*/
-export function getCGI(req: express.Request, options: oracleExpressMiddleware$options): environmentType {
-	const PROTOCOL = req.protocol ? req.protocol.toUpperCase() : '';
-	const CHARSET = 'UTF8';
-	const IANA_CHARSET = 'UTF-8';
-	const PATH = getPath(req);
-
-	const DEFAULT_CGI: environmentType = {
-		'PLSQL_GATEWAY': 'WebDb',
-		'GATEWAY_IVERSION': '2',
-		'SERVER_SOFTWARE': 'web_plsql',
-		'GATEWAY_INTERFACE': 'CGI/1.1',
-		'SERVER_PORT': typeof req.socket.localPort === 'number' ? req.socket.localPort.toString() : '',
-		'SERVER_NAME': os.hostname(),
-		'REQUEST_METHOD': req.method,
-		'PATH_INFO': req.params.name,
-		'SCRIPT_NAME': PATH.script,
-		'REMOTE_ADDR': (req.ip || '').replace('::ffff:', ''),
-		'SERVER_PROTOCOL': PROTOCOL + '/' + req.httpVersion,
-		'REQUEST_PROTOCOL': PROTOCOL,
-		'REMOTE_USER': '',
-		'HTTP_COOKIE': getCookieString(req),
-		'HTTP_USER_AGENT': req.get('user-agent') || '',
-		'HTTP_HOST': req.get('host') || '',
-		'HTTP_ACCEPT': req.get('accept') || '',
-		'HTTP_ACCEPT_ENCODING': req.get('accept-encoding') || '',
-		'HTTP_ACCEPT_LANGUAGE': req.get('accept-language') || '',
-		'HTTP_REFERER': req.get('referer') || '',
-		'HTTP_X_FORWARDED_FOR': req.get('x-forwarded-for') || '',
-		'WEB_AUTHENT_PREFIX': '',
-		'DAD_NAME': PATH.dad,
-		'DOC_ACCESS_PATH': 'doc',
-		'DOCUMENT_TABLE': options.doctable || '',
-		'PATH_ALIAS': '',
-		'REQUEST_CHARSET': CHARSET,
-		'REQUEST_IANA_CHARSET': IANA_CHARSET,
-		'SCRIPT_PREFIX': PATH.prefix
-	};
-
-	return Object.assign(DEFAULT_CGI, options.cgi);
-}
-
-/*
-* Create the HTTP_COOKIE string
-*/
-function getCookieString(req: express.Request): string {
-	let cookieString = '';
-
-	for (const propName in req.cookies) {
-		cookieString += propName + '=' + req.cookies[propName] + ';';
-	}
-
-	return cookieString;
-}
-
-/*
-* Get the script name and DAD name from a URL
-*/
-function getPath(req: express.Request): {script: string; prefix: string; dad: string} {
-	// create a valid url
-	const validUrl = req.protocol + '://' + os.hostname() + req.originalUrl;
-
-	// get the pathname from the url (new URL('https://example.org/abc/xyz?123').pathname => /abc/xyz)
-	const pathname = new URL(validUrl).pathname;
-
-	const tmp = trimPath(pathname.substr(0, pathname.lastIndexOf('/') + 1));
-	const script = '/' + tmp;
-	const prefix = '/' + tmp.substr(0, tmp.lastIndexOf('/'));
-	const dad = tmp.substr(tmp.indexOf('/') + 1);
-
-	return {script,	prefix, dad};
-}
-
-/*
-* Get a path that is not enclodes in slashes
-*/
-function trimPath(value: string): string {
-	return value.replace(/^\/+|\/+$/g, '');
-}

package/src/config.ts

@@ -1,97 +0,0 @@
-/*
-*	Configuration
-*/
-
-import {environmentType} from './cgi';
-export type oracleExpressMiddleware$options = {
-	defaultPage?: string;
-	doctable?: string;
-	cgi?: environmentType;
-	pathAlias?: {
-		alias: string;
-		procedure: string;
-	};
-	errorStyle: 'basic' | 'debug';
-	trace: 'on' | 'off' | 'test';
-};
-
-/**
-* Validation the configuration options.
-*
-* @param {Object} options - The configuration options.
-* @returns {oracleExpressMiddleware$options} - The validated configuration options.
-*/
-export function validate(options: Record<string, any>): oracleExpressMiddleware$options {
-	const validOptions: oracleExpressMiddleware$options = {
-		errorStyle: 'basic',
-		trace: 'off'
-	};
-
-	if (typeof options !== 'undefined') {
-		if (arguments.length !== 1 || typeof options !== 'object' || options === null) {
-			throw new TypeError('Invalid configuration object was given');
-		}
-		Object.keys(options).forEach(option => {
-			if (['defaultPage', 'doctable', 'cgi', 'pathAlias', 'errorStyle', 'trace'].indexOf(option) === -1) {
-				throw new TypeError(`Invalid configuration options "${option}"`);
-			}
-		});
-	} else {
-		return validOptions;
-	}
-
-	if (typeof options.defaultPage !== 'undefined') {
-		if (typeof options.defaultPage === 'string' && options.defaultPage.length > 0) {
-			validOptions.defaultPage = options.defaultPage;
-		} else {
-			throw new TypeError('The option "defaultPage" must be of type string and cannot be empty');
-		}
-	}
-
-	if (typeof options.doctable !== 'undefined') {
-		if (typeof options.doctable === 'string' && options.doctable.length > 0) {
-			validOptions.doctable = options.doctable;
-		} else {
-			throw new TypeError('The option "doctable" must be of type string and cannot be empty');
-		}
-	}
-
-	if (typeof options.cgi !== 'undefined') {
-		if (typeof options.cgi === 'object' && Object.keys(options.cgi).every(key => typeof key === 'string') && Object.values(options.cgi).every(value => typeof value === 'string')) {
-			validOptions.cgi = Object.assign({}, options.cgi);
-		} else {
-			throw new TypeError('The option "cgi" must be an object where all keys and values are of type string');
-		}
-	}
-
-	if (typeof options.pathAlias !== 'undefined') {
-		if (typeof options.pathAlias === 'object' &&
-			typeof options.pathAlias.alias === 'string' && options.pathAlias.alias.length > 0 &&
-			typeof options.pathAlias.procedure === 'string' && options.pathAlias.procedure.length > 0) {
-			validOptions.pathAlias = {
-				alias: options.pathAlias.alias,
-				procedure: options.pathAlias.procedure
-			};
-		} else {
-			throw new TypeError('The option "pathAlias" must be an object with the non-empty string properties "alias" and "procedure"');
-		}
-	}
-
-	if (typeof options.errorStyle !== 'undefined') {
-		if (typeof options.errorStyle !== 'string' || ['basic', 'debug'].indexOf(options.errorStyle) === -1) {
-			throw new TypeError('The optional option "errorStyle" must be "basic" or "debug"');
-		} else {
-			validOptions.errorStyle = options.errorStyle as 'basic' | 'debug';
-		}
-	}
-
-	if (typeof options.trace !== 'undefined') {
-		if (typeof options.trace !== 'string' || ['on', 'off', 'test'].indexOf(options.trace.toLowerCase()) === -1) {
-			throw new TypeError('The optional option "trace" must be "on" or "off"');
-		} else {
-			validOptions.trace = options.trace.toLowerCase() as 'on' | 'off' | 'test';
-		}
-	}
-
-	return validOptions;
-}

package/src/errorPage.ts

@@ -1,286 +0,0 @@
-/*
-*	Error handling
-*/
-
-import util from 'util';
-import escape from 'escape-html';
-import {ProcedureError} from './procedureError';
-import {RequestError} from './requestError';
-import express from 'express';
-import {Trace} from './trace';
-import {oracleExpressMiddleware$options} from './config';
-import {environmentType} from './cgi';
-type outputType = {html: string; text: string};
-
-/**
-* Show an error page
-*
-* @param {express.Request} req - The req object represents the HTTP request.
-* @param {express.Response} res - The res object represents the HTTP response that an Express app sends when it gets an HTTP request.
-* @param {Object} options - The configuration options.
-* @param {Trace} trace - Tracing object.
-* @param {Error} error - The error.
-*/
-export function errorPage(req: express.Request, res: express.Response, options: oracleExpressMiddleware$options, trace: Trace, error: unknown): void {
-	let output = {
-		html: '',
-		text: ''
-	};
-
-	// get the error description
-	try {
-		output = getError(req, error);
-	} catch (err) {
-		/* istanbul ignore next */
-		const header = 'ERROR';
-
-		/* istanbul ignore next */
-		const message = err instanceof Error ? `${err.message}\n${err.stack}` : JSON.stringify(err);
-
-		/* istanbul ignore next */
-		output.html += getHeaderHtml(header) + getHtml(message);
-
-		/* istanbul ignore next */
-		output.text += getHeaderHtml(header) + getHtml(message);
-	}
-
-	// trace to file
-	trace.write(output.text);
-
-	// console
-	console.error(output.text);
-
-	// show page
-	if (options.errorStyle === 'basic') {
-		res.status(404).send('Page not found');
-	} else {
-		res.status(404).send(getHtmlPage(output.html));
-	}
-}
-
-/*
-* Show an error page
-*/
-function getError(req: express.Request, error: unknown): outputType {
-	let timestamp: Date = new Date();
-	let message: string = '';
-	let environment: environmentType | null = null;
-	let sql: string | null = null;
-	let bind: any | null = null;
-
-	// 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 = error.stack || '';
-	} else {
-		if (typeof error === 'string') {
-			/* istanbul ignore next */
-			message = error + '\n';
-		}
-		try {
-			/* istanbul ignore next */
-			new Error(); // eslint-disable-line no-new
-		} catch (err) {
-			/* istanbul ignore next */
-			message += err instanceof Error ? err.stack : '';
-		}
-	}
-
-	const output: outputType = {
-		html: '',
-		text: ''
-	};
-
-	// timestamp
-	let header = 'TIMESTAMP';
-	output.html += getHeaderHtml(header);
-	output.html += getHtml(timestamp.toUTCString());
-
-	// error
-	header = 'ERROR';
-	output.html += getHeaderHtml(header);
-	output.html += getHtml(message);
-	output.text += getHeaderText(header);
-	output.text += getText(message);
-
-	// request
-	header = 'REQUEST';
-	output.text += getHeaderText(header);
-	output.text += getText(Trace.inspectRequest(req));
-
-	// parameters
-	if (typeof sql === 'string' && bind) {
-		header = 'PROCEDURE';
-		output.html += getHeaderHtml(header);
-		output.text += getHeaderText(header);
-		getProcedure(output, sql, bind);
-	}
-
-	// environment
-	if (environment) {
-		header = 'ENVIRONMENT';
-		output.html += getHeaderHtml(header);
-		output.text += getHeaderText(header);
-		getEnvironment(output, environment);
-	}
-
-	return output;
-}
-
-/*
-* get procedure
-*/
-function getProcedure(output: outputType, sql: string, bind: any) {
-	let html = '<table>';
-	let text = '';
-
-	text += 'PROCEDURE: ' + sql + '\n';
-	html += `<tr><td>PROCEDURE:</td><td>${sql}</td></tr>`;
-
-	try {
-		/* istanbul ignore else */
-		if (sql.indexOf('(:argnames, :argvalues)') < 0) {
-			for (const key in bind) {
-				const value = inspect(bind[key].val);
-
-				html += `<tr><td>${key}:</td><td>${value}</td></tr>`;
-				text += key + ': ' + value + '\n';
-			}
-		} else {
-			bind.argnames.val.forEach((name: string, index: number) => {
-				const value = inspect(bind.argvalues.val[index]);
-
-				html += `<tr><td>${name}:</td><td>${value}</td></tr>`;
-				text += name + ': ' + value + '\n';
-			});
-		}
-	} catch (err) {
-		/* istanbul ignore next */
-		output.html += err instanceof Error ? err.toString() : 'ERROR';
-
-		/* istanbul ignore next */
-		output.text += err instanceof Error ? err.toString() : 'ERROR';
-		/* istanbul ignore next */
-		return;
-	}
-
-	html += '</table>';
-
-	output.html += html;
-	output.text += text;
-}
-
-/*
-* get evnironment
-*/
-function getEnvironment(output: outputType, environment: environmentType) {
-	let html = '<table>';
-	let text = '';
-
-	try {
-		for (const key in environment) {
-			html += `<tr><td>${key}:</td><td>${environment[key]}</td></tr>`;
-			text += key + '=' + environment[key] + '\n';
-		}
-	} catch (err) {
-		/* istanbul ignore next */
-		output.html += err instanceof Error ? err.toString() : 'ERROR';
-
-		/* istanbul ignore next */
-		output.text += err instanceof Error ? err.toString() : 'ERROR';
-
-		/* istanbul ignore next */
-		return;
-	}
-
-	html += '</table>';
-
-	output.html += html;
-	output.text += text;
-}
-
-/*
-*	get text header
-*/
-function getHeaderText(text: string): string {
-	return `\n${text}\n${'='.repeat(text.length)}\n`;
-}
-
-/*
-*	get html header
-*/
-function getHeaderHtml(text: string): string {
-	return `<h1>${text}</h1>`;
-}
-
-/*
-*	get text
-*/
-function getText(text: string): string {
-	return text + '\n';
-}
-
-/*
-*	get html
-*/
-function getHtml(text: string): string {
-	return `<p>${convertToHtml(text)}</p>`;
-}
-
-/*
-*	convert value to string
-*/
-function inspect(value: any): string {
-	return util.inspect(value, {showHidden: false, depth: null, colors: false});
-}
-
-/*
-*	convert LF and/or CR to <br>
-*/
-function convertToHtml(text: string): string {
-	let html = escape(text);
-
-	html = html.replace(/(?:\r\n|\r|\n)/g, '<br />');
-	html = html.replace(/\t/g, '&nbsp;&nbsp;&nbsp;');
-
-	return html;
-}
-
-/*
-*	getHtmlPage
-*/
-function getHtmlPage(body: string): string {
-	return `<!DOCTYPE html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<title>web_plsql error page</title>
-<style type="text/css">
-html {
-	font-family: monospace, sans-serif;
-	font-size: 12px;
-}
-h1 {
-	font-size: 16px;
-	padding: 2px;
-	background-color: #cc0000;
-}
-</style>
-</head>
-<body>
-` + body + `
-</body>
-</html>
-`;
-}