@itentialopensource/adapter-netbrain 1.1.0 → 1.1.1

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 1.1.1 [09-06-2022]
+
+* Update Healthcheck and change tenantId Usage
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-netbrain!16
+
+---
+
 ## 1.1.0 [05-22-2022]
 
 * Migration to the latest Adapter Foundation

package/adapter.js

@@ -73,12 +73,50 @@ class Netbrain extends AdapterBaseCl {
    * @param {Callback} callback - The results of the call
    */
   healthCheck(reqObj, callback) {
-    // you can modify what is passed into the healthcheck by changing things in the newReq
-    let newReq = null;
-    if (reqObj) {
-      newReq = Object.assign(...reqObj);
+    let myRequest = reqObj;
+    const origin = `${this.id}-adapter-healthCheck`;
+
+    // we are overriding the adapterBase healthcheck so that it goes through the same process as other NetBrain calls.
+    if (this.healthcheckQuery && Object.keys(this.healthcheckQuery).length > 0) {
+      if (myRequest && myRequest.uriQuery) {
+        myRequest.uriQuery = { ...myRequest.uriQuery, ...this.healthcheckQuery };
+      } else if (myRequest) {
+        myRequest.uriQuery = this.healthcheckQuery;
+      } else {
+        myRequest = {
+          uriQuery: this.healthcheckQuery
+        };
+      }
     }
-    super.healthCheck(newReq, callback);
+    // super.healthCheck(newReq, callback);
+    return this.processRequest('.system', 'healthcheck', myRequest, false, 0, (irReturnData, irReturnError) => {
+      // unhealthy
+      if (irReturnError) {
+        // if we were healthy, toggle health
+        if (this.healthy) {
+          this.emit('OFFLINE', { id: this.id });
+          this.emit('DEGRADED', { id: this.id });
+          this.healthy = false;
+          log.error(`${origin}: HEALTH CHECK - Error ${irReturnError}`);
+        } else {
+          // still log but set the level to trace
+          log.trace(`${origin}: HEALTH CHECK - Still Errors ${irReturnError}`);
+        }
+
+        return callback(false);
+      }
+      // if we were unhealthy, toggle health
+      if (!this.healthy) {
+        this.emit('FIXED', { id: this.id });
+        this.emit('ONLINE', { id: this.id });
+        this.healthy = true;
+        log.info(`${origin}: HEALTH CHECK SUCCESSFUL`);
+      } else {
+        // still log but set the level to trace
+        log.trace(`${origin}: HEALTH CHECK STILL SUCCESSFUL`);
+      }
+      return callback(true);
+    });
   }
 
   /**
@@ -1219,7 +1257,7 @@ class Netbrain extends AdapterBaseCl {
    * @summary Query all the domains info in system.
    *
    * @function getV1CMDBDomains
-   * @param {string} tenantId - tenantId param
+   * @param {string} tenantId - tenantId param, if passed empty it will get it from the adapter config
    * @param {getCallback} callback - a callback function to return the result
    */
 
@@ -1235,14 +1273,25 @@ class Netbrain extends AdapterBaseCl {
       return callback(null, errorObj);
     }
 
-    /* HERE IS WHERE YOU VALIDATE DATA */
-
     /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
-    const queryParamsAvailable = { tenantId };
+    let configtenantId = tenantId;
+    if (configtenantId === undefined || configtenantId === null || configtenantId === '') {
+      if (this.allProps.authentication.tenantId) {
+        configtenantId = this.allProps.authentication.tenantId;
+      }
+    }
+    const queryParamsAvailable = { configtenantId };
     const queryParams = {};
     const pathVars = [];
     const bodyVars = {};
 
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (configtenantId === undefined || configtenantId === null || configtenantId === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['tenantId'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
     // loop in template. long callback arg name to avoid identifier conflicts
     Object.keys(queryParamsAvailable)
       .forEach((thisKeyInQueryParamsAvailable) => {
@@ -1700,19 +1749,25 @@ class Netbrain extends AdapterBaseCl {
       return callback(null, errorObj);
     }
 
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    let configtenantId = tenantId;
+    if (configtenantId === undefined || configtenantId === null || configtenantId === '') {
+      if (this.allProps.authentication.tenantId) {
+        configtenantId = this.allProps.authentication.tenantId;
+      }
+    }
+    const queryParamsAvailable = {};
+    const queryParams = {};
+    const pathVars = [configtenantId];
+    const bodyVars = {};
+
     /* HERE IS WHERE YOU VALIDATE DATA */
-    if (tenantId === undefined || tenantId === null || tenantId === '') {
+    if (configtenantId === undefined || configtenantId === null || configtenantId === '') {
       const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['tenantId'], null, null, null);
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
       return callback(null, errorObj);
     }
 
-    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
-    const queryParamsAvailable = {};
-    const queryParams = {};
-    const pathVars = [tenantId];
-    const bodyVars = {};
-
     // loop in template. long callback arg name to avoid identifier conflicts
     Object.keys(queryParamsAvailable)
       .forEach((thisKeyInQueryParamsAvailable) => {
@@ -8652,11 +8707,15 @@ class Netbrain extends AdapterBaseCl {
       return callback(null, errorObj);
     }
 
-    /* HERE IS WHERE YOU VALIDATE DATA */
-
     /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    let configtenantId = tenantId;
+    if (configtenantId === undefined || configtenantId === null || configtenantId === '') {
+      if (this.allProps.authentication.tenantId) {
+        configtenantId = this.allProps.authentication.tenantId;
+      }
+    }
     const queryParamsAvailable = {
-      tenantId,
+      configtenantId,
       domainId,
       fromDate,
       toDate
@@ -8665,6 +8724,13 @@ class Netbrain extends AdapterBaseCl {
     const pathVars = [];
     const bodyVars = {};
 
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (configtenantId === undefined || configtenantId === null || configtenantId === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['tenantId'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
     // loop in template. long callback arg name to avoid identifier conflicts
     Object.keys(queryParamsAvailable)
       .forEach((thisKeyInQueryParamsAvailable) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-netbrain",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "This adapter integrates with system described as: netbrainRestfulApi.",
   "main": "adapter.js",
   "systemName": "NetBrain",

package/pronghorn.json

@@ -783,7 +783,7 @@
         {
           "name": "tenantId",
           "type": "string",
-          "info": ": string",
+          "info": ": string : if not passed the tenantId from the adapter config will be used",
           "required": false,
           "schema": {
             "title": "tenantId",
@@ -953,8 +953,8 @@
         {
           "name": "tenantId",
           "type": "string",
-          "info": "This is the identifier of the Tenant.: string",
-          "required": true,
+          "info": ": string : if not passed the tenantId from the adapter config will be used",
+          "required": false,
           "schema": {
             "title": "tenantId",
             "type": "string"
@@ -3641,7 +3641,7 @@
         {
           "name": "tenantId",
           "type": "string",
-          "info": "Tenant ID.: string",
+          "info": ": string : if not passed the tenantId from the adapter config will be used",
           "required": false,
           "schema": {
             "title": "tenantId",

package/test/unit/adapterTestUnit.js

@@ -44,6 +44,7 @@ samProps.ssl.accept_invalid_cert = false;
 samProps.request.attempt_timeout = 60000;
 const attemptTimeout = samProps.request.attempt_timeout;
 const { stub } = samProps;
+samProps.authentication.tenantId = '';
 
 // these are the adapter properties. You generally should not need to alter
 // any of these after they are initially set up