@dhis2/app-service-data 3.2.4 → 3.2.8

package/build/es/react/hooks/useDataMutation.test.js

@@ -1,72 +1,337 @@
 import { renderHook, act } from '@testing-library/react-hooks';
-import React from 'react';
+import * as React from 'react';
 import { CustomDataProvider } from '../components/CustomDataProvider';
+import { useDataEngine } from './useDataEngine';
 import { useDataMutation } from './useDataMutation';
-const customData = {
-  answer: 42
-};
-
-const wrapper = ({
-  children
-}) => /*#__PURE__*/React.createElement(CustomDataProvider, {
-  data: customData
-}, children);
-
-const mutation = {
-  type: 'create',
-  resource: 'answer',
-  data: {
-    answer: 42
-  }
-};
-describe('useDataMustation', () => {
-  const originalError = console.error;
-  afterEach(() => {
-    console.error = originalError;
+describe('useDataMutation', () => {
+  it('should render without failing', async () => {
+    const mutation = {
+      type: 'create',
+      resource: 'answer',
+      data: {
+        answer: '?'
+      }
+    };
+    const data = {
+      answer: 42
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: data
+    }, children);
+
+    const {
+      result,
+      waitFor
+    } = renderHook(() => useDataMutation(mutation), {
+      wrapper
+    });
+    const [mutate, beforeMutation] = result.current;
+    expect(beforeMutation).toMatchObject({
+      loading: false,
+      called: false
+    });
+    act(() => {
+      mutate();
+    });
+    await waitFor(() => {
+      const [, duringMutation] = result.current;
+      expect(duringMutation).toMatchObject({
+        loading: true,
+        called: true
+      });
+    });
+    await waitFor(() => {
+      const [, afterMutation] = result.current;
+      expect(afterMutation).toMatchObject({
+        loading: false,
+        called: true,
+        data: 42
+      });
+    });
+  });
+  it('should run immediately with lazy: false', async () => {
+    const mutation = {
+      type: 'create',
+      resource: 'answer',
+      data: {
+        answer: '?'
+      }
+    };
+    const data = {
+      answer: 42
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: data
+    }, children);
+
+    const {
+      result,
+      waitFor
+    } = renderHook(() => useDataMutation(mutation, {
+      lazy: false
+    }), {
+      wrapper
+    });
+    const [, duringMutation] = result.current;
+    expect(duringMutation).toMatchObject({
+      loading: true,
+      called: true
+    });
+    await waitFor(() => {
+      const [, afterMutation] = result.current;
+      expect(afterMutation).toMatchObject({
+        loading: false,
+        called: true,
+        data: 42
+      });
+    });
   });
-  it('Should render without failing', async () => {
-    let hookState;
-    console.error = jest.fn();
+  it('should call onComplete on success', async () => {
+    const onComplete = jest.fn();
+    const mutation = {
+      type: 'create',
+      resource: 'answer',
+      data: {
+        answer: '?'
+      }
+    };
+    const data = {
+      answer: 42
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: data
+    }, children);
+
+    const {
+      result,
+      waitFor
+    } = renderHook(() => useDataMutation(mutation, {
+      onComplete
+    }), {
+      wrapper
+    });
+    expect(onComplete).toHaveBeenCalledTimes(0);
+    const [mutate] = result.current;
     act(() => {
-      hookState = renderHook(() => useDataMutation(mutation), {
-        wrapper
+      mutate();
+    });
+    await waitFor(() => {
+      const [, state] = result.current;
+      expect(state).toMatchObject({
+        loading: false,
+        called: true,
+        data: 42
       });
+      expect(onComplete).toHaveBeenCalledTimes(1);
+      expect(onComplete).toHaveBeenLastCalledWith(42);
     });
-    let [mutate, state] = hookState.result.current;
-    expect(state).toMatchObject({
-      called: false,
-      loading: false
+  });
+  it('should call onError on error', async () => {
+    const error = new Error('Something went wrong');
+    const onError = jest.fn();
+    const mutation = {
+      type: 'create',
+      resource: 'answer',
+      data: {
+        answer: 42
+      }
+    };
+    const data = {
+      answer: () => {
+        throw error;
+      }
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: data
+    }, children);
+
+    const {
+      result,
+      waitFor
+    } = renderHook(() => useDataMutation(mutation, {
+      onError
+    }), {
+      wrapper
     });
+    expect(onError).toHaveBeenCalledTimes(0);
+    const [mutate] = result.current;
     act(() => {
       mutate();
     });
-    mutate = hookState.result.current[0];
-    state = hookState.result.current[1];
-    expect(state).toMatchObject({
-      called: true,
-      loading: true
+    await waitFor(() => {
+      const [, state] = result.current;
+      expect(state).toMatchObject({
+        loading: false,
+        called: true,
+        error
+      });
     });
+    expect(onError).toHaveBeenCalledTimes(1);
+    expect(onError).toHaveBeenLastCalledWith(error);
   });
-  it('Should run immediately with lazy: false', async () => {
-    let hookState;
-    console.error = jest.fn();
+  it('should resolve variables', async () => {
+    const mutation = {
+      type: 'update',
+      resource: 'answer',
+      id: ({
+        id
+      }) => id,
+      data: {
+        answer: '?'
+      }
+    };
+    const answerSpy = jest.fn(() => 42);
+    const data = {
+      answer: answerSpy
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: data
+    }, children);
+
+    const {
+      result,
+      waitFor
+    } = renderHook(() => useDataMutation(mutation, {
+      lazy: false,
+      variables: {
+        id: '1'
+      }
+    }), {
+      wrapper
+    });
+    await waitFor(() => {
+      expect(answerSpy).toHaveBeenLastCalledWith(expect.any(String), expect.objectContaining({
+        id: '1'
+      }), expect.any(Object));
+    });
+    const [mutate] = result.current;
     act(() => {
-      hookState = renderHook(() => useDataMutation(mutation, {
-        lazy: false
-      }), {
-        wrapper
+      mutate({
+        id: '2'
       });
     });
-    let [, state] = hookState.result.current;
-    expect(state).toMatchObject({
-      called: true,
-      loading: true
+    await waitFor(() => {
+      expect(answerSpy).toHaveBeenLastCalledWith(expect.any(String), expect.objectContaining({
+        id: '2'
+      }), expect.any(Object));
     });
-    await hookState.waitForNextUpdate();
-    state = hookState.result.current[1];
+  });
+  it('should return a reference to the engine', async () => {
+    const mutation = {
+      type: 'create',
+      resource: 'answer',
+      data: {
+        answer: '?'
+      }
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: {}
+    }, children);
+
+    const engineHook = renderHook(() => useDataEngine(), {
+      wrapper
+    });
+    const mutationHook = renderHook(() => useDataMutation(mutation), {
+      wrapper
+    });
+    /**
+     * Ideally we'd check referential equality here with .toBe, but since
+     * both hooks run in a different context that doesn't work.
+     */
+
+    expect(mutationHook.result.current[1].engine).toStrictEqual(engineHook.result.current);
+  });
+  it('should return a stable mutate function', async () => {
+    const mutation = {
+      type: 'create',
+      resource: 'answer',
+      data: {
+        answer: '?'
+      }
+    };
+    const data = {
+      answer: 42
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: data
+    }, children);
+
+    const {
+      result
+    } = renderHook(() => useDataMutation(mutation), {
+      wrapper
+    });
+    const [firstMutate] = result.current;
+    await act(async () => {
+      await firstMutate({
+        variable: 'variable'
+      });
+    });
+    const [secondMutate, state] = result.current;
     expect(state).toMatchObject({
       loading: false,
-      data: 42
+      called: true
+    });
+    expect(firstMutate).toBe(secondMutate);
+  });
+  it('should resolve with the data from mutate on success', async () => {
+    const mutation = {
+      type: 'create',
+      resource: 'answer',
+      data: {
+        answer: '?'
+      }
+    };
+    const data = {
+      answer: 42
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: data
+    }, children);
+
+    const {
+      result,
+      waitFor
+    } = renderHook(() => useDataMutation(mutation), {
+      wrapper
+    });
+    let mutatePromise;
+    const [mutate] = result.current;
+    act(() => {
+      mutatePromise = mutate();
+    });
+    await waitFor(() => {
+      const [, state] = result.current;
+      expect(state).toMatchObject({
+        loading: false,
+        called: true,
+        data: 42
+      });
+      expect(mutatePromise).resolves.toBe(42);
     });
   });
 });

package/build/es/react/hooks/useDataQuery.js

@@ -1,4 +1,4 @@
-import { useState, useRef } from 'react';
+import { useState, useRef, useCallback } from 'react';
 import { useQuery, setLogger } from 'react-query';
 import { stableVariablesHash } from './stableVariablesHash';
 import { useDataEngine } from './useDataEngine';
@@ -84,9 +84,13 @@ export const useDataQuery = (query, {
   /**
    * Refetch allows a user to update the variables or just
    * trigger a refetch of the query with the current variables.
+   *
+   * We're using useCallback to make the identity of the function
+   * as stable as possible, so that it won't trigger excessive
+   * rerenders when used for side-effects.
    */
 
-  const refetch = newVariables => {
+  const refetch = useCallback(newVariables => {
     /**
      * If there are no updates that will trigger an automatic refetch
      * we'll need to call react-query's refetch directly
@@ -100,10 +104,6 @@ export const useDataQuery = (query, {
       }) => data);
     }
 
-    if (!enabled) {
-      setEnabled(true);
-    }
-
     if (newVariables) {
       // Use cached hash if it exists
       const currentHash = variablesHash.current || stableVariablesHash(variables);
@@ -113,8 +113,11 @@ export const useDataQuery = (query, {
       const mergedHash = stableVariablesHash(mergedVariables);
       const identical = currentHash === mergedHash;
 
-      if (identical) {
-        // If the variables are identical we'll need to trigger the refetch manually
+      if (identical && enabled) {
+        /**
+         * If the variables are identical and the query is enabled
+         * we'll need to trigger the refetch manually
+         */
         return queryRefetch({
           cancelRefetch: true,
           throwOnError: false
@@ -125,6 +128,11 @@ export const useDataQuery = (query, {
         variablesHash.current = mergedHash;
         setVariables(mergedVariables);
       }
+    } // Enable the query after the variables have been set to prevent extra request
+
+
+    if (!enabled) {
+      setEnabled(true);
     } // This promise does not currently reject on errors
 
 
@@ -133,13 +141,12 @@ export const useDataQuery = (query, {
         resolve(data);
       };
     });
-  };
+  }, [enabled, queryRefetch, variables]);
   /**
    * react-query returns null or an error, but we return undefined
    * or an error, so this ensures consistency with the other types.
    */
 
-
   const ourError = error || undefined;
   return {
     engine,

package/build/es/react/hooks/useDataQuery.test.js

@@ -497,6 +497,149 @@ describe('useDataQuery', () => {
     });
   });
   describe('return values: refetch', () => {
+    it('Should only trigger a single request when refetch is called on a lazy query with new variables', async () => {
+      const spy = jest.fn((type, query) => {
+        if (query.id === '1') {
+          return 42;
+        }
+
+        return 0;
+      });
+      const data = {
+        answer: spy
+      };
+      const query = {
+        x: {
+          resource: 'answer',
+          id: ({
+            id
+          }) => id
+        }
+      };
+
+      const wrapper = ({
+        children
+      }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+        data: data
+      }, children);
+
+      const {
+        result,
+        waitFor
+      } = renderHook(() => useDataQuery(query, {
+        lazy: true
+      }), {
+        wrapper
+      });
+      expect(spy).not.toHaveBeenCalled();
+      act(() => {
+        result.current.refetch({
+          id: '1'
+        });
+      });
+      await waitFor(() => {
+        expect(result.current).toMatchObject({
+          loading: false,
+          called: true,
+          data: {
+            x: 42
+          }
+        });
+      });
+      expect(spy).toHaveBeenCalledTimes(1);
+    });
+    it('Should only trigger a single request when refetch is called on a lazy query with identical variables', async () => {
+      const spy = jest.fn((type, query) => {
+        if (query.id === '1') {
+          return 42;
+        }
+
+        return 0;
+      });
+      const data = {
+        answer: spy
+      };
+      const query = {
+        x: {
+          resource: 'answer',
+          id: ({
+            id
+          }) => id
+        }
+      };
+
+      const wrapper = ({
+        children
+      }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+        data: data
+      }, children);
+
+      const {
+        result,
+        waitFor
+      } = renderHook(() => useDataQuery(query, {
+        lazy: true,
+        variables: {
+          id: '1'
+        }
+      }), {
+        wrapper
+      });
+      expect(spy).not.toHaveBeenCalled();
+      act(() => {
+        result.current.refetch({
+          id: '1'
+        });
+      });
+      await waitFor(() => {
+        expect(result.current).toMatchObject({
+          loading: false,
+          called: true,
+          data: {
+            x: 42
+          }
+        });
+      });
+      expect(spy).toHaveBeenCalledTimes(1);
+    });
+    it('Should have a stable identity if the variables have not changed', async () => {
+      const data = {
+        answer: () => 42
+      };
+      const query = {
+        x: {
+          resource: 'answer'
+        }
+      };
+
+      const wrapper = ({
+        children
+      }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+        data: data
+      }, children);
+
+      const {
+        result,
+        waitForNextUpdate,
+        rerender
+      } = renderHook(() => useDataQuery(query), {
+        wrapper
+      });
+      const firstRefetch = result.current.refetch;
+      await waitForNextUpdate();
+      act(() => {
+        result.current.refetch();
+        /**
+         * FIXME: https://github.com/tannerlinsley/react-query/issues/2481
+         * This forced rerender is not necessary in the app, just when testing.
+         * It is unclear why.
+         */
+
+        rerender();
+      });
+      await waitForNextUpdate();
+      expect(result.current.refetch).toBe(firstRefetch);
+    });
     it('Should return stale data and set loading to true on refetch', async () => {
       const answers = [42, 43];
       const mockSpy = jest.fn(() => Promise.resolve(answers.shift()));

package/build/types/links/RestAPILink/queryToRequestOptions/textPlainMatchers.d.ts

@@ -1,7 +1,8 @@
 import { ResolvedResourceQuery, FetchType } from '../../../engine';
 export declare const isReplyToMessageConversation: (type: FetchType, { resource }: ResolvedResourceQuery) => boolean;
 export declare const isCreateFeedbackMessage: (type: FetchType, { resource }: ResolvedResourceQuery) => boolean;
-export declare const isCreateOrUpdateInterpretation: (type: FetchType, { resource, id }: ResolvedResourceQuery) => boolean;
+export declare const isCreateInterpretation: (type: FetchType, { resource }: ResolvedResourceQuery) => boolean;
+export declare const isUpdateInterpretation: (type: FetchType, { resource, id }: ResolvedResourceQuery) => boolean;
 export declare const isCommentOnInterpretation: (type: FetchType, { resource }: ResolvedResourceQuery) => boolean;
 export declare const isInterpretationCommentUpdate: (type: FetchType, { resource, id }: ResolvedResourceQuery) => boolean;
 export declare const isAddOrUpdateSystemOrUserSetting: (type: FetchType, { resource }: ResolvedResourceQuery) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dhis2/app-service-data",
-    "version": "3.2.4",
+    "version": "3.2.8",
     "main": "./build/cjs/index.js",
     "module": "./build/es/index.js",
     "types": "build/types/index.d.ts",
@@ -22,7 +22,7 @@
         "build/**"
     ],
     "peerDependencies": {
-        "@dhis2/app-service-config": "3.2.4",
+        "@dhis2/app-service-config": "3.2.8",
         "@dhis2/cli-app-scripts": "^7.1.1",
         "prop-types": "^15.7.2",
         "react": "^16.8",