-
Notifications
You must be signed in to change notification settings - Fork 468
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(useAsyncStorage): make more robust
- Loading branch information
Showing
5 changed files
with
218 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -61,3 +61,4 @@ buck-out/ | |
|
|
||
| # builds by bob | ||
| lib/ | ||
| coverage | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| /** | ||
| * @format | ||
| */ | ||
| /* eslint-disable no-shadow */ | ||
| import { renderHook, act } from '@testing-library/react-hooks'; | ||
|
|
||
| import AsyncStorage, { useAsyncStorage } from '../src'; | ||
|
|
||
| afterEach(AsyncStorage.clear); | ||
|
|
||
| function expectStableCallbacks(result: any, rerender: () => void) { | ||
| const previousFunctions = Object.values(result.current).filter( | ||
| (item) => typeof item === 'function' | ||
| ); | ||
| rerender(); | ||
| const nowFunctions = Object.values(result.current).filter( | ||
| (item) => typeof item === 'function' | ||
| ); | ||
| expect(nowFunctions).toHaveLength(previousFunctions.length); | ||
| expect(nowFunctions).toEqual(previousFunctions); | ||
| } | ||
|
|
||
| describe('useAsyncStorage', () => { | ||
| it('should export only stable output', async () => { | ||
| const { result, rerender } = renderHook(() => useAsyncStorage('key')); | ||
| expect(result.error).toBeUndefined(); | ||
| expectStableCallbacks(result, rerender); | ||
| }); | ||
|
|
||
| it('can read/write data to/from storage', async () => { | ||
| const newData = Math.floor(Math.random() * 1000).toString(); | ||
| const { result } = renderHook(() => useAsyncStorage('key')); | ||
|
|
||
| await result.current.setItem(newData); | ||
|
|
||
| const data = await result.current.getItem(); | ||
|
|
||
| expect(data).toBe(newData); | ||
| }); | ||
|
|
||
| it('can remove from storage', async () => { | ||
| await AsyncStorage.setItem('key', 'value'); | ||
| const { result } = renderHook(() => useAsyncStorage('key')); | ||
| await act(() => result.current.removeItem()); | ||
| expect(await AsyncStorage.getItem('key')).toBeNull(); | ||
| }); | ||
|
|
||
| it.skip('should throw when mergeItem is not supported', async () => { | ||
| const { result } = renderHook(() => useAsyncStorage('key')); | ||
| const mergeItem = AsyncStorage.mergeItem; | ||
| delete AsyncStorage.mergeItem; | ||
| expect(result.current.mergeItem({})).rejects.toThrow(); | ||
| AsyncStorage.mergeItem = mergeItem; | ||
| }); | ||
|
|
||
| it('can use merge with current data in storage', async () => { | ||
| let originalPerson = { | ||
| name: 'Jerry', | ||
| age: 21, | ||
| characteristics: { | ||
| hair: 'black', | ||
| eyes: 'green', | ||
| }, | ||
| }; | ||
|
|
||
| const { result } = renderHook(() => useAsyncStorage('person')); | ||
|
|
||
| await result.current.setItem(JSON.stringify(originalPerson)); | ||
|
|
||
| originalPerson.name = 'Harry'; | ||
| originalPerson.characteristics.hair = 'red'; | ||
| // @ts-expect-error | ||
| originalPerson.characteristics.shoeSize = 40; | ||
|
|
||
| await result.current.mergeItem(JSON.stringify(originalPerson)); | ||
|
|
||
| const currentPerson = await result.current.getItem(); | ||
| const person = JSON.parse(currentPerson); | ||
|
|
||
| expect(person).toHaveProperty('name', 'Harry'); | ||
| expect(person.characteristics).toHaveProperty('hair', 'red'); | ||
| expect(person.characteristics).toHaveProperty('shoeSize', 40); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,35 @@ | ||
| import React from 'react'; | ||
| import AsyncStorage from './AsyncStorage'; | ||
| import type { AsyncStorageHook } from './types'; | ||
|
|
||
| export function useAsyncStorage(key: string): AsyncStorageHook { | ||
| return { | ||
| getItem: (...args) => AsyncStorage.getItem(key, ...args), | ||
| setItem: (...args) => AsyncStorage.setItem(key, ...args), | ||
| mergeItem: (...args) => | ||
| export function useAsyncStorage(key: string) { | ||
| const getItem = React.useCallback( | ||
| (...args) => AsyncStorage.getItem(key, ...args), | ||
| [key] | ||
| ); | ||
|
|
||
| const setItem = React.useCallback( | ||
| //@ts-ignore | ||
| (...args) => AsyncStorage.setItem(key, ...args), | ||
| [key] | ||
| ); | ||
|
|
||
| const mergeItem = React.useCallback( | ||
| (...args) => | ||
| //@ts-ignore | ||
| AsyncStorage.mergeItem?.(key, ...args) ?? | ||
| Promise.reject('Not implemented'), | ||
| removeItem: (...args) => AsyncStorage.removeItem(key, ...args), | ||
| [key] | ||
| ); | ||
|
|
||
| const removeItem = React.useCallback( | ||
| (...args) => AsyncStorage.removeItem(key, ...args), | ||
| [key] | ||
| ); | ||
|
|
||
| return { | ||
| getItem, | ||
| setItem, | ||
| mergeItem, | ||
| removeItem, | ||
| }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters