@restorecommerce/resource-base-interface 0.0.9 → 0.2.1

package/CHANGELOG.md

@@ -1,3 +1,28 @@
+### 0.2.1 (December 9th, 2021)
+
+- updated dependencies
+
+### 0.2.0 (August 4th, 2021)
+
+- updated create (to remove edgeDef creation) and delete method to match new proto structure response
+- generate status array for create and update operations and up tests
+- generate status array for upsert and improve error handling
+- added status array for delete response
+- filter structure changes
+- updated grpc-client for tests, fix for filter handling (enum mapping), added error array to all tests
+
+### 0.1.1 (May 18th, 2021)
+
+- improved logging
+
+### 0.1.0 (April 27th, 2021)
+
+#### Contains breaking changes!
+
+- switch to kafkajs
+- change config format for events
+- updated dependencies
+
 ### 0.0.9 (March 19th, 2021)
 
 - fix create and update to support inbound edges

package/lib/core/GraphResourcesServiceBase.d.ts

@@ -1,4 +1,5 @@
 import { GraphDatabaseProvider } from '@restorecommerce/chassis-srv';
+import { Logger } from 'winston';
 /**
  * Graph Resource API base provides functions for graph Operations such as
  * creating or modifying Vertices/Edges, graph traversal etc.
@@ -7,11 +8,12 @@ export declare class GraphResourcesServiceBase {
     private db;
     private bufferFiledCfg?;
     bufferedCollections: any;
+    logger: Logger;
     /**
      * @constructor
      * @param  {object} db Chassis arangodb provider.
      */
-    constructor(db: GraphDatabaseProvider, bufferFiledCfg?: any);
+    constructor(db: GraphDatabaseProvider, bufferFiledCfg?: any, logger?: Logger);
     /**
     * collection traversal - Performs a traversal starting from the given
     * startVertex and following edges contained in this edge collection.

package/lib/core/GraphResourcesServiceBase.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GraphResourcesServiceBase = void 0;
 const _ = require("lodash");
+const logger_1 = require("@restorecommerce/logger");
 /**
  * Graph Resource API base provides functions for graph Operations such as
  * creating or modifying Vertices/Edges, graph traversal etc.
@@ -20,7 +21,7 @@ class GraphResourcesServiceBase {
      * @constructor
      * @param  {object} db Chassis arangodb provider.
      */
-    constructor(db, bufferFiledCfg) {
+    constructor(db, bufferFiledCfg, logger) {
         this.db = db;
         this.bufferFiledCfg = bufferFiledCfg;
         if (bufferFiledCfg) {
@@ -30,6 +31,20 @@ class GraphResourcesServiceBase {
                 this.bufferedCollections.push(key);
             }
         }
+        if (logger) {
+            this.logger = logger;
+        }
+        else {
+            const defaultLoggerCfg = {
+                console: {
+                    handleExceptions: false,
+                    level: 'debug',
+                    colorize: true,
+                    prettyPrint: true
+                }
+            };
+            this.logger = (0, logger_1.createLogger)(defaultLoggerCfg);
+        }
     }
     /**
     * collection traversal - Performs a traversal starting from the given
@@ -48,82 +63,103 @@ class GraphResourcesServiceBase {
     traversal(call, context) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const request = (_a = call.request) === null || _a === void 0 ? void 0 : _a.request;
-            const collection_name = request.collection_name;
-            let start_vertex = request.start_vertex;
-            if (_.isEmpty(start_vertex)) {
-                start_vertex = request === null || request === void 0 ? void 0 : request.start_vertices;
-                if (!_.isEmpty(start_vertex)) {
-                    start_vertex = start_vertex.vertices;
+            try {
+                const request = (_a = call.request) === null || _a === void 0 ? void 0 : _a.request;
+                const collection_name = request.collection_name;
+                let start_vertex = request.start_vertex;
+                if (_.isEmpty(start_vertex)) {
+                    start_vertex = request === null || request === void 0 ? void 0 : request.start_vertices;
+                    if (!_.isEmpty(start_vertex)) {
+                        start_vertex = start_vertex.vertices;
+                    }
                 }
-            }
-            const opts = request === null || request === void 0 ? void 0 : request.opts;
-            if (_.isEmpty(start_vertex)) {
-                throw new Error('missing start vertex');
-            }
-            const edge_name = request === null || request === void 0 ? void 0 : request.edge_name;
-            let data;
-            let path;
-            let aql;
-            if (request === null || request === void 0 ? void 0 : request.data) {
-                data = request === null || request === void 0 ? void 0 : request.data;
-            }
-            if (request === null || request === void 0 ? void 0 : request.path) {
-                path = request === null || request === void 0 ? void 0 : request.path;
-            }
-            if (request === null || request === void 0 ? void 0 : request.aql) {
-                aql = request === null || request === void 0 ? void 0 : request.aql;
-            }
-            const queryResult = yield this.db.traversal(start_vertex, opts, collection_name, edge_name, data, path, aql);
-            let idPropertyMapping = new Map();
-            const vertexFields = queryResult.vertex_fields || [];
-            let marshallRequired = false;
-            for (let eachVertex of vertexFields) {
-                const collectionArray = eachVertex._id.split('/');
-                const resourceName = collectionArray[0].substring(0, collectionArray[0].length - 1);
-                marshallRequired = true;
-                if (this.bufferedCollections.indexOf(resourceName) > -1) {
-                    // need to marshall this collection instance data
-                    // map id to the actual key which needs to be marshelled
-                    idPropertyMapping.set(collectionArray[1], this.bufferFiledCfg[resourceName]);
-                    marshallRequired = true;
+                const opts = request === null || request === void 0 ? void 0 : request.opts;
+                if (_.isEmpty(start_vertex)) {
+                    throw new Error('missing start vertex');
                 }
-                // sanitize fields to remove _key, _rev and rename _id to id field
-                delete eachVertex._key;
-                delete eachVertex._rev;
-                eachVertex['id'] = eachVertex._id;
-                delete eachVertex._id;
-            }
-            let completeDecodedData = [];
-            if (marshallRequired || (queryResult && queryResult.data && queryResult.data.value)) {
-                // get the decoded JSON list of resources.
-                const decodedData = JSON.parse(Buffer.from(queryResult.data.value).toString());
-                for (let doc of decodedData) {
-                    if (idPropertyMapping.has(doc.id)) {
-                        completeDecodedData.push(this.marshallData(doc, idPropertyMapping.get(doc.id)));
+                const edge_name = request === null || request === void 0 ? void 0 : request.edge_name;
+                let data;
+                let path;
+                let aql;
+                if (request === null || request === void 0 ? void 0 : request.data) {
+                    data = request === null || request === void 0 ? void 0 : request.data;
+                }
+                if (request === null || request === void 0 ? void 0 : request.path) {
+                    path = request === null || request === void 0 ? void 0 : request.path;
+                }
+                if (request === null || request === void 0 ? void 0 : request.aql) {
+                    aql = request === null || request === void 0 ? void 0 : request.aql;
+                }
+                let queryResult;
+                try {
+                    this.logger.debug('Calling traversal', { start_vertex, collection_name });
+                    queryResult = yield this.db.traversal(start_vertex, opts, collection_name, edge_name, data, path, aql);
+                    this.logger.debug('Response from DB traversal', { response: queryResult });
+                }
+                catch (err) {
+                    this.logger.error('Error stack', err);
+                    this.logger.error('Error executing DB Traversal', { error: err.message });
+                    throw err;
+                }
+                let idPropertyMapping = new Map();
+                const vertexFields = queryResult.vertex_fields || [];
+                let marshallRequired = false;
+                for (let eachVertex of vertexFields) {
+                    const collectionArray = eachVertex._id.split('/');
+                    const resourceName = collectionArray[0].substring(0, collectionArray[0].length - 1);
+                    marshallRequired = true;
+                    if (this.bufferedCollections.indexOf(resourceName) > -1) {
+                        // need to marshall this collection instance data
+                        // map id to the actual key which needs to be marshelled
+                        idPropertyMapping.set(collectionArray[1], this.bufferFiledCfg[resourceName]);
+                        marshallRequired = true;
                     }
-                    else {
-                        completeDecodedData.push(doc);
+                    // sanitize fields to remove _key, _rev and rename _id to id field
+                    delete eachVertex._key;
+                    delete eachVertex._rev;
+                    eachVertex['id'] = eachVertex._id;
+                    delete eachVertex._id;
+                }
+                let completeDecodedData = [];
+                if (marshallRequired || (queryResult && queryResult.data && queryResult.data.value)) {
+                    // get the decoded JSON list of resources.
+                    const decodedData = JSON.parse(Buffer.from(queryResult.data.value).toString());
+                    for (let doc of decodedData) {
+                        if (idPropertyMapping.has(doc.id)) {
+                            completeDecodedData.push(this.marshallData(doc, idPropertyMapping.get(doc.id)));
+                        }
+                        else {
+                            completeDecodedData.push(doc);
+                        }
                     }
                 }
-            }
-            const size = 150;
-            const completeVertexFields = queryResult.vertex_fields;
-            while ((completeDecodedData && completeDecodedData.length > 0) ||
-                (completeVertexFields && completeVertexFields.length > 0)) {
-                if (completeDecodedData.length > 0) {
-                    const partDoc = completeDecodedData.splice(0, 1000);
-                    queryResult.data = { value: Buffer.from(JSON.stringify(partDoc)) };
+                const size = 150;
+                const completeVertexFields = queryResult.vertex_fields;
+                while ((completeDecodedData && completeDecodedData.length > 0) ||
+                    (completeVertexFields && completeVertexFields.length > 0)) {
+                    if (completeDecodedData.length > 0) {
+                        const partDoc = completeDecodedData.splice(0, 1000);
+                        this.logger.debug('Writing Buffer Chunk', partDoc);
+                        queryResult.data = { value: Buffer.from(JSON.stringify(partDoc)) };
+                    }
+                    if (completeVertexFields.length > 0) {
+                        queryResult.vertex_fields = completeVertexFields.splice(0, size);
+                    }
+                    yield call.write(queryResult);
+                    this.logger.debug('Buffer chunk written successfully');
                 }
-                if (completeVertexFields.length > 0) {
-                    queryResult.vertex_fields = completeVertexFields.splice(0, size);
+                if (queryResult && queryResult.paths && queryResult.paths.value) {
+                    yield call.write(queryResult);
                 }
-                yield call.write(queryResult);
+                this.logger.debug('Invoking end from traversal');
+                yield call.end();
+                this.logger.debug('Traversal request ended');
             }
-            if (queryResult && queryResult.paths && queryResult.paths.value) {
-                yield call.write(queryResult);
+            catch (err) {
+                this.logger.error('Error caught executing traversal', { err: err.message });
+                this.logger.error('Error stack', err);
+                throw err;
             }
-            yield call.end();
         });
     }
     /**
@@ -145,3 +181,4 @@ class GraphResourcesServiceBase {
     }
 }
 exports.GraphResourcesServiceBase = GraphResourcesServiceBase;
+//# sourceMappingURL=GraphResourcesServiceBase.js.map

package/lib/core/GraphResourcesServiceBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GraphResourcesServiceBase.js","sourceRoot":"","sources":["../../src/core/GraphResourcesServiceBase.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA4B;AAE5B,oDAAuD;AAGvD;;;GAGG;AACH,MAAa,yBAAyB;IAGpC;;;OAGG;IACH,YAAoB,EAAyB,EAAU,cAAoB,EAAE,MAAe;QAAxE,OAAE,GAAF,EAAE,CAAuB;QAAU,mBAAc,GAAd,cAAc,CAAM;QACzE,IAAI,cAAc,EAAE;YAClB,IAAI,CAAC,mBAAmB,GAAG,EAAE,CAAC;YAC9B,KAAK,IAAI,GAAG,IAAI,cAAc,EAAE;gBAC9B,8DAA8D;gBAC9D,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACpC;SACF;QACD,IAAI,MAAM,EAAE;YACV,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;SACtB;aAAM;YACL,MAAM,gBAAgB,GAAG;gBACvB,OAAO,EAAE;oBACP,gBAAgB,EAAE,KAAK;oBACvB,KAAK,EAAE,OAAO;oBACd,QAAQ,EAAE,IAAI;oBACd,WAAW,EAAE,IAAI;iBAClB;aACF,CAAC;YACF,IAAI,CAAC,MAAM,GAAG,IAAA,qBAAY,EAAC,gBAAgB,CAAC,CAAC;SAC9C;IACH,CAAC;IAED;;;;;;;;;;;;;MAaE;IACI,SAAS,CAAC,IAAS,EAAE,OAAa;;;YACtC,IAAI;gBACF,MAAM,OAAO,GAAG,MAAA,IAAI,CAAC,OAAO,0CAAE,OAAO,CAAC;gBACtC,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;gBAChD,IAAI,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;gBACxC,IAAI,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;oBAC3B,YAAY,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,CAAC;oBACvC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;wBAC5B,YAAY,GAAG,YAAY,CAAC,QAAQ,CAAC;qBACtC;iBACF;gBACD,MAAM,IAAI,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,CAAC;gBAC3B,IAAI,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;oBAC3B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;iBACzC;gBACD,MAAM,SAAS,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,CAAC;gBACrC,IAAI,IAAI,CAAC;gBACT,IAAI,IAAI,CAAC;gBACT,IAAI,GAAG,CAAC;gBACR,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,EAAE;oBACjB,IAAI,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,CAAC;iBACtB;gBACD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,EAAE;oBACjB,IAAI,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,CAAC;iBACtB;gBACD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,GAAG,EAAE;oBAChB,GAAG,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,GAAG,CAAC;iBACpB;gBACD,IAAI,WAAW,CAAC;gBAChB,IAAI;oBACF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC,CAAC;oBAC1E,WAAW,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EACtD,eAAe,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;oBAC/C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4BAA4B,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC;iBAC5E;gBAAC,OAAO,GAAG,EAAE;oBACZ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;oBACtC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;oBAC1E,MAAM,GAAG,CAAC;iBACX;gBACD,IAAI,iBAAiB,GAAG,IAAI,GAAG,EAAkB,CAAC;gBAClD,MAAM,YAAY,GAAG,WAAW,CAAC,aAAa,IAAI,EAAE,CAAC;gBACrD,IAAI,gBAAgB,GAAG,KAAK,CAAC;gBAC7B,KAAK,IAAI,UAAU,IAAI,YAAY,EAAE;oBACnC,MAAM,eAAe,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAClD,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;oBACpF,gBAAgB,GAAG,IAAI,CAAC;oBACxB,IAAI,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE;wBACvD,iDAAiD;wBACjD,wDAAwD;wBACxD,iBAAiB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC;wBAC7E,gBAAgB,GAAG,IAAI,CAAC;qBACzB;oBACD,kEAAkE;oBAClE,OAAO,UAAU,CAAC,IAAI,CAAC;oBACvB,OAAO,UAAU,CAAC,IAAI,CAAC;oBACvB,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;oBAClC,OAAO,UAAU,CAAC,GAAG,CAAC;iBACvB;gBACD,IAAI,mBAAmB,GAAG,EAAE,CAAC;gBAC7B,IAAI,gBAAgB,IAAI,CAAC,WAAW,IAAI,WAAW,CAAC,IAAI,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;oBACnF,0CAA0C;oBAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;oBAC/E,KAAK,IAAI,GAAG,IAAI,WAAW,EAAE;wBAC3B,IAAI,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;4BACjC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;yBACjF;6BAAM;4BACL,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;yBAC/B;qBACF;iBACF;gBACD,MAAM,IAAI,GAAG,GAAG,CAAC;gBACjB,MAAM,oBAAoB,GAAG,WAAW,CAAC,aAAa,CAAC;gBACvD,OAAO,CAAC,mBAAmB,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,CAAC;oBAC5D,CAAC,oBAAoB,IAAI,oBAAoB,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE;oBAC3D,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE;wBAClC,MAAM,OAAO,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;wBACpD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;wBACnD,WAAW,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;qBACpE;oBACD,IAAI,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE;wBACnC,WAAW,CAAC,aAAa,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;qBAClE;oBACD,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;oBAC9B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;iBACxD;gBACD,IAAI,WAAW,IAAI,WAAW,CAAC,KAAK,IAAI,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE;oBAC/D,MAAM,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;iBAC/B;gBACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;gBACjD,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;gBACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;aAC9C;YAAC,OAAO,GAAG,EAAE;gBACZ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kCAAkC,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC5E,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;gBACtC,MAAM,GAAG,CAAC;aACX;;KACF;IAED;;;;;;OAMG;IACH,YAAY,CAAC,QAAa,EAAE,WAAgB;QAC1C,IAAI,WAAW,IAAI,QAAQ,IAAI,QAAQ,CAAC,WAAW,CAAC,EAAE;YACpD,MAAM,UAAU,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;YACzC,oCAAoC;YACpC,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;YACjE,QAAQ,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;YAC3B,QAAQ,CAAC,WAAW,CAAC,CAAC,KAAK,GAAG,gBAAgB,CAAC;SAChD;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AA/JD,8DA+JC"}

package/lib/core/ResourcesAPI.d.ts

@@ -12,13 +12,14 @@ export declare class ResourcesAPIBase {
     bufferField: string;
     requiredFields: any;
     resourceName: string;
+    logger: any;
     /**
      * @constructor
      * @param  {object} db Chassis arangodb provider.
      * @param {string} collectionName Name of database collection.
      * @param {any} fieldHandlerConf The collection's field generators configuration.
      */
-    constructor(db: DatabaseProvider, collectionName: string, fieldHandlerConf?: any, edgeCfg?: any, graphName?: string);
+    constructor(db: DatabaseProvider, collectionName: string, fieldHandlerConf?: any, edgeCfg?: any, graphName?: string, logger?: any);
     /**
      * Finds documents based on provided filters and options
      * @param {object} filter key value filter using mongodb/nedb filter format.
@@ -41,7 +42,7 @@ export declare class ResourcesAPIBase {
      * @param requiredFields
      * @param documents
      */
-    checkRequiredFields(requiredFields: string[], documents: any): void;
+    checkRequiredFields(requiredFields: string[], documents: any, result: any[]): any;
     /**
      * Removes documents found by id.
      *