npm - web_plsql - Versions diffs - 0.5.1 → 0.8.0 - Mend

web_plsql 0.5.1 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (96) hide show

package/README.md +128 -111
package/examples/server_apex.js +26 -0
package/examples/server_sample.js +30 -0
package/examples/sql/{doc_table.sql → doctable.sql} +1 -1
package/examples/sql/install.sql +6 -9
package/examples/sql/sample_package.sql +27 -0
package/examples/sql/sample_package_body.sql +245 -0
package/examples/static/sample.css +11 -10
package/package.json +92 -83
package/src/cgi.js +127 -0
package/src/error.js +24 -0
package/src/errorPage.js +296 -0
package/src/file.js +95 -0
package/src/handlerLogger.js +21 -0
package/src/handlerMetrics.js +46 -0
package/src/handlerPlSql.js +65 -0
package/src/handlerUpload.js +32 -0
package/src/index.js +17 -0
package/src/oracle.js +80 -0
package/src/parsePage.js +193 -0
package/src/procedure.js +260 -0
package/src/procedureError.js +40 -0
package/src/procedureNamed.js +233 -0
package/src/procedureSanitize.js +215 -0
package/src/procedureVariable.js +57 -0
package/src/request.js +103 -0
package/src/{requestError.ts → requestError.js} +8 -4
package/src/sendResponse.js +104 -0
package/src/server.js +185 -0
package/src/shutdown.js +53 -0
package/src/stream.js +28 -0
package/src/trace.js +74 -0
package/src/tty.js +48 -0
package/src/types.js +146 -0
package/src/upload.js +92 -0
package/src/version.js +38 -0
package/types/cgi.d.ts +4 -0
package/types/error.d.ts +1 -0
package/types/errorPage.d.ts +10 -0
package/types/file.d.ts +6 -0
package/types/handlerLogger.d.ts +2 -0
package/types/handlerMetrics.d.ts +4 -0
package/types/handlerPlSql.d.ts +8 -0
package/types/handlerUpload.d.ts +7 -0
package/types/index.d.ts +10 -0
package/types/oracle.d.ts +5 -0
package/types/parsePage.d.ts +3 -0
package/types/procedure.d.ts +10 -0
package/types/procedureError.d.ts +23 -0
package/types/procedureNamed.d.ts +14 -0
package/types/procedureSanitize.d.ts +14 -0
package/types/procedureVariable.d.ts +9 -0
package/types/request.d.ts +7 -0
package/types/requestError.d.ts +8 -0
package/types/sendResponse.d.ts +4 -0
package/types/server.d.ts +11 -0
package/types/shutdown.d.ts +2 -0
package/types/stream.d.ts +1 -0
package/types/trace.d.ts +5 -0
package/types/tty.d.ts +4 -0
package/types/types.d.ts +251 -0
package/types/upload.d.ts +5 -0
package/types/version.d.ts +8 -0
package/.editorconfig +0 -8
package/.eslintignore +0 -3
package/.eslintrc.js +0 -347
package/CHANGELOG.md +0 -133
package/examples/apex.js +0 -70
package/examples/credentials.js +0 -22
package/examples/oracledb_example.js +0 -30
package/examples/sample.js +0 -101
package/examples/sql/sample.pkb +0 -223
package/examples/sql/sample.pks +0 -24
package/jest.config.js +0 -207
package/src/cgi.ts +0 -95
package/src/config.ts +0 -97
package/src/errorPage.ts +0 -286
package/src/fileUpload.ts +0 -126
package/src/index.ts +0 -65
package/src/page.ts +0 -275
package/src/procedure.ts +0 -360
package/src/procedureError.ts +0 -27
package/src/request.ts +0 -139
package/src/stream.ts +0 -26
package/src/trace.ts +0 -194
package/test/.eslintrc.json +0 -5
package/test/__tests__/cgi.ts +0 -96
package/test/__tests__/config.ts +0 -41
package/test/__tests__/errorPage.ts +0 -101
package/test/__tests__/oracledb_mock.ts +0 -98
package/test/__tests__/server.ts +0 -495
package/test/__tests__/stream.ts +0 -21
package/test/mock/oracledb.ts +0 -85
package/test/static/static.html +0 -1
package/tsconfig.json +0 -24
package/tsconfig.src.json +0 -23

package/test/__tests__/server.ts DELETED Viewed

@@ -1,495 +0,0 @@
-import {describe, beforeAll, afterAll, beforeEach, it, expect} from '@jest/globals';
-import util from 'util';
-import express from 'express';
-import http from 'http';
-import oracledb from 'oracledb';
-import path from 'path';
-import bodyParser from 'body-parser';
-// @ts-expect-error
-import multipart from 'connect-multiparty';
-import cookieParser from 'cookie-parser';
-import compression from 'compression';
-import request from 'supertest';
-import {setExecuteCallback, createPool} from '../mock/oracledb';
-const webplsql = require('../../src/index'); // eslint-disable-line @typescript-eslint/no-var-requires
-const PORT = 8765;
-const PATH = '/base';
-const DEFAULT_PAGE = 'sample.pageIndex';
-const DOC_TABLE = 'docTable';
-type serverConfigType = {
-	app: express.Application;
-	server: http.Server;
-	connectionPool: oracledb.Pool;
-}
-describe('server utilities', () => {
-	it('should start a server', async () => {
-		const serverConfig = await serverStart();
-		expect(Object.prototype.toString.call(serverConfig)).toBe('[object Object]');
-		expect(Object.prototype.toString.call(serverConfig.app.listen)).toBe('[object Function]');
-		expect(Object.prototype.toString.call(serverConfig.server)).toBe('[object Object]');
-		//expect(serverConfig.connectionPool).toBeInstanceOf(oracledb.Pool);
-		await serverStop(serverConfig);
-	});
-});
-describe('server static', () => {
-	let serverConfig: any;
-	beforeAll(async () => {
-		serverConfig = await serverStart();
-	});
-	afterAll(async () => {
-		await serverStop(serverConfig);
-	});
-	beforeEach(() => {
-		setExecuteCallback();
-	});
-	it('get a static file', () =>
-		request(serverConfig.app).get('/static/static.html')
-			.expect(200, new RegExp('.*<html><body><p>static</p></body></html>.*')));
-	it('report a 404 error on a missing static file', () =>
-		request(serverConfig.app).get('/static/file_does_not_exist.html')
-			.expect(404));
-	it('get default page', () =>
-		request(serverConfig.app).get(PATH)
-			.expect(302, `Found. Redirecting to ${PATH}/${DEFAULT_PAGE}`));
-	it('get page', () => {
-		sqlExecuteProxy({
-			proc: 'sample.pageIndex();',
-			lines: [
-				'Content-type: text/html; charset=UTF-8\n',
-				'X-ORACLE-IGNORE:  IGNORE\n',
-				'Custom-header:  important\n',
-				'\n',
-				'<html><body><p>static</p></body></html>\n'
-			]
-		});
-		return request(serverConfig.app).get(`${PATH}/${DEFAULT_PAGE}`)
-			.expect(200, new RegExp('.*<html><body><p>static</p></body></html>.*'));
-	});
-	it('get page with query string', () => {
-		sqlExecuteProxy({
-			proc: 'sample.pageIndex(a=>:p_a,b=>:p_b);',
-			para: [
-				{name: 'a', value: '1'},
-				{name: 'b', value: '2'}
-			],
-			lines: [
-				'Content-type: text/html; charset=UTF-8\n',
-				'\n',
-				'<html><body><p>static</p></body></html>\n'
-			]
-		});
-		return request(serverConfig.app).get(`${PATH}/${DEFAULT_PAGE}?a=1&b=2`)
-			.expect(200, new RegExp('.*<html><body><p>static</p></body></html>.*'));
-	});
-	it('get page with query string containing duplicate names', () => {
-		sqlExecuteProxy({
-			proc: 'sample.pageIndex(a=>:p_a);',
-			para: [
-				{name: 'a', value: ['1', '2']}
-			],
-			lines: [
-				'Content-type: text/html; charset=UTF-8\n',
-				'\n',
-				'<html><body><p>static</p></body></html>\n'
-			]
-		});
-		return request(serverConfig.app).get(`${PATH}/${DEFAULT_PAGE}?a=1&a=2`)
-			.expect(200, new RegExp('.*<html><body><p>static</p></body></html>.*'));
-	});
-	it('get page with flexible parameters', () => {
-		sqlExecuteProxy({
-			proc: 'sample.pageIndex(:argnames, :argvalues);',
-			para: [
-				{name: 'argnames', value: ['a', 'b']},
-				{name: 'argvalues', value: ['1', '2']}
-			],
-			lines: [
-				'Content-type: text/html; charset=UTF-8\n',
-				'\n',
-				'<html><body><p>static</p></body></html>\n'
-			]
-		});
-		return request(serverConfig.app).get(`${PATH}/!${DEFAULT_PAGE}?a=1&b=2`)
-			.expect(200, new RegExp('.*<html><body><p>static</p></body></html>.*'));
-	});
-	it('get page with cookies', () => {
-		sqlExecuteProxy({
-			proc: 'sample.pageIndex();',
-			lines: [
-				'Content-type: text/html; charset=UTF-8\n',
-				'Set-Cookie: C1=V1; path=/apex; Domain=mozilla.org; Expires=Wed, 21 Oct 2015 07:28:00 GMT; Secure; HttpOnly\n',
-				'\n',
-				'<html><body><p>static</p></body></html>\n'
-			]
-		});
-		return request(serverConfig.app).get(`${PATH}/${DEFAULT_PAGE}`)
-			.expect(200)
-			.expect('set-cookie', 'C1=V1; Domain=mozilla.org; Path=/apex; Expires=Wed, 21 Oct 2015 07:28:00 GMT; HttpOnly')
-			.expect(new RegExp('.*<html><body><p>static</p></body></html>.*'));
-	});
-	it('redirect to a new url', () => {
-		sqlExecuteProxy({
-			proc: 'sample.pageIndex();',
-			lines: ['Location: www.google.com\n']
-		});
-		return request(serverConfig.app).get(`${PATH}/${DEFAULT_PAGE}`)
-			.expect(302);
-	});
-	it('get json', () => {
-		sqlExecuteProxy({
-			proc: 'sample.pageJson();',
-			lines: [
-				'Content-type: application/json\n',
-				'\n',
-				'{"name":"johndoe"}'
-			]
-		});
-		return request(serverConfig.app).get(`${PATH}/sample.pageJson`)
-			.expect(200, '{"name":"johndoe"}');
-	});
-	it('get application/x-www-form-urlencoded', () => {
-		sqlExecuteProxy({
-			proc: 'sample.pageForm(name=>:p_name);',
-			para: [
-				{name: 'name', value: 'johndoe'}
-			],
-			lines: [
-				'Content-Type: text/html\n',
-				'\n',
-				'<html><body><p>static</p></body></html>\n'
-			]
-		});
-		return request(serverConfig.app)
-			.get(`${PATH}/sample.pageForm`)
-			.set('Content-Type', 'application/x-www-form-urlencoded')
-			.send('name=johndoe')
-			.expect(200, new RegExp('.*<html><body><p>static</p></body></html>.*'));
-	});
-	it('get application/x-www-form-urlencoded with file', () => {
-		sqlExecuteProxy({
-			proc: 'sample.pageForm(',
-			para: [
-				{name: 'user_name', value: 'Tobi'}
-			],
-			lines: [
-				'Content-Type: text/html\n',
-				'\n',
-				'<html><body><p>static</p></body></html>\n'
-			]
-		});
-		const test = request(serverConfig.app).post(`${PATH}/sample.pageForm`);
-		test.set('Content-Type', 'multipart/form-data; boundary=foo');
-		test.write('--foo\r\n');
-		test.write('Content-Disposition: form-data; name="user_name"\r\n');
-		test.write('\r\n');
-		test.write('Tobi');
-		test.write('\r\n--foo\r\n');
-		test.write('Content-Disposition: form-data; name="text"; filename="test/server.js"\r\n');
-		test.write('\r\n');
-		test.write('some text here');
-		test.write('\r\n--foo--');
-		return test.expect(200, new RegExp('.*<html><body><p>static</p></body></html>.*'));
-	});
-	it('set status', () => {
-		sqlExecuteProxy({
-			proc: 'sample.pageIndex();',
-			lines: [
-				'Status: 302 status\n'
-			]
-		});
-		return request(serverConfig.app).get(`${PATH}/${DEFAULT_PAGE}`)
-			.expect(302);
-	});
-	it('set x-db-content-length header', () => {
-		sqlExecuteProxy({
-			proc: 'sample.pageJson();',
-			lines: [
-				'x-db-content-length: 0\n',
-			]
-		});
-		return request(serverConfig.app).get(`${PATH}/sample.pageJson`)
-			.expect(200);
-	});
-	it('use the pathAlias configuration setting', () => {
-		sqlExecuteProxy({
-			proc: 'pathAlias(p_path=>:p_path);',
-			lines: [
-				'Content-type: text/html; charset=UTF-8\n',
-				'\n',
-				'<html><body><p>static</p></body></html>\n'
-			]
-		});
-		return request(serverConfig.app).get(`${PATH}/alias`)
-			.expect(200, new RegExp('.*<html><body><p>static</p></body></html>.*'));
-	});
-	/*
-	it('GET /sampleRoute/cgi should validate the cgi', () => {
-		request(application.expressApplication).get('/sampleRoute/cgi')
-			.expect(200, 'cgi', done);
-	});
-	it('GET /basicRoute/basicPage should generate a 401 error', () => {
-		request(application.expressApplication)
-			.get('/basicRoute/basicPage')
-			.expect(401, 'Access denied', done);
-	});
-	it('GET /basicRoute/basicPage should authorize', () => {
-		request(application.expressApplication)
-			.get('/basicRoute/basicPage')
-			.auth('myusername', 'mypassword')
-			.expect(200, done);
-	});
-	it('should upload files', () => {
-		const FILENAME = 'temp/index.html';
-		const CONTENT = 'content of index.html';
-		let test;
-		// create a static file
-		mkdirp.sync('temp');
-		fs.writeFileSync(FILENAME, CONTENT);
-		// test the upload
-		test = request(application.expressApplication).post('/sampleRoute/fileUpload');
-		test.attach('file', FILENAME);
-		test.expect(200, done);
-	});
-	it('should respond with 404', () => {
-		let test = request(application.expressApplication).get('/invalidRoute');
-		test.expect(404, new RegExp('.*404 Not Found.*'), done);
-	});
-	it('should respond with 404', () => {
-		let test = request(application.expressApplication).get('/sampleRoute/errorInPLSQL');
-		test.expect(404, new RegExp('.*Failed to parse target procedure.*'), done);
-	});
-	it('should respond with 500', () => {
-		let test = request(application.expressApplication).get('/sampleRoute/internalError');
-		test.expect(500, done);
-	});
-	it('does stop', () => {
-		server.stop(application, () => {
-			application = null;
-			assert.ok(true);
-			done();
-		});
-	});
-	it('does not start', () => {
-		server.start().then(() => {
-		}, function (err) {
-			assert.strictEqual(err, 'Configuration object must be an object');
-			done();
-		});
-	});
-	*/
-});
-/*
-*	Start server
-*/
-async function serverStart(): Promise<serverConfigType> {
-	// create connection pool
-	const connectionPool = await createPool({
-		user: 'sample',
-		password: 'sample',
-		connectString: 'localhost:1521/TEST'
-	});
-	// create express app
-	const app = express();
-	// add middleware
-	app.use(multipart());
-	app.use(bodyParser.json());
-	app.use(bodyParser.urlencoded({extended: true}));
-	app.use(cookieParser());
-	app.use(compression());
-	// add the oracle pl/sql express middleware
-	app.use(PATH + '/:name?', webplsql(connectionPool, {
-		trace: 'test',
-		defaultPage: DEFAULT_PAGE,
-		doctable: DOC_TABLE,
-		pathAlias: {
-			alias: 'alias',
-			procedure: 'pathAlias'
-		}
-	}));
-	// serving static files
-	const staticResourcesPath = path.join(process.cwd(), 'test', 'static');
-	app.use('/static', express.static(staticResourcesPath));
-	// listen on port
-	const server = app.listen(PORT);
-	return {app, server, connectionPool: connectionPool as unknown as oracledb.Pool};
-}
-/*
-*	Stop server
-*/
-async function serverStop(config: serverConfigType) {
-	await config.server.close();
-	await config.connectionPool.close();
-}
-/*
-*	Set the proxy for the next sql procedure to be executed
-*/
-function sqlExecuteProxy(config: {proc: string; para?: Array<{name: string; value: string | Array<string>}>; lines: Array<string>}) {
-	setExecuteCallback((sql: string, bind: any) => {
-		if (sql.indexOf('dbms_utility.name_resolve') !== -1) {
-			const noPara: {outBinds: {names: Array<string>; types: Array<string>}} = {
-				outBinds: {
-					names: [],
-					types: []
-				}
-			};
-			return typeof config.para === 'undefined' ? noPara : config.para.reduce((accumulator, currentValue) => {
-				accumulator.outBinds.names.push(currentValue.name);
-				accumulator.outBinds.types.push('VARCHAR2');
-				return accumulator;
-			}, noPara);
-		}
-		if (sql.indexOf(config.proc) !== -1) {
-			if (typeof config.para !== 'undefined') {
-				if (!parameterEqual(sql, bind, config.para)) {
-					console.error(`===> Parameter mismatch\n${'-'.repeat(30)}\n${util.inspect(bind)}\n${'-'.repeat(30)}`);
-					return {};
-				}
-			}
-			return {
-				outBinds: {
-					fileType: null,
-					fileSize: null,
-					fileBlob: null,
-					lines: config.lines,
-					irows: config.lines.length
-				}
-			};
-		}
-		if (sql.indexOf('INSERT INTO') === 0) {
-			return {
-				rowsAffected: 1
-			};
-		}
-		console.error(`===> sql statement cannot be identified\n${'-'.repeat(30)}\n${sql}\n${'-'.repeat(30)}`);
-		return {};
-	});
-}
-function parameterEqual(sql: string, bind: any, parameters: Array<{name: string; value: string | Array<string>}>): boolean {
-	return sql.indexOf('(:argnames, :argvalues)') === -1 ? parameterFixedEqual(bind, parameters) : parameterFlexibleEqual(bind, parameters);
-}
-function parameterFixedEqual(bind: any, parameters: Array<{name: string; value: string | Array<string>}>): boolean {
-	return parameters.every(para => {
-		if (!bind.hasOwnProperty('p_' + para.name)) {
-			console.error(`===> The parameter "${para.name}" is missing`);
-			return false;
-		}
-		if (Array.isArray(para.value)) {
-			return para.value.every((v, i) => {
-				const equal = v === bind['p_' + para.name].val[i];
-				if (!equal) {
-					console.error(`===> The value "${v}" of parameter "${para.name}" is different`);
-				}
-				return equal;
-			});
-		}
-		return para.value === bind['p_' + para.name].val;
-	});
-}
-function parameterFlexibleEqual(bind: any, parameters: Array<{name: string; value: string | Array<string>}>): boolean {
-	if (parameters.length !== 2) {
-		console.error('===> Invalid number of parameters');
-		return false;
-	}
-	if (!parameters.every(para => ['argnames', 'argvalues'].indexOf(para.name) !== -1)) {
-		console.error('===> Invalid parameter names');
-		return false;
-	}
-	if (!bind.hasOwnProperty('argnames') || !bind.hasOwnProperty('argvalues')) {
-		console.error('===> Missing bindings');
-		return false;
-	}
-	return parameters.every(para => Array.isArray(para.value) && arrayEqual(para.value, bind[para.name].val));
-}
-/*
-*	Compare two arrays
-*/
-function arrayEqual(array1: Array<any>, array2: Array<any>): boolean {
-	if (!array1 || !array2) {
-		return false;
-	}
-	if (array1.length !== array2.length) {
-		return false;
-	}
-	return array1.every((e, i) => e === array2[i]);
-}

package/test/__tests__/stream.ts DELETED Viewed

@@ -1,21 +0,0 @@
-import {describe, it, expect} from '@jest/globals';
-import {streamToBuffer} from '../../src/stream';
-import fs from 'fs';
-describe('stream', () => {
-	it('should convert a stream to a buffer', async () => {
-		const buffer = Buffer.from('Hey there', 'utf8');
-		const filename = 'file.tmp';
-		const file = fs.openSync(filename, 'w+');
-		fs.writeSync(file, buffer, 0, buffer.length, 0);
-		fs.closeSync(file);
-		const readStream = fs.createReadStream('file.tmp');
-		const readBuffer = await streamToBuffer(readStream);
-		expect(buffer.equals(readBuffer)).toBeTruthy();
-		fs.unlinkSync(filename);
-	});
-});

package/test/mock/oracledb.ts DELETED Viewed

@@ -1,85 +0,0 @@
-/* eslint-disable class-methods-use-this, @typescript-eslint/no-unused-vars */
-type executeCallbackType = (sql: string, bindParams?: any) => any;
-let _executeCallback: executeCallbackType | null = null;
-export function setExecuteCallback(callback: executeCallbackType | null = null): void {
-	_executeCallback = callback;
-}
-export class Lob {
-	type: number;
-	constructor(type: number) {
-		this.type = type;
-	}
-	close(): Promise<void> {
-		return Promise.resolve();
-	}
-}
-export class Connection {
-	execute(sql: string, bindParams?: Record<string, unknown>, options?: Record<string, unknown>): Promise<any> {
-		return Promise.resolve(_executeCallback ? _executeCallback(sql, bindParams) : {});
-	}
-	createLob(type: number): Promise<Lob> {
-		const lob = new Lob(type);
-		return Promise.resolve(lob);
-	}
-	release(): Promise<void> {
-		return Promise.resolve();
-	}
-}
-export class ConnectionPool {
-	onExecuteCallback: ((sql: string, bindParams: any) => any) | null;
-	constructor() {
-		this.onExecuteCallback = null;
-	}
-	getConnection(): Promise<Connection> {
-		const connection = new Connection();
-		return Promise.resolve(connection);
-	}
-	close(): Promise<void> {
-		return Promise.resolve();
-	}
-}
-export function createPool(options: Record<string, unknown>): Promise<ConnectionPool> {
-	const connectionPool = new ConnectionPool();
-	return Promise.resolve(connectionPool);
-}
-export function getConnection(options: Record<string, unknown>): Promise<Connection> {
-	const connection = new Connection();
-	return Promise.resolve(connection);
-}
-export const BIND_IN = 1;
-export const BIND_INOUT = 2;
-export const BIND_OUT = 3;
-export const STRING = 4;
-export const NUMBER = 5;
-export const DATE = 6;
-export const CURSOR = 7;
-export const BUFFER = 8;
-export const CLOB = 9;
-export const BLOB = 10;
-export const poolMin = 1;
-export const poolMax = 1;
-export const poolIncrement = 1;
-export const poolTimeout = 1;
-export const prefetchRows = 1;
-export const stmtCacheSize = 1;
-export const version = 0;
-export const oracleClientVersion = 0;

package/test/static/static.html DELETED Viewed

	@@ -1 +0,0 @@
1	- <html><body><p>static</p></body></html>

package/tsconfig.json DELETED Viewed

@@ -1,24 +0,0 @@
-{
-  "compilerOptions": {
-    "skipLibCheck": true,
-    "moduleResolution": "node",
-    "baseUrl": ".",
-    "outDir": "lib",
-    "target": "es6",
-    "lib": [
-      "es2015",
-      "es2016",
-      "es2017",
-      "es2018"
-    ],
-    "module": "commonjs",
-    "sourceMap": true,
-    "strict": true,
-    "alwaysStrict": true,
-    "esModuleInterop": true
-  },
-  "include": [
-    "src/**/*",
-    "test/**/*"
-  ]
-}

package/tsconfig.src.json DELETED Viewed

@@ -1,23 +0,0 @@
-{
-  "compilerOptions": {
-    "skipLibCheck": true,
-    "moduleResolution": "node",
-    "baseUrl": ".",
-    "outDir": "lib",
-    "target": "es6",
-    "lib": [
-      "es2015",
-      "es2016",
-      "es2017",
-      "es2018"
-    ],
-    "module": "commonjs",
-    "sourceMap": true,
-    "strict": true,
-    "alwaysStrict": true,
-    "esModuleInterop": true
-  },
-  "include": [
-    "src/**/*"
-  ]
-}