RTK 1.8 and 1.9 planning

[markerikson]

This was originally "1.8 planning", but 1.8 ended up just having the listener middleware. So, keeping the issue around for both.

1.8:

• TS fixes for configureStore and getDefaultMiddleware
• Merge in the listener middleware

Initial notional items for 1.9:

• Drop support for TS < 4.1
• Actual string literal types for createSlice

What else would we want to get in?

Existing milestone: https://github.com/reduxjs/redux-toolkit/milestone/7

Looking through the issues, other candidates:

• Could go in a 1.8.x:
  • Using updateMany in adapter with custom sortComparer ignores several updates with same id  #1853 / Fix #1853 - updateMany on sorted entity adapter #1860
• Probably 1.9:
  • Add upsertQueryData functionality #1720
  • RTK Query - query level customization/normalization of cache key #1668
  • RTKQ feature proposal: Add transformError property to the endpoints #1139
  • Add inferred action creator types #975
  • RFC: add "merge" functionality #1059

For the record, I think this probably ought to be the last feature release before we look at doing RTK 2.0 and dropping IE11 compat ( ref: #958 )

[phryneas]

maybe a cAT.pinTypes/typeFactory thing?

[markerikson]

Unrelated but as a note for later: we should link the RTKQ "Essentials" tutorial pages from the RTKQ "Overview" page:

https://www.reddit.com/r/webdev/comments/sc6eoc/redux_toolkit_query_is_no_one_using_it/

[lindapaiste]

Another docs suggestion (possibly for me to implement): add more info/examples about dealing with errors. In particular, explaining the difference between a fetch error and serialized JavaScript error. https://stackoverflow.com/questions/70899492/redux-toolkit-do-not-send-request-when-query-param-is-invalid/71002555?noredirect=1#comment125554343_71002555

[phryneas]

@lindapaiste that would be a very welcome contribution!

[markerikson]

Throwing this here for lack of anywhere better:

https://www.reddit.com/r/reactjs/comments/q6lit4/thoughts_about_redux_reactquery_together/i0s3f27/

One thing i found that it needs extra config is SSR, if you are planning on doing SSR with something like Next for example, then you need to setup next-redux-wrapper and split your state, and combining reducers with the apiSlice while also supporting a global HYDRATE action to sync up server state with client state was a bit of a pain, we had to set a reducer case for HYDRATE for each slice, which can get big.

RTK Query looks promising but SSR is certainly a bit more painful compared to the "initialData" approach of react-query, one thing i do like is that you can still use endpoints defined within your apiSlice on the server instead of custom fetch functions.

Also a quick note about that, if you are working with a custom api fetch library that handles all your endpoint calls, its a bit hard to integrate that with query builders in RTK Query, RTK Query seems like a great option if you are using axios or fetch to build your data fetching side of the app from the ground. If you have something custom built already around some fetching library to handle your endpoint calls, then you will probably need to work some sort of integration between RTK Query and your library, react-query is a bit more detached from what you end up using as a fetcher.

[phryneas]

We should also deprecate the object notation of extraReducers and createReducer so we can remove it in 2.0.

I did some experiments - while removing is not a problem, deprecating the extraReducers object notation seems impossible. It would require adding a second overload to createSlice and that breaks half the inference (seems to be a TS quirk). So I would suggest deprecating it with a runtime warning in dev instead.

[markerikson]

If @FaberVitale can pull off the Suspense support in #2245 , that would presumably be 1.9 as well.

[FaberVitale]

If @FaberVitale can pull off the Suspense support in #2245 , that would presumably be 1.9 as well.

We need to upgrade react, react-redux, react-dom & @types/react to react 18 versions:

redux-toolkit/package.json

Line 43 in 0050738

"react": "npm:17.0.2",

Are there features in the codebase that need useSyncExternalStore?

IIRC there was an issue with ApiProvider:

redux-toolkit/packages/toolkit/src/query/react/ApiProvider.tsx

Line 48 in 0050738

setupListeners(store.dispatch, props.setupListeners)

[markerikson]

Hmm. That is going to make versioning interesting :)

Given that the rest of RTKQ's features work with any version of React that has hooks... maybe we accept a React peer range of 16.8+, but have a runtime dev check in the suspense functionality that throws an error if it isn't a high enough React version?

Also we may need to update all of our examples and tests to work under React 18 as well.

And yeah, that line in ApiProvider should really be in an effect

[phryneas]

I opened a PR for that ApiProvider bug.

[AlexeiDarmin]

@markerikson @phryneas I've made an additive feature request in #2355 and if 1.8 and 1.9 are possibly going to be the last releases before 2.0 then I'd like to ping y'all to get some priority feedback on it.

I don't know how big of an effort it would be, but if it's a feature that you'd support adding to RTK Query - I'm willing to take a stab at implementing it.

[talatkuyuk]

I have opened a discussion #2361 (comment)

The requested feature : giving an option (optional) in such a way as to skip the automated-invalidation for the last-focused query (only) while setting automated-invalidation in the mutation definition.

toggleFieldOfUser: builder.mutation<boolean, string>({
 query: (id) => ({
    url: `/users/${id}`,
    method: "PUT",
}),
invalidatesTags: cacher.cacheByIdArg("User"),  // <-----------------------  this will remain !
skipAutomatedInvalidationForLastFocusedQuery: true;   // <---------------  additional option (optional)
transformResponse: (result: { success: true }) => result.success,
async onQueryStarted(arg, { dispatch, queryFulfilled, getState }) {
   // manual cache update implementation.  <--- just for the last-focused query, we will deal with ourself
}

[FaberVitale]

If @FaberVitale can pull off the Suspense support in #2245 , that would presumably be 1.9 as well.

We need to upgrade react, react-redux, react-dom & @types/react to react 18 versions:

redux-toolkit/package.json

Line 43 in 0050738

"react": "npm:17.0.2",

The React 18 upgrade is live here: #2409

#2409 is partially for maintenance but it also required for #2245

[FaberVitale]

Created PR #2420

Closes #2395 Pass abort reason of thunk action to AbortController

[markerikson]

Pasting notes from today's triage call:

• Add 'content-type' ResponseHandler #2363: hand-edit weird return logic and merge
• Elaborate on refreshToken examples #2362: we should do more docs edits to show that base queries can accept an object, and equivalence between objects and string URLs
• Re-export cast utility functions from immer #2308: add Immer+TS readonly and castDraft() description to "Usage with Immer" page
• Implement codemods for createReducer and createSlice builder  #2303: Need to move from packages/toolkit/codemod/ to packages/codemod/; also needs a CLI; should be listed in the 2.0 release notes
• add types for manually typing hook results in userland code #2276: show TS example of the typed query hook type
• need to merge next and v1.9-integration together
• going to drop TS <4.1 support
• createSlice: use template literal types for action type #2250: needs rebase and conflict fixes, can merge into 1.9
• retry condition by http error response #2239: needs re-reading for wording checks; add documentation with a use case
• add timeout option to fetchBaseQuery #2143: done, just fix conflicts
• Add possibility to manually unsubscribe from useLazyQuery #2055 #2133: wrong idea; don't want an unsubscribe, instead should have a reset
• feat(query): Adds subscribe option to prefetch, automatically unsubscribes if not present [#1283] #1938: needs reworking; Matt
• feat(meta): Passes meta to result description functions [#1904] #1910: needs docs rewording; Matt
• Add setupListeners example for react-native #1931: needs reworking; Matt
• add transformErrorReponse to rtkq endpoints #1841: needs reworking; Matt

Also, not 1.9 related, but:

• Have some kind of Suspense Cache usage discussion with the React and React Query teams?

[markerikson]

Status notes from Lenz:

• retry condition by http error response #2239 needs a type change to allow for either maxRetries or condition as an argument, but not both - and then remove passing maxRetries into the condition arguments. and maybe another look at the docs

• Fix manually initiate()d rtk-query promises #2187 seems good but might need a conflict resolve and rerun of the tests

• add transformErrorReponse to rtkq endpoints #1841 looks essentially good for merging, but please take another look, four eyes see more than two 🙂

[markerikson]

Afraid I didn't do anything on this for about a month - been playing lots of golf, and work's been busy. But, golf season is coming to an end, and I want to pick this up and push it through soon.

I've got tomorrow free and Monday off, and I intend to focus on RTK 1.9 work.

[markerikson]

Working to collect a list of all the actual PRs that have gone into the 1.9 branch so I can figure out what needs to be documented and how to organize 1.9 release notes, and there's a lot :)

Up to date through #2768 .

The major outstanding code item is #2477 and nailing down an alternative API for getting operation promises. Beyond that we also need updated docs, and the release notes will need to provide instructions on running the codemods. (Probably should put the object reducer deprecation as the very first item in the release notes...)

RTK Query Features

• feature : endpoint-specific args serializers #2493
  • Rework endpoint serializeQueryArgs to allow object/number returns #2835
• RFC: add "merge" functionality #1059
• add transformErrorReponse to rtkq endpoints #1841
• implemented upsertQueryData functionality per #1720 #2007 #2266
  • fix upsertQueryData race situations #2646
  • Fix upsert #2669
• Add forceRefetch to QueryExtraOptions #2663
  • Fix refetches when sQA returns same value and queryArgs are object #2844
• Internal RTKQ rewrites:
  • Batch RTKQ "subscribe on reject" actions, and improve cache collection timer handling #2599
  • Consolidate RTKQ middleware to simplify stack size #2641
  • Fix assorted issues with the RTKQ middleware refactor #2644
  • reset dispatchQueued variable after flushing #2757
  • Speed up subscription behavior by tracking state in middleware #2759
  • Check middleware registration directly to avoid persistence issues #2850
  • Fix "running thunks" types and remove unnecessary RTKQ selectors #2856

RTKQ Minor Changes

• fetchBaseQuery:
  • Add jsonContentType to fetchBaseQuery options #2403
  • add timeout option to fetchBaseQuery #2143
  • Add isJsonContentType predicate to fetchBaseQuery #2331
  • Add 'content-type' ResponseHandler #2363
  • prepareHeaders does not need to return headers any more #2775
  • allow for global responseHandler and validateStatus configuration #2823
• Fix manually initiate()d rtk-query promises #2187
• return promise from query result & hook refetch #2212
• retry condition by http error response #2239
  • Fix retryCondition error. #2743

TS Types and Tweaks

• createSlice: use template literal types for action type #2250
• feat: Add the ability to type StoreEnhancers #2550
• add createAsyncThunk.withTypes #2604
• Try fixing createAsyncThunk issues with TS 4.8 #2643
• Exports:
  • add types for manually typing hook results in userland code #2276
  • RFC: Expose endpoint types #1646
  • Add ThunkMiddleware to the re-exported types from redux-thunk #2451
  • Export the BaseQueryApi interface from rtk-query so it can be used as a type in TypeScript without importing from dist/. #2740
  • fix: export ToolkitStore interface from configureStore #2750

Other

• Add runtime deprecation warning for reducer object notation #2591
  • Implement codemods for createReducer and createSlice builder #2602
  • Add codemods-cli and rewrite "object reducer" codemods #2768

[markerikson]

LIVE!

https://github.com/reduxjs/redux-toolkit/releases/tag/v1.9.0