Skip to content

Latest commit

 

History

History
186 lines (171 loc) · 17.1 KB

99-diagnostics.md

File metadata and controls

186 lines (171 loc) · 17.1 KB

99 — Diagnostics, binned

Status: DRAFT. Solid 2.0's diagnostic table (documentation/solid-2.0/08-dev-diagnostics.md, quick reference) with each code assigned to one bin. The first bin is the grammar; the second is the checker; the third stays runtime attribution. Codes keep Solid's names so a compile-time error and the dev-mode runtime error mean the same thing.

Bins:

  • U — Unwritable. The grammar has no position for the program. Parse or scope error. Cites the rule that removes the position.
  • S — Static. A query over the static graph (inputs, regions, lanes). Compile error or warning.
  • R — Runtime. Timing, data-dependent, or cross-module-dynamic. Stays in the runtime's attribution engine unchanged.
  • S/R — static within a module, runtime across component boundaries where the edge is dynamic (a prop getter, dynamic()).
Code Bin Rule / note
REACTIVE_WRITE_IN_OWNED_SCOPE U W-2: reactive scope has no statement position
ACTION_CALLED_IN_OWNED_SCOPE S R-io-3: an action called in reactive scope (an io import: IO_IN_REACTIVE)
IO_IN_FN (new) S R-io-2: a fn body that is io
ASYNC_STORE_SETTER U ST: a draft block is synchronous by grammar
STRICT_READ_UNTRACKED U E-4/E-5: the only snapshots are initializers and peek
UNTRACKED_READ_AFTER_AWAIT U R-pending: inputs are static; no tracking window
PENDING_ASYNC_UNTRACKED_READ S 04 R-8: UNGUARDED_SNAPSHOT (new): a handler's snapshot of a value with no committed value or a failure row, neither handled (-> v, try/catch) nor covered (disabled reading it, or inside its loading and errored regions)
PENDING_ASYNC_FORBIDDEN_SCOPE S same
OPTIMISTIC_WRITE_WHILE_LOADING, OPTIMISTIC_WRITE_BEFORE_LOAD S 06 AC-3a: GUESS_WHILE_LOADING (new; guess for optimistic, as in 07 decision 18), a guess a click can make while its value loads a new question or its first one, from an element not covered
PRIMITIVE_IN_FORBIDDEN_SCOPE U SC-2: declarations do not occur in imperative scope
PRIMITIVE_IN_EFFECT_CALLBACK U same
CLEANUP_IN_FORBIDDEN_SCOPE U EF-5: cleanup is the apply block's return
MISSING_EFFECT_FN U EF-1: an effect is two halves by grammar
SYNC_NODE_RECEIVED_ASYNC U R-pending: the row says
FLUSH_IN_EFFECT_CALLBACK U W-3: no API to split an instant
NO_OWNER_EFFECT U O: every declaration has a region
NO_OWNER_CLEANUP U same
NO_OWNER_BOUNDARY U same
RUN_WITH_DISPOSED_OWNER S O-3: its static form is REGION_ESCAPE; the runtime error stays the JS-boundary backstop (CN-3b)
SETTLED_CLEANUP_UNOWNED S EF-7: an onSettled callback that returns a cleanup (EF-5's shapes); effect () { … } is the owned form (EF-4)
ON_FLUSH_IN_OWNED_SCOPE S EF-8: onFlush in reactive scope is IO_IN_REACTIVE, an error (Solid: a dev warning)
SNAPSHOT_ARGUMENT (new) S E-10: reactive argument to a value parameter at an instantiation
SNAPSHOT_INITIALIZER (new) S E-4 / DV-6: a source initializer reads a reactive value outside peek(…)
INVALID_REFRESH_TARGET S refresh requires a source with a question (V-9)
INVALID_AFFECTS_TARGET S same
LOADING_ON_OUTSIDE_HOLD S/R H: a reader of the on data outside the boundary; S within a component (08 CN-3e), R through a prop
ASYNC_OUTSIDE_LOADING_BOUNDARY S/R H: a pending reader with no armed boundary on its path; S only in a client-only build, for a first load (08 CN-3d)
EFFECT_WRITES_OWN_SOURCE S C-3: an error (ruled 2026-10-23); closures the apply creates are exempt
EFFECT_RELAY_TEAR S C-3 generalised: an effect relaying a source to a source
ASYNC_WATERFALL S R-pending: await whose inputs depend on another await
SILENT_HOLD (structural form) S/R H-9: a write whose cone contains no probe; timing form stays R
HUGE_FAN_IN, WIDE_SCOPE_DEPS S counts on the static graph
HUGE_FAN_OUT S/R static within module
DYNAMIC_ASYNC_COMPONENT S R-pending on a component-typed value
LONG_HOLD R timing
FALLBACK_FLASH R timing
STACKED_HOLDS R timing
ABANDONED_FLIGHTS R timing
UNTRACKED_ASYNC_HANDLER R timing; the structural half (no write before await, no action) is S
HOT_SCOPE_* R profiling
WASTED_RECOMPUTE R data-dependent
UNSTABLE_MEMO_OUTPUT R data-dependent (partly S once ST decides structured equality)
UNSTABLE_LIST_IDENTITY S ST: key is on the type; unkeyed for over records is a diagnostic
IMMUTABLE_UPDATE_IN_STORE U ST: a structured equation is a delta over pre, not a replaced container
GUESS_REVERTED R data-dependent
GRAPH_GROWTH R profiling
REACTIVITY_HALTED R an error escaping every boundary
INVARIANT_VIOLATION R runtime internal
SETTLE_WALK_UNINITIALIZED_SOURCE U E-4: every source has an initializer
SERVER_WRITE S 12 SF-4: a write in a server function's body (anywhere else a write is imperative scope, which the server never runs, SV-2)
SSR_*, HEAD_*, LATE_HEADER_WRITE, FRAME_MARKER_CORRUPTED, LAZY_ASSET_UNMAPPED, PRELOAD_DESCRIPTOR_INVALID R server/transport; out of scope for the language
UNRECOGNIZED_INSERT_VALUE R 13 TY-3b: Solid's JSX.Element takes any object, so a record shown by mistake is a run-time finding, as in Solid
UNSCOPED_HOLE_ALLOCATED_IDS R hydration
HYDRATION_MISMATCH R 10 SV-3c: a pure JS function computed differently on server and client; SV-7 narrows it to an assertion that lied
LOWERCASE_EVENT_ATTRIBUTE U X: handlers are a grammar form

Codes the checker adds

ref/src/check.ts (08) reports these, each with the rule it enforces. Where Solid has no code for the shape (its runtime cannot see it), the code is new. Every row has a rejected variant in scenarios/S-check-1.md or the scenario named.

Code Bin Rule Scenario
DUPLICATE_DECLARATION S E-7 S-check-1
SHADOWED_IMPORT (new) S MO-1d S-module-1
CYCLE S C-1 (CN-3a: union of branches; only an equation's own pre breaks it) S-check-1, S-core-1
PRE_OF_NON_REACTIVE S C-2 S-check-1
UNBOUND S lexical scope (a component sees its declaration site, RG-7a; props of a component that declares none, RG-4b) S-check-1
ARGUMENT_COUNT (new) S AC-1f: a call of a declared action with another number of arguments than its parameters S-check-1
UNKNOWN_COMPONENT, COMPONENT_AS_VALUE S RG-4a S-check-1, S-region-5
INSTANTIATION_NOT_BOUND S E-9 / RG-6 S-region-6
SNAPSHOT_ARGUMENT S E-10 S-region-6
SNAPSHOT_INITIALIZER S E-4 / DV-6 S-surface-1
IO_IN_REACTIVE S IO-2 / R-io-3 S-surface-1
ACTION_CALLED_IN_OWNED_SCOPE S IO-2 / R-io-3 S-check-1
IO_IN_FN S R-io-2 S-check-1
REACTIVE_WRITE_IN_OWNED_SCOPE U/S W-2 (a statement position) / SC-3 (a statement-bodied closure in reactive scope) S-core-1, S-check-1
WRITE_TO_NON_SOURCE S W-1 S-core-1, S-check-1
DRAFT_WRITE_OUTSIDE_DRAFT S ST-3a S-store-2
ASYNC_STORE_SETTER S ST-3b S-check-1
GUESS_OUTSIDE_HOLD S AC-3 (an effect's apply block: never an action, AC-1b) S-check-1, S-infer-1
HELD_WRITE S AC-1c S-infer-2
STALE_OWN_READ S AC-1d S-infer-5
STALE_WRITE_BACK S AC-1e S-infer-6
STALE_CAPTURE S AC-1g S-infer-7
GUESS_NO_QUESTION — retired 2026-11-20: any source takes a guess (AC-3, ST-5c; 07 decision 21) S-guess-writable-1, -2
GUESS_ON_DEFERRED S AC-3 / ST-5c (a deferred equation lags its truth, V-16) S-guess-equation
GUESS_WHILE_LOADING S AC-3a (Solid's OPTIMISTIC_WRITE_WHILE_LOADING, at compile time) S-guess-equation, check.rs unit test
INVALID_REFRESH_TARGET, INVALID_AFFECTS_TARGET S AC-4, AC-5 S-check-1
REGION_ESCAPE S O-3, O-3a, O-3b S-check-1 (seven shapes), S-module-1
UNSTABLE_LIST_IDENTITY S ST-4b (narrow form: map into fresh records, unkeyed) S-store-3
CONTEXT_NOT_FOUND S RG-7b (over the static application tree; a context with a default is always found) S-check-1, S-region-7, S-ai-feed, S-context-1
ROW_NARROWER_THAN_INFERRED S CN-4a (checked only where a row is written); R-f-9 for fails(…) S-check-1, S-fail-1
EFFECT_WRITES_OWN_SOURCE S C-3 (directly or through equations; not closures the apply creates) S-check-2
UNHANDLED_FAILURE S R-f-5 / CN-6a (over the static application tree; props where read, children where rendered) S-fail-1, S-fail-2
CATCH_NOT_ON_AWAIT (new) S R-f-4: a catch after anything but an await (a failed value is shown by an errored region where it is read; 2026-11-19) S-fail-1, S-catch-snapshot
UNCAUGHT_ACTION_FAILURE S R-f-6 / CN-6a (incl. a prop the action reads, checked at each application) S-action-1, S-fail-2
NOT_AN_ERROR_CLASS S R-f-1 S-fail-1
WRITE_TO_NON_SOURCE (MO-2) S MO-2a: an imported source is read-only S-module-1
IMPORT_ROW_MISMATCH S MO-4a: pure / fails on an .rx import S-module-1
MODULE_CYCLE S MO-5 S-module-1
NOT_EXPORTED, MODULE_NOT_FOUND S MO-6a S-module-1
NOT_A_CONTEXT, CONTEXT_AS_VALUE S RG-7a S-context-1
SOURCE_CONTEXT, WRITE_TO_NON_SOURCE (O-4) S O-4: a context is read beneath its provision; context x: source T withdrawn (RG-7c, 2026-10-31) S-context-1
ROW_NARROWER_THAN_INFERRED (RG-7e) S a provision wider than its context's declared rows S-context-1
SERVER_CAPTURE S 12 SF-3: a server function names reactive state (by kind; through the fns it calls) S-sf-1
SERVER_WRITE S 12 SF-4 S-sf-1
SERVER_ONLY, CLIENT_IN_SERVER S 12 SF-5a, SF-5c S-sf-1
CLIENT_QUESTION_UNHELD S 10 SV-7b: a client question's reader with no loading above it on some path (Solid: ASYNC_OUTSIDE_LOADING_BOUNDARY, at run time) S-server-3
CLIENT_NOT_AWAITED S 12 SF-5b S-server-3
STYLE_PLACEMENT S 07 CSS-1: a <style> off its view's top level, or a second one S-surface-2
UNTIL_PREDICATE S 06 AC-6: until's argument is not a predicate () => e S-action-2
HOOK_CALLBACK (new) S 02 EF-7, EF-8: onSettled's or onFlush's argument is not a closure () => { … } S-flush-1
SETTLED_CLEANUP_UNOWNED, IO_IN_REACTIVE (EF-7, EF-8) S an onSettled callback returning a cleanup; either hook called in reactive scope S-settled-1, S-flush-1
AWAIT_IN_EXPRESSION (new) S 06 AC-1: an await inside an expression of imperative scope — a run suspends only at a statement (await e, let v = await e, either with a catch) S-await-1
TOP_LEVEL_MARKUP S 09 MO-1c: markup at a module's top level — the view is export default component App every scenario
CONTENT_MODEL S 10 SV-7d: nesting the HTML parser restructures, across templates (component roots, branches, placed children) S-server-4
IMPORT_ROW_MISMATCH (SF-5) S server/client on an import that a .d.rx declares otherwise S-sf-1
WIRE_VALUE S/R 12 SF-6a: at compile time where the types are known (13 TY-5a), else at run time S-sf-1, S-types-1
MISSING_AWAIT (new) S 04 R-1a: an equation whose value may be a promise or a stream, which Solid's memo would consume; write await e (13 TY-5b) S-types-1
TSnnnn S 13 TY-1: TypeScript's errors over the projection, on .rx lines S-types-1

The advisory rows (ruled 2026-10-23, in part)

Under CN-1a there is no warning tier, so an S row is a compile error or it is not a diagnostic. ASYNC_WATERFALL, HUGE_FAN_IN, HUGE_FAN_OUT, WIDE_SCOPE_DEPS, SILENT_HOLD (structural) and UNTRACKED_ASYNC_HANDLER (structural half) are not errors — they are performance and shape advice about correct programs — and move to a separate advisory tool that reads the same static graph and never fails a build (the rustc/clippy split). EFFECT_WRITES_OWN_SOURCE is an error (C-3); EFFECT_RELAY_TEAR (an effect copying one source into another — an equation written the long way, with a one-instant tear, but also how a source is synced into a JS-owned one) stays advisory. DYNAMIC_ASYNC_COMPONENT is a type question for the type layer (13); UNRECOGNIZED_INSERT_VALUE stays Solid's, at run time (13 TY-3b). LOADING_ON_OUTSIDE_HOLD was one; since 2026-10-30 (Ryan) it is an error, 08 CN-3e: the old content stays up with no sign of the wait, a silent hold, which is a defect, not advice. (SERVER_WRITE was one; 12 SF-4 makes it a row rule.)

Parse errors that name a habit

Not Solid codes: a parse error (U by construction) whose line reads like JavaScript, React or Solid carries the code of the habit and the .rx it most likely meant, appended to the parser's own message (hint in ref/src/parse.ts and compiler/src/parse.rs; scenario S-parse-hints). Any other parse error is PARSE. Every code, here and above, has a section with a fix in guide/diagnostics.md, and the compiler's tests check its examples.

Code What it looks like
JS_LOCAL const / let / var in a component or at top level
JS_FUNCTION function f() { … }
JS_RETURN return <div>…</div> in a component
JS_API createSignal(…), useState(…), … on a failing line
ASSIGNMENT x = …, x += …, x++ where a write x := … was meant (W-1)
REACTIVE_WRITE_IN_OWNED_SCOPE () => x := …: the arrow needs a braced body (W-2, SC-3)

Counting

bin codes
U 21
S 13
S/R 5
R 17 (+ the SSR family)

The U and S rows are the language's claim. Every one needs a scenario in scenarios/ whose verdict is "rejected", and an error message written for a reader who will fix the program without running it.