Network code enhancements in Thin mode

Author: sharadraju

lib/errors.js

@@ -145,7 +145,7 @@ const ERR_TLS_HOSTMATCH_FAILURE = 508;
 const ERR_INVALID_PACKET = 509;
 const ERR_CONNECTION_TIMEDOUT = 510;
 const ERR_CONNECTION_REFUSED = 511;
-const ERR_INVALID_ADDRESS = 512;
+const ERR_INVALID_CONNECTSTRING_PARAMETERS = 512;
 const ERR_CONNECTION_INBAND = 513;
 const ERR_INVALID_CONNECT_STRING_SYNTAX = 514;
 const ERR_INVALID_EZCONNECT_SYNTAX = 515;
@@ -406,8 +406,8 @@ messages.set(ERR_CONNECTION_TIMEDOUT,                   // NJS-510
   'connection to host %s port %d timed out. Request exceeded "%s" of %d seconds. (CONNECTION_ID=%s)');
 messages.set(ERR_CONNECTION_REFUSED,                    // NJS-511
   'connection to listener at host %s port %d was refused. (CONNECTION_ID=%s)\nCause: %s');
-messages.set(ERR_INVALID_ADDRESS,                       // NJS-512
-  'invalid address specified. %s %s');
+messages.set(ERR_INVALID_CONNECTSTRING_PARAMETERS,      // NJS-512
+  'invalid connection string parameters.\n%s');
 messages.set(ERR_CONNECTION_INBAND,                     // NJS-513
   'error received through in-band notification: %s');
 messages.set(ERR_INVALID_CONNECT_STRING_SYNTAX,         // NJS-514
@@ -701,7 +701,7 @@ module.exports = {
   ERR_INVALID_PACKET,
   ERR_CONNECTION_TIMEDOUT,
   ERR_CONNECTION_REFUSED,
-  ERR_INVALID_ADDRESS,
+  ERR_INVALID_CONNECTSTRING_PARAMETERS,
   ERR_CONNECTION_INBAND,
   ERR_INVALID_CONNECT_STRING_SYNTAX,
   ERR_INVALID_EZCONNECT_SYNTAX,

lib/thin/sqlnet/ezConnectResolver.js

@@ -29,41 +29,6 @@
 const {lookup} = require('dns').promises;
 const errors = require("../../errors.js");
 
-String.prototype.format = function() {
-  var args = arguments;
-  return this.replace(/{([0-9]+)}/g, function(match, index) {
-    // check if the argument is there
-    return typeof args[index] == 'undefined' ? match : args[index];
-  });
-};
-
-// String formats for creating the TNS URL.
-const DESCRIPTION_FORMAT = "(DESCRIPTION={0}{1}{2}{3})";
-const DESCRIPTION_FORMAT_LB = "(DESCRIPTION=(LOAD_BALANCE=ON){0}{1}{2}{3})";
-const ADDRESS_LIST_FORMAT = "(ADDRESS_LIST={0})";
-const ADDRESS_LIST_FORMAT_LB = "(ADDRESS_LIST=(LOAD_BALANCE=ON){0})";
-const ADDRESS_FORMAT = "(ADDRESS=(PROTOCOL={0})(HOST={1})(PORT={2}){3})";
-const HTTPS_PROXY_FORMAT = "(HTTPS_PROXY={0})";
-const HTTPS_PROXY_PORT_FORMAT = "(HTTPS_PROXY_PORT={0})";
-const CONNECT_DATA_FORMAT = "(CONNECT_DATA={0}{1}{2}{3}{4}{5}{6})";
-const SERVICE_NAME_FORMAT = "(SERVICE_NAME={0})";
-const SERVER_MODE_FORMAT = "(SERVER={0})";
-const INSTANCE_NAME_FORMAT = "(INSTANCE_NAME={0})";
-const SERVICE_TAG_FORMAT = "(SERVICE_TAG={0})";
-const POOL_CONNECTION_CLASS_FORMAT = "(POOL_CONNECTION_CLASS={0})";
-const POOL_PURITY_FORMAT = "(POOL_PURITY={0})";
-const CONNECTION_ID_PREFIX_FORMAT = "(CONNECTION_ID_PREFIX={0})";
-const SECURITY_FORMAT = "(SECURITY={0})";
-const SERVER_DN_MATCH_FORMAT = "(SSL_SERVER_DN_MATCH={0})";
-const SERVER_DN_FORMAT = "(SSL_SERVER_CERT_DN={0})";
-const MY_WALLET_DIR_FORMAT = "(MY_WALLET_DIRECTORY={0})";
-const ENCRYPTION_CLIENT_FORMAT = "(ENCRYPTION_CLIENT={0})";
-const ENCRYPTION_TYPES_CLIENT_FORMAT = "(ENCRYPTION_TYPES_CLIENT={0})";
-const CRYPTO_CHECKSUM_CLIENT_FORMAT = "(CRYPTO_CHECKSUM_CLIENT={0})";
-const CRYPTO_CHECKSUM_TYPES_CLIENT_FORMAT = "(CRYPTO_CHECKSUM_TYPES_CLIENT={0})";
-const KEY_VALUE_FORMAT = "({0}={1})";
-
-
 // The host information pattern of the EZConnect URL format.
 /*
 Used (?=) for lookahead and \\k<hostnames> for the backreference.Lookahead
@@ -183,24 +148,23 @@ class EZConnectResolver {
     }
 
     // Try to get the proxy information from URL properties
-    let proxyHost = this.urlProps.get("HTTPS_PROXY");
-    let proxyPort = this.urlProps.get("HTTPS_PROXY_PORT");
-    let addressInfo =
+    const proxyHost = this.urlProps.get("HTTPS_PROXY");
+    const proxyPort = this.urlProps.get("HTTPS_PROXY_PORT");
+    const addressInfo =
       await this.buildAddressList(hostInfo, protocol, proxyHost, proxyPort);
 
     let connectionIdPrefix =
       this.urlProps.get("CONNECTION_ID_PREFIX");
     // Build the available information in TNS format.
-    if (this.lb) {
-      return DESCRIPTION_FORMAT_LB.format(this.buildDescriptionParams(), addressInfo,
-        this.buildConnectData(serviceName, serverMode, instanceName,
-          connectionIdPrefix), this.buildSecurityInfo(protocol));
-    } else {
-      return DESCRIPTION_FORMAT.format(this.buildDescriptionParams(), addressInfo,
-        this.buildConnectData(serviceName, serverMode, instanceName,
-          connectionIdPrefix), this.buildSecurityInfo(protocol));
-    }
-
+    const parts = [];
+    if (this.lb)
+      parts.push("(LOAD_BALANCE=ON)");
+    parts.push(this.buildDescriptionParams());
+    parts.push(addressInfo);
+    parts.push(this.buildConnectData(serviceName, serverMode, instanceName,
+      connectionIdPrefix));
+    parts.push(this.buildSecurityInfo(protocol));
+    return `(DESCRIPTION=${parts.join('')})`;
   }
 
   /**
@@ -211,23 +175,31 @@ class EZConnectResolver {
    * @param connectionIdPrefix prefix which will be appended to the connection id [optional].
    * @return CONNECT_DATA as string
    */
-  buildConnectData(serviceName,
-    serverMode,
-    instanceName,
-    connectionIdPrefix) {
-
-    let poolConnectionClass = this.urlProps.get("POOL_CONNECTION_CLASS");
-    let poolPurity = this.urlProps.get("POOL_PURITY");
-    let serviceTag = this.urlProps.get("SERVICE_TAG");
-
-    return CONNECT_DATA_FORMAT.format(SERVICE_NAME_FORMAT.format(serviceName == null ? '' : serviceName),
-      serverMode == null ? '' : SERVER_MODE_FORMAT.format(serverMode),
-      instanceName == null ? '' : INSTANCE_NAME_FORMAT.format(instanceName),
-      poolConnectionClass == null ? '' : POOL_CONNECTION_CLASS_FORMAT.format(poolConnectionClass),
-      poolPurity == null ? '' : POOL_PURITY_FORMAT.format(POOL_PURITY_FORMAT),
-      serviceTag == null ? '' : SERVICE_TAG_FORMAT.format(serviceTag),
-      connectionIdPrefix == null ? '' : CONNECTION_ID_PREFIX_FORMAT.format(connectionIdPrefix));
+  buildConnectData(serviceName, serverMode, instanceName, connectionIdPrefix) {
+    const poolConnectionClass = this.urlProps.get("POOL_CONNECTION_CLASS");
+    const poolPurity = this.urlProps.get("POOL_PURITY");
+    const serviceTag = this.urlProps.get("SERVICE_TAG");
+
+    const parts = [];
+    if (serviceName)
+      parts.push(`(SERVICE_NAME=${serviceName})`);
+    else
+      parts.push('(SERVICE_NAME=)');
+    if (serverMode)
+      parts.push(`(SERVER=${serverMode})`);
+    if (instanceName)
+      parts.push(`(INSTANCE_NAME=${instanceName})`);
+    if (poolConnectionClass)
+      parts.push(`(POOL_CONNECTION_CLASS=${poolConnectionClass})`);
+    if (poolPurity)
+      parts.push(`(POOL_PURITY=${poolPurity})`);
+    if (serviceTag)
+      parts.push(`(SERVICE_TAG=${serviceTag})`);
+    if (connectionIdPrefix)
+      parts.push(`(CONNECTION_ID_PREFIX=${connectionIdPrefix})`);
+    return `(CONNECT_DATA=${parts.join("")})`;
   }
+
   /**
 * Builds the address information of the DESCRIPTION node with the given
 * information.
@@ -245,8 +217,7 @@ class EZConnectResolver {
     let builder = new Array();
     let proxyInfo = '';
     if (proxyHost != null && proxyPort != null) {
-      // Builds the proxy information if it is available
-      proxyInfo = HTTPS_PROXY_FORMAT.format(proxyHost) + HTTPS_PROXY_PORT_FORMAT.format(proxyPort);
+      proxyInfo = `(HTTPS_PROXY=${proxyHost})(HTTPS_PROXY_PORT=${proxyPort})`;
     }
 
     if (protocol == null) protocol = 'TCP';
@@ -269,13 +240,14 @@ class EZConnectResolver {
         }
       }
       naddr += addressNodeCount;
-      if (addressLists.length > 1 && addressNodeCount > 1) {
-        builder.push(ADDRESS_LIST_FORMAT_LB.format(addressListBuilder.join('')));
-      } else if (addressLists.length > 1) {
-        builder.push(ADDRESS_LIST_FORMAT.format(addressListBuilder.join('')));
-      } else {
-        builder.push(addressListBuilder.join(''));
-      }
+      const parts = [];
+      if (addressLists.length > 1 && addressNodeCount > 1)
+        parts.push('(LOAD_BALANCE=ON)');
+      parts.push(addressListBuilder.join(''));
+      if (addressLists.length > 1)
+        builder.push(`(ADDRESS_LIST=${parts.join('')})`);
+      else
+        builder.push(parts.join(''));
     }
     if (naddr == 1) {
       shost = shost.trim();
@@ -309,15 +281,12 @@ class EZConnectResolver {
 * @param proxyInfo
 * @return addressInfo
 */
-  getAddrStr(hostName, port,
-    protocol, proxyInfo) {
+  getAddrStr(hostName, port, protocol, proxyInfo) {
     let host = hostName.trim();
     // If it is IPV6 format address then remove the enclosing '[' and ']'
     if (host.startsWith("[") && host.endsWith("]"))
       host = host.substring(1, host.length - 1);
-
-    return ADDRESS_FORMAT.format(protocol, host, port, proxyInfo);
-
+    return `(ADDRESS=(PROTOCOL=${protocol})(HOST=${host})(PORT=${port})${proxyInfo})`;
   }
   /**
 * Builds the parameters for the DESCRIPTION node using the parsed properties
@@ -330,7 +299,7 @@ class EZConnectResolver {
     let builder = new Array();
     this.urlProps.forEach(function(v, k) {
       if (DESCRIPTION_PARAMS.includes(k)) // Add only if it is a DESCRIPTION node parameter
-        builder.push(KEY_VALUE_FORMAT.format(k, v));
+        builder.push(`(${k}=${v})`);
     });
     return builder.join('');
   }
@@ -341,41 +310,22 @@ class EZConnectResolver {
 * @return security node of the description as string.
 */
   buildSecurityInfo(protocol) {
-    let securityInfo = new Array();
+    const securityInfo = new Array();
     if (protocol != null && protocol.toLowerCase() == "tcps") {
       // In EZConnect format if the DN match is not specified the enable it
       // by default for TCPS protocol.
-      let serverDNMatch = this.urlProps.get("SSL_SERVER_DN_MATCH");
-      let serverCertDN = this.urlProps.get("SSL_SERVER_CERT_DN");
-      let walletDir = this.urlProps.get("MY_WALLET_DIRECTORY");
-      if (serverDNMatch != null && (serverDNMatch == "false" || serverDNMatch == "off" || serverDNMatch == "no")) {
-        securityInfo.push(SERVER_DN_MATCH_FORMAT.format(serverDNMatch));
-      } else {
-        securityInfo.push(SERVER_DN_MATCH_FORMAT.format('TRUE'));
-      }
+      const serverDNMatch = this.urlProps.get("SSL_SERVER_DN_MATCH") || 'TRUE';
+      const serverCertDN = this.urlProps.get("SSL_SERVER_CERT_DN");
+      const walletDir = this.urlProps.get("MY_WALLET_DIRECTORY");
+      securityInfo.push(`(SSL_SERVER_DN_MATCH=${serverDNMatch})`);
       if (serverCertDN != null)
-        securityInfo.push(SERVER_DN_FORMAT.format(serverCertDN));
-
+        securityInfo.push(`(SSL_SERVER_CERT_DN=${serverCertDN}})`);
       if (walletDir != null)
-        securityInfo.push(MY_WALLET_DIR_FORMAT.format(walletDir));
-
-    } else {
-      let encryptionClient = this.urlProps.get("ENCRYPTION_CLIENT");
-      let encryptionClientTypes = this.urlProps.get("ENCRYPTION_TYPES_CLIENT");
-      let checksumClient = this.urlProps.get("CRYPTO_CHECKSUM_CLIENT");
-      let checksumClientTypes = this.urlProps.get("CRYPTO_CHECKSUM_TYPES_CLIENT");
-      if (encryptionClient != null)
-        securityInfo.push(ENCRYPTION_CLIENT_FORMAT.format(encryptionClient));
-      if (encryptionClientTypes != null)
-        securityInfo.push(ENCRYPTION_TYPES_CLIENT_FORMAT.format(encryptionClientTypes));
-      if (checksumClient != null)
-        securityInfo.push(CRYPTO_CHECKSUM_CLIENT_FORMAT.format(checksumClient));
-      if (checksumClientTypes != null)
-        securityInfo.push(CRYPTO_CHECKSUM_TYPES_CLIENT_FORMAT.format(checksumClientTypes));
-
+        securityInfo.push(`(MY_WALLET_DIRECTORY=${walletDir})`);
     }
-    return (securityInfo.length == 0) ?
-      '' : SECURITY_FORMAT.format(securityInfo.join(''));
+    if (securityInfo.length === 0)
+      return '';
+    return `(SECURITY=${securityInfo.join('')})`;
   }
 
   /**
@@ -529,10 +479,6 @@ class EZConnectResolver {
     aliasMap.set("ssl_server_cert_dn", "SSL_SERVER_CERT_DN");
     aliasMap.set("ssl_server_dn_match", "SSL_SERVER_DN_MATCH");
     aliasMap.set("wallet_location", "MY_WALLET_DIRECTORY");
-    aliasMap.set("encryption_client", "ENCRYPTION_CLIENT");
-    aliasMap.set("encryption_types_client", "ENCRYPTION_TYPES_CLIENT");
-    aliasMap.set("crypto_checksum_client", "CRYPTO_CHECKSUM_CLIENT");
-    aliasMap.set("crypto_checksum_types_client", "CRYPTO_CHECKSUM_TYPES_CLIENT");
     aliasMap.set("pool_connection_class", "POOL_CONNECTION_CLASS");
     aliasMap.set("pool_purity", "POOL_PURITY");
     aliasMap.set("service_tag", "SERVICE_TAG");

lib/thin/sqlnet/navNodes.js

@@ -81,8 +81,8 @@ class Address {
     if (hostnvp)
       this.host = hostnvp.atom;
 
-    if (protnvp == null) errors.throwErr(errors.ERR_INVALID_ADDRESS, "undefined", "protocol not supported");
-    this.prot = protnvp.atom;
+    if (protnvp)
+      this.prot = protnvp.atom;
 
     if (httpsProxyNVP)
       this.httpsProxy = httpsProxyNVP.atom;
@@ -307,10 +307,6 @@ class Description {
             this.params.walletLocation = tmpnv.atom;
           }
         }
-      } else if (childnv.name.toUpperCase() == "WEBSOCK_URI") {
-        this.params.websockUri = childnv.atom;
-      } else if (childnv.name.toUpperCase() == "WEBSOCK_UNAME") {
-        this.params.websockUname = childnv.atom;
       }
     }
   }
@@ -734,12 +730,6 @@ class NavDescription extends Description {
     if ('httpsProxy' in this.params) {
       cs.sBuf.push("(HTTPS_PROXY=" + this.params.httpsProxy + ")");
     }
-    if ('websockUri' in this.params) {
-      cs.sBuf.push("(WEBSOCK_URI=" + this.params.websockUri + ")");
-    }
-    if ('websockUname' in this.params) {
-      cs.sBuf.push("(WEBSOCK_UNAME=" + this.params.websockUname + ")");
-    }
     if (!this.failover) {
       cs.sBuf.push(NavSchemaObject.NFO);
     }

lib/thin/sqlnet/networkSession.js

@@ -145,7 +145,7 @@ class NetworkSession {
     this.sAtts = new SessionAtts(uuid);
     this.sAtts.setFrom(userConfig);
     this.sAtts.setFrom(address.desc.params);  /* Resolve attributes from Connect String */
-    await this.sAtts.prepare();
+    await this.sAtts.prepare(address.protocol);
 
     /* Insert Connection ID */
     let rootNVPair = createNVPair(address.CNdata.join(""));
@@ -164,11 +164,10 @@ class NetworkSession {
    * Make the transport level connection
    */
   async transportConnect(address) {
-    if (address.protocol.toUpperCase() == 'TCP' ||
-      address.protocol.toUpperCase() == 'TCPS') {
+    if (address.protocol && (address.protocol.toUpperCase() == 'TCP' || address.protocol.toUpperCase() == 'TCPS')) {
       this.ntAdapter = new NTTCP(this.sAtts.nt);
     } else {
-      errors.throwErr(errors.ERR_INVALID_ADDRESS, address.protocol, "protocol not supported");
+      errors.throwErr(errors.ERR_INVALID_CONNECTSTRING_PARAMETERS, address.protocol + " protocol not supported");
     }
     await this.ntAdapter.connect(address);
     this.ntAdapter.startRead();
@@ -318,7 +317,10 @@ class NetworkSession {
         if (err.message.startsWith('NJS-510')) {
           this.ntAdapter.connected = true; // Pretend as connected
         }
-        this.ntAdapter.disconnect(constants.NSFIMM);
+        if (this.ntAdapter) {
+          this.ntAdapter.disconnect(constants.NSFIMM);
+          this.ntAdapter = null;
+        }
         connected = false;
         savedErr = err;
         try {
@@ -510,8 +512,11 @@ class NetworkSession {
     let address;
     try {
       address = await this.getAddress(addressNode, userConfig);
-    } catch {
-      errors.throwErr(errors.ERR_INVALID_ADDRESS, "Ensure the ADDRESS parameters have been entered correctly", "the most likely incorrect parameter is the host name");
+    } catch (err) {
+      if (err.message == "All options tried") /* Not even one valid Address */
+        errors.throwErr(errors.ERR_INVALID_CONNECTSTRING_PARAMETERS, "Ensure the ADDRESS parameters have been entered correctly, the most likely incorrect parameter is the host name");
+      else
+        errors.throwErr(errors.ERR_INVALID_CONNECTSTRING_PARAMETERS, err.message);
     }
     await this.connect1(address, addressNode, userConfig);
   }

lib/thin/sqlnet/sessionAtts.js

@@ -103,12 +103,6 @@ class SessionAtts {
       if (typeof params.sslServerCertDN === 'string') {
         this.nt.sslServerCertDN = params.sslServerCertDN;
       }
-      if (typeof params.websockUname === 'string') {
-        this.nt.websockUname = params.websockUname;
-      }
-      if (typeof params.websockUri === 'string') {
-        this.nt.websockUri = params.websockURI;
-      }
       if (typeof params.enable === 'string' && params.enable.toUpperCase() == "BROKEN") {
         this.nt.enabledDCD = true;
       }
@@ -141,7 +135,7 @@ class SessionAtts {
    * Prepare attributes for connection, Generate Connection ID and read Wallet file
    *
    */
-  async prepare() {
+  async prepare(protocol) {
     if (!this.uuid) {
       this.uuid = await genuuid();
       this.uuid = this.uuid.toString('base64');
@@ -153,7 +147,7 @@ class SessionAtts {
     }
     this.nt.connectionId = this.connectionId;
 
-    if (this.nt.walletFile) {
+    if (protocol && (protocol.toUpperCase() == "TCPS" && this.nt.walletFile)) {
       this.nt.wallet = await this.readWalletFile();
     }