Add support for config_provider_time_to_live parameter in configuration provider plugin

Author: sharadraju

doc/src/release_notes.rst

@@ -46,6 +46,9 @@ Common Changes
 Thin Mode Changes
 +++++++++++++++++
 
+#)  Added support for the config_time_to_live parameter for configurations
+    retrieved from centralized configuration providers.
+    
 #)  Fixed bug validating the database host during connection.
 
 #)  Enabled proxy user to be passed with :ref:`external authentication <extauth>`

lib/oracledb.js

@@ -917,6 +917,7 @@ async function _setConfigParameters(obj, credential, configProvider) {
     configObject[key] = val;
   }
   configObject.connectString = obj.connect_descriptor;
+  configObject.configTTL = obj.config_time_to_live;
   if (!configObject.connectString)
     errors.throwErr(errors.ERR_CONFIG_PROVIDER_FAILED_TO_RETRIEVE_CONFIG, 'connect_descriptor must be set');
 
@@ -989,32 +990,37 @@ async function _retrieveParamValueFromVault(paramObj, credential, configProvider
 //-----------------------------------------------------------------------------
 // _checkConfigProvider()
 //
-// Look for the config provider in the connection string and retreives
+// Look for the config provider in the connection string and retrieves
 // object stored in the config Provider.
 // Returns object based on precedence between input object and the one retrieved
 // from Config Provider.
 //-----------------------------------------------------------------------------
 async function _checkConfigProvider(options) {
   // Time for Cache entries to be deleted in milliseconds
-  const cacheEntriesDuration = settings.configProviderCacheTimeout * 1000;
-  let secondOpts;
+  let cacheEntriesDuration = settings.configProviderCacheTimeout * 1000;
+  let secondOpts, cachedConfigEntry;
   const url = options.connectString || options.connectionString;
   if (!url)
     return options;
 
-  if (configProviderCache && configProviderCache.has(url) && ((Date.now() - configProviderCache.get(url).timeAdded) < cacheEntriesDuration)) {
-    const cacheOpts1 = configProviderCache.get(url).cacheOpts;
-    secondOpts = { ...cacheOpts1};
+  if (configProviderCache && (cachedConfigEntry = configProviderCache.get(url))) {
+    const config = cachedConfigEntry.cacheOpts;
+    if (config.configTTL)
+      cacheEntriesDuration = config.configTTL * 1000;
 
-    //deobfuscate password
-    if (secondOpts.password)
-      secondOpts.password = protocolUtil.getDeobfuscatedValue(secondOpts.password.value, secondOpts.password.obfuscatedValue);
+    if ((Date.now() - cachedConfigEntry.timeAdded) < cacheEntriesDuration) {
+      secondOpts = { ...config};
 
-    //deobfuscate walletContent
-    if (secondOpts.walletContent)
-      secondOpts.walletContent = protocolUtil.getDeobfuscatedValue(secondOpts.walletContent.value, secondOpts.walletContent.obfuscatedValue);
+      //deobfuscate password
+      if (secondOpts.password)
+        secondOpts.password = protocolUtil.getDeobfuscatedValue(secondOpts.password.value, secondOpts.password.obfuscatedValue);
 
-  } else {
+      //deobfuscate walletContent
+      if (secondOpts.walletContent)
+        secondOpts.walletContent = protocolUtil.getDeobfuscatedValue(secondOpts.walletContent.value, secondOpts.walletContent.obfuscatedValue);
+    }
+  }
+  if (!secondOpts) {
     let parsedUrl = url;
     let urlExtendedPart;
     const baseRegex = new RegExp("^config-(?<provider>[A-Za-z0-9]+)(://)(?<provider_arg>[^?]+)");

plugins/configProviders/azure/index.js

@@ -128,6 +128,9 @@ class AzureProvider extends base {
     //retrieve password
     configObject.password = await this.retrieveParamValueFromAzureConfigurationProvider(client, label, 'password');
 
+    // retrieve config_time_to_live
+    configObject.configTTL = await this.retrieveParamValueFromAzureConfigurationProvider(client, label, 'config_time_to_live');
+
     // retrieve wallet_location
     configObject.walletContent = await this.retrieveParamValueFromAzureConfigurationProvider(client, label, 'wallet_location');