cozy-client 27.3.2 → 27.4.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [27.4.0](https://github.com/cozy/cozy-client/compare/v27.3.2...v27.4.0) (2021-11-25)
+
+
+### Features
+
+* onError Callback ([c5f65d3](https://github.com/cozy/cozy-client/commit/c5f65d33e0ab29a22b409365151173a3b7645b56))
+
+
+
+
+
 ## [27.3.2](https://github.com/cozy/cozy-client/compare/v27.3.1...v27.3.2) (2021-11-17)
 
 

package/dist/CozyClient.js

@@ -128,7 +128,7 @@ var DOC_UPDATE = 'update';
  * @property {boolean} [autoHydrate]
  * @property {object} [oauth]
  * @property {Function} [onTokenRefresh]
- * @property {Function} [onTokenRefresh]
+ * @property {Function} [onError] - Default callback if a query is errored
  * @property  {Link}         [link]   - Backward compatibility
  * @property  {Array<Link>}  [links]  - List of links
  * @property  {object}       [schema] - Schema description for each doctypes
@@ -1276,10 +1276,32 @@ var CozyClient = /*#__PURE__*/function () {
               case 24:
                 _context8.prev = 24;
                 _context8.t0 = _context8["catch"](15);
-                this.dispatch((0, _store.receiveQueryError)(queryId, _context8.t0));
+                this.dispatch((0, _store.receiveQueryError)(queryId, _context8.t0)); // specific onError
+
+                if (!options.onError) {
+                  _context8.next = 31;
+                  break;
+                }
+
+                options.onError(_context8.t0); // defaulted onError
+
+                _context8.next = 36;
+                break;
+
+              case 31:
+                if (!this.options.onError) {
+                  _context8.next = 35;
+                  break;
+                }
+
+                this.options.onError(_context8.t0);
+                _context8.next = 36;
+                break;
+
+              case 35:
                 throw _context8.t0;
 
-              case 28:
+              case 36:
               case "end":
                 return _context8.stop();
             }
@@ -2256,6 +2278,21 @@ var CozyClient = /*#__PURE__*/function () {
         }));
       });
     }
+    /**
+     * At any time put an error function
+     *
+     * @param {Function} [onError] - Set a callback for queries which are errored
+     */
+
+  }, {
+    key: "setOnError",
+    value: function setOnError(onError) {
+      if (this.options && this.options.onError) {
+        throw new Error('On Error is already defined');
+      }
+
+      this.options.onError = onError;
+    }
   }, {
     key: "toJSON",
     value: function toJSON() {
@@ -2415,7 +2452,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 = "27.3.2";
+CozyClient.version = "27.4.0";
 
 _microee.default.mixin(CozyClient);
 

package/dist/CozyClient.spec.js

@@ -162,7 +162,6 @@ describe('CozyClient initialization', () => {
       })
     }
     const client = await CozyClient.fromOldOAuthClient(oldClient)
-    console.log({ stackClient: client.stackClient })
     expect(client.stackClient.uri).toBe(url)
     expect(client.stackClient.oauthOptions.clientID).toBe(oauth.clientID)
     expect(client.stackClient.token.accessToken).toBe(token.accessToken)
@@ -1402,6 +1401,54 @@ describe('CozyClient', () => {
         receiveQueryResult('allTodos', fakeResponse)
       )
     })
+
+    const setupOnError = () => {
+      const error = new TypeError('Failed to fetch')
+      requestHandler.mockReturnValueOnce(Promise.reject(error))
+      const onError = jest.fn().mockReturnValueOnce(() => true)
+      return onError
+    }
+
+    it('should call onError callback when an error is thrown. Callback passed as argument', async () => {
+      const onError = setupOnError()
+
+      await client.query(query, { as: 'allTodos', onError })
+      expect(onError).toBeCalled()
+    })
+
+    it('should call onError callback when an error is catched. It is passed during instantiation', async () => {
+      const onError = setupOnError()
+      const client = new CozyClient({ onError })
+
+      await client.query(query, { as: 'allTodos' })
+      expect(onError).toBeCalled()
+    })
+
+    it('should call onError callback when an error is catched. It is passed with setOnError', async () => {
+      const onError = setupOnError()
+      client.setOnError(onError)
+
+      await client.query(query, { as: 'allTodos' })
+      expect(onError).toBeCalled()
+    })
+
+    it('should throw an error when we call setOnError twice (or several times)', async () => {
+      const client = new CozyClient({})
+      const onError = () => true
+
+      const funcShouldThrow = () => client.setOnError(onError)
+      expect(funcShouldThrow).not.toThrow()
+      expect(funcShouldThrow).toThrow('On Error is already defined')
+    })
+
+    it('should throw an error when there is no onError callback', async () => {
+      const error = new TypeError('Failed to fetch')
+      requestHandler.mockReturnValueOnce(Promise.reject(error))
+
+      await expect(client.query(query, { as: 'allTodos' })).rejects.toThrow(
+        'Failed to fetch'
+      )
+    })
   })
 
   describe('queryAll', () => {

package/dist/hooks/useQuery.js

@@ -25,6 +25,8 @@ var _types = require("../types");
 
 var _context = require("../context");
 
+var _dsl = require("../queries/dsl");
+
 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; }
@@ -41,15 +43,16 @@ var generateFetchMoreQueryDefinition = function generateFetchMoreQueryDefinition
 /**
  * Fetches a queryDefinition and returns the queryState
  *
- * @param  {object} queryDefinition - Definition created with Q()
+ * @param  {QueryDefinition} queryDefinition - Definition created with Q()
  *
- * @param  {object} options - Options
- * @param  {object} options.as - Name for the query [required]
- * @param  {boolean} options.enabled - If set to false, the query won't be executed
- * @param  {object} options.fetchPolicy - Fetch policy
- * @param  {object} options.singleDocData - If true, the "data" returned will be
+ * @typedef {object} UseQueryOptions
+ * @property  {object} as - Name for the query [required]
+ * @property  {boolean} enabled - If set to false, the query won't be executed
+ * @property  {object} fetchPolicy - Fetch policy
+ * @property  {object} singleDocData - If true, the "data" returned will be
  * a single doc instead of an array for single doc queries. Defaults to false for backward
  * compatibility but will be set to true in the future.
+ * @property {Function} onError - Callback if the query is errored
  *
  * @returns {UseQueryReturnValue}
  */

package/dist/hooks/useQuery.spec.jsx

@@ -1,13 +1,20 @@
 import { renderHook } from '@testing-library/react-hooks'
 
+import CozyClient from '../CozyClient'
+import CozyLink from '../CozyLink'
 import useQuery, { useQueries } from './useQuery'
 import { Q } from '../queries/dsl'
 
 import { setupClient, makeWrapper } from '../testing/utils'
 import simpsonsFixture from '../testing/simpsons.json'
 
-const setupQuery = ({ queryDefinition, queryOptions, storeQueries }) => {
-  const client = setupClient({ queries: storeQueries })
+const setupQuery = ({
+  customClient,
+  queryDefinition,
+  queryOptions,
+  storeQueries
+}) => {
+  const client = customClient || setupClient({ queries: storeQueries })
   const hookResult = renderHook(() => useQuery(queryDefinition, queryOptions), {
     wrapper: makeWrapper(client)
   })
@@ -159,6 +166,30 @@ describe('use query', () => {
     expect(lastCallArgs).toMatchObject({ skip: current.data.length })
     expect(fetchMoreResult).toEqual({ data: null })
   })
+
+  it('should call onError callback when an error is thrown. Callback passed as argument', async () => {
+    jest.spyOn(console, 'error').mockImplementation(() => null)
+    const requestHandler = jest.fn()
+    const client = new CozyClient({
+      links: [new CozyLink(requestHandler)]
+    })
+    const error = new TypeError('Failed to fetch')
+    requestHandler.mockReturnValue(Promise.reject(error))
+    const onError = jest.fn().mockReturnValue(() => true)
+    setupQuery({
+      customClient: client,
+      queryOptions: {
+        as: 'fake-query',
+        onError
+      },
+      queryDefinition: () => Q('io.cozy.todos')
+    })
+
+    // TODO find a better alternative
+    setTimeout(() => {
+      expect(onError).toBeCalled()
+    }, 100)
+  })
 })
 
 describe('use queries', () => {

package/dist/types.js

@@ -85,7 +85,8 @@ var _dsl = require("./queries/dsl");
  * @property {string} [as] - Name of the query
  * @property {Function} [fetchPolicy] - Fetch policy to bypass fetching based on what's already inside the state. See "Fetch policies"
  * @property {AutoUpdateOptions} [autoUpdate] - Options for the query auto update
- * @property {string} [options.update] - Does not seem to be used
+ * @property {string} [update] - Does not seem to be used
+ * @property {Function} [onError] - Callback when the query is errored
  */
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-client",
-  "version": "27.3.2",
+  "version": "27.4.0",
   "license": "MIT",
   "main": "dist/index.node.js",
   "browser": "dist/index.js",
@@ -69,5 +69,5 @@
     "react-native-inappbrowser-reborn": "^3.5.1"
   },
   "sideEffects": false,
-  "gitHead": "826f995c85378bdcd76f3a62428c1d9857f0136d"
+  "gitHead": "1ab42dff2e9088f4a3daff29866ad7a22b093791"
 }

package/types/CozyClient.d.ts

@@ -10,6 +10,10 @@ export type ClientOptions = {
     autoHydrate?: boolean;
     oauth?: object;
     onTokenRefresh?: Function;
+    /**
+     * - Default callback if a query is errored
+     */
+    onError?: Function;
     /**
      * - Schema description for each doctypes
      */
@@ -39,7 +43,7 @@ export type ClientOptions = {
  * @property {boolean} [autoHydrate]
  * @property {object} [oauth]
  * @property {Function} [onTokenRefresh]
- * @property {Function} [onTokenRefresh]
+ * @property {Function} [onError] - Default callback if a query is errored
  * @property  {Link}         [link]   - Backward compatibility
  * @property  {Array<Link>}  [links]  - List of links
  * @property  {object}       [schema] - Schema description for each doctypes
@@ -146,6 +150,10 @@ declare class CozyClient {
         autoHydrate?: boolean;
         oauth?: object;
         onTokenRefresh?: Function;
+        /**
+         * - Default callback if a query is errored
+         */
+        onError?: Function;
         /**
          * - If set to false, the client will not instantiate a Redux store automatically. Use this if you want to merge cozy-client's store with your own redux store. See [here](https://docs.cozy.io/en/cozy-client/react-integration/#1b-use-your-own-redux-store) for more information.
          */
@@ -640,6 +648,12 @@ declare class CozyClient {
      * @param {object} data - Data that is inserted in the store. Shape: { doctype: [data] }
      */
     setData(data: object): void;
+    /**
+     * At any time put an error function
+     *
+     * @param {Function} [onError] - Set a callback for queries which are errored
+     */
+    setOnError(onError?: Function): void;
     toJSON(): SnapshotClient;
 }
 declare namespace CozyClient {

package/types/hooks/useQuery.d.ts

@@ -1,24 +1,48 @@
 export function useQueries(querySpecs: any): {};
 export default useQuery;
+/**
+ * Fetches a queryDefinition and returns the queryState
+ */
+export type UseQueryOptions = {
+    /**
+     * - Name for the query [required]
+     */
+    as: object;
+    /**
+     * - If set to false, the query won't be executed
+     */
+    enabled: boolean;
+    /**
+     * - Fetch policy
+     */
+    fetchPolicy: object;
+    /**
+     * - If true, the "data" returned will be
+     * a single doc instead of an array for single doc queries. Defaults to false for backward
+     * compatibility but will be set to true in the future.
+     */
+    singleDocData: object;
+    /**
+     * - Callback if the query is errored
+     */
+    onError: Function;
+};
 /**
  * Fetches a queryDefinition and returns the queryState
  *
- * @param  {object} queryDefinition - Definition created with Q()
+ * @param  {QueryDefinition} queryDefinition - Definition created with Q()
  *
- * @param  {object} options - Options
- * @param  {object} options.as - Name for the query [required]
- * @param  {boolean} options.enabled - If set to false, the query won't be executed
- * @param  {object} options.fetchPolicy - Fetch policy
- * @param  {object} options.singleDocData - If true, the "data" returned will be
+ * @typedef {object} UseQueryOptions
+ * @property  {object} as - Name for the query [required]
+ * @property  {boolean} enabled - If set to false, the query won't be executed
+ * @property  {object} fetchPolicy - Fetch policy
+ * @property  {object} singleDocData - If true, the "data" returned will be
  * a single doc instead of an array for single doc queries. Defaults to false for backward
  * compatibility but will be set to true in the future.
+ * @property {Function} onError - Callback if the query is errored
  *
  * @returns {UseQueryReturnValue}
  */
-declare function useQuery(queryDefinition: object, options: {
-    as: object;
-    enabled: boolean;
-    fetchPolicy: object;
-    singleDocData: object;
-}): UseQueryReturnValue;
+declare function useQuery(queryDefinition: QueryDefinition, options: any): UseQueryReturnValue;
+import { QueryDefinition } from "../queries/dsl";
 import { UseQueryReturnValue } from "../types";

package/types/types.d.ts

@@ -64,6 +64,10 @@ export type QueryOptions = {
      * - Does not seem to be used
      */
     update?: string;
+    /**
+     * - Callback when the query is errored
+     */
+    onError?: Function;
 };
 export type FetchMoreAble = {
     fetchMore: Function;