[2.0 rc.15 / next] GRAPH_GROWTH reports a keyed cache filling with new keys as a leak, and a cache has no way to say what it is
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 15/100
- Tipo di issue
- Bug
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- typescript
- Ambito
- frontend, observability
Direzione di ricerca
Start with walkGraph in packages/signals/src/core/attribution.ts, which counts nodes alive at both navigation start and settle as survived, and with createProjection next to createStore, which records owners in storeOwners but does not. Run the three-variant repro from the issue under --conditions=browser --conditions=development. Done means variant B goes quiet, variants A and C still report, and the three new graph-growth tests pass. The { cache: true } option is a design proposal, so confirm the API with maintainers before implementing.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Summary
A cache that keeps entries by key reports GRAPH_GROWTH when visits fill it with new keys, and the message says a visit left a createRoot() behind with no dispose. This is the usual shape of a data layer's entity cache: one entry per item, each under its own root so it can be evicted, all under the cache's long-lived root. Since #4020 (fixing #4007), a series must also climb in what outlived each navigation, but a cache's entries are alive when the next navigation starts and survive it, exactly as a leaked root would. Nothing in the graph's shape tells a cache filling up from a leak, and there is no way for the cache to say what it is. OBSERVE.exclude is meant for an observer's own subtree and silences every diagnostic under it, not only this check.
Reproduction
solid-js 2.0.0-rc.15, no DOM. Each visit to /items/:page lists two items the cache hasn't seen; / sits between visits.
import {
OBSERVE,
createEffect,
createMemo,
createProjection,
createRenderEffect,
createRoot,
createSignal,
flush,
getOwner,
runWithOwner,
} from "solid-js";
import { attribution } from "solid-js/attribution";
const variant = process.argv[2] ?? "A";
attribution.enable({ log: false });
const findings: { route: string; grew: string[] }[] = [];
OBSERVE!.diagnostics.subscribe((event) => {
if (event.code === "GRAPH_GROWTH") findings.push(event.data as { route: string; grew: string[] });
});
// An entry per item (a signal and a projection of it), each under its own
// root so it can be evicted, all under the cache's root.
const cache = createRoot((dispose) => ({ owner: getOwner()!, dispose }), {
cache: variant !== "A",
});
const entries = new Map<number, { value: number }>();
const fill = (id: number) =>
runWithOwner(cache.owner, () =>
createRoot(() => {
const [value] = createSignal(id);
entries.set(
id,
createProjection<{ value: number }>(
(draft) => {
draft.value = value() * 2;
},
{ value: 0 },
),
);
}),
);
const leaked: (() => void)[] = [];
const app = createRoot((dispose) => {
const [location, setLocation] = createSignal("/");
createRenderEffect(
() => (location(), [...entries.values()].reduce((sum, entry) => sum + entry.value, 0)),
() => {},
);
return { setLocation, dispose };
});
flush();
const navigate = (name: string, to: string, before?: () => void) => {
OBSERVE!.attribution.withOrigin({ kind: "navigation", name, to }, () => {
before?.();
app.setLocation(to);
});
flush();
};
for (const page of [1, 2, 3]) {
navigate("/items/:page", `/items/${page}`, () => {
fill(page * 2 - 1);
fill(page * 2);
if (variant === "C")
runWithOwner(null, () =>
createRoot((dispose) => {
leaked.push(dispose);
const [n] = createSignal(0);
createEffect(n, () => {});
createMemo(() => n() + 1);
}),
);
});
navigate("/", "/");
}
console.log(variant, findings);
Run with node --conditions=browser --conditions=development repro.ts <A|B|C>.
| Variant | 2.0.0-rc.15 | 2.0.0-rc.15 with the fix below |
|---|---|---|
| A: the cache under a plain root | reports | reports |
B: the cache root created with { cache: true } |
reports | quiet |
| C: B, plus a detached root left behind on every visit | reports | reports |
Without the fix the option doesn't exist, so B is the same as A.
Cause
walkGraph (packages/signals/src/core/attribution.ts) counts every node alive at a navigation's start and still alive at its settle as survived, whoever owns it. Projections also record no owner: createStore puts its owner in storeOwners, and store property nodes are stamped from it, but createProjection doesn't, so a projection's property nodes have none.
Expected
A cache can declare itself, and what it keeps is left out of what survived, while a leak beside it still reports. Related: #4007, #4020.
Possible fix
Let a root say it is a cache: createRoot(fn, { cache: true }) (and createOwner). Observe tiers set a config bit for it, as they do for CONFIG_WIDE and CONFIG_SUPERSEDES, and prod ignores the option. walkGraph then leaves out of survived what such a root keeps: the owners and computations under it, and the signals created there (_owner). The whole-graph counts (graphSize()) are unchanged. createProjection records the owner in scope in storeOwners, as createStore does, so the stores and projections a cache keeps are left out too, and their attribution owner paths become complete as well.
Tested on the RC.15 release commit (ea4438b1; next at 9f4174b6 has no signals changes since): the signals suite passes with it (5,212 tests, 20 expected failures, 2 skipped; 5,209 without it). Three new graph-growth tests cover a declared cache staying quiet, the same cache undeclared still reporting, and a leak beside a declared cache still reporting. The two declared-cache tests fail without the change, and the first one also fails when only the projection's owner isn't recorded.
(submitted by Claude Opus 5.5 on behalf of rvlzzr)
- Lingua principale
- TypeScript
- Stelle
- 36.1k
- Fork
- 1.1k
- Merge medio
- 10h 41m
- PR unite (30g)
- 363
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di solidjs/solid
-
Difficoltà 3/5 Mezza giornata Idoneità per principianti 55/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 30/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 3/5 Mezza giornata Idoneità per principianti 45/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
I maintainer di solito rispondono entro 1 giorno
-
signals: a landing reveals a held write its stale reader re-derives onto a new flight (U-5, D-9)Aperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 12/100
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di solidjs/solid
Issue simili
-
area:ui effort:S enhancement priority:P2
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
QuantumNous/new-api#7839 ·
I maintainer di solito rispondono entro 1 giorno
-
good first issue maintenance
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
dark-princezz/stellar-hooks#1010 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
interledger/rhyza#352 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
I maintainer di solito rispondono entro 1 giorno