web_plsql 0.6.0 → 0.8.0

package/README.md

@@ -24,11 +24,15 @@ Please visit the [node-oracledb](https://node-oracledb.readthedocs.io/en/latest/
 * Create a new npm project (`npm i`)
 * Install package (`npm i --omit=dev web_plsql`)
 
-# Example
+# Example (native)
 * Change to the `examples/sql` directory, start SQLPLus, connect to the database as SYS specifying the SYSDBA roleInstall and install the sample schema `@examples/sql/install.sql`.
-* Start the sample server using `node examples/server_sample.js` after having set the ORACLE_SERVER environment variable to the database where you just installed the sample schema.
+* Start server using `node examples/server_sample.js` after having set the WEB_PLSQL_ORACLE_SERVER environment variable to the database where you just installed the sample schema.
 * Invoke a browser and open the page `http://localhost/sample`.
 
+# Example (container)
+* Build the image using `npm run image-build`
+* Start the container using `./run_container.sh` after eventually modifying the `run_container.sh` script.
+
 # Running
 There are 2 main options on how to use the mod_plsql Express middleware:
 

package/examples/server_apex.js

@@ -1,8 +1,6 @@
-#!/usr/bin/env node
+import {startHttpServer} from '../src/index.js';
 
-import {startServer} from '../src/index.js';
-
-void startServer({
+void startHttpServer({
 	port: 80,
 	routeStatic: [
 		{

package/examples/server_sample.js

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 
-import {startServer} from '../src/index.js';
+import {startHttpServer} from '../src/index.js';
 
-void startServer({
-	port: 80,
+void startHttpServer({
+	port: 8888,
 	routeStatic: [
 		{
 			route: '/static',
@@ -13,9 +13,9 @@ void startServer({
 	routePlSql: [
 		{
 			route: '/sample',
-			user: 'sample', // PlsqlDatabaseUserName
-			password: 'sample', // PlsqlDatabasePassword
-			connectString: process.env.ORACLE_SERVER ?? '', // PlsqlDatabaseConnectString
+			user: process.env.WEB_PLSQL_ORACLE_USER ?? 'sample', // PlsqlDatabaseUserName
+			password: process.env.WEB_PLSQL_ORACLE_PASSWORD ?? 'sample', // PlsqlDatabasePassword
+			connectString: process.env.WEB_PLSQL_ORACLE_SERVER ?? 'localhost:1521/orcl', // PlsqlDatabaseConnectString
 			defaultPage: 'sample_pkg.page_index', // PlsqlDefaultPage
 			documentTable: 'doctable', // PlsqlDocumentTablename
 			exclusionList: ['sample_pkg.page_exclusion_list'], // PlsqlExclusionList

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "web_plsql",
-	"version": "0.6.0",
+	"version": "0.8.0",
 	"author": "Dieter Oberkofler <dieter.oberkofler@gmail.com>",
 	"license": "MIT",
 	"description": "The Express Middleware for Oracle PL/SQL",
@@ -48,24 +48,26 @@
 		"types": "rm -rf types && tsc  --noEmit false --declaration true --declarationDir types --emitDeclarationOnly true --allowJs true --target es2020 --module es2020 --moduleResolution node src/*.js",
 		"clean": "shx rm -f *.tgz && shx rm -f *.log",
 		"ci": "npm run clean && npm run lint && npm run test",
-		"create-package": "shx rm -f *.tgz && npm pack"
+		"create-package": "shx rm -f *.tgz && npm pack",
+		"image-build": "docker build --no-cache --progress=plain --tag=web_plsql .",
+		"image-save": "docker save web_plsql | gzip > web_plsql.tar.gz"
 	},
 	"dependencies": {
 		"basic-auth": "2.0.1",
-		"body-parser": "1.20.3",
-		"compression": "1.7.5",
+		"body-parser": "2.2.0",
+		"compression": "1.8.0",
 		"connect-multiparty": "2.2.0",
 		"cookie-parser": "1.4.7",
 		"debug": "4.4.0",
 		"escape-html": "1.0.3",
-		"express": "4.21.2",
+		"express": "5.1.0",
 		"fs-extra": "11.3.0",
-		"http-parser-js": "0.5.9",
+		"http-parser-js": "0.5.10",
 		"morgan": "1.10.0",
-		"multer": "^1.4.5-lts.1",
-		"oracledb": "6.7.1",
-		"rotating-file-stream": "3.2.5",
-		"zod": "3.24.1"
+		"multer": "1.4.5-lts.2",
+		"oracledb": "6.8.0",
+		"rotating-file-stream": "3.2.6",
+		"zod": "3.24.2"
 	},
 	"devDependencies": {
 		"@types/basic-auth": "1.1.8",
@@ -76,17 +78,17 @@
 		"@types/escape-html": "1.0.4",
 		"@types/fs-extra": "11.0.4",
 		"@types/morgan": "1.9.9",
-		"@types/multer": "^1.4.12",
-		"@types/node": "22.13.1",
-		"@types/oracledb": "6.5.3",
-		"@types/supertest": "6.0.2",
-		"eslint": "9.20.0",
-		"eslint-plugin-jsdoc": "50.6.3",
-		"prettier": "3.5.0",
+		"@types/multer": "1.4.12",
+		"@types/node": "22.14.1",
+		"@types/oracledb": "6.6.0",
+		"@types/supertest": "6.0.3",
+		"eslint": "9.24.0",
+		"eslint-plugin-jsdoc": "50.6.9",
+		"prettier": "3.5.3",
 		"rimraf": "6.0.1",
-		"shx": "0.3.4",
-		"supertest": "7.0.0",
-		"typescript": "5.7.3",
-		"typescript-eslint": "8.23.0"
+		"shx": "0.4.0",
+		"supertest": "7.1.0",
+		"typescript": "5.8.3",
+		"typescript-eslint": "8.30.1"
 	}
 }

package/src/file.js

@@ -1,5 +1,20 @@
 import {promises as fs, readFileSync} from 'node:fs';
 
+/**
+ * Read file.
+ *
+ * @param {string} filePath - File name.
+ * @returns {string} The string.
+ */
+export const readFileSyncUtf8 = (filePath) => {
+	try {
+		return readFileSync(filePath, 'utf8');
+	} catch (err) {
+		/* istanbul ignore next */
+		throw new Error(`Unable to read file "${filePath}"`);
+	}
+};
+
 /**
  * Read file.
  *
@@ -71,7 +86,10 @@ export const isFile = async (filePath) => {
 		return false;
 	}
 
-	const stats = await fs.stat(filePath);
-
-	return stats.isFile();
+	try {
+		const stats = await fs.stat(filePath);
+		return stats.isFile();
+	} catch {
+		return false;
+	}
 };

package/src/index.js

@@ -1,5 +1,5 @@
 // server
-export {startServer} from './server.js';
+export {createHttpServer, createHttpsServer, startHttpServer, loadConfig} from './server.js';
 export * from './shutdown.js';
 
 // handler

package/src/server.js

@@ -1,6 +1,8 @@
 import debugModule from 'debug';
 const debug = debugModule('webplsql:server');
 
+import http from 'node:http';
+import https from 'node:https';
 import express from 'express';
 import bodyParser from 'body-parser';
 import cookieParser from 'cookie-parser';
@@ -13,9 +15,11 @@ import {handlerUpload} from './handlerUpload.js';
 import {handlerLogger} from './handlerLogger.js';
 import {initMetrics, handlerMetrics} from './handlerMetrics.js';
 import {handlerWebPlSql} from './handlerPlSql.js';
-import {getPackageVersion} from './version.js';
+import {getPackageVersion, getExpressVersion} from './version.js';
+import {readFileSyncUtf8, getJsonFile} from './file.js';
 
 /**
+ * @typedef {import('express').Express} Express
  * @typedef {import('express').Request} Request
  * @typedef {import('express').Response} Response
  * @typedef {import('express').NextFunction} NextFunction
@@ -25,29 +29,83 @@ import {getPackageVersion} from './version.js';
  */
 
 /**
- * Start generic server.
- * @param {configType} config - The config.
- * @returns {Promise<void>} - Promise.
+ * Create HTTP server.
+ * @param {Express} app - express application
+ * @param {number} port - port number
+ * @param {Pool[]} connectionPools - database connection
+ * @returns {Promise<http.Server>} - server
  */
-export const startServer = async (config) => {
-	debug('startServer', config);
+export const createHttpServer = (app, port, connectionPools) => {
+	return new Promise((resolve) => {
+		// Create server
+		// eslint-disable-next-line @typescript-eslint/no-misused-promises
+		const server = http.createServer({}, app);
+
+		// Install shutdown handler
+		installShutdown(async () => {
+			// Close database pool.
+			await poolsClose(connectionPools);
+
+			// Close server
+			return new Promise((resolve) => server.close(() => resolve()));
+		});
+
+		// Listen on HTTP ports
+		server.listen(port, () => {
+			resolve(server);
+		});
+	});
+};
 
-	config = z$configType.parse(config);
+/**
+ * Create HTTPS server.
+ * @param {Express} app - express application
+ * @param {string} sslKeyFilename - ssl
+ * @param {string} sslCertFilename - ssl
+ * @param {number} port - port number
+ * @param {Pool[]} connectionPools - database connection
+ * @returns {Promise<https.Server>} - server
+ */
+export const createHttpsServer = (app, sslKeyFilename, sslCertFilename, port, connectionPools) => {
+	return new Promise((resolve) => {
+		// Load certificates
+		const key = readFileSyncUtf8(sslKeyFilename);
+		const cert = readFileSyncUtf8(sslCertFilename);
+
+		// Create server
+		// eslint-disable-next-line @typescript-eslint/no-misused-promises
+		const server = https.createServer({key, cert}, app);
+
+		// Install shutdown handler
+		installShutdown(async () => {
+			// Close database pool.
+			await poolsClose(connectionPools);
+
+			// Close server
+			return new Promise((resolve) => server.close(() => resolve()));
+		});
+
+		// Listen on HTTP ports
+		server.listen(port, () => {
+			resolve(server);
+		});
+	});
+};
 
-	console.log(`WEB_PL/SQL ${getPackageVersion()}`);
+/**
+ * Start HTTP server.
+ * @param {configType} config - The config.
+ * @returns {Promise<void>} - Promise.
+ */
+export const startHttpServer = async (config) => {
+	debug('startHttpServer', config);
 
-	/** @type {Pool[]} */
-	const pools = [];
+	const expressVersion = getExpressVersion();
+	const packageVersion = getPackageVersion();
 
-	// Install shutdown handler
-	installShutdown(async () => {
-		// Close database pools.
-		await poolsClose(pools);
-		pools.length = 0;
+	config = z$configType.parse(config);
 
-		// Close server
-		return new Promise((resolve) => server.close(() => resolve()));
-	});
+	console.log(`WEB_PL/SQL ${packageVersion} using express ${expressVersion}`);
 
 	// Create express app
 	const app = express();
@@ -75,13 +133,16 @@ export const startServer = async (config) => {
 		app.use(handlerLogger(config.loggerFilename));
 	}
 
+	/** @type {Pool[]} */
+	const connectionPools = [];
+
 	// Oracle pl/sql express middleware
 	for (const i of config.routePlSql) {
 		// Allocate the Oracle database pool
 		const pool = await poolCreate(i.user, i.password, i.connectString);
-		pools.push(pool);
+		connectionPools.push(pool);
 
-		app.use(`${i.route}/:name?`, handlerWebPlSql(pool, i));
+		app.use([`${i.route}/:name`, i.route], handlerWebPlSql(pool, i));
 
 		console.log(`Application route "http://localhost:${config.port}${i.route}"`);
 		console.log(`   Oracle user:           ${i.user}`);
@@ -101,6 +162,24 @@ export const startServer = async (config) => {
 		}, 1000);
 	}
 
-	// listen on port
-	const server = app.listen(config.port);
+	await createHttpServer(app, config.port, connectionPools);
+};
+
+/**
+ * Load configuration.
+ * @param {string} [filename] - The configuration filename.
+ * @returns {configType} - Promise.
+ */
+export const loadConfig = (filename) => {
+	debug('loadConfig', filename);
+
+	if (typeof filename !== 'string' || filename.length === 0) {
+		filename = 'config.json';
+	}
+
+	const data = getJsonFile(filename);
+
+	const config = z$configType.parse(data);
+
+	return config;
 };

package/src/version.js

@@ -21,3 +21,18 @@ export const getPackageVersion = () => {
 
 	return typeof pkg.version === 'string' ? pkg.version : '';
 };
+
+/**
+ * Retrieves the express version from package.json.
+ *
+ * @returns {string} The version number of the package.
+ */
+export const getExpressVersion = () => {
+	const __filename = fileURLToPath(import.meta.url);
+	const __dirname = dirname(__filename);
+	const packageJsonPath = join(__dirname, '../node_modules/express/package.json');
+
+	const pkg = /** @type {PackageJSON} */ (getJsonFile(packageJsonPath));
+
+	return typeof pkg.version === 'string' ? pkg.version : '';
+};

package/types/file.d.ts

@@ -1,3 +1,4 @@
+export function readFileSyncUtf8(filePath: string): string;
 export function readFile(filePath: string): Promise<Buffer>;
 export function removeFile(filePath: string): Promise<void>;
 export function getJsonFile(filePath: string): unknown;

package/types/index.d.ts

@@ -1,4 +1,3 @@
-export { startServer } from "./server.js";
 export * from "./shutdown.js";
 export * from "./oracle.js";
 export * from "./file.js";
@@ -7,4 +6,5 @@ export * from "./version.js";
 export { handlerWebPlSql } from "./handlerPlSql.js";
 export { handlerLogger } from "./handlerLogger.js";
 export { handlerUpload } from "./handlerUpload.js";
+export { createHttpServer, createHttpsServer, startHttpServer, loadConfig } from "./server.js";
 export { initMetrics, handlerMetrics } from "./handlerMetrics.js";

package/types/server.d.ts

@@ -1,4 +1,8 @@
-export function startServer(config: configType): Promise<void>;
+export function createHttpServer(app: Express, port: number, connectionPools: Pool[]): Promise<http.Server>;
+export function createHttpsServer(app: Express, sslKeyFilename: string, sslCertFilename: string, port: number, connectionPools: Pool[]): Promise<https.Server>;
+export function startHttpServer(config: configType): Promise<void>;
+export function loadConfig(filename?: string): configType;
+export type Express = import("express").Express;
 export type Request = import("express").Request;
 export type Response = import("express").Response;
 export type NextFunction = import("express").NextFunction;

package/types/version.d.ts

@@ -1,4 +1,5 @@
 export function getPackageVersion(): string;
+export function getExpressVersion(): string;
 export type PackageJSON = {
     /**
      * - The package version.