fix unwrapResult behaviour #704
Conversation
|
Deploy preview for redux-starter-kit-docs ready! Built with commit f435f49 https://deploy-preview-704--redux-starter-kit-docs.netlify.app |
|
Ummh, yeah. Not consistent in all TS versions. Taking a look. |
phryneas
force-pushed
the
fix-unwrapResult
branch
from
bd60fab to
96380aa
Compare
| @@ -43,7 +43,9 @@ const commonProperties: Array<keyof SerializedError> = [ | |||
| ] | |||
|
|
|||
| class RejectWithValue<RejectValue> { | |||
| constructor(public readonly value: RejectValue) {} | |||
| public name = 'RejectWithValue' | |||
There was a problem hiding this comment.
The RejectWithValue class now implements the Error interface.
| }, | ||
| SerializedError | ||
| > | ||
| | ReturnType<AsyncThunkFulfilledActionCreator<Returned, ThunkArg>> |
There was a problem hiding this comment.
This seems to have been an oversight when introducing all these types for wrapping. Could remove some duplication.
| error: Error | null, | ||
| requestId: string, | ||
| arg: ThunkArg, | ||
| payload?: RejectedValue |
There was a problem hiding this comment.
The fourth "payload" argument was removed, since RejectWithValue now was the Error shape.
This could cause problems if anyone would have created rejected actions by hand, although this is a pattern we never documented, so I guess this "breaking change" might be okay.
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 66fe742:
|
| } | ||
| return (returned as any).payload | ||
| return action.payload | ||
| } |
There was a problem hiding this comment.
And yeah, this is the actual new behavior as discussed in #704.
|
And for completeness:
|
| test('fulfilled case', async () => { | ||
| const asyncThunk = createAsyncThunk('test', () => { | ||
| return 'fulfilled!' | ||
| }) | ||
|
|
||
| const unwrapPromise = asyncThunk()(dispatch, getState, extra).then( | ||
| unwrapResult | ||
| ) | ||
|
|
||
| await expect(unwrapPromise).resolves.toBe('fulfilled!') | ||
| }) | ||
| test('error case', async () => { | ||
| const error = new Error('Panic!') | ||
| const asyncThunk = createAsyncThunk('test', () => { | ||
| throw error | ||
| }) | ||
|
|
||
| const unwrapPromise = asyncThunk()(dispatch, getState, extra).then( | ||
| unwrapResult | ||
| ) | ||
|
|
||
| await expect(unwrapPromise).rejects.toEqual(miniSerializeError(error)) | ||
| }) | ||
| test('rejectWithValue case', async () => { | ||
| const asyncThunk = createAsyncThunk('test', (_, { rejectWithValue }) => { | ||
| return rejectWithValue('rejectWithValue!') | ||
| }) | ||
|
|
||
| const unwrapPromise = asyncThunk()(dispatch, getState, extra).then( | ||
| unwrapResult | ||
| ) | ||
|
|
||
| await expect(unwrapPromise).rejects.toBe('rejectWithValue!') | ||
| }) |
There was a problem hiding this comment.
And this is the new behaviour in a nutshell.
|
I also updated the docs on Also, I removed a bunch of |
| test('fulfilled case', async () => { | ||
| const asyncThunk = createAsyncThunk('test', () => { | ||
| return 'fulfilled!' | ||
| }) | ||
|
|
||
| const unwrapPromise = asyncThunk()(dispatch, getState, extra).then( | ||
| unwrapResult | ||
| ) | ||
|
|
||
| await expect(unwrapPromise).resolves.toBe('fulfilled!') | ||
| }) | ||
| test('error case', async () => { | ||
| const error = new Error('Panic!') | ||
| const asyncThunk = createAsyncThunk('test', () => { | ||
| throw error | ||
| }) | ||
|
|
||
| const unwrapPromise = asyncThunk()(dispatch, getState, extra).then( | ||
| unwrapResult | ||
| ) | ||
|
|
||
| await expect(unwrapPromise).rejects.toEqual(miniSerializeError(error)) | ||
| }) | ||
| test('rejectWithValue case', async () => { | ||
| const asyncThunk = createAsyncThunk('test', (_, { rejectWithValue }) => { | ||
| return rejectWithValue('rejectWithValue!') | ||
| }) | ||
|
|
||
| const unwrapPromise = asyncThunk()(dispatch, getState, extra).then( | ||
| unwrapResult | ||
| ) | ||
|
|
||
| await expect(unwrapPromise).rejects.toBe('rejectWithValue!') | ||
| }) |
phryneas
force-pushed
the
fix-unwrapResult
branch
from
f435f49 to
66fe742
Compare
|
I'm merging this into a new v1.5.0-integration branch now. |
* Adding requestStatus to createAsyncThunk. * Adding async thunk matchers. * Updating redux-toolkit.api.md. * Again adding redux-toolkit.api.md. * Cleaning up JSDocs. * Fixing actions provided to tests. * Simplifying isAsyncThunkAction. * Moving isAnyAsyncThunkAction into isAsyncThunkAction. * Making isPending/Rejected/Fulfilled HOCs like isAnyAsyncThunk. * Using map instead of loop. * Moving tests for isAnyAsyncThunkAction inside isAsyncThunkAction. * Updating matchers.test.ts. * Adding typetests for existing 4 HOCs. * Updating JSDocs. * Formatting. * Exporting more specific matcher HOCs. * Fixing JSDocs. * Adding isRejectedWithValue based on payload. * Using flag to determine isRejectedWithValue in case payload is falsy. * Renaming flag to rejectedWithValue for consistency with #704. * Fixing previous tests. * Renaming flag to rejectedWithValue for consistency with #704. * Adding tests for isRejectedWithValue. * Moving variable name back due to possible confusing with same named param. And fixing bug. * Formatting. * Updating redux-toolkit.api.md.
This fixes #701 while roughly keeping current behaviour.
@stridera, wanna take a look?
I'll highlight behavioural differences in the code.