@itentialopensource/adapter-utils 5.7.2 → 5.9.0

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 5.9.0 [09-23-2024]
+
+* Cache ssl file contents in memory
+
+See merge request itentialopensource/adapter-utils!303
+
+---
+
+## 5.8.0 [09-09-2024]
+
+* Add support for RESTCONF endpoints
+
+See merge request itentialopensource/adapter-utils!298
+
+---
+
 ## 5.7.2 [09-06-2024]
 
 * Update lock file

package/lib/connectorRest.js

@@ -127,6 +127,9 @@ let crest = null;
 let cacheHHead = null;
 let cacheHSchema = null;
 let cacheHPay = null;
+let sslCAFilePath = null;
+let sslKeyFilePath = null;
+let sslCertFilePath = null;
 
 const mfaStepsResults = []; // keeps requested result for each step
 
@@ -2028,34 +2031,32 @@ async function buildTokenRequest(reqPath, reqBody, callProperties, callback) {
             options.rejectUnauthorized = false;
           } else {
             // if we are not accepting invalid certs, need the ca file in the options
-            try {
-              options.rejectUnauthorized = true;
-              if (sslCAFileContent && sslCAFileContent !== '') {
-                options.ca = [sslCAFileContent];
-              } else {
-                options.ca = [fs.readFileSync(sslCAFile)];
-              }
-            } catch (e) {
-              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCAFile], null, null, null);
+            options.rejectUnauthorized = true;
+            if (sslCAFileContent && sslCAFileContent !== '') {
+              options.ca = [sslCAFileContent];
+            } else if (sslCAFile) {
+              options.ca = sslCAFile;
+            } else {
+              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCAFilePath], null, null, null);
               log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
               return reject(errorObj);
             }
             // if there is a cert file, try to read in a cert file in the options
-            if (sslCertFile) {
-              try {
-                options.cert = [fs.readFileSync(sslCertFile)];
-              } catch (e) {
-                const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCertFile], null, null, null);
+            if (sslCertFilePath) {
+              if (sslCertFile) {
+                options.cert = sslCertFile;
+              } else {
+                const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCertFilePath], null, null, null);
                 log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
                 return reject(errorObj);
               }
             }
             // if there is a key file, try to read in a key file in the options
-            if (sslKeyFile) {
-              try {
-                options.key = [fs.readFileSync(sslKeyFile)];
-              } catch (e) {
-                const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslKeyFile], null, null, null);
+            if (sslKeyFilePath) {
+              if (sslKeyFile) {
+                options.key = sslKeyFile;
+              } else {
+                const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslKeyFilePath], null, null, null);
                 log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
                 return reject(errorObj);
               }
@@ -4453,22 +4454,40 @@ class ConnectorRest {
       }
 
       // set the ssl ca file (optional - default is null)
-      if (typeof props.ssl.ca_file === 'string') {
-        sslCAFile = props.ssl.ca_file;
+      if (typeof props.ssl.ca_file === 'string' && props.ssl.ca_file.trim() !== '') {
+        sslCAFilePath = props.ssl.ca_file;
+        try {
+          sslCAFile = [fs.readFileSync(props.ssl.ca_file)];
+        } catch (err) {
+          log.error(`Failed to read CA file: ${err.message}`);
+          sslCAFile = null;
+        }
       }
 
-      if (typeof props.ssl.ca_file_content === 'string') {
+      if (typeof props.ssl.ca_file_content === 'string' && props.ssl.ca_file_content.trim() !== '') {
         sslCAFileContent = props.ssl.ca_file_content;
       }
 
       // set the ssl key file (optional - default is null)
-      if (typeof props.ssl.key_file === 'string') {
-        sslKeyFile = props.ssl.key_file;
+      if (typeof props.ssl.key_file === 'string' && props.ssl.key_file.trim() !== '') {
+        sslKeyFilePath = props.ssl.key_file;
+        try {
+          sslKeyFile = [fs.readFileSync(props.ssl.key_file)];
+        } catch (err) {
+          log.error(`Failed to read SSL file: ${err.message}`);
+          sslKeyFile = null;
+        }
       }
 
       // set the ssl cert file (optional - default is null)
-      if (typeof props.ssl.cert_file === 'string') {
-        sslCertFile = props.ssl.cert_file;
+      if (typeof props.ssl.cert_file === 'string' && props.ssl.cert_file.trim() !== '') {
+        sslCertFilePath = props.ssl.cert_file;
+        try {
+          sslCertFile = [fs.readFileSync(props.ssl.cert_file)];
+        } catch (err) {
+          log.error(`Failed to read SSL Cert file: ${err.message}`);
+          sslCertFile = null;
+        }
       }
 
       // set the ssl ciphers (optional - default is null)
@@ -4741,34 +4760,32 @@ class ConnectorRest {
           options.rejectUnauthorized = false;
         } else {
           // if we are not accepting invalid certs, need the ca file in the options
-          try {
-            options.rejectUnauthorized = true;
-            if (sslCAFileContent && sslCAFileContent !== '') {
-              options.ca = [sslCAFileContent];
-            } else {
-              options.ca = [fs.readFileSync(sslCAFile)];
-            }
-          } catch (e) {
-            const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCAFile], null, null, null);
+          options.rejectUnauthorized = true;
+          if (sslCAFileContent && sslCAFileContent !== '') {
+            options.ca = [sslCAFileContent];
+          } else if (sslCAFile) {
+            options.ca = sslCAFile;
+          } else {
+            const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCAFilePath], null, null, null);
             log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
             return callback(null, errorObj);
           }
           // if there is a cert file, try to read in a cert file in the options
-          if (sslCertFile) {
-            try {
-              options.cert = [fs.readFileSync(sslCertFile)];
-            } catch (e) {
-              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCertFile], null, null, null);
+          if (sslCertFilePath) {
+            if (sslCertFile) {
+              options.cert = sslCertFile;
+            } else {
+              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCertFilePath], null, null, null);
               log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
               return callback(null, errorObj);
             }
           }
           // if there is a key file, try to read in a key file in the options
-          if (sslKeyFile) {
-            try {
-              options.key = [fs.readFileSync(sslKeyFile)];
-            } catch (e) {
-              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslKeyFile], null, null, null);
+          if (sslKeyFilePath) {
+            if (sslKeyFile) {
+              options.key = sslKeyFile;
+            } else {
+              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslKeyFilePath], null, null, null);
               log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
               return callback(null, errorObj);
             }
@@ -4938,34 +4955,32 @@ class ConnectorRest {
           options.rejectUnauthorized = false;
         } else {
           // if we are not accepting invalid certs, need the ca file in the options
-          try {
-            options.rejectUnauthorized = true;
-            if (sslCAFileContent && sslCAFileContent !== '') {
-              options.ca = [sslCAFileContent];
-            } else {
-              options.ca = [fs.readFileSync(sslCAFile)];
-            }
-          } catch (e) {
-            const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCAFile], null, null, null);
+          options.rejectUnauthorized = true;
+          if (sslCAFileContent && sslCAFileContent !== '') {
+            options.ca = [sslCAFileContent];
+          } else if (sslCAFile) {
+            options.ca = sslCAFile;
+          } else {
+            const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCAFilePath], null, null, null);
             log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
             return callback(null, errorObj);
           }
           // if there is a cert file, try to read in a cert file in the options
-          if (sslCertFile) {
-            try {
-              options.cert = [fs.readFileSync(sslCertFile)];
-            } catch (e) {
-              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCertFile], null, null, null);
+          if (sslCertFilePath) {
+            if (sslCertFile) {
+              options.cert = sslCertFile;
+            } else {
+              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslCertFilePath], null, null, null);
               log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
               return callback(null, errorObj);
             }
           }
           // if there is a key file, try to read in a key file in the options
-          if (sslKeyFile) {
-            try {
-              options.key = [fs.readFileSync(sslKeyFile)];
-            } catch (e) {
-              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslKeyFile], null, null, null);
+          if (sslKeyFilePath) {
+            if (sslKeyFile) {
+              options.key = sslKeyFile;
+            } else {
+              const errorObj = this.transUtil.formatErrorObject(origin, 'Missing File', [sslKeyFilePath], null, null, null);
               log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
               return callback(null, errorObj);
             }

package/lib/propertyUtil.js

@@ -1023,7 +1023,7 @@ class AdapterPropertyUtil {
       errorObj.exception = e;
 
       // return the error message
-      log.info(`unable to get adapter config from database: ${e}`);
+      log.info(`unable to get adapter config from database: ${e}, using config from file system`);
       return callback(null, errorObj);
     }
   }

package/lib/restHandler.js

@@ -683,6 +683,10 @@ function buildRequestPath(entity, action, entitySchema, reqPath, uriPathVars, ur
           // with the provided id
           let idString = '';
 
+          // if encoding is changed in call properties that overrides the default
+          if (callProperties && Object.hasOwnProperty.call(callProperties, 'encode_pathvars')) {
+            encodePath = callProperties.encode_pathvars;
+          }
           // check if the current URI path ends with a slash (may require
           // slash at end)
           if (uriPath[hindex - 2] === '/' || uriPath[hindex - 2] === ':') {
@@ -793,6 +797,10 @@ function buildRequestPath(entity, action, entitySchema, reqPath, uriPathVars, ur
           addquery = entitySchema.querykey;
         }
         if (systemQuery !== null) {
+          // if encoding is changed in call properties that overrides the default
+          if (callProperties && Object.hasOwnProperty.call(callProperties, 'encode_queryvars')) {
+            encodeUri = callProperties.encode_queryvars;
+          }
           // if we are encoding - use querystring since it does it all!
           if (encodeUri === true) {
             addquery += querystring.stringify(systemQuery);
@@ -847,6 +855,7 @@ function buildRequestPath(entity, action, entitySchema, reqPath, uriPathVars, ur
 
       // remove any double slashes that may be in the path - can happen if base path is / or ends in a /
       uriPath = uriPath.replace(/\/\//g, '/');
+      uriPath = uriPath.replace(/=\//g, '=');
 
       const result = {
         path: uriPath
@@ -892,6 +901,7 @@ function buildRequestPath(entity, action, entitySchema, reqPath, uriPathVars, ur
 
     // remove any double slashes that may be in the path - can happen if base path is / or ends in a /
     uriPath = uriPath.replace(/\/\//g, '/');
+    uriPath = uriPath.replace(/=\//g, '=');
 
     const result = {
       path: uriPath

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-utils",
-  "version": "5.7.2",
+  "version": "5.9.0",
   "description": "Itential Adapter Utility Libraries",
   "scripts": {
     "postinstall": "node utils/setup.js",

package/compliance-report.json

@@ -1,9 +0,0 @@
-{
-  "ComplianceEntries": [
-    {
-      "name": "Compliance Summary",
-      "numInvalidProjects": 0,
-      "numValidProjects": 0
-    }
-  ]
-}

package/compliance-report.txt

@@ -1,5 +0,0 @@
----------------------------------------------------------------------------------------------
-**** Project Compliance Summary ****
-0 project(s) are not valid
-0 project(s) are valid
----------------------------------------------------------------------------------------------