cozy-client 31.0.1 → 32.0.0

package/dist/CozyClient.js

@@ -2550,7 +2550,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 = "31.0.1";
+CozyClient.version = "32.0.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/Query.spec.jsx

@@ -184,6 +184,7 @@ describe('Query', () => {
         {
           bookmark: null,
           count: 0,
+          fetchedPagesCount: 0,
           data: [],
           definition: { doctype: 'io.cozy.todos' },
           fetch: expect.any(Function),

package/dist/hooks/useQuery.spec.jsx

@@ -84,6 +84,7 @@ describe('use query', () => {
         'lastError',
         'hasMore',
         'count',
+        'fetchedPagesCount',
         'data',
         'bookmark',
         'options',

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

@@ -23,6 +23,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "pending",
+    "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "a",
     "lastError": null,
@@ -60,6 +61,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "loaded",
+    "fetchedPagesCount": 1,
     "hasMore": false,
     "id": "a",
     "lastError": null,
@@ -96,6 +98,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "loaded",
+    "fetchedPagesCount": 1,
     "hasMore": false,
     "id": "a",
     "lastError": null,
@@ -132,6 +135,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "pending",
+    "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
     "lastError": null,
@@ -168,6 +172,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "loaded",
+    "fetchedPagesCount": 1,
     "hasMore": false,
     "id": "a",
     "lastError": null,
@@ -201,6 +206,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "pending",
+    "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
     "lastError": null,
@@ -243,6 +249,7 @@ Object {
       ],
     },
     "fetchStatus": "loaded",
+    "fetchedPagesCount": 1,
     "hasMore": false,
     "id": "a",
     "lastError": null,
@@ -274,6 +281,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "pending",
+    "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
     "lastError": null,
@@ -311,6 +319,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "loaded",
+    "fetchedPagesCount": 1,
     "hasMore": false,
     "id": "a",
     "lastError": null,
@@ -343,6 +352,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "pending",
+    "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
     "lastError": null,
@@ -379,6 +389,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "loaded",
+    "fetchedPagesCount": 1,
     "hasMore": false,
     "id": "a",
     "lastError": null,
@@ -410,6 +421,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "pending",
+    "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
     "lastError": null,
@@ -448,6 +460,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "pending",
+    "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "a",
     "lastError": null,
@@ -477,6 +490,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "pending",
+    "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
     "lastError": null,
@@ -513,6 +527,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "loaded",
+    "fetchedPagesCount": 2,
     "hasMore": false,
     "id": "a",
     "lastError": null,
@@ -546,6 +561,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "pending",
+    "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
     "lastError": null,
@@ -586,6 +602,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "loaded",
+    "fetchedPagesCount": 1,
     "hasMore": false,
     "id": "a",
     "lastError": null,
@@ -617,6 +634,7 @@ Object {
       "sort": undefined,
     },
     "fetchStatus": "pending",
+    "fetchedPagesCount": 0,
     "hasMore": false,
     "id": "b",
     "lastError": null,

package/dist/store/queries.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.QueryIDGenerator = exports.getQueryFromSlice = exports.receiveQueryError = exports.receiveQueryResult = exports.loadQuery = exports.initQuery = exports.default = exports.makeSorterFromDefinition = exports.mergeSelectorAndPartialIndex = exports.convert$gtNullSelectors = exports.isReceivingData = exports.isQueryAction = void 0;
+exports.QueryIDGenerator = exports.getQueryFromSlice = exports.receiveQueryError = exports.receiveQueryResult = exports.loadQuery = exports.initQuery = exports.default = exports.makeSorterFromDefinition = exports.mergeSelectorAndPartialIndex = exports.convert$gtNullSelectors = exports.sortAndLimitDocsIds = exports.isReceivingData = exports.isQueryAction = void 0;
 
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 
@@ -90,25 +90,65 @@ var queryInitialState = {
   lastError: null,
   hasMore: false,
   count: 0,
+  fetchedPagesCount: 0,
   data: [],
   bookmark: null
 };
+/**
+ * Return the docs ids accordingly to the given sort and fetched docs
+ *
+ * @param {QueryState} queryState - Current state
+ * @param {DocumentsStateSlice} documents - Reference to the documents slice
+ * @param {Array<string>} ids - The updated ids after query
+ * @param {object} params - The additional params
+ * @param {number} params.count - The count of retrieved docs
+ * @param {number} params.fetchedPagesCount - The number of pages already fetched
+ * @returns {Array<string>} The list of sorted ids
+ */
 
-var updateQueryDataFromResponse = function updateQueryDataFromResponse(queryState, response, documents) {
-  var updatedIds = (0, _uniq.default)([].concat((0, _toConsumableArray2.default)(queryState.data), (0, _toConsumableArray2.default)(response.data.map(_helpers.properId))));
+var sortAndLimitDocsIds = function sortAndLimitDocsIds(queryState, documents, ids, _ref) {
+  var count = _ref.count,
+      fetchedPagesCount = _ref.fetchedPagesCount;
+  var evaluatedIds = (0, _toConsumableArray2.default)(ids);
 
-  if (queryState.definition.sort) {
+  if (queryState.definition.sort && documents) {
     var sorter = makeSorterFromDefinition(queryState.definition);
-    var doctype = queryState.definition.doctype;
-    var allDocs = documents[doctype];
-    var docs = allDocs ? updatedIds.map(function (_id) {
+    var allDocs = documents[queryState.definition.doctype];
+    var docs = allDocs ? evaluatedIds.map(function (_id) {
       return allDocs[_id];
     }).filter(Boolean) : [];
-    var sortedDocs = sorter(docs);
-    updatedIds = sortedDocs.map(_helpers.properId);
+    evaluatedIds = sorter(docs).map(_helpers.properId);
+  }
+
+  if (queryState.definition.limit) {
+    evaluatedIds = queryState.definition.limit ? evaluatedIds.slice(0, count * fetchedPagesCount) : evaluatedIds;
   }
 
-  return updatedIds;
+  return evaluatedIds;
+};
+/**
+ * Return the query docs ids, taken from the action response and the documents' slice
+ *
+ * @param {QueryState} queryState - Current state
+ * @param {object} response - The action response
+ * @param {DocumentsStateSlice} documents - Reference to the documents slice
+ * @param {object} params - The additional params
+ * @param {number} params.count - The count of retrieved docs
+ * @param {number} params.fetchedPagesCount - The number of pages already fetched
+ * @returns {Array<string>} The list of sorted ids
+ */
+
+
+exports.sortAndLimitDocsIds = sortAndLimitDocsIds;
+
+var updateQueryDataFromResponse = function updateQueryDataFromResponse(queryState, response, documents, _ref2) {
+  var count = _ref2.count,
+      fetchedPagesCount = _ref2.fetchedPagesCount;
+  var updatedIds = (0, _uniq.default)([].concat((0, _toConsumableArray2.default)(queryState.data), (0, _toConsumableArray2.default)(response.data.map(_helpers.properId))));
+  return sortAndLimitDocsIds(queryState, documents, updatedIds, {
+    count: count,
+    fetchedPagesCount: fetchedPagesCount
+  });
 };
 /**
  * Reducer for a query slice
@@ -177,11 +217,18 @@ var query = function query() {
           });
         }
 
+        var count = response.meta && response.meta.count ? response.meta.count : response.data.length;
+        var fetchedPagesCount = state.fetchedPagesCount + 1;
+        var data = updateQueryDataFromResponse(state, response, documents, {
+          count: count,
+          fetchedPagesCount: fetchedPagesCount
+        });
         return _objectSpread(_objectSpread(_objectSpread({}, state), common), {}, {
           bookmark: response.bookmark || null,
           hasMore: response.next !== undefined ? response.next : state.hasMore,
-          count: response.meta && response.meta.count ? response.meta.count : response.data.length,
-          data: updateQueryDataFromResponse(state, response, documents)
+          count: count,
+          fetchedPagesCount: fetchedPagesCount,
+          data: data
         });
       }
 
@@ -371,20 +418,16 @@ var updateData = function updateData(query, newData, documents) {
   // It is also faster than union.
 
   var updatedData = (0, _difference.default)((0, _concat.default)(originalIds, toAdd), toRemove);
-
-  if (query.definition.sort && documents) {
-    var sorter = makeSorterFromDefinition(query.definition);
-    var allDocs = documents[query.definition.doctype];
-    var docs = updatedData.map(function (_id) {
-      return allDocs[_id];
-    });
-    var sortedDocs = sorter(docs);
-    updatedData = sortedDocs.map(_helpers.properId);
-  }
-
+  var count = query.count,
+      fetchedPagesCount = query.fetchedPagesCount;
+  var docsIds = sortAndLimitDocsIds(query, documents, updatedData, {
+    count: count,
+    fetchedPagesCount: fetchedPagesCount
+  });
   return _objectSpread(_objectSpread({}, query), {}, {
-    data: updatedData,
+    data: docsIds,
     count: updatedData.length,
+    fetchedPagesCount: fetchedPagesCount,
     lastUpdate: changed ? Date.now() : query.lastUpdate
   });
 };

package/dist/store/queries.spec.js

@@ -3,7 +3,8 @@ import queries, {
   receiveQueryResult,
   convert$gtNullSelectors,
   makeSorterFromDefinition,
-  mergeSelectorAndPartialIndex
+  mergeSelectorAndPartialIndex,
+  sortAndLimitDocsIds
 } from './queries'
 import { Q } from '../queries/dsl'
 import { TODO_1, TODO_2, TODO_3 } from '../__tests__/fixtures'
@@ -332,3 +333,98 @@ describe('mergeSelectorAndPartialIndex', () => {
     expect(mergeSelectorAndPartialIndex(query)).toMatchObject(result)
   })
 })
+
+describe('sortAndLimitDocsIds', () => {
+  const docs = {
+    'io.cozy.files': {
+      doc1: {
+        _id: 'doc1',
+        name: 'toto'
+      },
+      doc2: {
+        _id: 'doc2',
+        name: 'tata'
+      },
+      doc3: {
+        _id: 'doc3',
+        name: 'tutu'
+      },
+      doc4: {
+        _id: 'doc4',
+        name: 'tutu'
+      }
+    }
+  }
+  it('should return ids as is, when no sort', () => {
+    const query = Q('io.cozy.files')
+    const ids = sortAndLimitDocsIds(
+      { definition: query.toDefinition() },
+      docs,
+      ['doc1', 'doc2', 'doc3'],
+      {
+        count: 0,
+        fetchedPagesCount: 0
+      }
+    )
+    expect(ids).toEqual(['doc1', 'doc2', 'doc3'])
+  })
+  it('should return ids as is, when no documents in the documents slice', () => {
+    const query = Q('io.cozy.files').sortBy([{ name: 'asc' }])
+
+    const ids = sortAndLimitDocsIds(
+      { definition: query.toDefinition() },
+      null,
+      ['doc1', 'doc2', 'doc3'],
+      {
+        count: 0,
+        fetchedPagesCount: 0
+      }
+    )
+    expect(ids).toEqual(['doc1', 'doc2', 'doc3'])
+  })
+  it('should return sorted ids', () => {
+    const query = Q('io.cozy.files').sortBy([{ name: 'asc' }])
+
+    const ids = sortAndLimitDocsIds(
+      { definition: query.toDefinition() },
+      docs,
+      ['doc1', 'doc2', 'doc3'],
+      {
+        count: 3,
+        fetchedPagesCount: 1
+      }
+    )
+    expect(ids).toEqual(['doc2', 'doc1', 'doc3'])
+  })
+  it('should return sorted ids, accordingly to limitBy', () => {
+    const query1 = Q('io.cozy.files')
+      .sortBy([{ name: 'asc' }])
+      .limitBy(2)
+
+    const ids1 = sortAndLimitDocsIds(
+      { definition: query1.toDefinition() },
+      docs,
+      ['doc1', 'doc2', 'doc3'],
+      {
+        count: 2,
+        fetchedPagesCount: 1
+      }
+    )
+    expect(ids1).toEqual(['doc2', 'doc1'])
+
+    const query2 = Q('io.cozy.files')
+      .sortBy([{ name: 'asc' }])
+      .limitBy(1)
+
+    const ids2 = sortAndLimitDocsIds(
+      { definition: query2.toDefinition() },
+      docs,
+      ['doc1', 'doc2', 'doc3'],
+      {
+        count: 1,
+        fetchedPagesCount: 2
+      }
+    )
+    expect(ids2).toEqual(['doc2', 'doc1'])
+  })
+})

package/dist/store.spec.js

@@ -230,6 +230,83 @@ describe('Store', () => {
       ).toBe(FILE_1.label)
     })
 
+    it('should respect the query limit', () => {
+      const query = new Q({
+        doctype: 'io.cozy.todos',
+        limit: 2
+      })
+      let queryResult
+      store.dispatch(initQuery('Q1', query))
+      store.dispatch(initQuery('Q2', query.offset(2)))
+      store.dispatch(
+        receiveQueryResult('Q1', {
+          data: [TODO_1, TODO_2]
+        })
+      )
+      store.dispatch(
+        receiveQueryResult('Q2', {
+          data: [TODO_3, TODO_4]
+        })
+      )
+      // There are now 4 docs in the store
+      expect(
+        Object.keys(store.getState().cozy.documents['io.cozy.todos']).length
+      ).toBe(4)
+      // Q1 and Q2 only returns 2 todos because of the limit
+      queryResult = getQueryFromStore(store, 'Q1')
+      expect(queryResult.data.length).toBe(2)
+      expect(queryResult.data.map(x => x._id)).toEqual(['todo_1', 'todo_2'])
+      queryResult = getQueryFromStore(store, 'Q2')
+      expect(queryResult.data.length).toBe(2)
+      expect(queryResult.data.map(x => x._id)).toEqual(['todo_3', 'todo_4'])
+    })
+
+    it('should respect the query limit with sort', () => {
+      const query = new Q({
+        doctype: 'io.cozy.todos',
+        limit: 2
+      })
+      let queryResult
+      store.dispatch(initQuery('Q1', query.sortBy([{ label: 'asc' }])))
+      store.dispatch(initQuery('Q2', query.sortBy([{ label: 'desc' }])))
+
+      // Labels' ascending order, as defined in fixtures: TODO_3, TODO_1, TODO_4, TODO_2
+      store.dispatch(
+        receiveQueryResult('Q2', {
+          data: [TODO_2, TODO_4]
+        })
+      )
+      store.dispatch(
+        receiveQueryResult('Q1', {
+          data: [TODO_3, TODO_1]
+        })
+      )
+
+      // There are now 4 docs in the store, ordered by their query arrival
+      const todosInStore = store.getState().cozy.documents['io.cozy.todos']
+      expect(Object.values(todosInStore)).toEqual([
+        TODO_2,
+        TODO_4,
+        TODO_3,
+        TODO_1
+      ])
+      // Q1 and Q2 retrieves the todos sorted by label, thanks to the sort in the store
+      queryResult = getQueryFromStore(store, 'Q1')
+      expect(
+        queryResult.data.map(x => ({ _id: x._id, label: x.label }))
+      ).toEqual([
+        { _id: 'todo_3', label: 'Build stuff' },
+        { _id: 'todo_1', label: 'Buy bread' }
+      ])
+      queryResult = getQueryFromStore(store, 'Q2')
+      expect(
+        queryResult.data.map(x => ({ _id: x._id, label: x.label }))
+      ).toEqual([
+        { _id: 'todo_4', label: 'Run a semi-marathon' },
+        { _id: 'todo_2', label: 'Check email' }
+      ])
+    })
+
     describe('deletion', () => {
       let originalWarn
       beforeEach(() => {
@@ -326,6 +403,7 @@ describe('Store', () => {
         lastErrorUpdate: null,
         hasMore: false,
         count: 0,
+        fetchedPagesCount: 0,
         data: null
       })
     })

package/dist/types.js

@@ -67,6 +67,7 @@ var _dsl = require("./queries/dsl");
  * @property {Error} lastError
  * @property {boolean} hasMore
  * @property {number} count
+ * @property {number} fetchedPagesCount
  * @property {object|Array} data
  * @property {string} bookmark
  * @property {object} [execution_stats]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "31.0.1",
+  "version": "32.0.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -18,7 +18,7 @@
     "@types/jest": "^26.0.20",
     "@types/lodash": "^4.14.170",
     "btoa": "^1.2.1",
-    "cozy-stack-client": "^31.0.0",
+    "cozy-stack-client": "^32.0.0",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.13",
     "microee": "^0.0.6",
@@ -73,5 +73,5 @@
     "react-native-ios11-devicecheck": "https://github.com/cozy/react-native-devicecheck#app-attest-v0.1"
   },
   "sideEffects": false,
-  "gitHead": "e989cf8c1f026696b4bf0720f3161067f1166d8b"
+  "gitHead": "d289d3676de1de89d0ff38d659c188319e73c16f"
 }

package/types/store/queries.d.ts

@@ -1,5 +1,9 @@
 export function isQueryAction(action: any): boolean;
 export function isReceivingData(action: any): boolean;
+export function sortAndLimitDocsIds(queryState: QueryState, documents: DocumentsStateSlice, ids: Array<string>, { count, fetchedPagesCount }: {
+    count: number;
+    fetchedPagesCount: number;
+}): Array<string>;
 export function convert$gtNullSelectors(selector: any): object;
 export function mergeSelectorAndPartialIndex(queryDefinition: object): object;
 export function makeSorterFromDefinition(definition: QueryDefinition): (arg0: Array<CozyClientDocument>) => Array<CozyClientDocument>;
@@ -46,6 +50,8 @@ export class QueryIDGenerator {
 export namespace QueryIDGenerator {
     const UNNAMED: string;
 }
+import { QueryState } from "../types";
+import { DocumentsStateSlice } from "../types";
 import { QueryDefinition } from "../queries/dsl";
 import { CozyClientDocument } from "../types";
 /**
@@ -58,4 +64,3 @@ import { CozyClientDocument } from "../types";
 declare function queries(state: QueriesStateSlice, action: object, documents?: DocumentsStateSlice, haveDocumentsChanged?: boolean): QueriesStateSlice;
 import { QueryOptions } from "../types";
 import { QueriesStateSlice } from "../types";
-import { DocumentsStateSlice } from "../types";

package/types/types.d.ts

@@ -41,6 +41,7 @@ export type QueryState = {
     lastError: Error;
     hasMore: boolean;
     count: number;
+    fetchedPagesCount: number;
     data: object | any[];
     bookmark: string;
     execution_stats?: object;