Moved config providers to the plugins extension. Permanent Fix for Issues #1688 and #1691

Author: sharadraju

doc/src/release_notes.rst

@@ -66,6 +66,11 @@ Common Changes
 Thin Mode Changes
 +++++++++++++++++
 
+#)  Moved centralized configuration provider support to be part of the
+    plugins to prevent package build errors with external bundlers like
+    webpack and esbuild. See:
+    `Issue #1791 <https://github.com/oracle/node-oracledb/issues/1791>`__.
+
 #)  Fixed bug which forced node-oracledb to resolve the database host name
     even if a proxy was specified in the connect string. Now the proxy
     specified in the connect string will resolve the database host name.

examples/azureConfigProvider.js

@@ -37,7 +37,7 @@
 Error.stackTraceLimit = 50;
 
 const oracledb = require('oracledb');
-
+require('oracledb/plugins/configProviders/azure');
 // This example runs in both node-oracledb Thin and Thick modes.
 //
 // Optionally run in node-oracledb Thick mode

examples/ociConfigProvider.js

@@ -37,6 +37,7 @@
 Error.stackTraceLimit = 50;
 
 const oracledb = require('oracledb');
+require('oracledb/plugins/configProviders/ociobject');
 
 // This example runs in both node-oracledb Thin and Thick modes.
 //

examples/ociConfigProviderPool.js

@@ -37,7 +37,7 @@
 Error.stackTraceLimit = 50;
 
 const oracledb = require('oracledb');
-
+require('oracledb/plugins/configProviders/ociobject');
 // This example runs in both node-oracledb Thin and Thick modes.
 //
 // Optionally run in node-oracledb Thick mode

lib/configProviders/file.js

@@ -24,12 +24,14 @@
 //
 //-----------------------------------------------------------------------------
 const fs = require('fs').promises;
-const { base } = require("./base.js");
-class localJson extends base {
+const util = require('node:util');
+const oracledb = require('oracledb');
+class locaJson {
 
   constructor(provider_arg, urlExtendedPart) {
-    super(urlExtendedPart);
-    this._addParam("filePath", provider_arg);
+    const params = new URLSearchParams(urlExtendedPart);
+    this.paramMap = new URLSearchParams([...params].map(([key, value]) => [key.toLowerCase(), value])); //parse the extended part and store parameters in Map
+    this.paramMap.set('filepath', provider_arg);
   }
   //---------------------------------------------------------------------------
   // init()
@@ -53,4 +55,19 @@ class localJson extends base {
     return this.obj;
   }
 }
-module.exports = localJson;
+//---------------------------------------------------------------------------
+//  hookFn()
+//  hookFn will get registered to the driver while loading the plugins
+//---------------------------------------------------------------------------
+async function hookFn(args) {
+  const configProvider = new locaJson(args.provider_arg, args.urlExtendedPart);
+  try {
+    configProvider.init();
+  } catch (err) {
+    const errmsg = util.format('Centralized Config Provider failed to load required libraries. Please install the required libraries.\n %s', err.message);
+    throw new Error(errmsg);
+  }
+  return [await configProvider.returnConfig(), configProvider.credential];
+}
+oracledb.registerConfigProviderHooks('file', hookFn);
+

lib/errors.js

@@ -198,13 +198,8 @@ const ERR_INVALID_SERVICE_NAME = 518;
 const ERR_INVALID_SID = 519;
 const ERR_TNS_NAMES_FILE_MISSING = 520;
 const ERR_CONNECTION_EOF = 521;
-const ERR_AZURE_CONFIG_PROVIDER_AUTH_FAILED = 522;
 const ERR_CONFIG_PROVIDER_FAILED_TO_RETRIEVE_CONFIG = 523;
-const ERR_CONFIG_PROVIDER_NOT_SUPPORTED = 524;
-const ERR_CONFIG_PROVIDER_LOAD_FAILED = 525;
-const ERR_OCIOBJECT_CONFIG_PROVIDER_AUTH_FAILED = 526;
-const ERR_AZURE_VAULT_AUTH_FAILED = 527;
-const ERR_AZURE_SERVICE_PRINCIPAL_AUTH_FAILED = 528;
+const ERR_REGISTER_HOOKFN_CONFIGPROVIDER = 524;
 const ERR_WALLET_TYPE_NOT_SUPPORTED = 529;
 const ERR_HOST_NOT_FOUND = 530;
 const ERR_ANO_PACKET = 531;
@@ -577,20 +572,10 @@ messages.set(ERR_TNS_NAMES_FILE_MISSING,                // NJS-520
   'cannot connect to Oracle Database. File tnsnames.ora not found in %s');
 messages.set(ERR_CONNECTION_EOF,                        // NJS-521
   'connection to host %s port %d received end-of-file on communication channel. (CONNECTION_ID=%s)');
-messages.set(ERR_AZURE_CONFIG_PROVIDER_AUTH_FAILED,     // NJS-522
-  'Azure Authentication Failed: The authentication parameter value %s may be incorrect');
 messages.set(ERR_CONFIG_PROVIDER_FAILED_TO_RETRIEVE_CONFIG,   // NJS-523
   'Failed to retrieve configuration from Centralized Configuration Provider:\n %s');
-messages.set(ERR_CONFIG_PROVIDER_NOT_SUPPORTED,         // NJS-524
-  'Configuration Provider not supported: %s');
-messages.set(ERR_CONFIG_PROVIDER_LOAD_FAILED,           // NJS-525
-  'Centralized Config Provider failed to load required libraries. Please install the required libraries.\n %s');
-messages.set(ERR_OCIOBJECT_CONFIG_PROVIDER_AUTH_FAILED, // NJS-526
-  'OCI authentication failed: The authentication parameter value %s may be incorrect');
-messages.set(ERR_AZURE_VAULT_AUTH_FAILED,               // NJS-527
-  'Azure Vault: Provide correct Azure Vault authentication details');
-messages.set(ERR_AZURE_SERVICE_PRINCIPAL_AUTH_FAILED,   // NJS-528
-  'Azure service principal authentication requires either a client certificate path or a client secret string');
+messages.set(ERR_REGISTER_HOOKFN_CONFIGPROVIDER,         // NJS-524
+  '%s Configuration provider plugin not registered. Please register the hook function for the same');
 messages.set(ERR_WALLET_TYPE_NOT_SUPPORTED,             // NJS-529
   'Invalid wallet content format. Supported format is PEM');
 messages.set(ERR_HOST_NOT_FOUND,                        // NJS-530
@@ -933,14 +918,9 @@ module.exports = {
   ERR_NO_CONFIG_DIR,
   ERR_TNS_ENTRY_NOT_FOUND,
   ERR_CONNECTION_EOF,
-  ERR_AZURE_CONFIG_PROVIDER_AUTH_FAILED,
-  ERR_OCIOBJECT_CONFIG_PROVIDER_AUTH_FAILED,
-  ERR_AZURE_VAULT_AUTH_FAILED,
-  ERR_AZURE_SERVICE_PRINCIPAL_AUTH_FAILED,
   ERR_CONFIG_PROVIDER_FAILED_TO_RETRIEVE_CONFIG,
   ERR_CONFIG_PROVIDER_PARAM_TYPE,
-  ERR_CONFIG_PROVIDER_NOT_SUPPORTED,
-  ERR_CONFIG_PROVIDER_LOAD_FAILED,
+  ERR_REGISTER_HOOKFN_CONFIGPROVIDER,
   ERR_DATA_COMPRESSION,
   ERR_WALLET_TYPE_NOT_SUPPORTED,
   ERR_HOST_NOT_FOUND,

lib/oracledb.js

@@ -68,6 +68,7 @@ const poolCache = {};
 const tempUsedPoolAliases = {};
 const defaultPoolAlias = 'default';
 const registeredHooks = [];
+const registeredConfigProviderHooks = new Map();
 let configProviderCache;
 
 // save arguments for call to initOracleClient()
@@ -904,7 +905,7 @@ async function shutdown(a1, a2) {
   await conn.close();
 }
 
-async function _setConfigParameters(obj, configProviderObject, configProvider) {
+async function _setConfigParameters(obj, credential, configProvider) {
   const configObject = {};
   const pmSection = 'njs';
   const params = obj[pmSection];
@@ -918,21 +919,21 @@ async function _setConfigParameters(obj, configProviderObject, configProvider) {
 
   configObject.user = obj.user;
   if (obj.password) {
-    configObject.password = await _retrieveParamValueFromVault(obj['password'], configProviderObject.credential, configProvider);
+    configObject.password = await _retrieveParamValueFromVault(obj['password'], credential, configProvider);
   }
   if (obj.wallet_location) {
     // retrieve wallet_location
-    configObject.walletContent = await _retrieveParamValueFromVault(obj['wallet_location'], configProviderObject.credential, configProvider);
+    configObject.walletContent = await _retrieveParamValueFromVault(obj['wallet_location'], credential, configProvider);
     //only Pem file supported
-    if (!configProviderObject.isPemFile(configObject.walletContent))
+    if (!nodbUtil.isPemFile(configObject.walletContent))
       errors.throwErr(errors.ERR_WALLET_TYPE_NOT_SUPPORTED);
   }
   return configObject;
 }
 
 async function _retrieveParamValueFromVault(paramObj, credential, configProvider) {
-  const auth = paramObj.authentication;
   const paramMap = new Map();
+  const auth = paramObj.authentication;
   if (auth) {
     for (const key in auth) {
       if (key == 'method')
@@ -941,6 +942,7 @@ async function _retrieveParamValueFromVault(paramObj, credential, configProvider
       paramMap.set(key.toLowerCase(), val);
     }
   }
+  const args = {};
   if (paramObj.type == "base64") {
     console.log("WARNING: Base64 Encoding in a JSON Password should only be used in development environments");
     return Buffer.from(paramObj.value, "base64").toString("utf-8");
@@ -951,27 +953,31 @@ async function _retrieveParamValueFromVault(paramObj, credential, configProvider
     } else
       errors.throwErr(errors.ERR_CONFIG_PROVIDER_PARAM_TYPE, 'password type text is only allowed in ocivault and azurevault');
   } else if (paramObj.type == "azurevault") {
-    const azureVaultClass = require('../lib/configProviders/azurevault.js');
-    const azureVaultObject = new azureVaultClass();
-    azureVaultObject.init();
-    paramMap.set("azuresecreturl", paramObj.value);
-    azureVaultObject.paramMap = paramMap;
+    paramMap.set('azuresecreturl', paramObj.value);
     if (!(configProvider == 'azure' || configProvider == 'azurevault'))
       credential = null;
-
-    const paramValue = await azureVaultObject.returnConfig(credential);
+    const hookFn = registeredConfigProviderHooks['azurevault'];
+    if (hookFn == undefined)
+      errors.throwErr(errors.ERR_REGISTER_HOOKFN_CONFIGPROVIDER, 'azurevault');
+    args.credential = credential;
+    args.paramMap = paramMap;
+    const vaultReturn = await hookFn(args);
+    const paramValue = vaultReturn[0];
     return paramValue;
 
   } else if (paramObj.type == "ocivault") {
-    const ociVaultClass = require('../lib/configProviders/ocivault.js');
-    const ociVaultObject = new ociVaultClass();
-    ociVaultObject.init();
-    paramMap.set("ocidvault", paramObj.value);
-    ociVaultObject.paramMap = paramMap;
+
+    paramMap.set('ocidvault', paramObj.value);
     if (!(configProvider == 'ociobject' || configProvider == 'ocivault'))
       credential = null;
-
-    const paramValue = await ociVaultObject.returnConfig(credential);
+    const hookFn = registeredConfigProviderHooks['ocivault'];
+    if (hookFn == undefined)
+      errors.throwErr(errors.ERR_REGISTER_HOOKFN_CONFIGPROVIDER, 'ocivault');
+    const args = {};
+    args.credential = credential;
+    args.paramMap = paramMap;
+    const vaultReturn = await hookFn(args);
+    const paramValue = vaultReturn[0];
     return paramValue;
   }  else {
     errors.throwErr(errors.ERR_CONFIG_PROVIDER_PARAM_TYPE, 'password/wallet_location');
@@ -1017,28 +1023,26 @@ async function _checkConfigProvider(options) {
     if (match) {
       const provider = match.groups.provider;
       const provider_arg = match.groups.provider_arg;
-      let configPckg;
-      try {
-        configPckg = require('./configProviders/' + provider);
-      } catch (err) {
-        errors.throwErr(errors.ERR_CONFIG_PROVIDER_NOT_SUPPORTED, provider);
-      }
-      const configProvider = new configPckg(provider_arg, urlExtendedPart);
-      try {
-        configProvider.init();
-      } catch (err) {
-        errors.throwErr(errors.ERR_CONFIG_PROVIDER_LOAD_FAILED, err.message);
-      }
+      const hookFn = registeredConfigProviderHooks[provider];
+      if (hookFn == undefined)
+        errors.throwErr(errors.ERR_REGISTER_HOOKFN_CONFIGPROVIDER, provider);
+      const args = {};
+      args.provider_arg = provider_arg;
+      args.urlExtendedPart = urlExtendedPart;
+
       try {
+      // hookFn returns an array with first element as the config stored in the configProvider
+      // second being the credential to the configProvider
+        const configProviderReturn = await hookFn(args);
+        secondOpts = configProviderReturn[0];
         if (!configProviderCache) {
           configProviderCache = new Map();
         }
-        secondOpts = await configProvider.returnConfig();
         if (!secondOpts) {
           errors.throwErr(errors.ERR_CONFIG_PROVIDER_FAILED_TO_RETRIEVE_CONFIG, 'no configuration found in ' + provider);
         }
         if (provider != 'azure')
-          secondOpts = await _setConfigParameters(secondOpts, configProvider, provider);
+          secondOpts = await _setConfigParameters(secondOpts, configProviderReturn[1], provider);
 
         // obfuscate password & walletcontent and store config in the cache
         const cacheOpts = { ...secondOpts};
@@ -1152,6 +1156,19 @@ function registerProcessConfigurationHook(fn) {
   registeredHooks.push(fn);
 }
 
+//-----------------------------------------------------------------------------
+// registerConfigProviderHooks()
+//
+// Registers configProvider plugin modules and registered modules will be called and
+// executed during pool and standalone connection creation.
+//-----------------------------------------------------------------------------
+function registerConfigProviderHooks(configProvider, fn) {
+  errors.assertArgCount(arguments, 2, 2);
+  errors.assertParamValue(typeof fn === 'function', 1);
+  errors.assertParamValue(typeof configProvider === 'string', 1);
+  registeredConfigProviderHooks[configProvider] = fn;
+}
+
 // module exports
 module.exports = {
 
@@ -1183,6 +1200,7 @@ module.exports = {
   getPool,
   initOracleClient,
   registerProcessConfigurationHook,
+  registerConfigProviderHooks,
   shutdown: nodbUtil.callbackify(nodbUtil.wrapFn(shutdown)),
   startup: nodbUtil.callbackify(nodbUtil.wrapFn(startup)),
 

lib/util.js

@@ -34,6 +34,25 @@ const types = require('./types.js');
 const constants = require('./constants.js');
 const traceHandler = require('./traceHandler.js');
 
+const pemHeaders = [
+  '-----BEGIN CERTIFICATE-----',
+  '-----BEGIN PUBLIC KEY-----',
+  '-----BEGIN PRIVATE KEY-----',
+  '-----BEGIN RSA PRIVATE KEY-----',
+  '-----BEGIN DSA PRIVATE KEY-----',
+  '-----BEGIN EC PRIVATE KEY-----',
+  '-----BEGIN ENCRYPTED PRIVATE KEY-----'
+];
+const pemFooters = [
+  '-----END CERTIFICATE-----',
+  '-----END PUBLIC KEY-----',
+  '-----END PRIVATE KEY-----',
+  '-----END RSA PRIVATE KEY-----',
+  '-----END DSA PRIVATE KEY-----',
+  '-----END EC PRIVATE KEY-----',
+  '-----END ENCRYPTED PRIVATE KEY-----'
+];
+
 // set of valid network characters
 const validNetworkCharacterSet = new Set(['A', 'B', 'C', 'D', 'E', 'F', 'G',
   'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V',
@@ -80,6 +99,13 @@ function getInstallURL() {
   return ('Node-oracledb installation instructions: https://node-oracledb.readthedocs.io/en/latest/user_guide/installation.html');
 }
 
+// check if a file has contents of a .pem file
+function isPemFile(content) {
+  //remove any line breaks at the end of the content
+  content = content.trim();
+  return pemHeaders.some(header => content.includes(header)) &&
+       pemFooters.some(footer => content.endsWith(footer));
+}
 
 // getInstallHelp returns a string with installation usage tips that may be helpful
 function getInstallHelp() {
@@ -599,5 +625,6 @@ module.exports = {
   sanitize,
   verifySodaDoc,
   wrapFn,
-  wrapFns
+  wrapFns,
+  isPemFile
 };