cozy-client 57.2.0 → 57.3.0

package/dist/CozyClient.js

@@ -3097,7 +3097,7 @@ var CozyClient = /*#__PURE__*/function () {
 CozyClient.hooks = CozyClient.hooks || {};
 CozyClient.fetchPolicies = _policies.default; //COZY_CLIENT_VERSION_PACKAGE in replaced by babel. See babel config
 
-CozyClient.version = "57.2.0";
+CozyClient.version = "57.3.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/store/documents.js

@@ -9,15 +9,13 @@ exports.extractAndMergeDocument = exports.getCollectionFromSlice = exports.getDo
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
-var _keyBy = _interopRequireDefault(require("lodash/keyBy"));
-
 var _get = _interopRequireDefault(require("lodash/get"));
 
-var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
-
 var _omit = _interopRequireDefault(require("lodash/omit"));
 
-var _merge = _interopRequireDefault(require("lodash/merge"));
+var _fastDeepEqual = _interopRequireDefault(require("fast-deep-equal"));
+
+var _deepmerge = _interopRequireDefault(require("@fastify/deepmerge"));
 
 var _logger = _interopRequireDefault(require("../logger"));
 
@@ -33,6 +31,8 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 
 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 deepmergeFn = (0, _deepmerge.default)();
+
 var storeDocument = function storeDocument(state, document) {
   var type = document._type;
 
@@ -54,7 +54,7 @@ var storeDocument = function storeDocument(state, document) {
 
   var existingDoc = (0, _get.default)(state, [type, (0, _helpers.properId)(document)]);
 
-  if ((0, _isEqual.default)(existingDoc, document)) {
+  if ((0, _fastDeepEqual.default)(existingDoc, document)) {
     return state;
   } else {
     return _objectSpread(_objectSpread({}, state), {}, (0, _defineProperty2.default)({}, type, _objectSpread(_objectSpread({}, state[type]), {}, (0, _defineProperty2.default)({}, (0, _helpers.properId)(document), mergeDocumentsWithRelationships(existingDoc, document)))));
@@ -203,44 +203,76 @@ var getCollectionFromSlice = function getCollectionFromSlice() {
 
   return Object.values(state[doctype]);
 };
-/*
-  This method has been created in order to get a returned object
-  in `data` with the full set on information coming potentially from
+/**
+ * 
+ * This method has been created in order to get a returned object
+   in `data` with the full set on information coming potentially from
   `included`
-
+ 
   This method should be somewhere else. The `document` shall not be
   dealt with included / data and so on.
-
+ 
   This method takes `data` and `included` and merge both sources
   together. It should be always up-to-date. The returned object
   will be as full of information as it can be.
-*/
+ 
+ * @param {Array<import('../types').CozyClientDocument>} newData - Queries documents 
+ * @param {import("../types").DocumentsStateSlice} updatedStateWithIncluded documents' state 
+ * @returns {import("../types").DocumentsStateSlice} the merged documents state
+ */
 
 
 exports.getCollectionFromSlice = getCollectionFromSlice;
 
-var extractAndMergeDocument = function extractAndMergeDocument(data, updatedStateWithIncluded) {
-  var doctype = data[0]._type;
+var extractAndMergeDocument = function extractAndMergeDocument(newData, updatedStateWithIncluded) {
+  var doctype = newData[0]._type;
 
   if (!doctype) {
-    _logger.default.info('Document without _type', data[0]);
+    _logger.default.info('Document without _type', newData[0]);
 
     throw new Error('Document without _type');
-  }
+  } // Index docs by id, for faster retrieval
+
+
+  var newDocsMap = new Map(newData.map(function (doc) {
+    return [(0, _helpers.properId)(doc), doc];
+  }));
+  var mergedState = Object.assign({}, updatedStateWithIncluded); // FIXME: this was introduced for a bug in banks, but it does not look useful
+
+  mergedState[doctype] = Object.assign({}, updatedStateWithIncluded[doctype]);
 
-  var sortedData = (0, _keyBy.default)(data, _helpers.properId);
-  var mergedData = Object.assign({}, updatedStateWithIncluded);
-  mergedData[doctype] = Object.assign({}, updatedStateWithIncluded[doctype]);
-  Object.values(sortedData).map(function (data) {
-    var id = (0, _helpers.properId)(data);
+  if (!mergedState[doctype]) {
+    mergedState[doctype] = {};
+  }
 
-    if (mergedData[doctype][id]) {
-      mergedData[doctype][id] = (0, _merge.default)({}, mergedData[doctype][id], data);
-    } else {
-      mergedData[doctype][id] = data;
+  var haveDocumentsChanged = false;
+  newDocsMap.forEach(function (newDoc, key) {
+    var id = key;
+    var currentDoc = mergedState[doctype][id];
+
+    if (!currentDoc) {
+      mergedState[doctype][id] = newDoc;
+      haveDocumentsChanged = true;
+    } else if (!(0, _fastDeepEqual.default)(currentDoc, newDoc)) {
+      // XXX Here we check if the doc has changed. Note this would be way faster
+      // by just relying on revision change, but:
+      //  - it does not work if the new doc is partial (i.e. retrieved with a .select query)
+      //  - some documents might change without a rev change: typically the thumbnails links
+      //    in io.cozy.files, and the io.cozy.settings.instance doc, with additional
+      //    fields added by the stack
+      //  - some documents don't have any revision
+      mergedState[doctype][id] = deepmergeFn(mergedState[doctype][id], newDoc);
+      haveDocumentsChanged = true;
     }
-  });
-  return mergedData;
+  }); // XXX If there is any state change, the updated state should have a new reference,
+  // as we heavily rely on referential equality.
+  // Conversely, if there is no change, the same reference should be kept
+
+  if (haveDocumentsChanged) {
+    return mergedState;
+  }
+
+  return updatedStateWithIncluded;
 };
 
 exports.extractAndMergeDocument = extractAndMergeDocument;

package/dist/store/documents.spec.js

@@ -4,11 +4,9 @@ import {
 } from './documents'
 
 describe('extractAndMerge', () => {
-  const data = {
-    0: {
-      id: 'b6ff135b34e041ffb2d4a4865f3e0a53',
+  const data = [
+    {
       _id: 'b6ff135b34e041ffb2d4a4865f3e0a53',
-      type: 'io.cozy.files',
       _type: 'io.cozy.files',
       blabla: 'new field',
       cozyMetadata: {
@@ -18,24 +16,20 @@ describe('extractAndMerge', () => {
         }
       }
     },
-    1: {
-      id: 'b6ff135b34e041ffb2d4a4865f3e235f',
-      type: 'io.cozy.files',
-      _type: 'io.cozy.files',
+    {
       _id: 'b6ff135b34e041ffb2d4a4865f3e235f',
+      _type: 'io.cozy.files',
       blibli: 'another new field'
     }
-  }
+  ]
   const updatedStateWithIncluded = {
     'io.cozy.files': {
       b6ff135b34e041ffb2d4a4865f3e0a53: {
-        attributes: {
-          type: 'file',
-          name: 'IMG_0016.PNG',
-          dir_id: '7d2f9c24cd345ce3171bf71f401e80c6'
-        },
-        id: 'b6ff135b34e041ffb2d4a4865f3e0a53',
         _id: 'b6ff135b34e041ffb2d4a4865f3e0a53',
+        _type: 'io.cozy.files',
+        name: 'IMG_0016.PNG',
+        type: 'file',
+        dir_id: '7d2f9c24cd345ce3171bf71f401e80c6',
         links: { self: '/files/b6ff135b34e041ffb2d4a4865f3e0a53' },
         meta: { rev: '5-87840eceaab358e38aa8b6bb0d4577b1' },
         relationships: {
@@ -43,8 +37,6 @@ describe('extractAndMerge', () => {
             links: { related: '/files/7d2f9c24cd345ce3171bf71f401e80c6' }
           }
         },
-        type: 'io.cozy.files',
-        _type: 'io.cozy.files',
         cozyMetadata: {
           updated_at: '987654',
           updatedByApps: {
@@ -53,22 +45,18 @@ describe('extractAndMerge', () => {
         }
       },
       b6ff135b34e041ffb2d4a4865f3e235f: {
-        attributes: {
-          type: 'file',
-          name: 'IMG_0054.PNG',
-          dir_id: '7d2f9c24cd345ce3171bf71f401e80c6'
-        },
-        id: 'b6ff135b34e041ffb2d4a4865f3e235f',
         _id: 'b6ff135b34e041ffb2d4a4865f3e235f',
+        _type: 'io.cozy.files',
+        type: 'file',
+        name: 'IMG_0054.PNG',
+        dir_id: '7d2f9c24cd345ce3171bf71f401e80c6',
         links: { self: '/files/b6ff135b34e041ffb2d4a4865f3e235f' },
         meta: { rev: '5-ca91c0dc02dafb38eb56070c1d80d62c' },
         relationships: {
           parent: {
             links: { related: '/files/7d2f9c24cd345ce3171bf71f401e80c6' }
           }
-        },
-        type: 'io.cozy.files',
-        _type: 'io.cozy.files'
+        }
       }
     }
   }
@@ -84,11 +72,9 @@ describe('extractAndMerge', () => {
         b6ff135b34e041ffb2d4a4865f3e0a53: {
           _id: 'b6ff135b34e041ffb2d4a4865f3e0a53',
           _type: 'io.cozy.files',
-          attributes: {
-            dir_id: '7d2f9c24cd345ce3171bf71f401e80c6',
-            name: 'IMG_0016.PNG',
-            type: 'file'
-          },
+          dir_id: '7d2f9c24cd345ce3171bf71f401e80c6',
+          name: 'IMG_0016.PNG',
+          type: 'file',
           blabla: 'new field',
           cozyMetadata: {
             created_at: '123456',
@@ -98,34 +84,28 @@ describe('extractAndMerge', () => {
               date: '2019-06-11T01:02:03Z'
             }
           },
-          id: 'b6ff135b34e041ffb2d4a4865f3e0a53',
           links: { self: '/files/b6ff135b34e041ffb2d4a4865f3e0a53' },
           meta: { rev: '5-87840eceaab358e38aa8b6bb0d4577b1' },
           relationships: {
             parent: {
               links: { related: '/files/7d2f9c24cd345ce3171bf71f401e80c6' }
             }
-          },
-          type: 'io.cozy.files'
+          }
         },
         b6ff135b34e041ffb2d4a4865f3e235f: {
           _id: 'b6ff135b34e041ffb2d4a4865f3e235f',
           _type: 'io.cozy.files',
-          attributes: {
-            dir_id: '7d2f9c24cd345ce3171bf71f401e80c6',
-            name: 'IMG_0054.PNG',
-            type: 'file'
-          },
+          dir_id: '7d2f9c24cd345ce3171bf71f401e80c6',
+          name: 'IMG_0054.PNG',
+          type: 'file',
           blibli: 'another new field',
-          id: 'b6ff135b34e041ffb2d4a4865f3e235f',
           links: { self: '/files/b6ff135b34e041ffb2d4a4865f3e235f' },
           meta: { rev: '5-ca91c0dc02dafb38eb56070c1d80d62c' },
           relationships: {
             parent: {
               links: { related: '/files/7d2f9c24cd345ce3171bf71f401e80c6' }
             }
-          },
-          type: 'io.cozy.files'
+          }
         }
       }
     }
@@ -171,20 +151,16 @@ describe('extractAndMerge', () => {
       'even if the mergedData is the same, because reselect createSelector update ' +
       'according to object reference, not only value',
     () => {
-      const dataAlreadyIncludedInUpdatedStateWithIncluded = {
-        0: {
-          id: 'b6ff135b34e041ffb2d4a4865f3e0a53',
+      const dataAlreadyIncludedInUpdatedStateWithIncluded = [
+        {
           _id: 'b6ff135b34e041ffb2d4a4865f3e0a53',
-          type: 'io.cozy.files',
           _type: 'io.cozy.files'
         },
-        1: {
-          id: 'b6ff135b34e041ffb2d4a4865f3e235f',
-          type: 'io.cozy.files',
-          _type: 'io.cozy.files',
-          _id: 'b6ff135b34e041ffb2d4a4865f3e235f'
+        {
+          _id: 'b6ff135b34e041ffb2d4a4865f3e235f',
+          _type: 'io.cozy.files'
         }
-      }
+      ]
 
       const returnedDatas = extractAndMergeDocument(
         dataAlreadyIncludedInUpdatedStateWithIncluded,
@@ -202,6 +178,44 @@ describe('extractAndMerge', () => {
       )
     }
   )
+  it('should keep state reference in case no document has changed', () => {
+    const newDoc = { ...data[0] }
+
+    const mergedState = extractAndMergeDocument(
+      [newDoc],
+      updatedStateWithIncluded
+    )
+    expect(mergedState === updatedStateWithIncluded)
+  })
+
+  it('should have different state reference if a new document is added', () => {
+    const newDoc = {
+      _id: '1234',
+      _type: 'io.cozy.files',
+      name: 'New doc'
+    }
+    const mergedState = extractAndMergeDocument(
+      [newDoc],
+      updatedStateWithIncluded
+    )
+    expect(mergedState !== updatedStateWithIncluded)
+  })
+
+  it('should have different state reference if an existing document have changed', () => {
+    const newDoc = {
+      ...data[0],
+      cozyMetadata: {
+        ...data[0].cozyMetadata,
+        updatedByApps: '2025-01-01'
+      }
+    }
+
+    const mergedState = extractAndMergeDocument(
+      [newDoc],
+      updatedStateWithIncluded
+    )
+    expect(mergedState !== updatedStateWithIncluded)
+  })
 })
 
 describe('mergeDocumentsWithRelationships', () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "57.2.0",
+  "version": "57.3.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -15,11 +15,13 @@
   },
   "dependencies": {
     "@cozy/minilog": "1.0.0",
+    "@fastify/deepmerge": "^2.0.2",
     "@types/jest": "^26.0.20",
     "@types/lodash": "^4.14.170",
     "btoa": "^1.2.1",
     "cozy-stack-client": "^57.2.0",
     "date-fns": "2.29.3",
+    "fast-deep-equal": "^3.1.3",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
     "microee": "^0.0.6",
@@ -72,5 +74,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "f9c7c5c422ae18a648278cecf820f9a367447263"
+  "gitHead": "aa4094d6cb80bbd4173cc82fb1a2a06406718b5e"
 }

package/types/store/documents.d.ts

@@ -3,5 +3,5 @@ export default documents;
 export function getDocumentFromSlice(state: import('../types').DocumentsStateSlice, doctype: string, id: string): import('../types').CozyClientDocument;
 export function getDocumentsFromSlice(state: import('../types').DocumentsStateSlice, doctype: string, ids: Array<string>): Array<import('../types').CozyClientDocument>;
 export function getCollectionFromSlice(state: {}, doctype: any): any[];
-export function extractAndMergeDocument(data: any, updatedStateWithIncluded: any): any;
+export function extractAndMergeDocument(newData: Array<import('../types').CozyClientDocument>, updatedStateWithIncluded: import("../types").DocumentsStateSlice): import("../types").DocumentsStateSlice;
 declare function documents(state: {}, action: any): any;