fix(persist): fix async migrate on persist middleware (#2877)

* fix(perist): add support for async migrate on persist middleware * feat(vitest): rename vitest.config.ts to vitest.config.mts * fix: fix minor issues * fix: fix minor issues * feat: minor changes * feat: revert vitest changes --------- Co-authored-by: Daishi Kato <[email protected]>
pmndrs · Dec 4, 2024 · 9bae069 · 9bae069
1 parent af7ff21
commit 9bae069
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 10 deletions.
diff --git a/src/middleware/persist.ts b/src/middleware/persist.ts
@@ -258,13 +258,14 @@ const persistImpl: PersistImpl = (config, baseOptions) => (set, get, api) => {
             deserializedStorageValue.version !== options.version
           ) {
             if (options.migrate) {
-              return [
-                true,
-                options.migrate(
-                  deserializedStorageValue.state,
-                  deserializedStorageValue.version,
-                ),
-              ] as const
+              const migration = options.migrate(
+                deserializedStorageValue.state,
+                deserializedStorageValue.version,
+              )
+              if (migration instanceof Promise) {
+                return migration.then((result) => [true, result] as const)
+              }
+              return [true, migration] as const
             }
             console.error(
               `State loaded from storage couldn't be migrated since no migrate function was provided`,

diff --git a/tests/persistAsync.test.tsx b/tests/persistAsync.test.tsx
@@ -193,10 +193,10 @@ describe('persist middleware with async configuration', () => {
     })
   })
 
-  it('can migrate persisted state', async () => {
+  it('can async migrate persisted state', async () => {
     const setItemSpy = vi.fn()
     const onRehydrateStorageSpy = vi.fn()
-    const migrateSpy = vi.fn(() => ({ count: 99 }))
+    const migrateSpy = vi.fn(() => Promise.resolve({ count: 99 }))
 
     const storage = {
       getItem: async () =>

diff --git a/tests/persistSync.test.tsx b/tests/persistSync.test.tsx
@@ -131,7 +131,7 @@ describe('persist middleware with sync configuration', () => {
     expect(onRehydrateStorageSpy2).toBeCalledWith({ count: 42 }, undefined)
   })
 
-  it('can migrate persisted state', () => {
+  it('can non-async migrate persisted state', () => {
     const setItemSpy = vi.fn()
     const onRehydrateStorageSpy = vi.fn()
     const migrateSpy = vi.fn(() => ({ count: 99 }))