@pi-r/oracle 0.5.0 → 0.6.1

package/client/index.d.ts

@@ -1,7 +1,13 @@
-import type { OracleDataSource } from '@e-mc/types/lib/db';
-
+import type { IModule } from '@e-mc/types/lib';
+import type { LogType } from '@e-mc/types/lib/logger';
 import type { IDbSourceClient } from '@e-mc/db/types';
 
-declare const Oracle: IDbSourceClient<OracleDataSource>;
+import type { OracleDataSource } from '../types';
+
+import type { InitialiseOptions } from 'oracledb';
+
+declare const Oracle: IDbSourceClient<OracleDataSource> & {
+    initOracleClient(this: IModule, credential: InitialiseOptions, type?: LogType): void;
+};
 
 export = Oracle;

package/client/index.js

@@ -1,21 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DB_SOURCE_TYPE = exports.DB_SOURCE_CLIENT = exports.checkTimeout = exports.executeBatchQuery = exports.executeQuery = exports.setCredential = void 0;
+exports.DB_SOURCE_TYPE = exports.DB_SOURCE_CLIENT = exports.checkTimeout = exports.executeBatchQuery = exports.executeQuery = exports.setCredential = exports.initOracleClient = void 0;
 const oracledb = require("oracledb");
 const util_1 = require("@e-mc/db/util");
 const types_1 = require("@e-mc/types");
 const Db = require("@e-mc/db");
 const DbPool = require('@e-mc/db/pool');
 class OraclePool extends DbPool {
-    getConnection() {
+    async getConnection() {
         return this.client.getConnection();
     }
-    close() {
+    async close() {
         return this.client.close();
     }
     isEmpty() {
-        const { connectionsInUse, currentQueueLength } = this.client.getStatistics();
-        return this.closed || connectionsInUse === 0 && currentQueueLength === 0;
+        if (this.closed) {
+            return true;
+        }
+        try {
+            const data = this.client.getStatistics();
+            if (data) {
+                const { connectionsInUse, currentQueueLength } = data;
+                return connectionsInUse === 0 && currentQueueLength === 0;
+            }
+            return true;
+        }
+        catch {
+            return false;
+        }
     }
     get closeable() {
         return super.closeable || this.client.status === 6001 /* POOL_STATUS.DRAINING */;
@@ -24,6 +36,7 @@ class OraclePool extends DbPool {
         return this.client.status === 6002 /* POOL_STATUS.CLOSED */;
     }
 }
+const DRIVER_MODE = process.env.NODE_ORACLEDB_DRIVER_MODE;
 const POOL_STATE = {};
 const POOL_UNUSED = ['poolMax', 'poolMin', 'poolIncrement', 'poolTimeout', 'poolPingInterval', 'poolMaxPerShard', 'connectTimeout', 'queueMax', 'queueRequests', 'queueTimeout'];
 function removePoolProperties(credential) {
@@ -44,9 +57,47 @@ function removePoolProperties(credential) {
 }
 function getPoolKey(credential) {
     if (credential.connectString && (credential.user && credential.password || credential.externalAuth)) {
-        return credential.connectString + '_' + (credential.externalAuth ? 'external' : credential.user + '_' + credential.password) + '_' + (credential.edition || '') + '_' + (credential.tag ? credential.tag + '#' + (credential.matchAny ? '1' : '0') : '') + '_' + (credential.privilege ?? '') + '_' + Db.asString(credential.shardingKey) + '_' + Db.asString(credential.superShardingKey);
+        return credential.connectString + '_' + (credential.externalAuth ? 'external' : credential.user + '_' + credential.password) + '_' + (credential.edition || '') + '_' + (credential.tag ? credential.tag + '#' + (credential.matchAny ? '1' : '0') : '') + '_' + (credential.privilege ?? '') + '_' + (credential.configDir || '') + '_' + (credential.walletLocation || '') + '_' + (credential.sourceRoute || '') + '_' + Db.asString(credential.shardingKey, true) + '_' + Db.asString(credential.superShardingKey, true);
+    }
+}
+const useLibDir = () => process.platform === 'win32' || process.platform === 'darwin' && process.arch === 'x64';
+if (DRIVER_MODE === 'thick' && oracledb.thin) {
+    let libDir;
+    if (!useLibDir() || (0, types_1.isString)(libDir = process.env.NODE_ORACLEDB_CLIENT_LIB_DIR || process.env.ORACLE_HOME)) {
+        try {
+            oracledb.initOracleClient({ libDir, configDir: process.env.NODE_ORACLEDB_CLIENT_CONFIG_DIR, driverName: process.env.NODE_ORACLEDB_CLIENT_DRIVER_NAME, errorUrl: process.env.NODE_ORACLEDB_CLIENT_ERROR_URL });
+        }
+        catch (err) {
+            Db.writeFail(["Unable to configure client" /* ERR_DB.CLIENT */, 'oracledb'], err);
+        }
     }
 }
+function initOracleClient(credential, type) {
+    if (credential.libDir && oracledb.thin) {
+        if (DRIVER_MODE === 'thick') {
+            try {
+                oracledb.initOracleClient({ libDir: useLibDir() ? credential.libDir : undefined, driverName: credential.driverName, errorUrl: credential.errorUrl });
+            }
+            catch (err) {
+                if (err instanceof Error) {
+                    switch (err.code) {
+                        case 'NJS-090':
+                            this.addLog(this.statusType.WARN, err, 'oracledb', credential.libDir);
+                            break;
+                        default:
+                            this.writeFail(["Unable to configure client" /* ERR_DB.CLIENT */, 'oracledb'], err, { type: type ?? 65536 /* LOG_TYPE.DB */, fatal: false });
+                            break;
+                    }
+                }
+            }
+        }
+        else {
+            this.writeFail(["Unable to configure client" /* ERR_DB.CLIENT */, 'oracledb'], (0, types_1.errorMessage)('oracledb', 'Environment variable "NODE_ORACLEDB_DRIVER_MODE" was not set', 'thick'), { type: type ?? 65536 /* LOG_TYPE.DB */, fatal: false });
+        }
+        delete credential.libDir;
+    }
+}
+exports.initOracleClient = initOracleClient;
 async function setCredential(item) {
     let credential = this.getCredential(item), hostname, port, username, database;
     if (credential) {
@@ -99,65 +150,65 @@ async function setCredential(item) {
             throw (0, types_1.errorMessage)("oracle" /* STRINGS.MODULE_NAME */, 'Not defined - ' + errors.join(' | '));
         }
     }
+    initOracleClient.call(this, credential);
     const usePool = item.usePool;
-    if (usePool) {
-        const poolAlias = credential.poolAlias;
-        let password, pool;
-        if (typeof usePool === 'string' && (username = credential.user || poolAlias)) {
-            [password, pool] = DbPool.validateKey(POOL_STATE, username, usePool);
-            if (pool) {
-                pool.add(item, password);
-                return;
-            }
+    if (!usePool) {
+        return;
+    }
+    const poolAlias = credential.poolAlias;
+    let password, pool;
+    if (typeof usePool === 'string' && (username = credential.user || poolAlias)) {
+        [password, pool] = DbPool.validateKey(POOL_STATE, username, usePool);
+        if (pool) {
+            pool.add(item, password);
+            return;
         }
-        if (poolAlias) {
-            for (const poolKey in POOL_STATE) {
-                const current = POOL_STATE[poolKey];
-                if (current.client.poolAlias === poolAlias) {
-                    if (!current.closed) {
-                        current.add(item);
-                        return;
-                    }
-                    current.remove();
-                    break;
+    }
+    if (poolAlias) {
+        for (const poolKey in POOL_STATE) {
+            const current = POOL_STATE[poolKey];
+            if (current.client.poolAlias === poolAlias) {
+                if (!current.closed) {
+                    current.add(item);
+                    return;
                 }
+                current.remove();
+                break;
             }
         }
-        const poolKey = getPoolKey(credential);
-        if (poolKey) {
-            if (!(pool = POOL_STATE[poolKey]) || pool.closed) {
-                const config = this.getPoolConfig("oracle" /* STRINGS.MODULE_NAME */, password);
-                if (config) {
-                    const { min, max, idle, queue_max, queue_idle, timeout } = config;
-                    if (min >= 0) {
-                        credential.poolMin ?? (credential.poolMin = min);
-                    }
-                    if (max > 0) {
-                        credential.poolMax ?? (credential.poolMax = max);
-                    }
-                    if (idle >= 0) {
-                        credential.poolTimeout ?? (credential.poolTimeout = idle / 1000);
-                    }
-                    if (queue_max >= 0) {
-                        credential.queueMax ?? (credential.queueMax = queue_max);
-                    }
-                    if (queue_idle >= 0) {
-                        credential.queueTimeout ?? (credential.queueTimeout = queue_idle);
-                    }
-                    if (timeout >= 0) {
-                        credential.connectTimeout ?? (credential.connectTimeout = idle / 1000);
-                    }
-                }
-                new OraclePool(await oracledb.createPool(credential), poolKey, username && password ? { username, password } : undefined).add(item).parent = POOL_STATE;
-            }
-            else {
-                pool.add(item);
-            }
+    }
+    const poolKey = getPoolKey(credential);
+    if (!poolKey) {
+        item.usePool = false;
+        return;
+    }
+    if ((pool = POOL_STATE[poolKey]) && !pool.closed) {
+        pool.add(item);
+        return;
+    }
+    const config = this.getPoolConfig("oracle" /* STRINGS.MODULE_NAME */, password);
+    if (config) {
+        const { min, max, idle, queue_max, queue_idle, timeout } = config;
+        if (min >= 0) {
+            credential.poolMin ?? (credential.poolMin = min);
         }
-        else {
-            item.usePool = false;
+        if (max > 0) {
+            credential.poolMax ?? (credential.poolMax = max);
+        }
+        if (idle >= 0) {
+            credential.poolTimeout ?? (credential.poolTimeout = idle / 1000);
+        }
+        if (queue_max >= 0) {
+            credential.queueMax ?? (credential.queueMax = queue_max);
+        }
+        if (queue_idle >= 0) {
+            credential.queueTimeout ?? (credential.queueTimeout = queue_idle);
+        }
+        if (timeout >= 0) {
+            credential.connectTimeout ?? (credential.connectTimeout = idle / 1000);
         }
     }
+    new OraclePool(await oracledb.createPool(credential), poolKey, username && password ? { username, password } : undefined).add(item).parent = POOL_STATE;
 }
 exports.setCredential = setCredential;
 async function executeQuery(item, options) {
@@ -239,6 +290,9 @@ async function executeBatchQuery(batch, options = '', outResult) {
         item.transactionState &= ~64 /* DB_TRANSACTION.AUTH */;
         return client;
     };
+    if (this.host?.username) {
+        this.applyCommand(...batch);
+    }
     for (let i = 0; i < length; ++i) {
         const item = batch[i];
         const { source, query, params, ignoreCache, options: clientOptions } = item;
@@ -261,10 +315,9 @@ async function executeBatchQuery(batch, options = '', outResult) {
         }
         item.transactionState = 1 /* DB_TRANSACTION.ACTIVE */;
         const streamRow = typeof item.streamRow === 'string' ? this.hasCoerce("oracle" /* STRINGS.MODULE_NAME */, 'options', null, credential) && (0, types_1.asFunction)(item.streamRow) : item.streamRow;
-        const renewCache = ignoreCache === 0;
-        const cacheValue = renewCache ? { sessionKey, renewCache } : sessionKey;
+        const cacheValue = ignoreCache === undefined ? sessionKey : Array.isArray(ignoreCache) ? { sessionKey, exclusiveOf: ignoreCache } : { sessionKey, renewCache: ignoreCache === 0 };
         let queryString = '';
-        if ((caching && ignoreCache !== true || ignoreCache === false || ignoreCache === 1 || renewCache) && !streamRow) {
+        if (caching && ignoreCache !== true && !streamRow) {
             queryString = Db.asString(query, true) + '_' + Db.asString(params, true) + Db.asString(clientOptions, true);
             if (ignoreCache !== 1) {
                 const result = this.getQueryResult(source, removePoolProperties(credential), queryString, cacheValue);
@@ -363,7 +416,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
     }, outResult);
 }
 exports.executeBatchQuery = executeBatchQuery;
-function checkTimeout(value, limit = 0) {
+async function checkTimeout(value, limit = 0) {
     return DbPool.checkTimeout(POOL_STATE, value, limit);
 }
 exports.checkTimeout = checkTimeout;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pi-r/oracle",
-  "version": "0.5.0",
+  "version": "0.6.1",
   "description": "Oracle client driver for E-mc.",
   "main": "client/index.js",
   "types": "client/index.d.ts",
@@ -21,8 +21,8 @@
   "license": "MIT",
   "homepage": "https://github.com/anpham6/pi-r#readme",
   "dependencies": {
-    "@e-mc/db": "^0.7.0",
-    "@e-mc/types": "^0.7.0",
-    "oracledb": "^6.2.0"
+    "@e-mc/db": "^0.8.1",
+    "@e-mc/types": "^0.8.1",
+    "oracledb": "^6.3.0"
   }
 }

package/types/index.d.ts

@@ -2,10 +2,11 @@ import type { DbDataSource } from '@e-mc/types/lib/squared';
 
 import type { ExecuteAction, ServerAuth } from '@e-mc/types/lib/db';
 
-import type { BindParameters, ConnectionAttributes, ExecuteOptions, PoolAttributes } from 'oracledb';
+// @ts-ignore
+import type { BindParameters, ConnectionAttributes, ExecuteOptions, PoolAttributes, InitialiseOptions } from 'oracledb';
 
 export interface OracleDataSource extends DbDataSource<string, ExecuteOptions, unknown, string | OracleCredential, string>, ExecuteAction<BindParameters> {
     source: "oracle";
 }
 
-export interface OracleCredential extends ServerAuth, ConnectionAttributes, PoolAttributes {}
+export interface OracleCredential extends ServerAuth, ConnectionAttributes, PoolAttributes, InitialiseOptions {}