cozy-pouch-link 51.6.1 → 51.7.0

package/dist/CozyPouchLink.js

@@ -148,6 +148,7 @@ var normalizeAll = function normalizeAll(client) {
  * @property {string[]} doctypes Doctypes to replicate
  * @property {Record<string, object>} doctypesReplicationOptions A mapping from doctypes to replication options. All pouch replication options can be used, as well as the "strategy" option that determines which way the replication is done (can be "sync", "fromRemote" or "toRemote")
  * @property {import('./types').LinkPlatform} platform Platform specific adapters and methods
+ * @property {import('cozy-client/src/performances/types').PerformanceAPI} [performanceApi] - The performance API that can be used to measure performances
  */
 
 /**
@@ -180,7 +181,8 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
         periodicSync = options.periodicSync,
         initialSync = options.initialSync,
         syncDebounceDelayInMs = options.syncDebounceDelayInMs,
-        syncDebounceMaxDelayInMs = options.syncDebounceMaxDelayInMs;
+        syncDebounceMaxDelayInMs = options.syncDebounceMaxDelayInMs,
+        performanceApi = options.performanceApi;
     _this.options = options;
 
     if (!doctypes) {
@@ -201,6 +203,9 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
     _this.startReplicationDebounced = (0, _debounce.default)(_this._startReplication, syncDebounceDelayInMs || DEFAULT_DEBOUNCE_DELAY, {
       maxWait: syncDebounceMaxDelayInMs || MAX_DEBOUNCE_DELAY
     });
+    /** @type {import('cozy-client/src/performances/types').PerformanceAPI} */
+
+    _this.performanceApi = performanceApi || _cozyClient.defaultPerformanceApi;
     return _this;
   }
   /**
@@ -355,7 +360,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
       var _onLogin = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
         var _this2 = this;
 
-        var prefix, shouldDestroyDatabases, adapter;
+        var markName, prefix, shouldDestroyDatabases, adapter;
         return _regenerator.default.wrap(function _callee3$(_context3) {
           while (1) {
             switch (_context3.prev = _context3.next) {
@@ -370,11 +375,12 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
                 return _context3.abrupt("return");
 
               case 3:
+                markName = this.performanceApi.mark('onLogin');
                 prefix = (0, _utils.getPrefix)(this.client.stackClient.uri);
                 shouldDestroyDatabases = this.pouches && this.pouches.options && this.pouches.options.prefix !== prefix;
 
                 if (!shouldDestroyDatabases) {
-                  _context3.next = 15;
+                  _context3.next = 16;
                   break;
                 }
 
@@ -382,47 +388,47 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
                   _logger.default.info('PouchLink: URI changed, destroy pouches');
                 }
 
-                _context3.prev = 7;
-                _context3.next = 10;
+                _context3.prev = 8;
+                _context3.next = 11;
                 return this.pouches.destroy();
 
-              case 10:
-                _context3.next = 15;
+              case 11:
+                _context3.next = 16;
                 break;
 
-              case 12:
-                _context3.prev = 12;
-                _context3.t0 = _context3["catch"](7);
+              case 13:
+                _context3.prev = 13;
+                _context3.t0 = _context3["catch"](8);
 
                 _logger.default.warn('Error while destroying pouch DBs', _context3.t0);
 
-              case 15:
+              case 16:
                 if (prefix) {
-                  _context3.next = 17;
+                  _context3.next = 18;
                   break;
                 }
 
                 throw new Error('PouchLink: Prefix is required');
 
-              case 17:
+              case 18:
                 if (process.env.NODE_ENV !== 'production') {
                   _logger.default.log('Create pouches with ' + prefix + ' prefix');
                 }
 
-                _context3.next = 20;
+                _context3.next = 21;
                 return this.storage.getAdapterName();
 
-              case 20:
+              case 21:
                 if (_context3.sent) {
-                  _context3.next = 24;
+                  _context3.next = 25;
                   break;
                 }
 
                 adapter = (0, _get.default)(this.options, 'pouch.options.adapter');
-                _context3.next = 24;
+                _context3.next = 25;
                 return this.storage.persistAdapterName(adapter);
 
-              case 24:
+              case 25:
                 this.pouches = new _PouchManager.default(this.doctypes, {
                   pouch: this.options.pouch,
                   getReplicationURL: this.getReplicationURL.bind(this),
@@ -437,20 +443,25 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
                   executeQuery: this.executeQuery.bind(this),
                   platform: this.options.platform
                 });
-                _context3.next = 27;
+                _context3.next = 28;
                 return this.pouches.init();
 
-              case 27:
+              case 28:
                 if (this.client && this.initialSync) {
                   this.startReplication();
                 }
 
-              case 28:
+                this.performanceApi.measure({
+                  markName: markName,
+                  category: 'CozyPouchLink'
+                });
+
+              case 30:
               case "end":
                 return _context3.stop();
             }
           }
-        }, _callee3, this, [[7, 12]]);
+        }, _callee3, this, [[8, 13]]);
       }));
 
       function onLogin() {
@@ -887,6 +898,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
     value: function () {
       var _persistCozyData = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee9(data) {
         var forward,
+            markName,
             sanitizedDoc,
             oldDoc,
             db,
@@ -896,12 +908,13 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
             switch (_context9.prev = _context9.next) {
               case 0:
                 forward = _args9.length > 1 && _args9[1] !== undefined ? _args9[1] : doNothing;
+                markName = this.performanceApi.mark('persistCozyData');
                 sanitizedDoc = this.sanitizeJsonApi(data);
                 sanitizedDoc.cozyLocalOnly = true;
-                _context9.next = 5;
+                _context9.next = 6;
                 return this.getExistingDocument(data._id, data._type);
 
-              case 5:
+              case 6:
                 oldDoc = _context9.sent;
 
                 if (oldDoc) {
@@ -909,10 +922,16 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
                 }
 
                 db = this.pouches.getPouch(data._type);
-                _context9.next = 10;
+                _context9.next = 11;
                 return db.put(sanitizedDoc);
 
-              case 10:
+              case 11:
+                this.performanceApi.measure({
+                  markName: markName,
+                  category: 'CozyPouchLink'
+                });
+
+              case 12:
               case "end":
                 return _context9.stop();
             }
@@ -942,6 +961,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
       var _getExistingDocument = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee10(id, type) {
         var throwIfNotFound,
             db,
+            markName,
             existingDoc,
             _args10 = arguments;
         return _regenerator.default.wrap(function _callee10$(_context10) {
@@ -951,33 +971,38 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
                 throwIfNotFound = _args10.length > 2 && _args10[2] !== undefined ? _args10[2] : false;
                 _context10.prev = 1;
                 db = this.pouches.getPouch(type);
-                _context10.next = 5;
+                markName = this.performanceApi.mark('db.get from getExistingDocument');
+                _context10.next = 6;
                 return db.get(id);
 
-              case 5:
+              case 6:
                 existingDoc = _context10.sent;
+                this.performanceApi.measure({
+                  markName: markName,
+                  category: 'PouchDB'
+                });
                 return _context10.abrupt("return", existingDoc);
 
-              case 9:
-                _context10.prev = 9;
+              case 11:
+                _context10.prev = 11;
                 _context10.t0 = _context10["catch"](1);
 
                 if (!(_context10.t0.name === 'not_found' && !throwIfNotFound)) {
-                  _context10.next = 15;
+                  _context10.next = 17;
                   break;
                 }
 
                 return _context10.abrupt("return", null);
 
-              case 15:
+              case 17:
                 throw _context10.t0;
 
-              case 16:
+              case 18:
               case "end":
                 return _context10.stop();
             }
           }
-        }, _callee10, this, [[1, 9]]);
+        }, _callee10, this, [[1, 11]]);
       }));
 
       function getExistingDocument(_x9, _x10) {
@@ -1191,69 +1216,86 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
     key: "executeQuery",
     value: function () {
       var _executeQuery = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee14(_ref3) {
-        var doctype, selector, sort, fields, limit, id, ids, skip, indexedFields, partialFilter, db, res, withRows, findSelector, findOpts, index;
+        var doctype, selector, sort, fields, limit, id, ids, skip, indexedFields, partialFilter, markName, db, res, withRows, _markName, _markName2, _markName3, findSelector, findOpts, index, _markName4, jsonResult;
+
         return _regenerator.default.wrap(function _callee14$(_context14) {
           while (1) {
             switch (_context14.prev = _context14.next) {
               case 0:
                 doctype = _ref3.doctype, selector = _ref3.selector, sort = _ref3.sort, fields = _ref3.fields, limit = _ref3.limit, id = _ref3.id, ids = _ref3.ids, skip = _ref3.skip, indexedFields = _ref3.indexedFields, partialFilter = _ref3.partialFilter;
+                markName = this.performanceApi.mark('executeQuery');
                 db = this.getPouch(doctype);
 
                 if (!id) {
-                  _context14.next = 9;
+                  _context14.next = 12;
                   break;
                 }
 
-                _context14.next = 5;
+                _markName = this.performanceApi.mark('db.get from executeQuery');
+                _context14.next = 7;
                 return db.get(id);
 
-              case 5:
+              case 7:
                 res = _context14.sent;
+                this.performanceApi.measure({
+                  markName: _markName,
+                  category: 'PouchDB'
+                });
                 withRows = false;
-                _context14.next = 38;
+                _context14.next = 47;
                 break;
 
-              case 9:
+              case 12:
                 if (!ids) {
-                  _context14.next = 18;
+                  _context14.next = 23;
                   break;
                 }
 
-                _context14.next = 12;
+                _markName2 = this.performanceApi.mark('allDocs from executeQuery with ids');
+                _context14.next = 16;
                 return allDocs(db, {
                   include_docs: true,
                   keys: ids
                 });
 
-              case 12:
+              case 16:
                 res = _context14.sent;
+                this.performanceApi.measure({
+                  markName: _markName2,
+                  category: 'PouchDB'
+                });
                 res = withoutDesignDocuments(res);
                 res.total_rows = null; // pouch indicates the total number of docs in res.total_rows, even though we use "keys". Setting it to null avoids cozy-client thinking there are more docs to fetch.
 
                 withRows = true;
-                _context14.next = 38;
+                _context14.next = 47;
                 break;
 
-              case 18:
+              case 23:
                 if (!(!selector && !partialFilter && !fields && !sort)) {
-                  _context14.next = 26;
+                  _context14.next = 33;
                   break;
                 }
 
-                _context14.next = 21;
+                _markName3 = this.performanceApi.mark('allDocs from executeQuery');
+                _context14.next = 27;
                 return allDocs(db, {
                   include_docs: true,
                   limit: limit
                 });
 
-              case 21:
+              case 27:
                 res = _context14.sent;
+                this.performanceApi.measure({
+                  markName: _markName3,
+                  category: 'PouchDB'
+                });
                 res = withoutDesignDocuments(res);
                 withRows = true;
-                _context14.next = 38;
+                _context14.next = 47;
                 break;
 
-              case 26:
+              case 33:
                 findSelector = _helpers.default.normalizeFindSelector({
                   selector: selector,
                   sort: sort,
@@ -1269,33 +1311,43 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
                   limit: limit,
                   skip: skip
                 };
-                _context14.next = 30;
+                _context14.next = 37;
                 return this.ensureIndex(doctype, _objectSpread(_objectSpread({}, findOpts), {}, {
                   indexedFields: indexedFields,
                   partialFilter: partialFilter
                 }));
 
-              case 30:
+              case 37:
                 index = _context14.sent;
                 findOpts.use_index = index.id;
-                _context14.next = 34;
+                _markName4 = this.performanceApi.mark('find from executeQuery');
+                _context14.next = 42;
                 return find(db, findOpts);
 
-              case 34:
+              case 42:
                 res = _context14.sent;
+                this.performanceApi.measure({
+                  markName: _markName4,
+                  category: 'PouchDB'
+                });
                 res.offset = skip;
                 res.limit = limit;
                 withRows = true;
 
-              case 38:
-                return _context14.abrupt("return", jsonapi.fromPouchResult({
+              case 47:
+                jsonResult = jsonapi.fromPouchResult({
                   res: res,
                   withRows: withRows,
                   doctype: doctype,
                   client: this.client
-                }));
+                });
+                this.performanceApi.measure({
+                  markName: markName,
+                  category: 'CozyPouchLink'
+                });
+                return _context14.abrupt("return", jsonResult);
 
-              case 39:
+              case 50:
               case "end":
                 return _context14.stop();
             }
@@ -1313,67 +1365,73 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
     key: "executeMutation",
     value: function () {
       var _executeMutation = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee15(mutation, result, forward) {
-        var pouchRes;
+        var markName, pouchRes, jsonResult;
         return _regenerator.default.wrap(function _callee15$(_context15) {
           while (1) {
             switch (_context15.prev = _context15.next) {
               case 0:
+                markName = this.performanceApi.mark('executeMutation');
                 _context15.t0 = mutation.mutationType;
-                _context15.next = _context15.t0 === _cozyClient.MutationTypes.CREATE_DOCUMENT ? 3 : _context15.t0 === _cozyClient.MutationTypes.UPDATE_DOCUMENT ? 7 : _context15.t0 === _cozyClient.MutationTypes.UPDATE_DOCUMENTS ? 11 : _context15.t0 === _cozyClient.MutationTypes.DELETE_DOCUMENT ? 15 : _context15.t0 === _cozyClient.MutationTypes.ADD_REFERENCES_TO ? 19 : 23;
+                _context15.next = _context15.t0 === _cozyClient.MutationTypes.CREATE_DOCUMENT ? 4 : _context15.t0 === _cozyClient.MutationTypes.UPDATE_DOCUMENT ? 8 : _context15.t0 === _cozyClient.MutationTypes.UPDATE_DOCUMENTS ? 12 : _context15.t0 === _cozyClient.MutationTypes.DELETE_DOCUMENT ? 16 : _context15.t0 === _cozyClient.MutationTypes.ADD_REFERENCES_TO ? 20 : 24;
                 break;
 
-              case 3:
-                _context15.next = 5;
+              case 4:
+                _context15.next = 6;
                 return this.createDocument(mutation);
 
-              case 5:
+              case 6:
                 pouchRes = _context15.sent;
-                return _context15.abrupt("break", 24);
+                return _context15.abrupt("break", 25);
 
-              case 7:
-                _context15.next = 9;
+              case 8:
+                _context15.next = 10;
                 return this.updateDocument(mutation);
 
-              case 9:
+              case 10:
                 pouchRes = _context15.sent;
-                return _context15.abrupt("break", 24);
+                return _context15.abrupt("break", 25);
 
-              case 11:
-                _context15.next = 13;
+              case 12:
+                _context15.next = 14;
                 return this.updateDocuments(mutation);
 
-              case 13:
+              case 14:
                 pouchRes = _context15.sent;
-                return _context15.abrupt("break", 24);
+                return _context15.abrupt("break", 25);
 
-              case 15:
-                _context15.next = 17;
+              case 16:
+                _context15.next = 18;
                 return this.deleteDocument(mutation);
 
-              case 17:
+              case 18:
                 pouchRes = _context15.sent;
-                return _context15.abrupt("break", 24);
+                return _context15.abrupt("break", 25);
 
-              case 19:
-                _context15.next = 21;
+              case 20:
+                _context15.next = 22;
                 return this.addReferencesTo(mutation);
 
-              case 21:
+              case 22:
                 pouchRes = _context15.sent;
-                return _context15.abrupt("break", 24);
+                return _context15.abrupt("break", 25);
 
-              case 23:
+              case 24:
                 return _context15.abrupt("return", forward(mutation, result));
 
-              case 24:
-                return _context15.abrupt("return", jsonapi.fromPouchResult({
+              case 25:
+                jsonResult = jsonapi.fromPouchResult({
                   res: pouchRes,
                   withRows: false,
                   doctype: (0, _cozyClient.getDoctypeFromOperation)(mutation),
                   client: this.client
-                }));
+                });
+                this.performanceApi.measure({
+                  markName: markName,
+                  category: 'CozyPouchLink'
+                });
+                return _context15.abrupt("return", jsonResult);
 
-              case 25:
+              case 28:
               case "end":
                 return _context15.stop();
             }
@@ -1558,62 +1616,73 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
     key: "dbMethod",
     value: function () {
       var _dbMethod = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee21(method, mutation) {
-        var doctype, doc, docs, db, res;
+        var markName, doctype, doc, docs, db, res;
         return _regenerator.default.wrap(function _callee21$(_context21) {
           while (1) {
             switch (_context21.prev = _context21.next) {
               case 0:
+                markName = this.performanceApi.mark("dbMethod ".concat(method));
                 doctype = (0, _cozyClient.getDoctypeFromOperation)(mutation);
                 doc = mutation.document, docs = mutation.documents;
                 db = this.getPouch(doctype);
-                _context21.prev = 3;
+                _context21.prev = 4;
 
                 if (!docs) {
-                  _context21.next = 10;
+                  _context21.next = 11;
                   break;
                 }
 
-                _context21.next = 7;
+                _context21.next = 8;
                 return db[method](docs.map(function (doc) {
                   return sanitized(doc);
                 }));
 
-              case 7:
+              case 8:
                 res = _context21.sent;
-                _context21.next = 17;
+                _context21.next = 18;
                 break;
 
-              case 10:
+              case 11:
                 if (!doc) {
-                  _context21.next = 16;
+                  _context21.next = 17;
                   break;
                 }
 
-                _context21.next = 13;
+                _context21.next = 14;
                 return db[method](sanitized(doc));
 
-              case 13:
+              case 14:
                 res = _context21.sent;
-                _context21.next = 17;
+                _context21.next = 18;
                 break;
 
-              case 16:
+              case 17:
                 throw new Error('A mutation should either have document or documents member.');
 
-              case 17:
+              case 18:
+                this.performanceApi.measure({
+                  markName: markName,
+                  category: 'PouchDB'
+                });
                 return _context21.abrupt("return", res);
 
-              case 20:
-                _context21.prev = 20;
-                _context21.t0 = _context21["catch"](3);
+              case 22:
+                _context21.prev = 22;
+                _context21.t0 = _context21["catch"](4);
+                this.performanceApi.measure({
+                  markName: markName,
+                  measureName: "".concat(markName, " error"),
+                  category: 'PouchDB',
+                  color: 'error'
+                });
                 throw new Error("Coud not apply mutation: ".concat(_context21.t0.message));
 
-              case 23:
+              case 26:
               case "end":
                 return _context21.stop();
             }
           }
-        }, _callee21, this, [[3, 20]]);
+        }, _callee21, this, [[4, 22]]);
       }));
 
       function dbMethod(_x24, _x25) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-pouch-link",
-  "version": "51.6.1",
+  "version": "51.7.0",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "types/index.d.ts",
@@ -13,7 +13,7 @@
     "url": "git+https://github.com/cozy/cozy-client.git"
   },
   "dependencies": {
-    "cozy-client": "^51.6.1",
+    "cozy-client": "^51.7.0",
     "pouchdb-browser": "^7.2.2",
     "pouchdb-find": "^7.2.2"
   },
@@ -39,5 +39,5 @@
     "typecheck": "tsc -p tsconfig.json"
   },
   "sideEffects": false,
-  "gitHead": "b46c9c9248b140429972790624fa46b1b547226f"
+  "gitHead": "86418c696e22dcf873aa9d84ed195253ec058783"
 }

package/types/CozyPouchLink.d.ts

@@ -36,6 +36,10 @@ export type PouchLinkOptions = {
      * Platform specific adapters and methods
      */
     platform: import('./types').LinkPlatform;
+    /**
+     * - The performance API that can be used to measure performances
+     */
+    performanceApi?: any;
 };
 /**
  * @typedef {import('cozy-client/src/types').CozyClientDocument} CozyClientDocument
@@ -52,6 +56,7 @@ export type PouchLinkOptions = {
  * @property {string[]} doctypes Doctypes to replicate
  * @property {Record<string, object>} doctypesReplicationOptions A mapping from doctypes to replication options. All pouch replication options can be used, as well as the "strategy" option that determines which way the replication is done (can be "sync", "fromRemote" or "toRemote")
  * @property {import('./types').LinkPlatform} platform Platform specific adapters and methods
+ * @property {import('cozy-client/src/performances/types').PerformanceAPI} [performanceApi] - The performance API that can be used to measure performances
  */
 /**
  * Link to be passed to a `CozyClient` instance to support CouchDB. It instantiates
@@ -86,6 +91,8 @@ declare class PouchLink extends CozyLink {
     replicationStatus: Record<string, ReplicationStatus>;
     /** @private */
     private startReplicationDebounced;
+    /** @type {import('cozy-client/src/performances/types').PerformanceAPI} */
+    performanceApi: any;
     getReplicationURL(doctype: any): string;
     registerClient(client: any): Promise<void>;
     client: any;