Code

useSuspenseQuery#10323

Code

Merged

alessbell merged 159 commits intorelease-3.8apollographql/apollo-client:release-3.8from react-suspenseapollographql/apollo-client:react-suspenseCopy head branch name to clipboardDec 9, 2022

+4,770-19

Commits

Commits on Dec 8, 2022

• fix(regression): avoid calling useQuery onCompleted for cache writes (#10229)

  

  alessbell

  authored and

  jerelmiller

  committed
  a0665ee

• Write the first failing test for useSuspenseQuery

  jerelmiller

  committed
  9d77dd2

• Add extremely basic implementation to get a suspense query working

  jerelmiller

  committed
  9f582ff

• Use MockedProvider for test

  jerelmiller

  committed
  3fd7874

• Add jest-dom for tests

  jerelmiller

  committed
  e6d0f87

• Use toBeInTheDocument matcher for suspense query

  jerelmiller

  committed
  8770c15

• Minor tweak to test name

  jerelmiller

  committed
  ae1e414

• Rename useSuspenseQuery to useSuspenseQuery_experimental

  jerelmiller

  committed
  ce07b6e

• Export useSuspenseQuery

  jerelmiller

  committed
  4c885b6

• Add test to validate suspense works with variables

  jerelmiller

  committed
  79fda62

• Limit result to data and variables for now

  jerelmiller

  committed
  b027aa1

• Skip useSuspenseQuery TODO tests

  jerelmiller

  committed
  74493ef

• Add check to verify document type

  jerelmiller

  committed
  9a46d24

• Add a suspense cache and ensure it checks for it

  jerelmiller

  committed
  44c8810

• Add suspenseCache to MockedProvider

  jerelmiller

  committed
  367343c

• Add ability to resuspend when a query changes variables

  jerelmiller

  committed
  f3d5ab3

• Add a test to verify same variables returns same results

  jerelmiller

  committed
  78e9e6a

• Minor tweak to order of tests

  jerelmiller

  committed
  2bc01da

• Rework suspense cache and implementation a bit

  jerelmiller

  committed
  e1fe389

• Add ability to skip suspense when variables change

  jerelmiller

  committed
  9e67ddf

• Use patch-package to add renderHook to @testing-library/react-12

  jerelmiller

  committed
  e0ce47c

• Use renderHook exported from @testing-library/react

  jerelmiller

  committed
  c92fe71

• Rewrite useSuspenseQuery tests with renderHook

  jerelmiller

  committed
  b3bd05c

• Update suspense query options to a more limited set

  jerelmiller

  committed
  51a4924

• Limit the fetch policies available for useSuspenseQuery

  jerelmiller

  committed
  f8aa4ba

• Update tests to check component resuspends when changing variables for all fetch policies

  jerelmiller

  committed
  c24ed8f

• Create a helper to render base case hook

  jerelmiller

  committed
  dbbc9ba

• Add prettier and config but only for a few files

  jerelmiller

  committed
  60a901b

• Run prettier on allowed files

  jerelmiller

  committed
  4c479c5

• Pin prettier to exact version

  jerelmiller

  committed
  5989879

• Add test to validate fetch is called correct number of times

  jerelmiller

  committed
  afc19bc

• Ensure changing variables suspends properly

  jerelmiller

  committed
  cc1c65d

• Remove sanity check test

  jerelmiller

  committed
  257dd5a

• Minor adjustments to tests

  jerelmiller

  committed
  5822718

• Add ability to re-suspend when changing queries

  jerelmiller

  committed
  9bda93a

• Update name of test to better reflect what its testing

  jerelmiller

  committed
  67a813a

• Remove auto test setup for all fetch policies

  jerelmiller

  committed
  9c474d8

• Add validation to ensure support fetch policy is used

  jerelmiller

  committed
  3e4d95c

• Ensure default fetch policy is used for validation

  jerelmiller

  committed
  7899824

• Simpler test to better focus on its purpose

  jerelmiller

  committed
  def002d

• Better type for renderSuspenseHook

  jerelmiller

  committed
  19779ff

• Add missing DEFAULT_FETCH_POLICY constant

  jerelmiller

  committed
  c17ecc9

• Fix type of previous opts ref

  jerelmiller

  committed
  f844d83

• Fix incorrect test assertion

  jerelmiller

  committed
  bdb8199

• Minor change to order of tests

  jerelmiller

  committed
  838e0ef

• Add test to ensure referential equality is maintained

  jerelmiller

  committed
  c629212

• Add test to validate observable is torn down on unmount

  jerelmiller

  committed
  9e8e2ea

• Ensure suspense cache removes observable when town down

  jerelmiller

  committed
  fa67285

• Add test to validate suspense cache keeps query if used by others

  jerelmiller

  committed
  2f6a9c2

• Ensure useSuspenseQuery works properly with network-only fetch policy

  jerelmiller

  committed
  df25fe1

• Refactor tests to move some of the common test setup into own functions

  jerelmiller

  committed
  3fd11e2

• Add tests to verify no-cache fetch policy works correctly

  jerelmiller

  committed
  654fae8

• Add tests to validate cache-and-network fetch policy works correctly

  jerelmiller

  committed
  6acd59b

• Don't support standby fetch policy for now

  jerelmiller

  committed
  2166ca4

• Add test to verify client can be overridden

  jerelmiller

  committed
  fa037a0

• Add tests to verify cache is written properly

  jerelmiller

  committed
  3ac3792

• Handle when to suspend based on fetch policy and data in the cache

  jerelmiller

  committed
  97a1e78

• Rename opts to watchQueryOptions and use better type

  jerelmiller

  committed
  524d2cb

• More robust test for checking overridden client

  jerelmiller

  committed
  e48f3e4

• More robust way to check how many times a component suspended

  jerelmiller

  committed
  1c1a4a8

• Add ability to only suspend on initial fetch

  jerelmiller

  committed
  274df39

• Add missing imports and missed rename

  jerelmiller

  committed
  047448d

• Add test to verify no-cache maintains result on rerender

  jerelmiller

  committed
  11e9f7d

• Use fetch policy from client default options if available

  jerelmiller

  committed
  df6d041

• Ensure SuspensePolicy type is exported from types

  jerelmiller

  committed
  65169f6

• Add ability to use default variables from client

  jerelmiller

  committed
  0671b79

• Remove unnecessary console.log

  jerelmiller

  committed
  d68f226

• Simplify test that uses custom wrapper

  jerelmiller

  committed
  06753a3

• Add test and implementation to merge global and local variables

  jerelmiller

  committed
  8026019

• Add implementation to make sure variables can be removed

  jerelmiller

  committed
  d21bac5

• Add check to ensure useSuspenseQuery suspends immediately

  jerelmiller

  committed
  18b8538

• Add check to ensure suspense cache is defined

  jerelmiller

  committed
  04a9008

• Minor tweak to test name

  jerelmiller

  committed
  bd0d137

• Add tests to ensure useSuspenseQuery responds to cache updates

  jerelmiller

  committed
  9048d21

• Add test to ensure context is pased to link chain

  jerelmiller

  committed
  b6ffe3f

• Throw errors when the result is an error

  jerelmiller

  committed
  0ad0f8f

• Add react-error-boundary for tests

  jerelmiller

  committed
  3ca8a6e

• Add support for ignore and none error policies

  jerelmiller

  committed
  48834a8

• Better test setup to distinguish between network errors and graphql errors

  jerelmiller

  committed
  f57d899

• Add implementation to work with errorPolicy = "all"

  jerelmiller

  committed
  980ccc5

• Handle GraphQL errors with all error policies

  jerelmiller

  committed
  2339876

• Add error to result checked in tests

  jerelmiller

  committed
  4006da8

• Add tests to ensure partial data results are returned with errors

  jerelmiller

  committed
  2d85acc

• Add test to ensure error is persisted between renders

  jerelmiller

  committed
  cf5c2f5

• Add tests to ensure multiple GraphQL errors are handled

  jerelmiller

  committed
  528fb4d

• Add test to ensure errors are removed when changing variables

  jerelmiller

  committed
  f6e0964

• Add test to ensure canonizeResults works as expected

  jerelmiller

  committed
  cbbbe89

• Bump wait time to help with flaky test

  jerelmiller

  committed
  3d09030

• Add ability to return partial result data from the cache

  jerelmiller

  committed
  1998491

• Add additional supported options to suspense query hook type

  jerelmiller

  committed
  541aaad

• Refactor to use it.each to reduce duplication of some tests

  jerelmiller

  committed
  3b7a87c

• Use client.writeQuery in test since its more synchronous

  jerelmiller

  committed
  f339d3a

• Switch to toMatchObject expectation to check subset of return value

  jerelmiller

  committed
  aa035cb

• Implement refetch ability with useSuspenseQuery

  jerelmiller

  committed
  565c1eb

• Minor tweaks to test setup

  jerelmiller

  committed
  a95a19e

• Add implementation to throw an error after refetch returns error

  jerelmiller

  committed
  db01528

• Add tests to check error behavior when calling refetch

  jerelmiller

  committed
  35354c2

• Add test to validate partial data results for refetch

  jerelmiller

  committed
  f34040f

• Add support for fetchMore with useSuspenseQuery

  jerelmiller

  committed
  13cd91c

• Add test to validate nextFetchPolicy is applied after initial suspense

  jerelmiller

  committed
  49a22aa

• Add tests to verify refetchWritePolicy is honored

  jerelmiller

  committed
  2c5c9ba

• Add test verifying observable is unsubscribed properly

  jerelmiller

  committed
  2125c17

• Ignore useSuspenseQuery tests in React 17

  jerelmiller

  committed
  f7310e5

• Ensure TVariables is passed to TypedDocumentNode in getQuery

  jerelmiller

  committed
  bb24127

• Rename resolved property to fulfilled

  jerelmiller

  committed
  3712a8c

• Check to ensure result for same variables is the same object

  jerelmiller

  committed
  118dd62

• Add test to validate multiple refetches result in suspensions

  jerelmiller

  committed
  8e9d66c

• Allow suspenseCache in renderSuspenseHook helper

  jerelmiller

  committed
  b4d17d1

• Add check of render count on multiple refetch

  jerelmiller

  committed
  4d7fb8c

• Fix issue where a component was rendered before the promise resolved

  jerelmiller

  committed
  5e95086

• Remove variables from the result of useSuspenseQuery

  jerelmiller

  committed
  4b6a63b

• Fix missing import

  jerelmiller

  committed
  c99b30d

• Always run validations in dev

  jerelmiller

  committed
  fb320cd

• Add test to verify observable not over subscribed

  jerelmiller

  committed
  fe322da

• Add fix for rejected promise causing issue with test

  jerelmiller

  committed
  29f3d39

• Simplify suspense cache entry

  jerelmiller

  committed
  2c5d044

• Wrap refetch/fetchMore in act to remove warnings

  jerelmiller

  committed
  ecda316

• Use destructured values in useEffect

  jerelmiller

  committed
  33152ce

• Refactor useDeepMemo into its own hook file

  jerelmiller

  committed
  5852eda

• Add tests for useDeepMemo

  jerelmiller

  committed
  23a2569

• Remove unused import

  jerelmiller

  committed
  1ca9df1

• Simplify condition for setting network status

  jerelmiller

  committed
  57f7ed0

• Use entire watchQueryOptions in useEffect since its used

  jerelmiller

  committed
  993f86d

• Rename ref for clarity

  jerelmiller

  committed
  bd82501

• Extract custom hook for checking whether component is suspended

  jerelmiller

  committed
  72b8014

• Extract custom hook to get watch query options

  jerelmiller

  committed
  9c59615

• Remove old logic for checking suspended ref

  jerelmiller

  committed
  c88be2b

• Move validation to useWatchQueryOptions

  jerelmiller

  committed
  68737fc

• Use destructured value

  jerelmiller

  committed
  87edd05

• Update API for suspense cache

  jerelmiller

  committed
  a1cb546

• Consolidate subscription handlers since they are the same implementation

  jerelmiller

  committed
  968dad9

• Use variable when deleting entry from the suspense cache

  jerelmiller

  committed
  f0b958d

• Fix issue where fetchPolicy was overwritten when using nextFetchPolicy and changing variables

  jerelmiller

  committed
  9cf1658

• Move logic of getting result from observable into own hook

  jerelmiller

  committed
  3f86e7b

• Rename isSuspendedRef to isMountedRef for better clarity

  jerelmiller

  committed
  3f829ca

• Use variable to reduce typing

  jerelmiller

  committed
  b1e2223

• Always remove previous query/variables from suspense cache when they change

  jerelmiller

  committed
  fb2c83a

• Combine effects to remove suspense cache entries

  jerelmiller

  committed
  c7ce42b

• Fix regression on removing cache entry too soon

  jerelmiller

  committed
  f412fc4

• Allow prettier to work on internal hooks

  jerelmiller

  committed
  071d978

• Add test to ensure no network request for cache-first

  jerelmiller

  committed
  cf729e8

• Refactor logic for determining when to suspend

  jerelmiller

  committed
  1154a72

• Update bundle size

  jerelmiller

  committed
  dd9a3c3

• Update snapshot test

  jerelmiller

  committed
  7cd6fc1

• Fix typos in prettierignore

  jerelmiller

  committed
  731a54f

• Remove the check for parent suspense cache in ApolloProvider

  jerelmiller

  committed
  e0f1c97

• Warn when using no-cache fetch policy with returnPartialData

  jerelmiller

  committed
  4ee5a6a

• Add test to ensure cache-first suspends with partial data

  jerelmiller

  committed
  5f13ea6

• Add additional variable to better show intent of logic

  jerelmiller

  committed
  01584d5

• Add option to watchQuery that disables fetch on the first subscription

  jerelmiller

  committed
  13f5f2d

• Make useSuspenseQuery more robust by removing some patch cases by setting fetchOnFirstSubscribe to false

  jerelmiller

  committed
  563d287

• Add comment explaining use of fetchOnFirstSubscribe

  jerelmiller

  committed
  f735657

• Move promise inline

  jerelmiller

  committed
  be9595f

• Add changeset

  jerelmiller

  committed
  ba70c6c

• Update bundlesize

  jerelmiller

  committed
  f4e0ece

• Update package-lock.json

  jerelmiller

  committed
  8a8d454

Commits on Dec 9, 2022

• Fix typos in test comments

  jerelmiller

  committed
  23aa7fa

• Remove inaccurate comment

  jerelmiller

  committed
  5ae7138

• Pin patch-package to a specific version

  jerelmiller

  committed
  5212938