@dhis2/app-service-data 3.2.5 → 3.2.9

package/build/es/__tests__/mutations.test.js

@@ -1,76 +1,65 @@
-import { render, act, waitFor } from '@testing-library/react';
-import React from 'react';
+import { render, waitFor, act } from '@testing-library/react';
+import * as React from 'react';
 import { CustomDataProvider, DataMutation } from '../react';
-const mockBackend = {
-  target: jest.fn((type, query) => {
-    expect(query.resource).toBe('target');
-    expect(type).toBe('create');
-    expect(query.data).toMatchObject({
-      question: '?'
-    });
-    return Promise.resolve({
-      answer: 42
-    });
-  })
-};
-describe('Test mutations', () => {
-  it('Should call the mock callback', async () => {
-    let doMutation;
-    const renderFunction = jest.fn(([mutate, {
-      called,
-      loading,
-      error,
-      data
-    }]) => {
-      doMutation = mutate;
-      if (!called) return 'uncalled';
-      if (loading) return 'loading';
-      if (error) return /*#__PURE__*/React.createElement("div", null, "error: ", error.message);
-      if (data) return /*#__PURE__*/React.createElement("div", null, "data: ", data.answer);
-    });
-    const testMutation = {
-      resource: 'target',
+describe('<DataMutation />', () => {
+  it('should render without failing', async () => {
+    const endpointSpy = jest.fn(() => Promise.resolve(42));
+    const mutation = {
+      resource: 'answer',
       type: 'create',
       data: {
         question: '?'
       }
     };
-    const {
-      getByText
-    } = render( /*#__PURE__*/React.createElement(CustomDataProvider, {
-      data: mockBackend
-    }, /*#__PURE__*/React.createElement(DataMutation, {
-      mutation: testMutation
-    }, renderFunction)));
-    expect(getByText(/uncalled/i)).not.toBeUndefined();
-    expect(renderFunction).toHaveBeenCalledTimes(1);
-    expect(mockBackend.target).not.toHaveBeenCalled();
-    expect(renderFunction).toHaveBeenLastCalledWith([expect.any(Function), {
+    const data = {
+      answer: endpointSpy
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: data
+    }, children);
+
+    const renderSpy = jest.fn(() => null);
+    render( /*#__PURE__*/React.createElement(DataMutation, {
+      mutation: mutation
+    }, renderSpy), {
+      wrapper
+    });
+    expect(endpointSpy).toHaveBeenCalledTimes(0);
+    expect(renderSpy).toHaveBeenCalledTimes(1);
+    expect(renderSpy).toHaveBeenLastCalledWith([expect.any(Function), expect.objectContaining({
       called: false,
       loading: false,
       engine: expect.any(Object)
-    }]);
-    expect(doMutation).not.toBeUndefined();
-    act(() => {
-      doMutation && doMutation();
+    })]);
+    await act(async () => {
+      const firstRenderSpyCall = renderSpy.mock.calls[0];
+      const firstRenderSpyArgument = firstRenderSpyCall[0];
+      const [mutate] = firstRenderSpyArgument;
+      await mutate();
+    });
+    waitFor(() => {
+      expect(endpointSpy).toHaveBeenCalledTimes(1);
+      expect(renderSpy).toHaveBeenCalledTimes(2);
+      expect(renderSpy).toHaveBeenLastCalledWith([expect.any(Function), expect.objectContaining({
+        called: true,
+        loading: true,
+        engine: expect.any(Object)
+      })]);
+    });
+    waitFor(() => {
+      expect(endpointSpy).toHaveBeenCalledTimes(1);
+      expect(renderSpy).toHaveBeenCalledTimes(3);
+      expect(renderSpy).toHaveBeenLastCalledWith([expect.any(Function), expect.objectContaining({
+        called: true,
+        loading: false,
+        data: {
+          answer: 42
+        },
+        engine: expect.any(Object)
+      })]);
     });
-    expect(renderFunction).toHaveBeenCalledTimes(2);
-    expect(renderFunction).toHaveBeenLastCalledWith([doMutation, {
-      called: true,
-      loading: true,
-      engine: expect.any(Object)
-    }]);
-    expect(mockBackend.target).toHaveBeenCalledTimes(1);
-    await waitFor(() => getByText(/data: /i));
-    expect(renderFunction).toHaveBeenCalledTimes(3);
-    expect(renderFunction).toHaveBeenLastCalledWith([doMutation, {
-      called: true,
-      loading: false,
-      data: {
-        answer: 42
-      },
-      engine: expect.any(Object)
-    }]);
-    expect(getByText(/data: /i)).toHaveTextContent("data: 42");
   });
 });

package/build/es/links/CustomDataLink.js

@@ -23,7 +23,7 @@ export class CustomDataLink {
 
     const customResource = this.data[query.resource];
 
-    if (!customResource) {
+    if (customResource === undefined) {
       if (this.failOnMiss) {
         throw new Error("No data provided for resource type ".concat(query.resource, "!"));
       }

package/build/es/links/RestAPILink/queryToRequestOptions/textPlainMatchers.js

@@ -18,25 +18,32 @@ export const isReplyToMessageConversation = (type, {
 
 export const isCreateFeedbackMessage = (type, {
   resource
-}) => type === 'create' && resource === 'messageConversations/feedback'; // POST or PUT to `interpretations/${objectType}/${id}` (add or update an interpretation)
+}) => type === 'create' && resource === 'messageConversations/feedback'; // POST `interpretations/${objectType}/${id}` (add an interpretation to a visualization)
 
-export const isCreateOrUpdateInterpretation = (type, {
+export const isCreateInterpretation = (type, {
+  resource
+}) => {
+  const pattern = /^interpretations\/(?:reportTable|chart|visualization|map|eventVisualization|eventReport|eventChart|dataSetReport)\/[a-zA-Z0-9]{11}$/;
+  return type === 'create' && pattern.test(resource);
+}; // PUT to `interpretations/${id}` (update an interpretation)
+
+export const isUpdateInterpretation = (type, {
   resource,
   id
 }) => {
-  if (type !== 'create' && type !== 'replace') {
+  if (type !== 'replace') {
     return false;
   }
 
   let resourcePattern;
 
-  if (type === 'replace' && id) {
-    resourcePattern = /^interpretations\/(?:reportTable|chart|visualization|map|eventReport|eventChart|dataSetReport)$/;
+  if (id) {
+    resourcePattern = /^interpretations$/;
     const idPattern = /^[a-zA-Z0-9]{11}$/;
     return resourcePattern.test(resource) && idPattern.test(id);
   }
 
-  resourcePattern = /^interpretations\/(?:reportTable|chart|visualization|map|eventReport|eventChart|dataSetReport)\/[a-zA-Z0-9]{11}$/;
+  resourcePattern = /^interpretations\/[a-zA-Z0-9]{11}$/;
   return resourcePattern.test(resource);
 }; // POST to `interpretations/${id}/comments` (comment on an interpretation)
 

package/build/es/links/RestAPILink/queryToRequestOptions/textPlainMatchers.test.js

@@ -1,4 +1,4 @@
-import { isReplyToMessageConversation, isCreateFeedbackMessage, isCreateOrUpdateInterpretation, isCommentOnInterpretation, isInterpretationCommentUpdate, isAddOrUpdateSystemOrUserSetting, addOrUpdateConfigurationProperty, isMetadataPackageInstallation } from './textPlainMatchers';
+import { isReplyToMessageConversation, isCreateFeedbackMessage, isCreateInterpretation, isUpdateInterpretation, isCommentOnInterpretation, isInterpretationCommentUpdate, isAddOrUpdateSystemOrUserSetting, addOrUpdateConfigurationProperty, isMetadataPackageInstallation } from './textPlainMatchers';
 describe('isReplyToMessageConversation', () => {
   it('retuns true for POST to `messageConversations/${id}`', () => {
     expect(isReplyToMessageConversation('create', {
@@ -23,30 +23,58 @@ describe('isCreateFeedbackMessage', () => {
     })).toEqual(false);
   });
 });
-describe('isCreateOrUpdateInterpretation', () => {
+describe('isCreateInterpretation', () => {
   it('returns true for a POST to "interpretations/chart/${id}"', () => {
-    expect(isCreateOrUpdateInterpretation('create', {
+    expect(isCreateInterpretation('create', {
       resource: 'interpretations/chart/oXD88WWSQpR'
     })).toEqual(true);
   });
-  it('returns true for a PUT to "interpretations/chart/${id}"', () => {
-    expect(isCreateOrUpdateInterpretation('replace', {
+  it('returns false for a PUT to "interpretations/chart/${id}"', () => {
+    expect(isCreateInterpretation('replace', {
       resource: 'interpretations/chart/oXD88WWSQpR'
+    })).toEqual(false);
+  });
+  it('retuns false for PATCH requests with a valid query', () => {
+    expect(isCreateInterpretation('update', {
+      resource: 'interpretations/chart/oXD88WWSQpR'
+    })).toEqual(false);
+  });
+  it('returns false for a request to a different resource', () => {
+    expect(isCreateInterpretation('create', {
+      resource: 'interpretations/dummy/oXD88WWSQpR'
+    })).toEqual(false);
+  });
+});
+describe('isUpdateInterpretation', () => {
+  it('returns true for a PUT to "interpretations/${id}"', () => {
+    expect(isUpdateInterpretation('replace', {
+      resource: 'interpretations/oXD88WWSQpR'
     })).toEqual(true);
   });
   it('returns true for PUT with populated query.id', () => {
-    expect(isCreateOrUpdateInterpretation('replace', {
-      resource: 'interpretations/chart',
+    expect(isUpdateInterpretation('replace', {
+      resource: 'interpretations',
       id: 'oXD88WWSQpR'
     })).toEqual(true);
   });
-  it('retuns false for PATCH requests with a valid query', () => {
-    expect(isCreateOrUpdateInterpretation('update', {
-      resource: 'interpretations/chart/oXD88WWSQpR'
+  it('returns false for a POST to "interpretations/${id}"', () => {
+    expect(isUpdateInterpretation('create', {
+      resource: 'interpretations/oXD88WWSQpR'
+    })).toEqual(false);
+  });
+  it('returns false for a PATCH to "interpretations/${id}"', () => {
+    expect(isUpdateInterpretation('update', {
+      resource: 'interpretations/oXD88WWSQpR'
+    })).toEqual(false);
+  });
+  it('returns false for PATCH with populated query.id', () => {
+    expect(isUpdateInterpretation('update', {
+      resource: 'interpretations',
+      id: 'oXD88WWSQpR'
     })).toEqual(false);
   });
   it('returns false for a request to a different resource', () => {
-    expect(isCreateOrUpdateInterpretation('create', {
+    expect(isUpdateInterpretation('create', {
       resource: 'interpretations/dummy/oXD88WWSQpR'
     })).toEqual(false);
   });

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

@@ -104,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);
@@ -117,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
@@ -129,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