fix: Support executing queries from store

The `getCollectionFromSlice` helper expects an object
with doctypes as key.
However, the method `this.store.getState()` returns a
larger object such as
`{ cozy: { documents: { [doctype]: ... }, queries: {} }`.

In this case, the `client.getCollectionFromState` method
is more appropriate.

docs/api/cozy-client/README.md

@@ -425,7 +425,7 @@ Generated URL
 
 *Defined in*
 
-packages/cozy-client/src/store/stateHelpers.js:15
+[packages/cozy-client/src/store/stateHelpers.js:15](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/store/stateHelpers.js#L15)
 
 ***
 

packages/cozy-client/src/store/queries.js

@@ -12,11 +12,12 @@ import sift from 'sift'
 
 import flag from 'cozy-flags'
 
-import { getCollectionFromSlice, getDocumentFromSlice } from './documents'
+import { getDocumentFromSlice } from './documents'
 import { isReceivingMutationResult } from './mutations'
 import { properId } from './helpers'
 import { isAGetByIdQuery, QueryDefinition } from '../queries/dsl'
 import logger from '../logger'
+import { getCollectionFromState } from './stateHelpers'
 
 const INIT_QUERY = 'INIT_QUERY'
 const LOAD_QUERY = 'LOAD_QUERY'
@@ -310,12 +311,12 @@ const getSelectorFilterFn = queryDefinition => {
 /**
  * Execute the given query against the document state.
  *
- * @param {import('../types').DocumentsStateSlice} state - The documents state
+ * @param {import('../types').CozyStore} state - The cozy state
  * @param {QueryDefinition} queryDefinition - The query definition to execute
  * @returns {import("../types").QueryStateData} - The returned documents from the query
  */
 export const executeQueryFromState = (state, queryDefinition) => {
-  const documents = getCollectionFromSlice(state, queryDefinition.doctype)
+  const documents = getCollectionFromState(state, queryDefinition.doctype)
   const isSingleObjectResponse = !!queryDefinition.id
   if (!documents) {
     return { data: isSingleObjectResponse ? null : [] }

packages/cozy-client/src/store/queries.spec.js

@@ -696,6 +696,15 @@ describe('execute query from state', () => {
       }
     }
   }
+  const state = {
+    cozy: {
+      documents: {
+        ...docState
+      },
+      queries: {}
+    }
+  }
+
   it('should get the correct filtered results from state thanks to selector', () => {
     const query1 = {
       doctype: 'io.cozy.files',
@@ -705,7 +714,7 @@ describe('execute query from state', () => {
         }
       }
     }
-    const res1 = executeQueryFromState(docState, query1)
+    const res1 = executeQueryFromState(state, query1)
     expect(res1.data.length).toEqual(2)
     expect(res1.data[0]).toEqual(docState['io.cozy.files']['456'])
     expect(res1.data[1]).toEqual(docState['io.cozy.files']['789'])
@@ -716,7 +725,7 @@ describe('execute query from state', () => {
         name: 'well'
       }
     }
-    const res2 = executeQueryFromState(docState, query2)
+    const res2 = executeQueryFromState(state, query2)
     expect(res2.data.length).toEqual(1)
     expect(res2.data[0]).toEqual(docState['io.cozy.files']['123'])
 
@@ -729,7 +738,7 @@ describe('execute query from state', () => {
         name: 'hello'
       }
     }
-    const res3 = executeQueryFromState(docState, query3)
+    const res3 = executeQueryFromState(state, query3)
     expect(res3.data.length).toEqual(1)
     expect(res3.data[0]).toEqual(docState['io.cozy.files']['456'])
 
@@ -742,7 +751,7 @@ describe('execute query from state', () => {
         }
       }
     }
-    const res4 = executeQueryFromState(docState, query4)
+    const res4 = executeQueryFromState(state, query4)
     expect(res4.data.length).toEqual(0)
   })
 
@@ -751,14 +760,14 @@ describe('execute query from state', () => {
       doctype: 'io.cozy.files',
       id: '123'
     }
-    const res1 = executeQueryFromState(docState, query1)
+    const res1 = executeQueryFromState(state, query1)
     expect(res1.data).toEqual(docState['io.cozy.files']['123'])
 
     const query2 = {
       doctype: 'io.cozy.files',
       ids: ['123', '789']
     }
-    const res2 = executeQueryFromState(docState, query2)
+    const res2 = executeQueryFromState(state, query2)
     expect(res2.data.length).toEqual(2)
     expect(res2.data[0]).toEqual(docState['io.cozy.files']['123'])
     expect(res2.data[1]).toEqual(docState['io.cozy.files']['789'])
@@ -767,15 +776,15 @@ describe('execute query from state', () => {
       doctype: 'io.cozy.files',
       id: '-1'
     }
-    const res3 = executeQueryFromState(docState, query3)
+    const res3 = executeQueryFromState(state, query3)
     expect(res3.data).toEqual(null)
   })
 
   it('should get all the docs from state for the doctype when no filter', () => {
     const query1 = {
       doctype: 'io.cozy.files'
     }
-    const res1 = executeQueryFromState(docState, query1)
+    const res1 = executeQueryFromState(state, query1)
     expect(res1.data.length).toEqual(3)
   })
 

packages/cozy-client/src/types.js

@@ -213,6 +213,17 @@ import { QueryDefinition } from './queries/dsl'
  * @property {Boolean} [encrypted] - encrypted value of the field (legacy)
  */
 
+/**
+ * @typedef {object} CozyState
+ * @property {DocumentsStateSlice} documents
+ * @property {QueriesStateSlice} queries
+ */
+
+/**
+ * @typedef {object} CozyStore
+ * @property {CozyState} cozy
+ */
+
 /**
  * @typedef {{
  *   [key: string]: ManifestField;

packages/cozy-client/types/store/queries.d.ts

@@ -6,7 +6,7 @@ export function sortAndLimitDocsIds(queryState: import("../types").QueryState, d
 }): Array<string>;
 export function convert$gtNullSelectors(selector: any): object;
 export function mergeSelectorAndPartialIndex(queryDefinition: object): object;
-export function executeQueryFromState(state: import('../types').DocumentsStateSlice, queryDefinition: QueryDefinition): import("../types").QueryStateData;
+export function executeQueryFromState(state: import('../types').CozyStore, queryDefinition: QueryDefinition): import("../types").QueryStateData;
 export function makeSorterFromDefinition(definition: QueryDefinition): (arg0: Array<import("../types").CozyClientDocument>) => Array<import("../types").CozyClientDocument>;
 export function updateData(query: import("../types").QueryState, newData: Array<import("../types").CozyClientDocument>, documents: import("../types").DocumentsStateSlice): import("../types").QueryState;
 export default queries;

packages/cozy-client/types/types.d.ts

@@ -467,6 +467,13 @@ export type ManifestField = {
      */
     encrypted?: boolean;
 };
+export type CozyState = {
+    documents: DocumentsStateSlice;
+    queries: QueriesStateSlice;
+};
+export type CozyStore = {
+    cozy: CozyState;
+};
 export type ManifestFields = {
     [key: string]: ManifestField;
 };