cozy-pouch-link 60.28.1 → 60.29.0

package/dist/CozyPouchLink.js

@@ -184,6 +184,9 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
     _this.doctypes = doctypes;
     _this.doctypesReplicationOptions = doctypesReplicationOptions;
     _this.indexes = {};
+    /** @private Cache of per-drive logical-typed query engines, keyed by `dbDoctype::logicalDoctype`. */
+
+    _this._driveQueryEngines = new Map();
     _this.storage = new _localStorage.PouchLocalStorage(((_options$platform = options.platform) === null || _options$platform === void 0 ? void 0 : _options$platform.storage) || _platformWeb.platformWeb.storage);
     _this.initialSync = initialSync !== null && initialSync !== void 0 ? initialSync : false;
     _this.periodicSync = periodicSync !== null && periodicSync !== void 0 ? periodicSync : true;
@@ -201,14 +204,6 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
     _this.performanceApi = performanceApi || _cozyClient.defaultPerformanceApi;
     return _this;
   }
-  /**
-   * Return the PouchDB adapter name.
-   * Should be IndexedDB for newest adapters.
-   *
-   * @param {import('./types').LocalStorage} localStorage Methods to access local storage
-   * @returns {Promise<string>} The adapter name
-   */
-
 
   (0, _createClass2.default)(PouchLink, [{
     key: "getReplicationURL",
@@ -458,10 +453,11 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
                   queryEngine: this.queryEngine,
                   client: this.client
                 });
-                _context3.next = 30;
+                this._driveQueryEngines = new Map();
+                _context3.next = 31;
                 return this.pouches.init();
 
-              case 30:
+              case 31:
                 if (this.client && this.initialSync) {
                   this.startReplication();
                 }
@@ -471,7 +467,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
                   category: 'CozyPouchLink'
                 });
 
-              case 32:
+              case 33:
               case "end":
                 return _context3.stop();
             }
@@ -504,8 +500,9 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
               case 3:
                 this.pouches = null;
                 this.client = null;
+                this._driveQueryEngines = new Map();
 
-              case 5:
+              case 6:
               case "end":
                 return _context4.stop();
             }
@@ -743,11 +740,59 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
     value: function getSyncInfo(doctype) {
       return this.pouches.getSyncInfo(doctype);
     }
+    /**
+     * Returns the registered physical doctype for a given logical doctype and query options.
+     *
+     * @param {any} logicalDoctype - The logical doctype
+     * @param {object} [options] - Optional query options
+     */
+
+  }, {
+    key: "getDbDoctype",
+    value: function getDbDoctype(logicalDoctype, options) {
+      var _this4 = this;
+
+      var driveId = options === null || options === void 0 ? void 0 : options.driveId;
+      if (!driveId) return logicalDoctype;
+      var match = Object.keys(this.doctypesReplicationOptions || {}).find(function (d) {
+        var _this4$doctypesReplic;
+
+        return ((_this4$doctypesReplic = _this4.doctypesReplicationOptions[d]) === null || _this4$doctypesReplic === void 0 ? void 0 : _this4$doctypesReplic.driveId) === driveId;
+      });
+      return match || logicalDoctype;
+    }
+    /**
+     * @param {any} doctype - The doctype
+     * @param {object} [options] - Optional query options
+     */
+
   }, {
     key: "getQueryEngineFromDoctype",
-    value: function getQueryEngineFromDoctype(doctype) {
-      var dbName = (0, _utils.getDatabaseName)((0, _utils.getPrefix)(this.client.stackClient.uri), doctype);
-      return this.pouches.getQueryEngine(dbName, doctype);
+    value: function getQueryEngineFromDoctype(doctype, options) {
+      var logicalDoctype = doctype;
+      var dbDoctype = this.getDbDoctype(doctype, options);
+      var dbName = (0, _utils.getDatabaseName)((0, _utils.getPrefix)(this.client.stackClient.uri), dbDoctype);
+
+      if (logicalDoctype !== dbDoctype) {
+        // Separate cache keyed by dbDoctype::logicalDoctype so a drive DB is never stamped with the wrong _type.
+        var cacheKey = "".concat(dbDoctype, "::").concat(logicalDoctype);
+
+        var engine = this._driveQueryEngines.get(cacheKey);
+
+        if (!engine) {
+          var QueryEngine =
+          /** @type {typeof PouchDBQueryEngine} */
+          this.queryEngine || _pouchdb.default;
+          engine = new QueryEngine(this.pouches, logicalDoctype);
+          engine.openDB(dbName);
+
+          this._driveQueryEngines.set(cacheKey, engine);
+        }
+
+        return engine;
+      }
+
+      return this.pouches.getQueryEngine(dbName, logicalDoctype);
     }
   }, {
     key: "getPouch",
@@ -757,12 +802,12 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
     }
   }, {
     key: "supportsOperation",
-    value: function supportsOperation(operation) {
+    value: function supportsOperation(operation, options) {
       if (this.options.readOnly && operation.mutationType) {
         return false;
       }
 
-      var impactedDoctype = (0, _cozyClient.getDoctypeFromOperation)(operation); // If the Pouch is configured only to replicate from the remote,
+      var impactedDoctype = this.getDbDoctype((0, _cozyClient.getDoctypeFromOperation)(operation), options); // If the Pouch is configured only to replicate from the remote,
       // we don't want to apply the mutation on it, but to forward
       // to the next link
 
@@ -776,6 +821,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
         var result,
             forward,
             doctype,
+            dbDoctype,
             _args6 = arguments;
         return _regenerator.default.wrap(function _callee6$(_context6) {
           while (1) {
@@ -784,7 +830,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
                 result = _args6.length > 2 && _args6[2] !== undefined ? _args6[2] : null;
                 forward = _args6.length > 3 && _args6[3] !== undefined ? _args6[3] : doNothing;
 
-                if (!(options !== null && options !== void 0 && options.forceStack)) {
+                if (!((0, _cozyClient.resolveForceLink)(options) === 'stack')) {
                   _context6.next = 4;
                   break;
                 }
@@ -793,50 +839,51 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
 
               case 4:
                 doctype = (0, _cozyClient.getDoctypeFromOperation)(operation);
+                dbDoctype = this.getDbDoctype(doctype, options);
 
                 if (this.pouches) {
-                  _context6.next = 8;
+                  _context6.next = 9;
                   break;
                 }
 
                 if (process.env.NODE_ENV !== 'production') {
-                  _logger.default.info("Tried to access local ".concat(doctype, " but Cozy Pouch is not initialized yet. Forwarding the operation to next link"));
+                  _logger.default.info("Tried to access local ".concat(dbDoctype, " but Cozy Pouch is not initialized yet. Forwarding the operation to next link"));
                 }
 
                 return _context6.abrupt("return", forward(operation, options));
 
-              case 8:
-                if (!(this.pouches.getSyncStatus(doctype) === 'not_synced')) {
-                  _context6.next = 11;
+              case 9:
+                if (!(this.pouches.getSyncStatus(dbDoctype) === 'not_synced')) {
+                  _context6.next = 12;
                   break;
                 }
 
                 // The doctype is not locally synced and thus cannot be requested: forward to next link
                 if (process.env.NODE_ENV !== 'production') {
-                  _logger.default.info("Tried to access local ".concat(doctype, " but Cozy Pouch is not synced yet. Forwarding the operation to next link"));
+                  _logger.default.info("Tried to access local ".concat(dbDoctype, " but Cozy Pouch is not synced yet. Forwarding the operation to next link"));
                 }
 
                 return _context6.abrupt("return", forward(operation, options));
 
-              case 11:
-                _context6.next = 13;
-                return this.needsToWaitWarmup(doctype);
+              case 12:
+                _context6.next = 14;
+                return this.needsToWaitWarmup(dbDoctype);
 
-              case 13:
+              case 14:
                 if (!_context6.sent) {
-                  _context6.next = 16;
+                  _context6.next = 17;
                   break;
                 }
 
                 if (process.env.NODE_ENV !== 'production') {
-                  _logger.default.info("Tried to access local ".concat(doctype, " but not warmuped yet. Forwarding the operation to next link"));
+                  _logger.default.info("Tried to access local ".concat(dbDoctype, " but not warmuped yet. Forwarding the operation to next link"));
                 }
 
                 return _context6.abrupt("return", forward(operation, options));
 
-              case 16:
-                if (this.supportsOperation(operation)) {
-                  _context6.next = 19;
+              case 17:
+                if (this.supportsOperation(operation, options)) {
+                  _context6.next = 20;
                   break;
                 }
 
@@ -846,18 +893,18 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
 
                 return _context6.abrupt("return", forward(operation, options));
 
-              case 19:
+              case 20:
                 if (!operation.mutationType) {
-                  _context6.next = 23;
+                  _context6.next = 24;
                   break;
                 }
 
                 return _context6.abrupt("return", this.executeMutation(operation, options, result, forward));
 
-              case 23:
-                return _context6.abrupt("return", this.executeQuery(operation));
-
               case 24:
+                return _context6.abrupt("return", this.executeQuery(operation, options));
+
+              case 25:
               case "end":
                 return _context6.stop();
             }
@@ -1008,33 +1055,37 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
                 resp = _context9.sent;
 
                 if (!(!(resp !== null && resp !== void 0 && resp.data) || Object.keys(resp === null || resp === void 0 ? void 0 : resp.data).length < 1)) {
-                  _context9.next = 15;
+                  _context9.next = 17;
                   break;
                 }
 
-                return _context9.abrupt("return", pouch.put(sanitizedDoc));
+                _context9.next = 16;
+                return pouch.put(sanitizedDoc);
+
+              case 16:
+                return _context9.abrupt("return", _context9.sent);
 
-              case 15:
+              case 17:
                 oldDoc = (0, jsonapi.sanitizeJsonApi)(resp.data);
 
                 if (!(0, _helpers2.areDocsEqual)(oldDoc, sanitizedDoc)) {
-                  _context9.next = 18;
+                  _context9.next = 20;
                   break;
                 }
 
                 return _context9.abrupt("return");
 
-              case 18:
+              case 20:
                 sanitizedDoc._rev = oldDoc._rev;
-                _context9.next = 21;
+                _context9.next = 23;
                 return pouch.put(sanitizedDoc);
 
-              case 21:
-                _context9.next = 27;
+              case 23:
+                _context9.next = 29;
                 break;
 
-              case 23:
-                _context9.prev = 23;
+              case 25:
+                _context9.prev = 25;
                 _context9.t0 = _context9["catch"](3);
 
                 _logger.default.error("PersistCozyData failed: with ".concat(_context9.t0)); // Do nothing on catch, to avoid throwing a read query
@@ -1042,18 +1093,18 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
 
                 return _context9.abrupt("return", null);
 
-              case 27:
+              case 29:
                 this.performanceApi.measure({
                   markName: markName,
                   category: 'CozyPouchLink'
                 });
 
-              case 28:
+              case 30:
               case "end":
                 return _context9.stop();
             }
           }
-        }, _callee9, this, [[3, 23]]);
+        }, _callee9, this, [[3, 25]]);
       }));
 
       function persistCozyData(_x9) {
@@ -1112,17 +1163,22 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
     value: function hasIndex(name) {
       return Boolean(this.indexes[name]);
     }
+    /**
+     * @param {object} operation - The query operation
+     * @param {object} [options] - Optional query options
+     */
+
   }, {
     key: "executeQuery",
     value: function () {
-      var _executeQuery = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee11(_ref5) {
+      var _executeQuery = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee11(_ref5, options) {
         var doctype, selector, sort, fields, limit, id, ids, skip, indexedFields, partialFilter, sharingId, engine, res, findSelector, findOpts;
         return _regenerator.default.wrap(function _callee11$(_context11) {
           while (1) {
             switch (_context11.prev = _context11.next) {
               case 0:
                 doctype = _ref5.doctype, selector = _ref5.selector, sort = _ref5.sort, fields = _ref5.fields, limit = _ref5.limit, id = _ref5.id, ids = _ref5.ids, skip = _ref5.skip, indexedFields = _ref5.indexedFields, partialFilter = _ref5.partialFilter, sharingId = _ref5.sharingId;
-                engine = this.getQueryEngineFromDoctype(doctype);
+                engine = this.getQueryEngineFromDoctype(doctype, options);
 
                 if (!id) {
                   _context11.next = 8;
@@ -1214,7 +1270,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
         }, _callee11, this);
       }));
 
-      function executeQuery(_x11) {
+      function executeQuery(_x11, _x12) {
         return _executeQuery.apply(this, arguments);
       }
 
@@ -1314,7 +1370,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
         }, _callee12, this);
       }));
 
-      function executeMutation(_x12, _x13, _x14, _x15) {
+      function executeMutation(_x13, _x14, _x15, _x16) {
         return _executeMutation.apply(this, arguments);
       }
 
@@ -1344,7 +1400,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
         }, _callee13, this);
       }));
 
-      function createDocument(_x16) {
+      function createDocument(_x17) {
         return _createDocument.apply(this, arguments);
       }
 
@@ -1368,7 +1424,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
         }, _callee14, this);
       }));
 
-      function createDocuments(_x17) {
+      function createDocuments(_x18) {
         return _createDocuments.apply(this, arguments);
       }
 
@@ -1398,7 +1454,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
         }, _callee15, this);
       }));
 
-      function updateDocument(_x18) {
+      function updateDocument(_x19) {
         return _updateDocument.apply(this, arguments);
       }
 
@@ -1422,7 +1478,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
         }, _callee16, this);
       }));
 
-      function updateDocuments(_x19) {
+      function updateDocuments(_x20) {
         return _updateDocuments.apply(this, arguments);
       }
 
@@ -1457,7 +1513,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
         }, _callee17, this);
       }));
 
-      function deleteDocument(_x20) {
+      function deleteDocument(_x21) {
         return _deleteDocument.apply(this, arguments);
       }
 
@@ -1490,7 +1546,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
         }, _callee18, this);
       }));
 
-      function deleteDocuments(_x21) {
+      function deleteDocuments(_x22) {
         return _deleteDocuments.apply(this, arguments);
       }
 
@@ -1538,7 +1594,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
         }, _callee19, this);
       }));
 
-      function bulkMutation(_x22) {
+      function bulkMutation(_x23) {
         return _bulkMutation.apply(this, arguments);
       }
 
@@ -1562,7 +1618,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
         }, _callee20);
       }));
 
-      function addReferencesTo(_x23) {
+      function addReferencesTo(_x24) {
         return _addReferencesTo.apply(this, arguments);
       }
 
@@ -1641,7 +1697,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
         }, _callee21, this, [[4, 22]]);
       }));
 
-      function dbMethod(_x24, _x25) {
+      function dbMethod(_x25, _x26) {
         return _dbMethod.apply(this, arguments);
       }
 
@@ -1738,7 +1794,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
         }, _callee23, this);
       }));
 
-      function addDoctype(_x26, _x27, _x28) {
+      function addDoctype(_x27, _x28, _x29) {
         return _addDoctype.apply(this, arguments);
       }
 
@@ -1774,7 +1830,7 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
         }, _callee24, this);
       }));
 
-      function removeDoctype(_x29) {
+      function removeDoctype(_x30) {
         return _removeDoctype.apply(this, arguments);
       }
 
@@ -1783,14 +1839,27 @@ var PouchLink = /*#__PURE__*/function (_CozyLink) {
   }, {
     key: "getSharedDriveDoctypes",
     value: function getSharedDriveDoctypes() {
-      var _this4 = this;
+      var _this5 = this;
 
       return this.doctypes.filter(function (doctype) {
-        var _this4$doctypesReplic;
+        var _this5$doctypesReplic;
 
-        return (_this4$doctypesReplic = _this4.doctypesReplicationOptions[doctype]) === null || _this4$doctypesReplic === void 0 ? void 0 : _this4$doctypesReplic.driveId;
+        return (_this5$doctypesReplic = _this5.doctypesReplicationOptions[doctype]) === null || _this5$doctypesReplic === void 0 ? void 0 : _this5$doctypesReplic.driveId;
       });
     }
+  }, {
+    key: "name",
+    get: function get() {
+      return 'pouch';
+    }
+    /**
+     * Return the PouchDB adapter name.
+     * Should be IndexedDB for newest adapters.
+     *
+     * @param {import('./types').LocalStorage} localStorage Methods to access local storage
+     * @returns {Promise<string>} The adapter name
+     */
+
   }]);
   return PouchLink;
 }(_cozyClient.CozyLink);

package/dist/CozyPouchLink.spec.js

@@ -78,6 +78,38 @@ describe('CozyPouchLink', () => {
     expect(url).toBe('http://user:token@cozy.tools:8080/data/io.cozy.todos')
   })
 
+  it('has name === "pouch"', async () => {
+    await setup()
+    expect(link.name).toBe('pouch')
+  })
+
+  it('handles a forceLink:"dataproxy" query (regression: Plan A drive capability)', async () => {
+    await setup()
+    link.pouches.getSyncStatus = jest.fn().mockReturnValue('synced')
+    const forwardFn = jest.fn()
+    await link.request(
+      Q(TODO_DOCTYPE),
+      { forceLink: 'dataproxy' },
+      null,
+      forwardFn
+    )
+    expect(forwardFn).not.toHaveBeenCalled()
+  })
+
+  it('forwards a forceLink:"stack" query', async () => {
+    await setup()
+    const forwardFn = jest.fn()
+    await link.request(Q(TODO_DOCTYPE), { forceLink: 'stack' }, null, forwardFn)
+    expect(forwardFn).toHaveBeenCalled()
+  })
+
+  it('forwards a legacy forceStack:true query', async () => {
+    await setup()
+    const forwardFn = jest.fn()
+    await link.request(Q(TODO_DOCTYPE), { forceStack: true }, null, forwardFn)
+    expect(forwardFn).toHaveBeenCalled()
+  })
+
   describe('request handling', () => {
     const query1 = () => ({
       definition: () => Q(TODO_DOCTYPE).limitBy(100),
@@ -683,6 +715,180 @@ describe('CozyPouchLink', () => {
     })
   })
 
+  describe('driveId support', () => {
+    it('maps a driveId option to its registered drive doctype', () => {
+      const driveLink = new CozyPouchLink({
+        doctypes: ['io.cozy.files', 'io.cozy.files.shareddrives-abc'],
+        doctypesReplicationOptions: {
+          'io.cozy.files.shareddrives-abc': { driveId: 'abc' }
+        }
+      })
+      expect(driveLink.getDbDoctype('io.cozy.files', { driveId: 'abc' })).toBe(
+        'io.cozy.files.shareddrives-abc'
+      )
+      expect(driveLink.getDbDoctype('io.cozy.files', {})).toBe('io.cozy.files')
+      expect(driveLink.getDbDoctype('io.cozy.files', { driveId: 'nope' })).toBe(
+        'io.cozy.files'
+      )
+    })
+
+    it('reads the drive database but types docs as io.cozy.files', async () => {
+      const FILES_DOCTYPE = 'io.cozy.files'
+      const DRIVE_DOCTYPE = 'io.cozy.files.shareddrives-abc'
+
+      const driveLink = new CozyPouchLink({
+        doctypes: [FILES_DOCTYPE, DRIVE_DOCTYPE],
+        doctypesReplicationOptions: {
+          [DRIVE_DOCTYPE]: { driveId: 'abc' }
+        }
+      })
+      const driveClient = new CozyClient({
+        ...mockClient,
+        links: [driveLink],
+        warningForCustomHandlers: false,
+        schema: {}
+      })
+      driveClient.emit = jest.fn()
+      await driveLink.onLogin()
+      driveClient.setData = jest.fn()
+
+      await driveLink.getPouch(FILES_DOCTYPE).put({ _id: 'own1' })
+      await driveLink.getPouch(DRIVE_DOCTYPE).put({ _id: 'drive1' })
+
+      driveLink.pouches.getSyncStatus = jest.fn().mockReturnValue('synced')
+
+      const res = await driveLink.request(Q(FILES_DOCTYPE).getById('drive1'), {
+        driveId: 'abc'
+      })
+      expect(res.data._id).toBe('drive1')
+      expect(res.data._type).toBe(FILES_DOCTYPE)
+
+      await driveLink.reset()
+    })
+
+    it('reads the drive database through the find path and types docs as io.cozy.files', async () => {
+      const FILES_DOCTYPE = 'io.cozy.files'
+      const DRIVE_DOCTYPE = 'io.cozy.files.shareddrives-abc'
+
+      const driveLink = new CozyPouchLink({
+        doctypes: [FILES_DOCTYPE, DRIVE_DOCTYPE],
+        doctypesReplicationOptions: {
+          [DRIVE_DOCTYPE]: { driveId: 'abc' }
+        }
+      })
+      const driveClient = new CozyClient({
+        ...mockClient,
+        links: [driveLink],
+        warningForCustomHandlers: false,
+        schema: {}
+      })
+      driveClient.emit = jest.fn()
+      await driveLink.onLogin()
+      driveClient.setData = jest.fn()
+
+      await driveLink
+        .getPouch(FILES_DOCTYPE)
+        .put({ _id: 'own1', updated_at: '2024-01-01' })
+      await driveLink
+        .getPouch(DRIVE_DOCTYPE)
+        .put({ _id: 'drive1', updated_at: '2024-06-01' })
+
+      driveLink.pouches.getSyncStatus = jest.fn().mockReturnValue('synced')
+
+      const res = await driveLink.request(
+        Q(FILES_DOCTYPE)
+          .where({ updated_at: { $gt: null } })
+          .indexFields(['updated_at']),
+        { driveId: 'abc' }
+      )
+
+      expect(res.data.some(d => d._id === 'drive1')).toBe(true)
+      expect(res.data.some(d => d._id === 'own1')).toBe(false)
+      expect(res.data.every(d => d._type === FILES_DOCTYPE)).toBe(true)
+
+      await driveLink.reset()
+    })
+
+    it('supportsOperation is true for io.cozy.files with driveId when drive doctype is managed', async () => {
+      const FILES_DOCTYPE = 'io.cozy.files'
+      const DRIVE_DOCTYPE = 'io.cozy.files.shareddrives-abc'
+
+      const driveLink = new CozyPouchLink({
+        doctypes: [FILES_DOCTYPE, DRIVE_DOCTYPE],
+        doctypesReplicationOptions: {
+          [DRIVE_DOCTYPE]: { driveId: 'abc' }
+        }
+      })
+      const driveClient = new CozyClient({
+        ...mockClient,
+        links: [driveLink],
+        warningForCustomHandlers: false,
+        schema: {}
+      })
+      driveClient.emit = jest.fn()
+      await driveLink.onLogin()
+
+      expect(driveLink.supportsOperation({ doctype: FILES_DOCTYPE })).toBe(true)
+
+      await driveLink.reset()
+    })
+
+    it('request uses drive doctype sync state, not io.cozy.files sync state', async () => {
+      const FILES_DOCTYPE = 'io.cozy.files'
+      const DRIVE_DOCTYPE = 'io.cozy.files.shareddrives-abc'
+
+      const driveLink = new CozyPouchLink({
+        doctypes: [FILES_DOCTYPE, DRIVE_DOCTYPE],
+        doctypesReplicationOptions: {
+          [DRIVE_DOCTYPE]: { driveId: 'abc' }
+        }
+      })
+      const driveClient = new CozyClient({
+        ...mockClient,
+        links: [driveLink],
+        warningForCustomHandlers: false,
+        schema: {}
+      })
+      driveClient.emit = jest.fn()
+      await driveLink.onLogin()
+
+      await driveLink.getPouch(DRIVE_DOCTYPE).put({ _id: 'drive1' })
+
+      // Drive doctype synced, io.cozy.files not synced: drive query must be handled locally
+      driveLink.pouches.getSyncStatus = jest.fn(doctype => {
+        if (doctype === DRIVE_DOCTYPE) return 'synced'
+        return 'not_synced'
+      })
+
+      const forwardSpy = jest.fn()
+      const res = await driveLink.request(
+        Q(FILES_DOCTYPE).getById('drive1'),
+        { driveId: 'abc' },
+        null,
+        forwardSpy
+      )
+      expect(forwardSpy).not.toHaveBeenCalled()
+      expect(res.data._id).toBe('drive1')
+
+      // Inverse: drive doctype not synced, io.cozy.files synced: drive query must be forwarded
+      driveLink.pouches.getSyncStatus = jest.fn(doctype => {
+        if (doctype === DRIVE_DOCTYPE) return 'not_synced'
+        return 'synced'
+      })
+
+      const forwardSpy2 = jest.fn().mockResolvedValue({ data: null })
+      await driveLink.request(
+        Q(FILES_DOCTYPE).getById('drive1'),
+        { driveId: 'abc' },
+        null,
+        forwardSpy2
+      )
+      expect(forwardSpy2).toHaveBeenCalled()
+
+      await driveLink.reset()
+    })
+  })
+
   describe('deleteDocument', () => {
     it('should add _rev and _deleted prop to a deleted document', async () => {
       await setup()

package/dist/files.js

@@ -9,31 +9,45 @@ exports.queryFileById = exports.TYPE_FILE = exports.TYPE_DIRECTORY = void 0;
 
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
 var _cozyClient = require("cozy-client");
 
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
 var defaultFetchPolicy = _cozyClient.fetchPolicies.olderThan(5 * 60 * 1000); // 5 min
 
 
 var TYPE_DIRECTORY = 'directory';
 exports.TYPE_DIRECTORY = TYPE_DIRECTORY;
 var TYPE_FILE = 'file';
+/**
+ * @param {object} client - The cozy client
+ * @param {string} id - The file id
+ * @param {string} [driveId] - Optional shared-drive id to read the file from the drive scope
+ */
+
 exports.TYPE_FILE = TYPE_FILE;
 
 var queryFileById = /*#__PURE__*/function () {
-  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(client, id) {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(client, id, driveId) {
     var definition, options;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
           case 0:
             definition = (0, _cozyClient.Q)('io.cozy.files').getById(id);
-            options = {
-              as: "io.cozy.files/".concat(id),
+            options = _objectSpread({
+              as: driveId ? "io.cozy.files/drive/".concat(driveId, "/").concat(id) : "io.cozy.files/".concat(id),
               fetchPolicy: defaultFetchPolicy,
               singleDocData: true
-            };
+            }, driveId ? {
+              driveId: driveId
+            } : {});
             return _context.abrupt("return", client.fetchQueryAndGetFromState({
               definition: definition,
               options: options
@@ -47,7 +61,7 @@ var queryFileById = /*#__PURE__*/function () {
     }, _callee);
   }));
 
-  return function queryFileById(_x, _x2) {
+  return function queryFileById(_x, _x2, _x3) {
     return _ref.apply(this, arguments);
   };
 }();

package/dist/files.spec.js

@@ -22,4 +22,36 @@ describe('queryFileById', () => {
       }
     })
   })
+
+  it('with a driveId, builds a drive-scoped query with driveId and per-drive cache key, no forceLink', async () => {
+    const expectedResult = { data: { _id: 'dir-123', path: '/Drive/Folder' } }
+    const client = {
+      fetchQueryAndGetFromState: jest.fn().mockResolvedValue(expectedResult)
+    }
+
+    const res = await queryFileById(client, 'dir-123', 'drive-abc')
+
+    expect(res).toBe(expectedResult)
+    expect(client.fetchQueryAndGetFromState).toHaveBeenCalledTimes(1)
+    const calledOptions =
+      client.fetchQueryAndGetFromState.mock.calls[0][0].options
+    expect(calledOptions.as).toBe('io.cozy.files/drive/drive-abc/dir-123')
+    expect(calledOptions.driveId).toBe('drive-abc')
+    expect(calledOptions).not.toHaveProperty('forceLink')
+    expect(calledOptions.singleDocData).toBe(true)
+  })
+
+  it('without a driveId, options are byte-for-byte identical to the legacy call', async () => {
+    const client = {
+      fetchQueryAndGetFromState: jest.fn().mockResolvedValue({ data: null })
+    }
+
+    await queryFileById(client, 'some-id', undefined)
+
+    const calledOptions =
+      client.fetchQueryAndGetFromState.mock.calls[0][0].options
+    expect(calledOptions).not.toHaveProperty('driveId')
+    expect(calledOptions).not.toHaveProperty('forceLink')
+    expect(calledOptions.as).toBe('io.cozy.files/some-id')
+  })
 })

package/dist/jsonapi.js

@@ -243,7 +243,7 @@ var computeFileFullpath = /*#__PURE__*/function () {
 
           case 25:
             _context.next = 27;
-            return (0, _files.queryFileById)(client, file.dir_id);
+            return (0, _files.queryFileById)(client, file.dir_id, file.driveId);
 
           case 27:
             result = _context.sent;

package/dist/jsonapi.spec.js

@@ -750,4 +750,47 @@ describe('computeFileFullpath', () => {
     expect(res).toBe(file)
     expect(res.path).toBeUndefined()
   })
+
+  it('passes file.driveId to queryFileById when the file carries a driveId', async () => {
+    const driveParentDir = {
+      _id: 'drive-dir-1',
+      _type: 'io.cozy.files',
+      type: 'directory',
+      path: '/Drive/Folder'
+    }
+    queryFileById.mockResolvedValue({ data: driveParentDir })
+    const driveFile = {
+      _id: 'drive-file-1',
+      _type: 'io.cozy.files',
+      type: 'file',
+      dir_id: 'drive-dir-1',
+      name: 'report.pdf',
+      driveId: 'drive-abc'
+    }
+
+    const res = await computeFileFullpath(client, driveFile)
+
+    expect(queryFileById).toHaveBeenCalledWith(
+      client,
+      'drive-dir-1',
+      'drive-abc'
+    )
+    expect(res.path).toBe('/Drive/Folder/report.pdf')
+  })
+
+  it('passes undefined driveId to queryFileById for own (non-drive) files', async () => {
+    queryFileById.mockResolvedValue({ data: dir })
+    const ownFile = {
+      _id: 'own-file-1',
+      _type: 'io.cozy.files',
+      type: 'file',
+      dir_id: '123',
+      name: 'own.txt'
+      // no driveId field
+    }
+
+    await computeFileFullpath(client, ownFile)
+
+    expect(queryFileById).toHaveBeenCalledWith(client, '123', undefined)
+  })
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-pouch-link",
-  "version": "60.28.1",
+  "version": "60.29.0",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "types/index.d.ts",
@@ -13,7 +13,7 @@
     "url": "git+https://github.com/linagora/cozy-client.git"
   },
   "dependencies": {
-    "cozy-client": "^60.28.0",
+    "cozy-client": "^60.29.0",
     "pouchdb-browser": "^7.2.2",
     "pouchdb-find": "^7.2.2"
   },
@@ -41,5 +41,5 @@
     "typecheck": "tsc -p tsconfig.json"
   },
   "sideEffects": false,
-  "gitHead": "f067e3cd364d60f3b3fb7a450f11119220f4d39c"
+  "gitHead": "0e624ae6b3ba93c2618ba9d26f4d4f48945bf5c8"
 }

package/types/CozyPouchLink.d.ts

@@ -89,6 +89,8 @@ declare class PouchLink extends CozyLink {
     doctypes: string[];
     doctypesReplicationOptions: Record<string, any>;
     indexes: {};
+    /** @private Cache of per-drive logical-typed query engines, keyed by `dbDoctype::logicalDoctype`. */
+    private _driveQueryEngines;
     storage: PouchLocalStorage;
     initialSync: boolean;
     periodicSync: boolean;
@@ -197,9 +199,20 @@ declare class PouchLink extends CozyLink {
     public stopReplication(): void;
     onSyncError(error: any): Promise<void>;
     getSyncInfo(doctype: any): import("./types").SyncInfo;
-    getQueryEngineFromDoctype(doctype: any): any;
+    /**
+     * Returns the registered physical doctype for a given logical doctype and query options.
+     *
+     * @param {any} logicalDoctype - The logical doctype
+     * @param {object} [options] - Optional query options
+     */
+    getDbDoctype(logicalDoctype: any, options?: object): any;
+    /**
+     * @param {any} doctype - The doctype
+     * @param {object} [options] - Optional query options
+     */
+    getQueryEngineFromDoctype(doctype: any, options?: object): any;
     getPouch(doctype: any): any;
-    supportsOperation(operation: any): boolean;
+    supportsOperation(operation: any, options: any): boolean;
     /**
      * Get PouchDB changes
      * See https://pouchdb.com/api.html#changes
@@ -227,19 +240,11 @@ declare class PouchLink extends CozyLink {
      */
     needsToWaitWarmup(doctype: string): Promise<boolean>;
     hasIndex(name: any): boolean;
-    executeQuery({ doctype, selector, sort, fields, limit, id, ids, skip, indexedFields, partialFilter, sharingId }: {
-        doctype: any;
-        selector: any;
-        sort: any;
-        fields: any;
-        limit: any;
-        id: any;
-        ids: any;
-        skip: any;
-        indexedFields: any;
-        partialFilter: any;
-        sharingId: any;
-    }): Promise<any>;
+    /**
+     * @param {object} operation - The query operation
+     * @param {object} [options] - Optional query options
+     */
+    executeQuery({ doctype, selector, sort, fields, limit, id, ids, skip, indexedFields, partialFilter, sharingId }: object, options?: object): Promise<any>;
     executeMutation(mutation: any, options: any, result: any, forward: any): Promise<any>;
     createDocument(mutation: any): Promise<any>;
     createDocuments(mutation: any): Promise<any[]>;

package/types/files.d.ts

@@ -1,3 +1,3 @@
 export const TYPE_DIRECTORY: "directory";
 export const TYPE_FILE: "file";
-export function queryFileById(client: any, id: any): Promise<any>;
+export function queryFileById(client: object, id: string, driveId?: string): Promise<any>;