@itentialopensource/adapter-utils 5.1.6 → 5.1.7

package/CHANGELOG.md

@@ -1,4 +1,14 @@
 
+## 5.1.7 [09-09-2023]
+
+* Added pagination to expanded generic handler
+
+Closes ADAPT-2849
+
+See merge request itentialopensource/adapter-utils!276
+
+---
+
 ## 5.1.6 [09-06-2023]
 
 * add fixes to connector that are missing

package/lib/cacheHandler.js

@@ -464,7 +464,12 @@ function makeIAPCall(calls, requestHandler, callback) { // todo pass in properti
   for (let i = 0; i < calls.length; i += 1) {
     log.debug('Response :', calls[i].responseFields);
     callPromises.push(new Promise((resolve, reject) => {
-      requestHandler.genericAdapterRequest(calls[i].path, calls[i].method, calls[i].query, calls[i].body, calls[i].headers, (callRet, callErr) => {
+      const metadata = {};
+      if (calls[i].pagination) {
+        metadata.pagination = calls[i].pagination;
+        metadata.pagination.responseDatakey = calls[i].responseDatakey || '';
+      }
+      requestHandler.expandedGenericAdapterRequest(metadata, calls[i].path, calls[i].method, null, calls[i].query, calls[i].body, calls[i].headers, (callRet, callErr) => {
         if (callErr) {
           log.error('Make iap call failed with error');
           log.error(callErr);

package/lib/genericHandler.js

@@ -5,6 +5,54 @@
 /* eslint consistent-return: warn */
 
 /* NodeJS internal utilities */
+const jsonQuery = require('json-query');
+
+// INTERNAL FUNCTIONS
+
+/**
+ * @summary Update the offset for paginated call.
+ * @function incrementOffset
+ * @param {String} offsetType - type of offset (page or limit)
+ * @param {Number} data - previous offset
+ * @param {Number} limit - call limit
+ * @returns {Number} - new offset
+ */
+function incrementOffset(offsetType, previousOffset, limit) {
+  let newOffset;
+  if (offsetType === 'limit') {
+    newOffset = previousOffset + limit;
+  } else if (offsetType === 'page') {
+    newOffset = previousOffset + 1;
+  } else {
+    throw new Error(`Offset Type : ${offsetType} not supported or insufficient data was provided`);
+  }
+  return newOffset;
+}
+
+/**
+ * @summary Function to set the value at a specified property path
+ * @function setNestedProperty
+ * @param {Object} oldValue - Object to update
+ * @param {String} responseDataKey - path to property to update in . separated string
+ * @param {Object} newValue - Object with data to use in update
+ */
+function setNestedProperty(oldValue, responseDatakey, newValue) {
+  const newRes = jsonQuery(responseDatakey, { data: newValue.response }).value;
+  const oldRes = jsonQuery(responseDatakey, { data: oldValue.response }).value;
+  const path = responseDatakey.split('.');
+  let currentObj = oldValue.response;
+  for (let i = 0; i < path.length - 1; i += 1) {
+    const segment = path[i];
+    if (Object.hasOwnProperty.call(currentObj, segment)) {
+      currentObj = currentObj[segment];
+    } else {
+      currentObj[segment] = {};
+      currentObj = currentObj[segment];
+    }
+  }
+  // Modifies value at path and updates original object
+  currentObj[path[path.length - 1]] = oldRes.concat(newRes);
+}
 
 class GenericHandler {
   /**
@@ -156,7 +204,7 @@ class GenericHandler {
           }
           reqObj.addlHeaders = { ...reqObj.addlHeaders, ...signature };
           this.requestHandlerInst.identifyRequest('.generic', action, reqObj, returnF, (irReturnData, irReturnError) => {
-            // if we received an error or their is no response on the results
+            // if we received an error or there is no response on the results
             // return an error
             if (irReturnError) {
               /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
@@ -174,6 +222,24 @@ class GenericHandler {
           });
         });
       }
+
+      // Does not support AWS adapters due to the auth call above
+      if (metadata && metadata.pagination) {
+        return this.expandedGenericAdapterRequestPaginated(metadata.pagination, action, reqObj, returnF, meth, (returnData, returnError) => {
+          if (returnError) {
+            /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+            return callback(null, returnError);
+          }
+          if (!Object.hasOwnProperty.call(returnData, 'response')) {
+            const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Invalid Response', ['genericAdapterRequest'], null, null, null);
+            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+            return callback(null, errorObj);
+          }
+          /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+          // return the response
+          return callback(returnData, null);
+        });
+      }
       return this.requestHandlerInst.identifyRequest('.generic', action, reqObj, returnF, (irReturnData, irReturnError) => {
         // if we received an error or their is no response on the results
         // return an error
@@ -198,6 +264,85 @@ class GenericHandler {
     }
   }
 
+  /**
+   * Makes the requested generic call
+   *
+   * @function expandedGenericAdapterRequestPaginated
+   * @param {Object} metadata - metadata for the call (optional).
+   *                 Can be a stringified Object.
+   * @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (optional)
+   * @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (optional)
+   * @param {Object} pathVars - the parameters to be put within the url path (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} queryData - the parameters to be put on the url (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} requestBody - the body to add to the request (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} addlHeaders - additional headers to be put on the call (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} paginationObject - object specifying pagination variables and increment method
+   * @param {getCallback} callback - a callback function to return the result (Generics)
+   *                 or the error
+   */
+  expandedGenericAdapterRequestPaginated(paginationObject, action, reqObj, returnF, meth, callback) {
+    const origin = `${this.myid}-requestHandler-expandedGenericAdapterRequestPaginated`;
+    log.trace(origin);
+    let results;
+    // Set up variables for calls
+    const { offsetVar } = paginationObject;
+    const pagType = paginationObject.requestLocation; // Body or query supported
+    let pagLocation;
+    if (pagType === 'body') {
+      pagLocation = 'payload';
+    } else if (pagType === 'query') {
+      pagLocation = 'uriQuery';
+    } else {
+      const err = new Error(`Pagination Type : ${pagType} not supported or insufficient data was provided`);
+      return callback(null, err);
+    }
+    const limit = reqObj[pagLocation][paginationObject.limitVar];
+    const recursiveCall = (currentOffset) => {
+      try {
+        const myReqObj = {
+          ...reqObj
+        };
+        myReqObj[pagLocation][offsetVar] = currentOffset;
+        this.requestHandlerInst.identifyRequest('.generic', action, myReqObj, returnF, (result, error) => {
+          if (error) {
+            return callback(null, error);
+          }
+
+          if (!Object.hasOwnProperty.call(result, 'response')) {
+            const errorObj = this.requestHandlerInst.formatErrorObject(this.myid, meth, 'Invalid Response', ['genericAdapterRequestPaginated'], null, null, null);
+            log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+            return callback(null, errorObj);
+          }
+          // Results hasn't been populated yet
+          if (!results) {
+            results = { ...result };
+          } else if (paginationObject.responseDatakey) {
+            setNestedProperty(results, paginationObject.responseDatakey, result);
+          } else {
+            results.response = results.response.concat(result.response);
+          }
+          if (result.response.length === limit) {
+            const newOffset = incrementOffset(paginationObject.incrementBy, currentOffset, limit);
+            // Rescurse
+            recursiveCall(newOffset);
+          } else {
+            return callback(results, null);
+          }
+        });
+      } catch (e) {
+        // handle any exception
+        const errorObj = this.transUtil.checkAndReturn(e, origin, 'Expanded Generic Adapter Request with Pagination Failed');
+        return callback(null, errorObj);
+      }
+    };
+
+    recursiveCall(reqObj[pagLocation][offsetVar]);
+  }
+
   /**
    * Makes the requested generic call
    *

package/lib/requestHandler.js

@@ -654,6 +654,10 @@ class RequestHandler {
 
       // !! using Generic makes it easier on the Adapter Builder (just need to change the path)
       // !! you can also replace with a specific call if that is easier
+      if (callProps.pagination) {
+        metadata.pagination = callProps.pagination;
+        metadata.pagination.responseDatakey = callProps.responseDatakey || '';
+      }
       return this.expandedGenericAdapterRequest(metadata, uriPath, uriMethod, null, callQuery, callBody, callHeaders, (result, error) => {
         // if we received an error or their is no response on the results return an error
         if (error) {

package/lib/restHandler.js

@@ -1191,7 +1191,9 @@ class RestHandler {
       const bodyString = buildPayload(entity, action, entitySchema, payload);
 
       if ((callMeth !== 'GET' || entitySchema.sendGetBody) && bodyString !== '{}') {
-        thisAHdata['Content-length'] = Buffer.byteLength(bodyString);
+        if (!thisAHdata['Content-length'] && !thisAHdata['Content-Length']) {
+          thisAHdata['Content-length'] = Buffer.byteLength(bodyString);
+        }
       }
 
       // set up the request to be sent
@@ -1319,7 +1321,9 @@ class RestHandler {
         const bodyString = buildPayload('.system', 'healthcheck', healthSchema, payload);
 
         if ((callMeth !== 'GET' || healthSchema.sendGetBody) && bodyString !== '{}') {
-          thisAHdata['Content-length'] = Buffer.byteLength(bodyString);
+          if (!thisAHdata['Content-length'] && !thisAHdata['Content-Length']) {
+            thisAHdata['Content-length'] = Buffer.byteLength(bodyString);
+          }
         }
 
         // set up the request to be sent

package/package.json

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

package/schemas/propertiesSchema.json

@@ -1046,6 +1046,38 @@
                 "description": "The method of the call to getDevicesFiltered",
                 "default": "GET"
               },
+              "pagination": {
+                "type": "object",
+                "description": "todo",
+                "properties": {
+                  "offsetVar": {
+                    "type": "string",
+                    "description": "Name of variable that defines how to go to next set of results"
+                  },
+                  "limitVar": {
+                    "type": "string",
+                    "description": "Name of variable that defines the max results returned in a request"
+                  },
+                  "incrementBy": {
+                    "type": "string",
+                    "enum": [
+                      "limit",
+                      "page"
+                    ],
+                    "description": "How to incremenet offset. Default limit",
+                    "default": "limit"
+                  },
+                  "requestLocation": {
+                    "type": "string",
+                    "enum": [
+                      "query",
+                      "body"
+                    ],
+                    "description": "Where in request the pagination data goes",
+                    "default": "query"
+                  }
+                }
+              },
               "query": {
                 "type": "object",
                 "description": "The json object with query parameters of the call to getDevicesFiltered",
@@ -1402,31 +1434,63 @@
                   "properties": {
                     "path": {
                       "type": "string",
-                      "description": "The fully qualified path of the call to getDevice (e.g. /rest/api/device/{deviceid})",
+                      "description": "The fully qualified path of the call to populate the cache (e.g. /rest/api/devices)",
                       "default": ""
                     },
                     "method": {
                       "type": "string",
-                      "description": "The method of the call to getDevice",
+                      "description": "The method of the call to populate the cache",
                       "default": "GET"
                     },
+                    "pagination": {
+                      "type": "object",
+                      "description": "todo",
+                      "properties": {
+                        "offsetVar": {
+                          "type": "string",
+                          "description": "Name of variable that defines how to go to next set of results"
+                        },
+                        "limitVar": {
+                          "type": "string",
+                          "description": "Name of variable that defines the max results returned in a request"
+                        },
+                        "incrementBy": {
+                          "type": "string",
+                          "enum": [
+                            "limit",
+                            "page"
+                          ],
+                          "description": "How to incremenet offset. Default limit",
+                          "default": "limit"
+                        },
+                        "requestLocation": {
+                          "type": "string",
+                          "enum": [
+                            "query",
+                            "body"
+                          ],
+                          "description": "Where in request the pagination data goes",
+                          "default": "query"
+                        }
+                      }
+                    },
                     "query": {
                       "type": "object",
-                      "description": "The json object with query parameters of the call to getDevice",
+                      "description": "The json object with query parameters of the call to populate the cache",
                       "additionalProperties": {
                         "type": ["string", "number"]
                       }
                     },
                     "body": {
                       "type": "object",
-                      "description": "The json object with body of the call to getDevice",
+                      "description": "The json object with body of the call to populate the cache",
                       "additionalProperties": {
                         "type": ["string", "number"]
                       }
                     },
                     "headers": {
                       "type": "object",
-                      "description": "The json object with headers of the call to getDevice",
+                      "description": "The json object with headers of the call to populate the cache",
                       "additionalProperties": {
                         "type": ["string", "number"]
                       }
@@ -1442,7 +1506,7 @@
                     },
                     "requestFields": {
                       "type": "object",
-                      "description": "The json object with response fields of the call to getDevice",
+                      "description": "The json object with response fields of the call to populate the cache",
                       "additionalProperties": {
                         "type": ["string", "number"]
                       },
@@ -1455,7 +1519,7 @@
                     },
                     "responseFields": {
                       "type": "object",
-                      "description": "The json object with response fields of the call to getDevice",
+                      "description": "The json object with response fields of the call to populate the cache",
                       "additionalProperties": {
                         "type": ["string", "number"]
                       }