cozy-client 59.4.0 → 60.1.0

package/dist/store/__snapshots__/queries.spec.js.snap

@@ -19,6 +19,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -32,6 +33,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": null,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -58,6 +61,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -71,6 +75,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -96,6 +102,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -109,6 +116,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -134,6 +143,7 @@ Object {
         },
         "done": true,
       },
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -147,6 +157,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -172,6 +184,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -185,6 +198,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -207,6 +222,7 @@ Object {
       "selector": Object {
         "done": true,
       },
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -220,6 +236,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -247,6 +265,7 @@ Object {
       "selector": Object {
         "done": false,
       },
+      "sharingId": undefined,
       "skip": undefined,
       "sort": Array [
         Object {
@@ -264,6 +283,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -284,6 +305,7 @@ Object {
       "selector": Object {
         "done": true,
       },
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -297,6 +319,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": null,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -323,6 +347,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -336,6 +361,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -357,6 +384,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -370,6 +398,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -395,6 +425,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -408,6 +439,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -428,6 +461,7 @@ Object {
       "selector": Object {
         "done": true,
       },
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -445,6 +479,8 @@ Object {
         "add": false,
       },
     },
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -468,6 +504,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -481,6 +518,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": null,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -499,6 +538,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -512,6 +552,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -537,6 +579,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -550,6 +593,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -572,6 +617,7 @@ Object {
       "selector": Object {
         "done": true,
       },
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -589,6 +635,8 @@ Object {
         "remove": false,
       },
     },
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -614,6 +662,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -627,6 +676,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -647,6 +698,7 @@ Object {
       "selector": Object {
         "done": false,
       },
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -660,6 +712,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": null,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;
@@ -687,6 +741,7 @@ Object {
       "partialFilter": undefined,
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -700,6 +755,8 @@ Object {
     "lastFetch": 1337,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
   "b": Object {
     "bookmark": null,
@@ -723,6 +780,7 @@ Object {
       },
       "referenced": undefined,
       "selector": undefined,
+      "sharingId": undefined,
       "skip": undefined,
       "sort": undefined,
     },
@@ -736,6 +794,8 @@ Object {
     "lastFetch": null,
     "lastUpdate": 1337,
     "options": null,
+    "relationshipNames": Array [],
+    "storeData": Array [],
   },
 }
 `;

package/dist/store/queries.js

@@ -94,7 +94,9 @@ var queryInitialState = {
   count: 0,
   fetchedPagesCount: 0,
   data: [],
-  bookmark: null
+  storeData: [],
+  bookmark: null,
+  relationshipNames: []
 };
 /**
  * Return the docs ids accordingly to the given sort and fetched docs

package/dist/store/selector.js

@@ -0,0 +1,138 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.equalityCheckForQuery = void 0;
+
+function _createForOfIteratorHelper(o, allowArrayLike) { var it; if (typeof Symbol === "undefined" || o[Symbol.iterator] == null) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = o[Symbol.iterator](); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+/**
+ * Perform an equality check to determine whether or not two query results are equal.
+ *
+ * This is typically called by a `useSelector`, to determine if a render should be made because
+ * the query result has changed.
+ * See https://react-redux.js.org/api/hooks#equality-comparisons-and-updates
+ *
+ * We cannot use the default strict reference comparison here, because a new reference for the query
+ * result is made every time. However, the query result itself, in `storeData`, preserves references.
+ *
+ * Note we do not make a shallow equality check on documents, as it is much less efficient.
+ * It is however different for relationships: because of their hydratation, the references change
+ * even if the data is the same.
+ *
+ * @param {import("../types").QueryState} queryResA - A query result to compare
+ * @param {import("../types").QueryState} queryResB - A query result to compare
+ * @returns {boolean} whether or not the two query are equal
+ */
+var equalityCheckForQuery = function equalityCheckForQuery(queryResA, queryResB) {
+  if (queryResA === queryResB) {
+    // Referential equality
+    return true;
+  }
+
+  if (typeof queryResA !== 'object' || queryResA === null || typeof queryResB !== 'object' || queryResB === null) {
+    // queryResA or queryResB is not an object or null
+    return false;
+  }
+
+  if (queryResA.id !== queryResB.id) {
+    return false;
+  }
+
+  if (queryResA.fetchStatus !== queryResB.fetchStatus) {
+    return false;
+  }
+
+  var docsA = queryResA.storeData;
+  var docsB = queryResB.storeData;
+
+  if (!docsA || !docsB) {
+    // No data to check
+    return false;
+  }
+
+  if (!Array.isArray(docsA) && !Array.isArray(docsB) && docsA !== docsB) {
+    // Only one doc
+    return false;
+  }
+
+  if (Array.isArray(docsA) && Array.isArray(docsB) && !arraysHaveSameLength(docsA, docsB)) {
+    // A document was added or removed
+    return false;
+  }
+
+  if (Array.isArray(docsA) && Array.isArray(docsB)) {
+    for (var i = 0; i < docsA.length; i++) {
+      if (docsA[i] !== docsB[i]) {
+        // References should be the same for non-updated documents
+        return false;
+      }
+    }
+  }
+
+  if (queryResA.relationshipNames) {
+    // In case of relationships, we cannot check referential equality, because we
+    // "hydrate" the data by creating a new instance of the related relationship class.
+    // Thus, we check the document revision instead.
+    var hydratedDataA = queryResA.data;
+    var hydratedDataB = queryResB.data;
+
+    if (!Array.isArray(hydratedDataA) && !Array.isArray(hydratedDataB)) {
+      // One doc with changed relationship
+      return revsAreEqual(hydratedDataA, hydratedDataB);
+    }
+
+    if (!arraysHaveSameLength(hydratedDataA, hydratedDataB)) {
+      // A relationship have been added or removed
+      return false;
+    }
+
+    if (Array.isArray(hydratedDataA) && Array.isArray(hydratedDataB)) {
+      for (var _i = 0; _i < hydratedDataA.length; _i++) {
+        var _iterator = _createForOfIteratorHelper(queryResA.relationshipNames),
+            _step;
+
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var name = _step.value;
+            // Check hydrated relationship
+            var includedA = hydratedDataA[_i][name];
+            var includedB = hydratedDataB[_i][name];
+
+            if (includedA && includedB) {
+              if (!revsAreEqual(includedA, includedB)) {
+                return false;
+              }
+            }
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.f();
+        }
+      }
+    }
+  } // The query results are indeed equal
+
+
+  return true;
+};
+
+exports.equalityCheckForQuery = equalityCheckForQuery;
+
+var revsAreEqual = function revsAreEqual(docA, docB) {
+  if (!docA._rev || !docB._rev) {
+    return false;
+  }
+
+  return (docA === null || docA === void 0 ? void 0 : docA._rev) === (docB === null || docB === void 0 ? void 0 : docB._rev);
+};
+
+var arraysHaveSameLength = function arraysHaveSameLength(arrayA, arrayB) {
+  return Array.isArray(arrayA) && Array.isArray(arrayB) && arrayA.length === arrayB.length;
+};

package/dist/store/selector.spec.js

@@ -0,0 +1,238 @@
+import { equalityCheckForQuery } from './selector'
+
+const mapIdsToDocuments = (state, doctype, ids) => {
+  return ids.map(id => state[doctype][id])
+}
+
+const state = {
+  documents: {
+    'io.cozy.files': {
+      doc1: {
+        _id: 'doc1'
+      },
+      doc2: {
+        _id: 'doc2'
+      },
+      doc3: {
+        _id: 'doc3'
+      }
+    }
+  },
+  queries: {
+    query1: {
+      id: 'query1',
+      data: ['doc1', 'doc2']
+    },
+    query2: {
+      id: 'query2',
+      data: ['doc2']
+    }
+  }
+}
+
+const defaultQueryResult = {
+  id: 1,
+  data: [],
+  fetchStatus: 'loaded',
+  relationshipNames: null
+}
+
+describe('equalityCheckForQuery', () => {
+  const queryResultA1 = {
+    id: 1,
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc1',
+      'doc2'
+    ]),
+    ...defaultQueryResult
+  }
+  const queryResultA2 = {
+    id: 1,
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc1',
+      'doc2'
+    ]),
+    ...defaultQueryResult
+  }
+  const queryResultA3 = {
+    id: 1,
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc1',
+      'doc2',
+      'doc3'
+    ]),
+    ...defaultQueryResult
+  }
+  const queryResultA4 = {
+    id: 1,
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc2',
+      'doc3'
+    ]),
+    ...defaultQueryResult
+  }
+  const queryResultB1 = {
+    id: 2,
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', ['doc2']),
+    ...defaultQueryResult
+  }
+
+  const queryResultB2 = {
+    id: 2,
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', ['doc3']),
+    ...defaultQueryResult
+  }
+
+  const queryResultC1 = {
+    id: 3,
+    storeData: state.documents['io.cozy.files'].doc1,
+    data: {},
+    ...defaultQueryResult
+  }
+
+  const queryResultC2 = {
+    id: 3,
+    storeData: state.documents['io.cozy.files'].doc1,
+    data: {},
+    ...defaultQueryResult
+  }
+
+  const queryResultC3 = {
+    id: 3,
+    storeData: state.documents['io.cozy.files'].doc2,
+    data: {},
+    ...defaultQueryResult
+  }
+
+  it('should return true for referential equality', () => {
+    expect(equalityCheckForQuery(queryResultA1, queryResultA1)).toBe(true)
+    expect(equalityCheckForQuery(null, null)).toBe(true)
+  })
+
+  it('should return false if one object is null', () => {
+    expect(equalityCheckForQuery(null, queryResultA1)).toBe(false)
+    expect(equalityCheckForQuery(queryResultA1, null)).toBe(false)
+  })
+
+  it('should return false if one or both objects are not objects', () => {
+    // @ts-ignore
+    expect(equalityCheckForQuery('notAnObject', queryResultA1)).toBe(false)
+    // @ts-ignore
+    expect(equalityCheckForQuery(queryResultA1, 'notAnObject')).toBe(false)
+  })
+
+  it('should return false if `id` properties are different', () => {
+    expect(equalityCheckForQuery(queryResultA1, queryResultB1)).toBe(false)
+  })
+
+  it('should return false if one or both objects lack `data`', () => {
+    // @ts-ignore
+    expect(equalityCheckForQuery({ id: 1 }, queryResultA1)).toBe(false)
+    // @ts-ignore
+    expect(equalityCheckForQuery(queryResultA1, { id: 1 })).toBe(false)
+  })
+
+  it('should return false if `data` lengths are different', () => {
+    expect(equalityCheckForQuery(queryResultA1, queryResultA3)).toBe(false)
+  })
+
+  it('should return false if elements in `data` are different', () => {
+    expect(equalityCheckForQuery(queryResultA1, queryResultA3)).toBe(false)
+    expect(equalityCheckForQuery(queryResultA3, queryResultA4)).toBe(false)
+    expect(equalityCheckForQuery(queryResultB1, queryResultB2)).toBe(false)
+  })
+
+  it('should return true for matching data array, with equal references ', () => {
+    expect(equalityCheckForQuery(queryResultA1, queryResultA2)).toBe(true)
+  })
+
+  it('should return false for matching data array, with different references ', () => {
+    const queryResShallowCopyA1 = {
+      ...queryResultA1,
+      storeData: JSON.parse(JSON.stringify(queryResultA1.storeData)) // Deep copy
+    }
+    expect(equalityCheckForQuery(queryResultA1, queryResShallowCopyA1)).toBe(
+      false
+    )
+  })
+
+  it('should return true for matching object data', () => {
+    expect(equalityCheckForQuery(queryResultC1, queryResultC2)).toBe(true)
+  })
+  it('should return false for different object data', () => {
+    expect(equalityCheckForQuery(queryResultC1, queryResultC3)).toBe(false)
+  })
+})
+
+describe('equalityCheckForQuery with relationships', () => {
+  const queryResA = {
+    ...defaultQueryResult,
+    relationshipNames: ['relation1'],
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc1',
+      'doc2'
+    ]),
+    data: [{ relation1: { _rev: 'rev1' } }]
+  }
+
+  const queryResB = {
+    ...defaultQueryResult,
+    relationshipNames: ['relation1'],
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc1',
+      'doc2'
+    ]),
+    data: [{ relation1: { _rev: 'rev2' } }]
+  }
+
+  const queryResC = {
+    ...defaultQueryResult,
+    relationshipNames: ['relation1'],
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc1',
+      'doc2'
+    ]),
+    data: [{ relation1: { _rev: 'rev1' } }, { relation1: { _rev: 'rev2' } }]
+  }
+
+  const queryResD = {
+    ...defaultQueryResult,
+    relationshipNames: ['relation1', 'relation2'],
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', [
+      'doc1',
+      'doc2'
+    ]),
+    data: [{ relation1: { _rev: 'rev1' } }, { relation2: { _rev: 'rev2' } }]
+  }
+
+  const queryResE = {
+    ...defaultQueryResult,
+    relationshipNames: ['relation1'],
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', ['doc1']),
+    data: [{ relation1: { _id: '123' } }]
+  }
+
+  const queryResF = {
+    ...defaultQueryResult,
+    relationshipNames: ['relation1'],
+    storeData: mapIdsToDocuments(state.documents, 'io.cozy.files', ['doc1']),
+    data: [{ relation1: { _id: '123' } }]
+  }
+
+  it('returns true when data and relationship revisions match', () => {
+    expect(equalityCheckForQuery(queryResA, queryResA)).toBe(true)
+    expect(equalityCheckForQuery(queryResD, queryResD)).toBe(true)
+  })
+
+  it('returns false when relationship revisions differ', () => {
+    expect(equalityCheckForQuery(queryResA, queryResB)).toBe(false)
+  })
+
+  it('returns false when relationship revisions are missing', () => {
+    expect(equalityCheckForQuery(queryResE, queryResF)).toBe(false)
+  })
+
+  it('returns false when data lengths differ', () => {
+    expect(equalityCheckForQuery(queryResA, queryResC)).toBe(false)
+  })
+})