Skip to content

Commit 89cb1e6

Browse files
author
ismay
committed
chore(use-data-query): list breaking changes
BREAKING CHANGE: If you're using cli-app-scripts, these changes need @dhis2/cli-app-scripts version 7.1.1 or above. Since this is an optional peer-dependency you'll need to ensure you're using the proper version. BREAKING CHANGE: The DataProvider is now a required parent for all components that use the useDataQuery hook. For apps that use the dhis2 app-platform this will be done automatically, but for libraries (and storybook testing) you'll have to do this manually. BREAKING CHANGE: The variables supplied to refetch are not allowed to contain circular references. BREAKING CHANGE: The data and error values will not be cleared during a refetch (this allows for the opt-in stale-while-revalidate). This means that logic that relies on data or error being cleared during a refetch will now behave differently. For example, placing an if condition that checks if there is an error before a condition that checks for loading will now keep showing the error during a refetch, instead of showing the loading spinner. BREAKING CHANGE: There have been issues reported where yarn v1 had trouble installing the correct babel dependencies. For the situations where that occured, deduplicating the yarn.lock resolved the issue. BREAKING CHANGE: There is a rare but unresolved issue where it's possible for the timing in tests to behave differently from the timing in apps. This happens for tests that expect loading to be set to true immediately after calling refetch. Changing such an assertion to an assertion that waits for loading to eventually be true, i.e. @testing-library/react's waitFor(), resolves this issue.
1 parent a0c063e commit 89cb1e6

File tree

0 file changed

+0
-0
lines changed

    0 file changed

    +0
    -0
    lines changed

    0 commit comments

    Comments
     (0)