[RTK Query] api.util.upsertQueryData not work correctly when has transformResponse

[hieuvuvan]

for example

// http GET /admin/post.json
// response json: {"post": {"id": 123, "title": "the post"}}


type Post = {
  id: number;
  title: string;
}

type PostResponse = {
  post: Post
}

export const api = createApi({
  reducerPath: "api",
  baseQuery: fetchBaseQuery(),
  endpoints: (builder) => ({
    getPost: builder.query<Post, void>({
      query: () => `/admin/post.json`,
      transformResponse: (response: PostResponse) => response.post,
      providesTags: ["post"],
    })
  })
})

// Some where in the app

const updatedPost = {
  id: 123,
  title: "My Post"
}

dispatch(api.util.upsertQueryData("getPost", updatedPost)); // this not work, undefined body dispatch

I see it is breaking change from version 2.6.0, i also comment on the commit

[MrZipper7]

Was coming here to document more or less the same thing. What I found in my case is that if you dispatch an object correctly typed as the response type, then it will run the transformResponse on it and dispatch it correctly to the store.

However, typescript will claim that the object is not typed correctly (i.e. that it needs to be typed as the final type rather than the initial response type.

So in OP's case, this would work correctly:

const updatedPost = {
  "post": {
    "id": 123, 
    "title": "the post"
  }
}

dispatch(api.util.upsertQueryData("getPost", updatedPost));

but there would be a present typescript error of something like:

dispatch(api.util.upsertQueryData("getPost", updatedPost));
                                             ~~~~~~~~~~~
Argument of type [etc] is not assignable to parameter of type 'Post'.

So I guess what I'm not clear on is whether the upserted data is supposed to be the final type and the transformResponse is skipped, or if it should be the response type with the expectation that it will be transformed. Either way, something isn't working correctly.

Based on the code the OP shared, it seems like the intent was for the transformResponse to run, in which case, the main issue is the incorrect expected typing (in addition to the undocumented breaking change).

[nick-lvov-dev]

Having the same issue, I don't know exactly when the transformResponse behavior was changed because I'm sure it didn't use to run before on upsertQueryData. Please fix the types!