-
Notifications
You must be signed in to change notification settings - Fork 54
feat(grpc): gracefully handle subscription network error #509
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@dojoengine/grpc": patch | ||
| --- | ||
|
|
||
| feat(grpc): gracefully handle subscription network error |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,68 @@ | ||
| import { StrictMode, useEffect, useState } from "react"; | ||
| import { StrictMode, useCallback, useEffect, useState } from "react"; | ||
| import { createRoot } from "react-dom/client"; | ||
|
|
||
| import App from "./App"; | ||
| import { DojoProvider } from "@dojoengine/core"; | ||
| import manifest from "../../../core/manifest_dev.json" with { type: "json" }; | ||
| import { createDojoConfig } from "@dojoengine/core"; | ||
| const dojoConfig = createDojoConfig({ manifest: manifest }); | ||
| import { init, KeysClause, ToriiQueryBuilder } from "@dojoengine/sdk"; | ||
| import { Subscription } from "@dojoengine/grpc"; | ||
| import { constants } from "starknet"; | ||
|
|
||
| import manifest from "./manifest_sepolia.json" with { type: "json" }; | ||
| const dojoConfig = createDojoConfig({ | ||
| manifest: manifest, | ||
| toriiUrl: "https://api.cartridge.gg/x/nums-bal/torii", | ||
| }); | ||
|
|
||
| function Root({ sdk }) { | ||
| const [sub, setSub] = useState<Subscription | null>(null); | ||
|
|
||
| const subscription = useCallback(async () => { | ||
| return await sdk.subscribeEntityQuery({ | ||
| query: new ToriiQueryBuilder().withClause( | ||
| KeysClause([], [], "VariableLen").build() | ||
| ), | ||
| callback: ({ data, error }) => { | ||
| console.log(data, error); | ||
| }, | ||
| }); | ||
| }, [sdk]); | ||
| useEffect(() => { | ||
| subscription().then(([data, sub]) => setSub(sub)); | ||
| return () => { | ||
| if (sub) { | ||
| sub.cancel(); | ||
| } | ||
| }; | ||
| }, [sdk]); | ||
|
|
||
| function Root() { | ||
| const provider = new DojoProvider(dojoConfig.manifest); | ||
| return <div>Hello Dojo</div>; | ||
| } | ||
|
|
||
| const container = document.getElementById("root"); | ||
| if (!container) { | ||
| throw new Error("Root element not found"); | ||
| async function main() { | ||
| const sdk = await init({ | ||
| client: { | ||
| toriiUrl: dojoConfig.toriiUrl, | ||
| worldAddress: dojoConfig.manifest.world.address, | ||
| }, | ||
| domain: { | ||
| name: "nums", | ||
| version: "1.0", | ||
| chainId: constants.StarknetChainId.SN_SEPOLIA, | ||
| revision: "1", | ||
| }, | ||
| }); | ||
|
|
||
| const container = document.getElementById("root"); | ||
| if (!container) { | ||
| throw new Error("Root element not found"); | ||
| } | ||
|
|
||
| createRoot(container).render( | ||
| <StrictMode> | ||
| <Root sdk={sdk} /> | ||
| </StrictMode> | ||
| ); | ||
| } | ||
|
|
||
| createRoot(container).render( | ||
| <StrictMode> | ||
| <Root /> | ||
| </StrictMode> | ||
| ); | ||
| main().catch(console.error); | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
Effect cleanup never sees the latest subscription; leads to leaked subscriptions
In
Root,subis stored in state but not included in theuseEffectdependency array, so the cleanup function always captures the initialsubvalue (null) and never cancels the actual subscription. This can leave the grpc subscription running after unmount or re‑render.A simple fix is to keep the subscription in a ref and drive the effect off the memoized subscribe function instead of state:
This ensures the most recent subscription is always cancelled on cleanup and avoids re‑subscribing due to state changes.
I'll verify the review comment by examining the actual code in the repository.
Length of output: 233
🏁 Script executed:
Length of output: 641
🏁 Script executed:
Length of output: 1960
Fix memory leak in useEffect cleanup—subscription never gets cancelled
The bug is confirmed. The cleanup function captures the initial
subvalue (null) due to missingsubin the dependency array, so the actual subscription object returned bysubscription().then()is never cancelled. This leaves the grpc connection open after component unmount or re-render.The suggested refactor using
useRefis the correct approach. Apply the provided diff or equivalent to ensure the most recent subscription is stored in a ref and properly cleaned up on unmount.🤖 Prompt for AI Agents