fix stale props being passed to promiseFn when using watchFn (#181)

fix stale props being passed to promiseFn when using watchFn
async-library · Nov 11, 2019 · 2538607 · 2538607
2 parents 6bf5211 + dffd39f
commit 2538607
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 4 deletions.
diff --git a/packages/react-async/src/specs.js b/packages/react-async/src/specs.js
@@ -286,7 +286,7 @@ export const withPromiseFn = (Async, abortCtrl) => () => {
     expect(abortCtrl.abort).toHaveBeenCalledTimes(1)
   })
 
-  test("re-runs the promise when the value of `watch` changes", () => {
+  test("re-runs the promise with new props when the value of `watch` changes", () => {
     class Counter extends React.Component {
       constructor(props) {
         super(props)
@@ -304,19 +304,31 @@ export const withPromiseFn = (Async, abortCtrl) => () => {
     }
     const promiseFn = jest.fn().mockReturnValue(resolveTo())
     const { getByText } = render(
-      <Counter>{count => <Async promiseFn={promiseFn} watch={count} />}</Counter>
+      <Counter>{count => <Async promiseFn={promiseFn} watch={count} count={count} />}</Counter>
     )
     expect(promiseFn).toHaveBeenCalledTimes(1)
+    expect(promiseFn).toHaveBeenLastCalledWith(
+      expect.objectContaining({ count: 0 }),
+      expect.any(Object)
+    )
     fireEvent.click(getByText("increment"))
     expect(promiseFn).toHaveBeenCalledTimes(2)
+    expect(promiseFn).toHaveBeenLastCalledWith(
+      expect.objectContaining({ count: 1 }),
+      expect.any(Object)
+    )
     expect(abortCtrl.abort).toHaveBeenCalled()
     abortCtrl.abort.mockClear()
     fireEvent.click(getByText("increment"))
     expect(promiseFn).toHaveBeenCalledTimes(3)
+    expect(promiseFn).toHaveBeenLastCalledWith(
+      expect.objectContaining({ count: 2 }),
+      expect.any(Object)
+    )
     expect(abortCtrl.abort).toHaveBeenCalled()
   })
 
-  test("re-runs the promise when `watchFn` returns truthy", () => {
+  test("re-runs the promise with new props when `watchFn` returns truthy", () => {
     class Counter extends React.Component {
       constructor(props) {
         super(props)
@@ -338,11 +350,23 @@ export const withPromiseFn = (Async, abortCtrl) => () => {
       <Counter>{count => <Async promiseFn={promiseFn} watchFn={watchFn} count={count} />}</Counter>
     )
     expect(promiseFn).toHaveBeenCalledTimes(1)
+    expect(promiseFn).toHaveBeenLastCalledWith(
+      expect.objectContaining({ count: 0 }),
+      expect.any(Object)
+    )
     fireEvent.click(getByText("increment"))
     expect(promiseFn).toHaveBeenCalledTimes(1)
+    expect(promiseFn).toHaveBeenLastCalledWith(
+      expect.objectContaining({ count: 0 }),
+      expect.any(Object)
+    )
     expect(abortCtrl.abort).not.toHaveBeenCalled()
     fireEvent.click(getByText("increment"))
     expect(promiseFn).toHaveBeenCalledTimes(2)
+    expect(promiseFn).toHaveBeenLastCalledWith(
+      expect.objectContaining({ count: 2 }),
+      expect.any(Object)
+    )
     expect(abortCtrl.abort).toHaveBeenCalled()
   })
 

diff --git a/packages/react-async/src/useAsync.tsx b/packages/react-async/src/useAsync.tsx
@@ -196,7 +196,10 @@ function useAsync<T extends {}>(
   /* eslint-disable react-hooks/exhaustive-deps */
   const { watch, watchFn } = options
   useEffect(() => {
-    if (watchFn && lastOptions.current && watchFn(options, lastOptions.current)) load()
+    if (watchFn && lastOptions.current && watchFn(options, lastOptions.current)) {
+      lastOptions.current = options
+      load()
+    }
   })
   useEffect(() => {
     lastOptions.current = options