web_plsql 0.3.2 → 0.5.0

package/jest.config.js

@@ -0,0 +1,204 @@
+/*
+ * 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: {},
+	globals: {
+		'ts-jest': {
+			tsconfig: 'tsconfig.src.json',
+			diagnostics: true,
+			useESM: true,
+		}
+	},
+
+  // 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,
+
+  // 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/package.json

@@ -1,109 +1,85 @@
-{
-  "name": "web_plsql",
-  "version": "0.3.2",
-  "author": "Dieter Oberkofler <dieter.oberkofler@gmail.com>",
-  "license": "MIT",
-  "description": "The Express Middleware for Oracle PL/SQL",
-  "keywords": [
-    "node",
-    "nodejs",
-    "express",
-    "middleware",
-    "mod_plsql",
-    "plsql",
-    "pl/sql",
-    "oracle",
-    "ohs",
-    "ords",
-    "gateway",
-    "apex"
-  ],
-  "homepage": "https://github.com/doberkofler/web_plsql",
-  "engines": {
-    "node": ">=10"
-  },
-  "maintainers": [
-    {
-      "name": "Dieter Oberkofler",
-      "email": "dieter.oberkofler@gmail.com"
-    }
-  ],
-  "bugs": {
-    "url": "https://github.com/doberkofler/web_plsql/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/doberkofler/web_plsql.git"
-  },
-  "scripts": {
-    "clean": "rimraf access.log lib trace coverage .nyc_output",
-    "build": "tsc --project ./tsconfig.src.json",
-    "eslint": "eslint --cache --report-unused-disable-directives \"./**/*.ts\"",
-    "type-check": "tsc --project ./tsconfig.json --noEmit",
-    "lint": "npm run eslint && npm run type-check",
-    "test": "mocha",
-    "test-cov": "npm run build && nyc mocha",
-    "coveralls": "npm run test-cov && cat ./coverage/lcov.info | coveralls",
-    "sample": "node examples/sample.js",
-    "rebuild": "npm run clean && npm run lint && npm run build && npm run test",
-    "create-package": "shx rm -f *.tgz && npm pack",
-    "install": "npm run build"
-  },
-  "nyc": {
-    "include": [
-      "src/*.ts"
-    ],
-    "extension": [
-      ".ts"
-    ],
-    "require": [
-      "ts-node/register"
-    ],
-    "reporter": [
-      "text-summary",
-      "html"
-    ],
-    "sourceMap": true,
-    "instrument": true,
-    "all": true
-  },
-  "dependencies": {
-    "@types/body-parser": "1.19.0",
-    "@types/chai": "4.2.11",
-    "@types/compression": "1.7.0",
-    "@types/cookie-parser": "1.4.2",
-    "@types/escape-html": "0.0.20",
-    "@types/express": "4.17.3",
-    "@types/mkdirp": "1.0.0",
-    "@types/mocha": "7.0.2",
-    "@types/morgan": "1.9.0",
-    "@types/node": "13.9.5",
-    "@types/oracledb": "4.2.0",
-    "@typescript-eslint/eslint-plugin": "2.25.0",
-    "@typescript-eslint/parser": "2.25.0",
-    "body-parser": "1.19.0",
-    "chai": "4.2.0",
-    "compression": "1.7.4",
-    "connect-multiparty": "2.2.0",
-    "cookie-parser": "1.4.5",
-    "coveralls": "3.0.11",
-    "escape-html": "1.0.3",
-    "eslint": "6.8.0",
-    "express": "4.17.1",
-    "express-status-monitor": "1.2.9",
-    "http-parser-js": "0.5.2",
-    "mkdirp": "1.0.3",
-    "mocha": "7.1.1",
-    "morgan": "1.10.0",
-    "nyc": "15.0.0",
-    "rimraf": "3.0.2",
-    "shx": "0.3.2",
-    "source-map-support": "0.5.16",
-    "supertest": "4.0.2",
-    "ts-node": "8.8.1",
-    "typescript": "3.8.3"
-  },
-  "optionalDependencies": {
-    "oracledb": "4.2.0"
-  }
-}
+{
+  "name": "web_plsql",
+  "version": "0.5.0",
+  "author": "Dieter Oberkofler <dieter.oberkofler@gmail.com>",
+  "license": "MIT",
+  "description": "The Express Middleware for Oracle PL/SQL",
+  "keywords": [
+    "node",
+    "nodejs",
+    "express",
+    "middleware",
+    "mod_plsql",
+    "plsql",
+    "pl/sql",
+    "oracle",
+    "ohs",
+    "ords",
+    "gateway",
+    "apex"
+  ],
+  "homepage": "https://github.com/doberkofler/web_plsql",
+  "engines": {
+    "node": ">=16"
+  },
+  "maintainers": [
+    {
+      "name": "Dieter Oberkofler",
+      "email": "dieter.oberkofler@gmail.com"
+    }
+  ],
+  "bugs": {
+    "url": "https://github.com/doberkofler/web_plsql/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/doberkofler/web_plsql.git"
+  },
+  "scripts": {
+    "clean": "rimraf access.log lib trace coverage .nyc_output",
+    "build": "tsc --project ./tsconfig.src.json",
+    "eslint": "eslint --cache --report-unused-disable-directives \"./**/*.ts\"",
+    "type-check": "tsc --project ./tsconfig.json --noEmit",
+    "lint": "npm run eslint && npm run type-check",
+    "test": "jest --coverage=false",
+    "test:coverage": "jest",
+    "sample": "node examples/sample.js",
+    "rebuild": "npm run clean && npm run lint && npm run build && npm run test",
+    "create-package": "shx rm -f *.tgz && npm pack",
+    "install": "npm run build"
+  },
+  "dependencies": {
+    "body-parser": "1.20.0",
+    "compression": "1.7.4",
+    "connect-multiparty": "2.2.0",
+    "cookie-parser": "1.4.6",
+    "escape-html": "1.0.3",
+    "express": "4.18.1",
+    "express-status-monitor": "1.3.4",
+    "http-parser-js": "0.5.6",
+    "mkdirp": "1.0.4",
+    "morgan": "1.10.0",
+    "oracledb": "5.3.0"
+  },
+  "devDependencies": {
+    "@types/body-parser": "1.19.2",
+    "@types/compression": "1.7.2",
+    "@types/cookie-parser": "1.4.3",
+    "@types/escape-html": "1.0.2",
+    "@types/mkdirp": "1.0.2",
+    "@types/morgan": "1.9.3",
+    "@types/node": "17.0.31",
+    "@types/oracledb": "5.2.3",
+    "@types/supertest": "2.0.12",
+    "@typescript-eslint/eslint-plugin": "5.22.0",
+    "@typescript-eslint/parser": "5.22.0",
+    "eslint": "8.15.0",
+    "jest": "28.1.0",
+    "rimraf": "3.0.2",
+    "shx": "0.3.4",
+    "supertest": "6.2.3",
+    "ts-jest": "28.0.2",
+    "ts-node": "10.7.0",
+    "typescript": "4.6.4"
+  }
+}

package/src/cgi.ts

@@ -1,95 +1,95 @@
-/*
-*	Prepare the CGI information
-*/
-
-import os from 'os';
-import {URL} from 'url';
-import express from 'express';
-export type environmentType = {[key: string]: string};
-import {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': 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, '');
-}
+/*
+*	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, '');
+}