cozy-client 48.24.1 → 49.0.0

package/dist/CozyClient.spec.js

@@ -693,7 +693,8 @@ describe('CozyClient login', () => {
 
 describe('CozyClient', () => {
   const requestHandler = jest.fn()
-  const link = new CozyLink(requestHandler)
+  const persistHandler = jest.fn()
+  const link = new CozyLink(requestHandler, persistHandler)
 
   const MOCKED_DATE = '2018-05-05T09:09:00.115Z'
 
@@ -724,6 +725,7 @@ describe('CozyClient', () => {
 
   afterEach(() => {
     requestHandler.mockReset()
+    persistHandler.mockReset()
   })
   describe('setAppMetadata', () => {
     it('should update the appMetadata', () => {
@@ -1384,6 +1386,7 @@ describe('CozyClient', () => {
 
     it('should return the same result if the query is run while she is already in loading status whithout requesting the query twice', async () => {
       jest.spyOn(client, 'requestQuery')
+      requestHandler.mockResolvedValue({})
 
       const [resp, resp2] = await Promise.all([
         client.query(query, { as: 'allTodos' }),
@@ -1400,6 +1403,118 @@ describe('CozyClient', () => {
       expect(executeQueryFromState).toHaveBeenCalledTimes(1)
     })
 
+    it('should persist virtual document when no meta.rev nor _rev', async () => {
+      jest.spyOn(client, 'requestQuery')
+      requestHandler.mockResolvedValue({
+        data: {
+          _id: 'some_id'
+        }
+      })
+
+      await client.query(query, { as: 'allTodos' })
+
+      expect(persistHandler).toHaveBeenCalledWith(
+        {
+          _id: 'some_id'
+        },
+        expect.anything()
+      )
+    })
+
+    it('should not persist virtual document when meta.rev', async () => {
+      jest.spyOn(client, 'requestQuery')
+      requestHandler.mockResolvedValue({
+        data: {
+          _id: 'some_id',
+          meta: {
+            rev: 'SOME_REV'
+          }
+        }
+      })
+
+      await client.query(query, { as: 'allTodos' })
+
+      expect(persistHandler).not.toHaveBeenCalled()
+    })
+
+    it('should not persist virtual document when _rev', async () => {
+      jest.spyOn(client, 'requestQuery')
+      requestHandler.mockResolvedValue({
+        data: {
+          _id: 'some_id',
+          _rev: 'SOME_REV'
+        }
+      })
+
+      await client.query(query, { as: 'allTodos' })
+
+      expect(persistHandler).not.toHaveBeenCalled()
+    })
+
+    it('should persist array of virtual documents when no meta.rev nor _rev', async () => {
+      jest.spyOn(client, 'requestQuery')
+      requestHandler.mockResolvedValue({
+        data: [
+          {
+            _id: 'some_id'
+          },
+          {
+            _id: 'some_id2'
+          }
+        ]
+      })
+
+      await client.query(query, { as: 'allTodos' })
+
+      expect(persistHandler).toHaveBeenCalledWith(
+        {
+          _id: 'some_id'
+        },
+        expect.anything()
+      )
+      expect(persistHandler).toHaveBeenCalledWith(
+        {
+          _id: 'some_id2'
+        },
+        expect.anything()
+      )
+    })
+
+    it('should not persist virtual documents if cozyLocalOnly', async () => {
+      jest.spyOn(client, 'requestQuery')
+      requestHandler.mockResolvedValue({
+        data: [
+          {
+            _id: 'some_id',
+            cozyLocalOnly: true
+          }
+        ]
+      })
+
+      await client.query(query, { as: 'allTodos' })
+
+      expect(persistHandler).not.toHaveBeenCalled()
+    })
+
+    it('should enforce persisting io.cozy.files.shortcuts as virtual documents even if meta.rev exists', async () => {
+      jest.spyOn(client, 'requestQuery')
+      requestHandler.mockResolvedValue({
+        data: [
+          {
+            _id: 'some_id',
+            meta: {
+              rev: 'SOME_REV'
+            }
+          }
+        ]
+      })
+      const shortcutsQuery = Q('io.cozy.files.shortcuts')
+
+      await client.query(shortcutsQuery, { as: 'allShortcuts' })
+
+      expect(persistHandler).toHaveBeenCalled()
+    })
+
     describe('relationship with query failure', () => {
       beforeEach(() => {
         jest.spyOn(HasManyFiles, 'query').mockImplementation(() => {

package/dist/CozyLink.js

@@ -9,24 +9,122 @@ exports.chain = exports.default = void 0;
 
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 
 var CozyLink = /*#__PURE__*/function () {
-  function CozyLink(requestHandler) {
+  function CozyLink(requestHandler, persistHandler) {
     (0, _classCallCheck2.default)(this, CozyLink);
 
     if (typeof requestHandler === 'function') {
       this.request = requestHandler;
     }
+
+    if (typeof persistHandler === 'function') {
+      this.persistCozyData = persistHandler;
+    }
   }
+  /**
+   * Request the given operation from the link
+   *
+   * @param {any} operation - The operation to request
+   * @param {any} result - The result from the previous request of the chain
+   * @param {any} forward - The next request of the chain
+   * @returns {Promise<any>}
+   */
+
 
   (0, _createClass2.default)(CozyLink, [{
     key: "request",
-    value: function request(operation, result, forward) {
-      throw new Error('request is not implemented');
-    }
+    value: function () {
+      var _request = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(operation, result, forward) {
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                throw new Error('request is not implemented');
+
+              case 1:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee);
+      }));
+
+      function request(_x, _x2, _x3) {
+        return _request.apply(this, arguments);
+      }
+
+      return request;
+    }()
+    /**
+     * Persist the given data into the links storage
+     *
+     * @param {any} data - The document to persist
+     * @param {any} forward - The next persistCozyData of the chain
+     * @returns {Promise<any>}
+     */
+
+  }, {
+    key: "persistCozyData",
+    value: function () {
+      var _persistCozyData = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(data, forward) {
+        return _regenerator.default.wrap(function _callee2$(_context2) {
+          while (1) {
+            switch (_context2.prev = _context2.next) {
+              case 0:
+                throw new Error('persistCozyData is not implemented');
+
+              case 1:
+              case "end":
+                return _context2.stop();
+            }
+          }
+        }, _callee2);
+      }));
+
+      function persistCozyData(_x4, _x5) {
+        return _persistCozyData.apply(this, arguments);
+      }
+
+      return persistCozyData;
+    }()
+    /**
+     * Reset the link data
+     *
+     * @returns {Promise<any>}
+     */
+
+  }, {
+    key: "reset",
+    value: function () {
+      var _reset = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
+        return _regenerator.default.wrap(function _callee3$(_context3) {
+          while (1) {
+            switch (_context3.prev = _context3.next) {
+              case 0:
+                throw new Error('reset is not implemented');
+
+              case 1:
+              case "end":
+                return _context3.stop();
+            }
+          }
+        }, _callee3);
+      }));
+
+      function reset() {
+        return _reset.apply(this, arguments);
+      }
+
+      return reset;
+    }()
   }]);
   return CozyLink;
 }();
@@ -37,10 +135,15 @@ var toLink = function toLink(handler) {
   return typeof handler === 'function' ? new CozyLink(handler) : handler;
 };
 
-var defaultLinkHandler = function defaultLinkHandler(operation, result) {
+var defaultLinkRequestHandler = function defaultLinkRequestHandler(operation, result) {
   if (result) return result;else if (operation.execute) return operation.execute();else throw new Error("No link could handle operation ".concat(JSON.stringify(operation)));
 };
 
+var defaultLinkPersistHandler = function defaultLinkPersistHandler(operation, result) {// Do nothing
+};
+
+var defaultLinkHandler = new CozyLink(defaultLinkRequestHandler, defaultLinkPersistHandler);
+
 var chain = function chain(links) {
   return [].concat((0, _toConsumableArray2.default)(links), [defaultLinkHandler]).map(toLink).reduce(concat);
 };
@@ -48,11 +151,21 @@ var chain = function chain(links) {
 exports.chain = chain;
 
 var concat = function concat(firstLink, nextLink) {
-  return new CozyLink(function (operation, result, forward) {
+  var requestHandler = function requestHandler(operation, result, forward) {
     var nextForward = function nextForward(op, res) {
       return nextLink.request(op, res, forward);
     };
 
     return firstLink.request(operation, result, nextForward);
-  });
+  };
+
+  var persistHandler = function persistHandler(data, forward) {
+    var nextForward = function nextForward(d) {
+      return nextLink.persistCozyData(d, forward);
+    };
+
+    return firstLink.persistCozyData(data, nextForward);
+  };
+
+  return new CozyLink(requestHandler, persistHandler);
 };

package/dist/StackLink.js

@@ -7,12 +7,12 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = exports.transformBulkDocsResponse = void 0;
 
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
-var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
-
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
@@ -37,6 +37,8 @@ var _errors = require("./errors");
 
 var _logger = _interopRequireDefault(require("./logger"));
 
+var _utils = require("./utils");
+
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
 
 function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
@@ -92,6 +94,13 @@ var transformBulkDocsResponse = function transformBulkDocsResponse(bulkResponse,
     data: updatedDocs
   };
 };
+/**
+ * @typedef {object} StackLinkOptions
+ * @property {object} [stackClient] - A StackClient
+ * @property {object} [client] - A StackClient (deprecated)
+ * @property {import('cozy-pouch-link/dist/types').LinkPlatform} [platform] - Platform specific adapters and methods
+ */
+
 /**
  * Transfers queries and mutations to a remote stack
  */
@@ -105,16 +114,15 @@ var StackLink = /*#__PURE__*/function (_CozyLink) {
   var _super = _createSuper(StackLink);
 
   /**
-   * @param {object} [options] - Options
-   * @param  {object} [options.stackClient] - A StackClient
-   * @param  {object} [options.client] - A StackClient (deprecated)
+   * @param {StackLinkOptions} [options] - Options
    */
   function StackLink() {
     var _this;
 
     var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
         client = _ref.client,
-        stackClient = _ref.stackClient;
+        stackClient = _ref.stackClient,
+        platform = _ref.platform;
 
     (0, _classCallCheck2.default)(this, StackLink);
     _this = _super.call(this);
@@ -124,6 +132,7 @@ var StackLink = /*#__PURE__*/function (_CozyLink) {
     }
 
     _this.stackClient = stackClient || client;
+    _this.isOnline = platform === null || platform === void 0 ? void 0 : platform.isOnline;
     return _this;
   }
 
@@ -134,18 +143,130 @@ var StackLink = /*#__PURE__*/function (_CozyLink) {
     }
   }, {
     key: "reset",
-    value: function reset() {
-      this.stackClient = null;
-    }
+    value: function () {
+      var _reset = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                this.stackClient = null;
+
+              case 1:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee, this);
+      }));
+
+      function reset() {
+        return _reset.apply(this, arguments);
+      }
+
+      return reset;
+    }()
   }, {
     key: "request",
-    value: function request(operation, result, forward) {
-      if (operation.mutationType) {
-        return this.executeMutation(operation, result, forward);
+    value: function () {
+      var _request = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(operation, result, forward) {
+        return _regenerator.default.wrap(function _callee2$(_context2) {
+          while (1) {
+            switch (_context2.prev = _context2.next) {
+              case 0:
+                _context2.t0 = this.isOnline;
+
+                if (!_context2.t0) {
+                  _context2.next = 5;
+                  break;
+                }
+
+                _context2.next = 4;
+                return this.isOnline();
+
+              case 4:
+                _context2.t0 = !_context2.sent;
+
+              case 5:
+                if (!_context2.t0) {
+                  _context2.next = 7;
+                  break;
+                }
+
+                return _context2.abrupt("return", forward(operation));
+
+              case 7:
+                _context2.prev = 7;
+
+                if (!operation.mutationType) {
+                  _context2.next = 12;
+                  break;
+                }
+
+                _context2.next = 11;
+                return this.executeMutation(operation, result, forward);
+
+              case 11:
+                return _context2.abrupt("return", _context2.sent);
+
+              case 12:
+                _context2.next = 14;
+                return this.executeQuery(operation);
+
+              case 14:
+                return _context2.abrupt("return", _context2.sent);
+
+              case 17:
+                _context2.prev = 17;
+                _context2.t1 = _context2["catch"](7);
+
+                if (!(0, _utils.isReactNativeOfflineError)(_context2.t1)) {
+                  _context2.next = 21;
+                  break;
+                }
+
+                return _context2.abrupt("return", forward(operation));
+
+              case 21:
+                throw _context2.t1;
+
+              case 22:
+              case "end":
+                return _context2.stop();
+            }
+          }
+        }, _callee2, this, [[7, 17]]);
+      }));
+
+      function request(_x, _x2, _x3) {
+        return _request.apply(this, arguments);
       }
 
-      return this.executeQuery(operation);
-    }
+      return request;
+    }()
+  }, {
+    key: "persistCozyData",
+    value: function () {
+      var _persistCozyData = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(data, forward) {
+        return _regenerator.default.wrap(function _callee3$(_context3) {
+          while (1) {
+            switch (_context3.prev = _context3.next) {
+              case 0:
+                return _context3.abrupt("return", forward(data));
+
+              case 1:
+              case "end":
+                return _context3.stop();
+            }
+          }
+        }, _callee3);
+      }));
+
+      function persistCozyData(_x4, _x5) {
+        return _persistCozyData.apply(this, arguments);
+      }
+
+      return persistCozyData;
+    }()
     /**
      *
      * @param {QueryDefinition} query - Query to execute
@@ -191,77 +312,77 @@ var StackLink = /*#__PURE__*/function (_CozyLink) {
   }, {
     key: "executeMutation",
     value: function () {
-      var _executeMutation = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(mutation, result, forward) {
+      var _executeMutation = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(mutation, result, forward) {
         var mutationType, doc, docs, props, updateAllResp;
-        return _regenerator.default.wrap(function _callee$(_context) {
+        return _regenerator.default.wrap(function _callee4$(_context4) {
           while (1) {
-            switch (_context.prev = _context.next) {
+            switch (_context4.prev = _context4.next) {
               case 0:
                 mutationType = mutation.mutationType, doc = mutation.document, docs = mutation.documents, props = (0, _objectWithoutProperties2.default)(mutation, ["mutationType", "document", "documents"]);
-                _context.t0 = mutationType;
-                _context.next = _context.t0 === _dsl.MutationTypes.CREATE_DOCUMENT ? 4 : _context.t0 === _dsl.MutationTypes.UPDATE_DOCUMENTS ? 5 : _context.t0 === _dsl.MutationTypes.UPDATE_DOCUMENT ? 9 : _context.t0 === _dsl.MutationTypes.DELETE_DOCUMENT ? 10 : _context.t0 === _dsl.MutationTypes.ADD_REFERENCES_TO ? 11 : _context.t0 === _dsl.MutationTypes.REMOVE_REFERENCES_TO ? 12 : _context.t0 === _dsl.MutationTypes.ADD_REFERENCED_BY ? 13 : _context.t0 === _dsl.MutationTypes.REMOVE_REFERENCED_BY ? 18 : _context.t0 === _dsl.MutationTypes.UPLOAD_FILE ? 23 : 24;
+                _context4.t0 = mutationType;
+                _context4.next = _context4.t0 === _dsl.MutationTypes.CREATE_DOCUMENT ? 4 : _context4.t0 === _dsl.MutationTypes.UPDATE_DOCUMENTS ? 5 : _context4.t0 === _dsl.MutationTypes.UPDATE_DOCUMENT ? 9 : _context4.t0 === _dsl.MutationTypes.DELETE_DOCUMENT ? 10 : _context4.t0 === _dsl.MutationTypes.ADD_REFERENCES_TO ? 11 : _context4.t0 === _dsl.MutationTypes.REMOVE_REFERENCES_TO ? 12 : _context4.t0 === _dsl.MutationTypes.ADD_REFERENCED_BY ? 13 : _context4.t0 === _dsl.MutationTypes.REMOVE_REFERENCED_BY ? 18 : _context4.t0 === _dsl.MutationTypes.UPLOAD_FILE ? 23 : 24;
                 break;
 
               case 4:
-                return _context.abrupt("return", this.stackClient.collection(doc._type).create(doc));
+                return _context4.abrupt("return", this.stackClient.collection(doc._type).create(doc));
 
               case 5:
-                _context.next = 7;
+                _context4.next = 7;
                 return this.stackClient.collection(docs[0]._type).updateAll(docs);
 
               case 7:
-                updateAllResp = _context.sent;
-                return _context.abrupt("return", transformBulkDocsResponse(updateAllResp, docs));
+                updateAllResp = _context4.sent;
+                return _context4.abrupt("return", transformBulkDocsResponse(updateAllResp, docs));
 
               case 9:
-                return _context.abrupt("return", this.stackClient.collection(doc._type).update(doc));
+                return _context4.abrupt("return", this.stackClient.collection(doc._type).update(doc));
 
               case 10:
-                return _context.abrupt("return", this.stackClient.collection(doc._type).destroy(doc));
+                return _context4.abrupt("return", this.stackClient.collection(doc._type).destroy(doc));
 
               case 11:
-                return _context.abrupt("return", this.stackClient.collection(props.referencedDocuments[0]._type).addReferencesTo(doc, props.referencedDocuments));
+                return _context4.abrupt("return", this.stackClient.collection(props.referencedDocuments[0]._type).addReferencesTo(doc, props.referencedDocuments));
 
               case 12:
-                return _context.abrupt("return", this.stackClient.collection(props.referencedDocuments[0]._type).removeReferencesTo(doc, props.referencedDocuments));
+                return _context4.abrupt("return", this.stackClient.collection(props.referencedDocuments[0]._type).removeReferencesTo(doc, props.referencedDocuments));
 
               case 13:
                 if (!(doc._type === _const.DOCTYPE_FILES)) {
-                  _context.next = 17;
+                  _context4.next = 17;
                   break;
                 }
 
-                return _context.abrupt("return", this.stackClient.collection(_const.DOCTYPE_FILES).addReferencedBy(doc, props.referencedDocuments));
+                return _context4.abrupt("return", this.stackClient.collection(_const.DOCTYPE_FILES).addReferencedBy(doc, props.referencedDocuments));
 
               case 17:
                 throw new Error('The document type should be io.cozy.files');
 
               case 18:
                 if (!(doc._type === _const.DOCTYPE_FILES)) {
-                  _context.next = 22;
+                  _context4.next = 22;
                   break;
                 }
 
-                return _context.abrupt("return", this.stackClient.collection(_const.DOCTYPE_FILES).removeReferencedBy(doc, props.referencedDocuments));
+                return _context4.abrupt("return", this.stackClient.collection(_const.DOCTYPE_FILES).removeReferencedBy(doc, props.referencedDocuments));
 
               case 22:
                 throw new Error('The document type should be io.cozy.files');
 
               case 23:
-                return _context.abrupt("return", this.stackClient.collection(_const.DOCTYPE_FILES).upload(props.file, props.dirPath));
+                return _context4.abrupt("return", this.stackClient.collection(_const.DOCTYPE_FILES).upload(props.file, props.dirPath));
 
               case 24:
-                return _context.abrupt("return", forward(mutation, result));
+                return _context4.abrupt("return", forward(mutation, result));
 
               case 25:
               case "end":
-                return _context.stop();
+                return _context4.stop();
             }
           }
-        }, _callee, this);
+        }, _callee4, this);
       }));
 
-      function executeMutation(_x, _x2, _x3) {
+      function executeMutation(_x6, _x7, _x8) {
         return _executeMutation.apply(this, arguments);
       }