Fixed memory leak in rapid hook arg changing #4268

riqts · 2024-03-12T08:41:16Z

Tests failed in github actions referencing delay not being defined but I am not sure what to do to fix that, I did not add the import for delay, simply referenced it. Any direction for that would be appreciated.

codesandbox · 2024-03-12T08:41:19Z

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders

Open Preview

codesandbox-ci · 2024-03-12T08:43:13Z

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 527a6b7:

Sandbox	Source
rsk-github-issues-example	Configuration
@examples-query-react/basic	Configuration
@examples-query-react/advanced	Configuration
@examples-action-listener/counter	Configuration
rtk-esm-cra	Configuration

netlify · 2024-03-12T08:45:39Z

✅ Deploy Preview for redux-starter-kit-docs ready!

Name	Link
🔨 Latest commit	`527a6b7`
🔍 Latest deploy log	https://app.netlify.com/sites/redux-starter-kit-docs/deploys/65f7a3a92c3c37000803230d
😎 Deploy Preview	https://deploy-preview-4268--redux-starter-kit-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

packages/toolkit/src/query/core/buildMiddleware/cacheCollection.ts

phryneas · 2024-03-12T22:14:13Z

packages/toolkit/src/query/tests/buildHooks.test.tsx

+      fireEvent.click(screen.getByTestId('fetchButton'))
+
+      await act(async () => {
+        await delay(1000)


As that hasn't been defined in this file yet, you'll have to define it somewhere at the top of the file

function delay(ms: number) { return new Promise((resolve) => setTimeout(resolve, ms)) }

I believe you should also just be able to re-use the delay function from msw:

import { delay } from 'msw' await delay(1000)

My confusion here stems from the fact that it IS imported here and the test block directly below it uses it without problem.

Most likely I have just missed something painstakingly obvious, but I added a definition in the test block regardless.

packages/toolkit/src/query/tests/buildHooks.test.tsx

santirodriguezaffonso · 2024-03-15T18:32:37Z

Is this going to be merged someday? 😭

markerikson · 2024-03-15T18:35:12Z

@santirodriguezaffonso : the PR has been up for only 3 days, and we're all busy atm. Please don't beg for things to be merged.

EskiMojo14 · 2024-03-15T18:56:48Z

and in the meantime, you can click on the link in the codesandbox message to use the build that's already published.

packages/toolkit/src/query/core/buildMiddleware/cacheCollection.ts

packages/toolkit/src/query/tests/buildHooks.test.tsx

phryneas · 2024-03-17T17:14:20Z

Mark already said this, but please be a bit more patient.

We are all doing this in our free time, and some things can take days, weeks or even months - it all depends on how many resources we have at any given time, given our day jobs and private lifes we have to balance with voluntary Open Source.

riqts · 2024-03-18T02:17:32Z

Is this going to be merged someday? 😭

@santirodriguezaffonso
Sorry buddy, you are being held back by my poor code quality! I require Lenz to do all the thinking for me, I am just his vessel to add code.

phryneas

No "poor code quality" here - libraries just need different code than applications.
Your code was good from the start, we just have special requirements to keep bundle size down as a library :)

Thank you for the contribution!

) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@reduxjs/toolkit](https://redux-toolkit.js.org) ([source](https://togithub.com/reduxjs/redux-toolkit)) | [`2.2.1` -> `2.2.2`](https://renovatebot.com/diffs/npm/@reduxjs%2ftoolkit/2.2.1/2.2.2) | [![age](https://developer.mend.io/api/mc/badges/age/npm/@reduxjs%2ftoolkit/2.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@reduxjs%2ftoolkit/2.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@reduxjs%2ftoolkit/2.2.1/2.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@reduxjs%2ftoolkit/2.2.1/2.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>reduxjs/redux-toolkit (@reduxjs/toolkit)</summary> ### [`v2.2.2`](https://togithub.com/reduxjs/redux-toolkit/releases/tag/v2.2.2) [Compare Source](https://togithub.com/reduxjs/redux-toolkit/compare/v2.2.1...v2.2.2) This patch release fixes an incorrect build setting for the `legacy-esm` artifacts, and fixes an issue with RTKQ query hooks didn't always remove the cache entries if arguments were changed rapidly. #### Changes ##### `legacy-esm` Artifact Transpilation The `legacy-esm` build artifacts are intended for use by Webpack 4. Those were *supposed* to be transpiled to target `"es2017"`, but were in fact still set to target `"esnext"` - an oversight during the 2.0 development cycle. This release fixes that setting, so those artifacts are now correctly transpiled. ##### Other Fixes RTKQ query hooks now handle additional actions around argument changes that should result in cache entries being removed. Additionally, 2.2.1 contained a fix to an incorrectly named type: `TypedUseMutationTrigger` is now `TypedMutationTrigger`. #### What's Changed - rename TypedUseMutationTrigger to TypedMutationTrigger, and add deprecated alias by [@EskiMojo14](https://togithub.com/EskiMojo14) in [https://github.com/reduxjs/redux-toolkit/pull/4204](https://togithub.com/reduxjs/redux-toolkit/pull/4204) - Fixed memory leak in rapid hook arg changing by [@riqts](https://togithub.com/riqts) in [https://github.com/reduxjs/redux-toolkit/pull/4268](https://togithub.com/reduxjs/redux-toolkit/pull/4268) - Fix incorrect legacy-esm target by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/redux-toolkit/pull/4284](https://togithub.com/reduxjs/redux-toolkit/pull/4284) **Full Changelog**: reduxjs/redux-toolkit@v2.2.0...v2.2.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 4am on Monday" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/coveo/ui-kit).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@reduxjs/toolkit](https://redux-toolkit.js.org) ([source](https://togithub.com/reduxjs/redux-toolkit)) | [`^2.2.1` -> `^2.2.2`](https://renovatebot.com/diffs/npm/@reduxjs%2ftoolkit/2.2.1/2.2.2) | [![age](https://developer.mend.io/api/mc/badges/age/npm/@reduxjs%2ftoolkit/2.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@reduxjs%2ftoolkit/2.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@reduxjs%2ftoolkit/2.2.1/2.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@reduxjs%2ftoolkit/2.2.1/2.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>reduxjs/redux-toolkit (@reduxjs/toolkit)</summary> ### [`v2.2.2`](https://togithub.com/reduxjs/redux-toolkit/releases/tag/v2.2.2) [Compare Source](https://togithub.com/reduxjs/redux-toolkit/compare/v2.2.1...v2.2.2) This patch release fixes an incorrect build setting for the `legacy-esm` artifacts, and fixes an issue with RTKQ query hooks didn't always remove the cache entries if arguments were changed rapidly. #### Changes ##### `legacy-esm` Artifact Transpilation The `legacy-esm` build artifacts are intended for use by Webpack 4. Those were *supposed* to be transpiled to target `"es2017"`, but were in fact still set to target `"esnext"` - an oversight during the 2.0 development cycle. This release fixes that setting, so those artifacts are now correctly transpiled. ##### Other Fixes RTKQ query hooks now handle additional actions around argument changes that should result in cache entries being removed. Additionally, 2.2.1 contained a fix to an incorrectly named type: `TypedUseMutationTrigger` is now `TypedMutationTrigger`. #### What's Changed - rename TypedUseMutationTrigger to TypedMutationTrigger, and add deprecated alias by [@EskiMojo14](https://togithub.com/EskiMojo14) in [https://github.com/reduxjs/redux-toolkit/pull/4204](https://togithub.com/reduxjs/redux-toolkit/pull/4204) - Fixed memory leak in rapid hook arg changing by [@riqts](https://togithub.com/riqts) in [https://github.com/reduxjs/redux-toolkit/pull/4268](https://togithub.com/reduxjs/redux-toolkit/pull/4268) - Fix incorrect legacy-esm target by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/redux-toolkit/pull/4284](https://togithub.com/reduxjs/redux-toolkit/pull/4284) **Full Changelog**: reduxjs/redux-toolkit@v2.2.0...v2.2.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 5pm,every weekend" in timezone America/Los_Angeles, Automerge - "after 5pm,every weekend" in timezone America/Los_Angeles. 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/valora-inc/wallet).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

santirodriguezaffonso · 2024-04-09T16:28:15Z

Thanks guys! You rock 🤟🏻

) [![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [@reduxjs/toolkit](https://redux-toolkit.js.org) ([source](https://togithub.com/reduxjs/redux-toolkit)) | [`^2.2.1` -> `^2.2.2`](https://renovatebot.com/diffs/npm/@reduxjs%2ftoolkit/2.2.1/2.2.2) | [![age](https://developer.mend.io/api/mc/badges/age/npm/@reduxjs%2ftoolkit/2.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/@reduxjs%2ftoolkit/2.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/@reduxjs%2ftoolkit/2.2.1/2.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@reduxjs%2ftoolkit/2.2.1/2.2.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>reduxjs/redux-toolkit (@reduxjs/toolkit)</summary> ### [`v2.2.2`](https://togithub.com/reduxjs/redux-toolkit/releases/tag/v2.2.2) [Compare Source](https://togithub.com/reduxjs/redux-toolkit/compare/v2.2.1...v2.2.2) This patch release fixes an incorrect build setting for the `legacy-esm` artifacts, and fixes an issue with RTKQ query hooks didn't always remove the cache entries if arguments were changed rapidly. #### Changes ##### `legacy-esm` Artifact Transpilation The `legacy-esm` build artifacts are intended for use by Webpack 4. Those were *supposed* to be transpiled to target `"es2017"`, but were in fact still set to target `"esnext"` - an oversight during the 2.0 development cycle. This release fixes that setting, so those artifacts are now correctly transpiled. ##### Other Fixes RTKQ query hooks now handle additional actions around argument changes that should result in cache entries being removed. Additionally, 2.2.1 contained a fix to an incorrectly named type: `TypedUseMutationTrigger` is now `TypedMutationTrigger`. #### What's Changed - rename TypedUseMutationTrigger to TypedMutationTrigger, and add deprecated alias by [@EskiMojo14](https://togithub.com/EskiMojo14) in [https://github.com/reduxjs/redux-toolkit/pull/4204](https://togithub.com/reduxjs/redux-toolkit/pull/4204) - Fixed memory leak in rapid hook arg changing by [@riqts](https://togithub.com/riqts) in [https://github.com/reduxjs/redux-toolkit/pull/4268](https://togithub.com/reduxjs/redux-toolkit/pull/4268) - Fix incorrect legacy-esm target by [@markerikson](https://togithub.com/markerikson) in [https://github.com/reduxjs/redux-toolkit/pull/4284](https://togithub.com/reduxjs/redux-toolkit/pull/4284) **Full Changelog**: reduxjs/redux-toolkit@v2.2.0...v2.2.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 5pm,every weekend" in timezone America/Los_Angeles, Automerge - "after 5pm,every weekend" in timezone America/Los_Angeles. 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/valora-inc/wallet).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

riqts added 2 commits March 12, 2024 19:37

Added unsubscribeHandler for fulfilled/rejected queryThunk

7f85ad8

Added testcase for memory leak listed in github Issues

2a30b3d

riqts marked this pull request as draft March 12, 2024 09:02

Removed unnecessary delay call

a21a873

riqts marked this pull request as ready for review March 12, 2024 09:12

phryneas reviewed Mar 12, 2024

View reviewed changes

packages/toolkit/src/query/core/buildMiddleware/cacheCollection.ts Outdated Show resolved Hide resolved

phryneas reviewed Mar 12, 2024

View reviewed changes

packages/toolkit/src/query/tests/buildHooks.test.tsx Outdated Show resolved Hide resolved

riqts added 3 commits March 13, 2024 13:18

Re-defined delay function and removed Math.random() in favour of i++

43fe3cc

Moved near identical solutions into one conditional

c186225

Reformat for visual clarity

edafc36

phryneas reviewed Mar 17, 2024

View reviewed changes

packages/toolkit/src/query/core/buildMiddleware/cacheCollection.ts Outdated Show resolved Hide resolved

phryneas reviewed Mar 17, 2024

View reviewed changes

packages/toolkit/src/query/tests/buildHooks.test.tsx Show resolved Hide resolved

riqts added 2 commits March 18, 2024 13:06

Added additional check to clearly show resolution of queries

2b186ef

Refactored unsubscribe matching to make better use of type narrowing

527a6b7

riqts requested a review from phryneas March 18, 2024 02:49

phryneas approved these changes Mar 18, 2024

View reviewed changes

phryneas merged commit 128ce81 into reduxjs:master Mar 18, 2024
27 checks passed

Hamed-Ebrahimii mentioned this pull request May 25, 2024

[Snyk] Upgrade @reduxjs/toolkit from 2.1.0 to 2.2.3 Hamed-Ebrahimii/project#32

Open

syedabdullahali mentioned this pull request May 28, 2024

[Snyk] Upgrade @reduxjs/toolkit from 2.0.1 to 2.2.3 harshadashirsat6/Indexia-version-2.0#58

Open

This was referenced Aug 2, 2024

[Snyk] Upgrade @reduxjs/toolkit from 2.0.1 to 2.2.6 zntb/Redux-Counter#2

Merged

[Snyk] Upgrade @reduxjs/toolkit from 2.0.1 to 2.2.6 zntb/ReduxCart#4

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed memory leak in rapid hook arg changing #4268

Fixed memory leak in rapid hook arg changing #4268

riqts commented Mar 12, 2024 •

edited

Loading

codesandbox bot commented Mar 12, 2024

codesandbox-ci bot commented Mar 12, 2024 •

edited

Loading

netlify bot commented Mar 12, 2024 •

edited

Loading

phryneas Mar 12, 2024

aryaemami59 Mar 12, 2024

riqts Mar 13, 2024

santirodriguezaffonso commented Mar 15, 2024

markerikson commented Mar 15, 2024

EskiMojo14 commented Mar 15, 2024

phryneas commented Mar 17, 2024

riqts commented Mar 18, 2024

phryneas left a comment •

edited

Loading

santirodriguezaffonso commented Apr 9, 2024

Fixed memory leak in rapid hook arg changing #4268

Fixed memory leak in rapid hook arg changing #4268

Conversation

riqts commented Mar 12, 2024 • edited Loading

codesandbox bot commented Mar 12, 2024

Review or Edit in CodeSandbox

codesandbox-ci bot commented Mar 12, 2024 • edited Loading

netlify bot commented Mar 12, 2024 • edited Loading

✅ Deploy Preview for redux-starter-kit-docs ready!

phryneas Mar 12, 2024

Choose a reason for hiding this comment

aryaemami59 Mar 12, 2024

Choose a reason for hiding this comment

riqts Mar 13, 2024

Choose a reason for hiding this comment

santirodriguezaffonso commented Mar 15, 2024

markerikson commented Mar 15, 2024

EskiMojo14 commented Mar 15, 2024

phryneas commented Mar 17, 2024

riqts commented Mar 18, 2024

phryneas left a comment • edited Loading

Choose a reason for hiding this comment

santirodriguezaffonso commented Apr 9, 2024

riqts commented Mar 12, 2024 •

edited

Loading

codesandbox-ci bot commented Mar 12, 2024 •

edited

Loading

netlify bot commented Mar 12, 2024 •

edited

Loading

phryneas left a comment •

edited

Loading