fix(atomWithRefresh): non-writable refreshables throw an error if implicitly passed an argument (#2996)

* docs(atomWithRefresh): doesn't refresh with arguments passed

* fix(#2995): error instead of noop when fetch-only refreshable atom's setter is called with args

* Update tests/vanilla/utils/atomWithRefresh.test.ts

* Update test-multiple-builds.yml

* Update test-multiple-builds.yml

* Update test-multiple-builds.yml

---------

Co-authored-by: Daishi Kato <[email protected]>

Author: a10nik

.github/workflows/test-multiple-builds.yml

@@ -30,13 +30,13 @@ jobs:
       - name: Patch for DEV-ONLY
         if: ${{ matrix.env == 'development' }}
         run: |
-          sed -i~ "s/\(it\|describe\)[.a-zA-Z]*('\[DEV-ONLY\]/\1('/" tests/*/*.tsx tests/*/*/*.tsx
-          sed -i~ "s/\(it\|describe\)[.a-zA-Z]*('\[PRD-ONLY\]/\1.skip('/" tests/*/*.tsx tests/*/*/*.tsx
+          sed -i~ "s/\(it\|describe\)[.a-zA-Z]*('\[DEV-ONLY\]/\1('/" tests/*/*.ts* tests/*/*/*.ts*
+          sed -i~ "s/\(it\|describe\)[.a-zA-Z]*('\[PRD-ONLY\]/\1.skip('/" tests/*/*.ts* tests/*/*/*.ts*
       - name: Patch for PRD-ONLY
         if: ${{ matrix.env == 'production' }}
         run: |
-          sed -i~ "s/\(it\|describe\)[.a-zA-Z]*('\PRD-ONLY\]/\1('/" tests/*/*.tsx tests/*/*/*.tsx
-          sed -i~ "s/\(it\|describe\)[.a-zA-Z]*('\[DEV-ONLY\]/\1.skip('/" tests/*/*.tsx tests/*/*/*.tsx
+          sed -i~ "s/\(it\|describe\)[.a-zA-Z]*('\PRD-ONLY\]/\1('/" tests/*/*.ts* tests/*/*/*.ts*
+          sed -i~ "s/\(it\|describe\)[.a-zA-Z]*('\[DEV-ONLY\]/\1.skip('/" tests/*/*.ts* tests/*/*/*.ts*
       - name: Patch for CJS
         if: ${{ matrix.build == 'cjs' }}
         run: |

docs/utilities/resettable.mdx

@@ -198,7 +198,7 @@ const PostsList = () => {
       </ul>
 
       {/* Clicking this button will re-fetch the posts */}
-      <button type="button" onClick={refreshPosts}>
+      <button type="button" onClick={() => refreshPosts()}>
         Refresh posts
       </button>
     </div>

src/vanilla/utils/atomWithRefresh.ts

@@ -39,6 +39,8 @@ export function atomWithRefresh<Value, Args extends unknown[], Result>(
         set(refreshAtom, (c) => c + 1)
       } else if (write) {
         return write(get, set, ...args)
+      } else if (import.meta.env?.MODE !== 'production') {
+        throw new Error('refresh must be called without arguments')
       }
     },
   )

tests/vanilla/utils/atomWithRefresh.test.ts

@@ -0,0 +1,12 @@
+import { describe, expect, it, vi } from 'vitest'
+import { createStore } from 'jotai/vanilla'
+import { atomWithRefresh } from 'jotai/vanilla/utils'
+
+describe('atomWithRefresh', () => {
+  it('[DEV-ONLY] throws when refresh is called with extra arguments', () => {
+    const atom = atomWithRefresh(() => {})
+    const store = createStore()
+    const args = ['some arg'] as unknown as []
+    expect(() => store.set(atom, ...args)).throws()
+  })
+})