Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: prevent component re-rendering with the same account snapshot #4229

Merged
merged 5 commits into from
Sep 27, 2024

Conversation

weilliao05621
Copy link
Contributor

In addressing performance issues with a specific React hook, I identified that components using this hook were re-rendering unnecessarily. This was caused by the hook destructuring an object, which created a new reference each time it executed.

// `trackedResult` will always has new reference when the hook executed
 const trackedResult = { ...result }

To optimize this, I use useMemo to wrap the returned object. This change prevents the creation of a new object reference on every execution, ensuring that the object is only recalculated when its dependencies change. As a result, the number of re-renders for components utilizing this hook has significantly decreased.

Screenshots

Have tried the updated version in the project's react playground.

Before

2024-08-27.8.35.24.mov

After

2024-08-27.8.34.09.mov

Copy link

changeset-bot bot commented Aug 27, 2024

🦋 Changeset detected

Latest commit: 47f9c83

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
wagmi Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

vercel bot commented Aug 27, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
wagmi ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 27, 2024 3:10pm

@0x33dm
Copy link

0x33dm commented Sep 10, 2024

Nice catch! i hope this gets merged soon.

@tmm tmm force-pushed the main branch 2 times, most recently from 026feab to 9b7cc38 Compare September 11, 2024 21:57
@tmm
Copy link
Member

tmm commented Sep 16, 2024

Can you post the playground code that demonstrates this behavior or add a test that reproduces?

@weilliao05621
Copy link
Contributor Author

sure! will be working on the test case

@weilliao05621
Copy link
Contributor Author

screenshot for passing unit test

截圖 2024-09-27 下午2 48 30

I also do manual test with the playground:)
Here's the playground code for testing:

const MemoAccount = memo(function (props: {
  store: ReturnType<typeof useAccount>
}) {
  console.log("account update!")
  return <div>{props.store.address}</div>
})

function RerenderWithAccount() {
  const account = useAccount()
  const [count, setCount] = useState<number>(0)

  return (
    <>
      <MemoAccount store={account} />
      <button
        onClick={() => {
          setCount((prev) => prev + 1)
        }}
      >
        Update count: {count}
      </button>
    </>
  )
}

@tmm tmm merged commit c6b8efd into wevm:main Sep 27, 2024
3 of 5 checks passed
Nichebiche added a commit to Nichebiche/wagmi that referenced this pull request Nov 8, 2024
* fix: wevm#4140

* chore: update mipd

* chore: version packages (wevm#4141)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* feat: `useWatchAsset` hook (wevm#4128)

* feat: `useWatchAsset` hook

* test: add tests

* docs: add docs

* nit: use `getConnectorClient`

* fix: types

* test: fix

* test: fix

* test: fix

* chore: tweaks

* chore: changeset

---------

Co-authored-by: Tom Meagher <[email protected]>

* feat(vue): useBytecode (wevm#4145)

* feat: useBytecode

* docs: tweak the composable example for vue

* docs: use missing code highlighting for the TSQ Vue examples

* chore: fix tests

* chore: changeset

---------

Co-authored-by: Skas Merkushin <[email protected]>

* chore: version packages (wevm#4144)

* chore: version packages

* chore: correct version

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Tom Meagher <[email protected]>

* chore: update `@safe-global/safe-apps-sdk` (wevm#4146)

chore: update safe

* chore: version packages (wevm#4147)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* docs: update write-to-contract.md (wevm#4148)

This section talk about minting using tokenId input name but the example code switch to using address as input name

* fix: wevm#4118

* fix: wevm#4150

* chore: format

* close: wevm#4151

* chore: types

* chore: version packages (wevm#4152)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* FIX: useConnectorClient to be enabled only when connected or reconnecting (wevm#4124)

* update enabled param for useConnectorClient and add a test

* bring updated hook

* change set

* apply review

* chore: version packages (wevm#4155)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Update useEstimateGas.md (wevm#4156)

* feat: propagate transport rpc urls to connectors (wevm#4162)

* feat: propagate transport rpc urls to connectors

* tests: update snaps

* chore: tweak changeset

* chore: version packages (wevm#4163)

* chore: version packages

* Update package.json

* Update CHANGELOG.md

* Update version.ts

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: jxom <[email protected]>

* chore: add sponsor

* fix: wevm#4169

* chore: format

* test: chore

* chore: format

* chore: version packages (wevm#4170)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* test: createConfig restore unconfigured chainId

* chore: bump deps

* chore: bump deps

* chore: version packages (wevm#4182)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Update AppKit guide link (wevm#4190)

* fix: wevm#4097

* chore: version packages (wevm#4191)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* feat: validate internal state for persisted chainId

* chore: version packages (wevm#4192)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* chore: gg21

* chore: format

* chore: add sponsor

* docs: tweak

* fix: wevm#4196

* chore: version packages (wevm#4197)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Fixed the wrong input boxes. (wevm#4199)

Removed input boxes with input of Address and Value.
Added input boxes with input of tokenId.

* docs: tweaks

* chore: update ethereum provider to 2.15.0 (wevm#4208)

* chore: update ethereum provider to 2.15.0

* chore: add changeset file

* Update .changeset/neat-pants-care.md

---------

Co-authored-by: awkweb <[email protected]>

* fix: metaMask dappMetadata add default value (wevm#4203)

* fix: add name for mm connector (wevm#4211)

* fix: metaMask dappMetadata add default value

* chore: changeset

---------

Co-authored-by: rich.eth <[email protected]>

* chore: version packages (wevm#4212)

* Update @walletconnect/ethereum-provider to 2.15.1 (wevm#4213)

* chore: update @walletconnect/ethereum-provider to 2.15.1

* chore: ammend changeset to match convention

* chore: version packages (wevm#4214)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* chore: remove gc banner

* chore: sponsors

* chore: sponsor

* chore(connectors): bump wc provider

* chore: version packages (wevm#4232)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* docs: up

* chore: update @walletconnect/ethehreum-provider to version 2.15.3 (wevm#4243)

* chore: updates @walletconnect/ethehreum-provider to version 2.15.3

* Update .changeset/slow-moose-unite.md

---------

Co-authored-by: awkweb <[email protected]>

* test: setup connector

* test: remove

* chore: bump mm sdk (wevm#4251)

* feat: update sdk

* chore: format

* chore: tweaks

* chore: changeset

---------

Co-authored-by: abretonc7s <[email protected]>
Co-authored-by: abretonc7s <[email protected]>
Co-authored-by: abretonc7s <[email protected]>

* chore: version packages (wevm#4250)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* feat(vue): useWatchContractEvent (wevm#4252)

* feat(vue): useWatchContractEvent

* chore: snaps

* test: boost

* chore: format

* chore: tweaks

* chore: version packages (wevm#4253)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* fix: guard (get|use)ConnectorClient when reconnecting (wevm#4259)

* feat: connector client reconnection

* chore: changeset

* chore: snaps

* fix(react,vue): useReadContract deployless reads (wevm#4260)

* fix(react,vue): deployless reads

* chore: changeset

* chore: Update ethereum-provider to version 2.16.1 (wevm#4255)

* chore: update @walletconnect/ethereum-provider to 2.16.1

* chore: add changeset

* Update .changeset/empty-falcons-approve.md

---------

Co-authored-by: awkweb <[email protected]>

* chore: version packages (wevm#4261)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Add experimental actions export to react package (wevm#4262)

* Add experimental actions export to react package

* chore: add vue entrypoint

* chore: changeset

---------

Co-authored-by: Tom Meagher <[email protected]>

* chore: fix exports

* chore: version packages (wevm#4263)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* docs: fix typos (wevm#4264)

* fix typo

* fix typos

* fix typos

* fix typo

* fix typo

* feat: update the 'metamask-sdk' package to version '0.28.4' (wevm#4271)

* feat: update metamask-sdk package to version 0.28.4

* chore: changeset

---------

Co-authored-by: Tom Meagher <[email protected]>

* fix: allow detection of hardhat when using bun (wevm#4224)

* fix: allow detection of hardhat when using bun

- added the user agent check now that bun supports it when finding the package manager
- since bun does not have an ls command similar to the others, we check all installed packaged (--all is needed in monorepos) and check it it contains hardhat

* chore: tweaks

---------

Co-authored-by: Tom Meagher <[email protected]>

* Fix the switchChain error encountered when using the "metaMask" connector (wevm#4227)

* fix: metaMask switchChain

* chore: changeset

---------

Co-authored-by: Tom Meagher <[email protected]>

* chore: version packages (wevm#4278)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* chore: remove duplicate extend in getWalletClient (wevm#4286)

* chore: remove duplicate extend

* chore: changeset

---------

Co-authored-by: Tom Meagher <[email protected]>

* chore: version packages (wevm#4289)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* fix: guard against missing provider.on

* chore: version packages (wevm#4294)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* fix: prevent component re-rendering with the same account snapshot (wevm#4229)

* fix: prevent component re-rendering with the same account snapshot

* test: check component re-rendering caused by useSyncExternalStoreWithTracked

* test: update

* chore: changeset

---------

Co-authored-by: Tom Meagher <[email protected]>

* test: boost coverage

* chore: version packages (wevm#4299)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* Fix race condition in injected.ts (wevm#4207)

* Fix race condition in injected.ts

It can hangs if "once" catches an event with unexpected chainId

* chore: tweaks

---------

Co-authored-by: Tom Meagher <[email protected]>

* chore: version packages (wevm#4300)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* chore: bump dev deps (wevm#4302)

* chore: bump dev deps

* chore: bump vitest

* chore: format

* chore: bump

* chore: tweaks

---------

Co-authored-by: tmm <[email protected]>

* test: up

* test: cov

* chore: format

* test: skip

* chore: bump deps

* chore: snaps

* chore: fix script

* chore: version packages (wevm#4315)

* docs: tweaks

* feat: bump mm sdk (wevm#4337)

* feat: update metamask sdk and implement connectSign

* feat: cleanup

* feat: cleanup

* sdk 0.29.1

* feat: cleanup

* feat: url default

* feat: prevent breaking changes

* feat: cleanup

* chore: tweaks

* chore: tweaks

* chore: format

* chore: changeset

---------

Co-authored-by: abretonc7s <[email protected]>
Co-authored-by: tmm <[email protected]>

* test: snaps

* chore: version packages (wevm#4342)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* chore: bump mm (wevm#4345)

* chore: bump mm sdk

* chore: changeset

* chore: version packages (wevm#4346)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* fix: uniswap wallet trying to make itself look like MetaMask (wevm#4336)

* fix: uniswap wallet trying to make itself look like MetaMask

* chore: changeset

---------

Co-authored-by: Tom Meagher <[email protected]>

* test: mock reconnect

* chore: format

* chore: viem tweaks

* chore: up viem

* chore: up snaps

* fix: MetaMask disconnecting during the connection process. (wevm#4347)

* fix: disconnection during the connection process.

* fix: disconnection during the connection process.

* chore: tweaks

* chore: changeset

* chore: comment

---------

Co-authored-by: Tom Meagher <[email protected]>

* chore: add codeowners

* feat: bump metamask 0.30.0 (wevm#4350)

* feat: bump metamask 0.30.0

* feat: add changeset

* Update .changeset/tasty-clouds-kiss.md

Co-authored-by: awkweb <[email protected]>

* Update .changeset/tasty-clouds-kiss.md

---------

Co-authored-by: awkweb <[email protected]>

* chore: version packages (wevm#4348)

* feat(connectors): filter mipd by connector rdns (wevm#4343)

* feat(connectors): filter mipd by connector rdns

* feat: add connect listeners

* test: boost coverage

* test(core): eip 6963 announce

* test: tweaks

* chore: format

* chore: changeset

* feat: works with ssr flag

* chore: changeset

* chore: tweaks

---------

Co-authored-by: tmm <[email protected]>

* chore: skip

* chore: version packages (wevm#4354)

* chore: version packages

* chore: fix version

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Tom Meagher <[email protected]>

* chore: up version

* chore(core): bump internal deps (wevm#4349)

chore: bump deps

* feat(core): mock defaultConnected

* chore: version packages (wevm#4355)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* test: tweak

* chore: clean up deps (wevm#4357)

* chore: clean up deps

* chore: types

* chore: changeset

* chore: bump deps

* chore: version packages (wevm#4359)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* chore: boost coverage

* ci: protected push

* feat: export type

* chore: version packages (wevm#4361)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* fix: MetaMask readonlyRPCMap type (wevm#4362)

* fix: MetaMask readonlyRPCMap type

* chore: tweaks

* chore: changeset

---------

Co-authored-by: Tom Meagher <[email protected]>

* chore: version packages (wevm#4363)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* test: up

* chore: add sponsor

* docs: bump deps

* chore(cli): bump chokidar (wevm#4370)

* chore: bump chokidar

* chore: fmt

* chore: changeset

---------

Co-authored-by: Tom Meagher <[email protected]>

* chore: version packages (wevm#4378)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* chore: add sponsor

* fix: Safe connector not working in some Vite apps (wevm#4371)

* Fix Safe connector not working in some Vite apps

* Fix Safe connector not working in some Vite apps

* chore: tweaks

---------

Co-authored-by: Tom Meagher <[email protected]>

* fix: waitForTransactionReceipt proper eth_call usage (wevm#4339)

* fix: waitForTransactionReceipt proper eth_call usage

* chore: tweaks

---------

Co-authored-by: Tom Meagher <[email protected]>

* docs(cli/create-wagmi): template selection (wevm#4356)

* docs(cli/create-wagmi): template selection

Explain how to select the template when you don't specify `--template` or `-t`, and what each option means.

* docs: up

---------

Co-authored-by: Tom Meagher <[email protected]>

* chore: snaps

* fix: wevm#4353

* docs: close wevm#4344

* chore: snaps

* chore: version packages (wevm#4380)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* docs: rpc

* fix: wevm#4310

* fix: wevm#4367

* chore: version packages (wevm#4383)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* chore: pnpm catalogs

* chore: tweaks

* chore: bump dependencies (wevm#4385)

* chore: bump dependencies

* Update .changeset/four-pens-collect.md

---------

Co-authored-by: Jake <=>
Co-authored-by: awkweb <[email protected]>

* chore: fix types

* chore: version packages (wevm#4387)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* chore: snaps

* fix: injected connector throws error after switching to a chain that was just added via `'wallet_addEthereumChain'`. (wevm#4311)

* fix: injected connector throwing error after switching to a chain that was just added via `'wallet_addEthereumChain'`.

* chore: changeset

* chore: tweaks

---------

Co-authored-by: Tom Meagher <[email protected]>

* test: tweaks

* chore: version packages (wevm#4388)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

---------

Co-authored-by: Tom Meagher <[email protected]>
Co-authored-by: jxom <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Vladyslav Dalechyn <[email protected]>
Co-authored-by: Skas Merkushin <[email protected]>
Co-authored-by: Samson Adesanoye <[email protected]>
Co-authored-by: tmm <[email protected]>
Co-authored-by: t0rbik <[email protected]>
Co-authored-by: wy <[email protected]>
Co-authored-by: Radek Sienkiewicz <[email protected]>
Co-authored-by: Vedant-asati <[email protected]>
Co-authored-by: tomiir <[email protected]>
Co-authored-by: rich.eth <[email protected]>
Co-authored-by: rich.eth <[email protected]>
Co-authored-by: abretonc7s <[email protected]>
Co-authored-by: abretonc7s <[email protected]>
Co-authored-by: abretonc7s <[email protected]>
Co-authored-by: Łukasz Stankiewicz <[email protected]>
Co-authored-by: omahs <[email protected]>
Co-authored-by: Omri Dan <[email protected]>
Co-authored-by: Roderik van der Veer <[email protected]>
Co-authored-by: 闲尘 <[email protected]>
Co-authored-by: Kevin Ingersoll <[email protected]>
Co-authored-by: Weil Liao <[email protected]>
Co-authored-by: Dmitry Blues <[email protected]>
Co-authored-by: Edouard Bougon <[email protected]>
Co-authored-by: v1rtl <[email protected]>
Co-authored-by: Ice and dust <[email protected]>
Co-authored-by: insomnia.exe <[email protected]>
Co-authored-by: Ori Pomerantz <[email protected]>
Co-authored-by: cb-jake <[email protected]>
Co-authored-by: Eugene Chybisov <[email protected]>
@Nichebiche Nichebiche mentioned this pull request Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants