Skip to content

feat(): load abort signal + harden the message layer - #327

Draft
ShaMan123 wants to merge 21 commits into
ThatOpen:mainfrom
ShaMan123:feat/load-signal
Draft

ShaMan123 wants to merge 21 commits into
ThatOpen:mainfrom
ShaMan123:feat/load-signal

Conversation

@ShaMan123

@ShaMan123 ShaMan123 commented Oct 11, 2026 •

Copy link
Copy Markdown
Contributor

Part of a stack of six PRs that replaces #305. The branches live in a fork, so GitHub can't chain them: every PR is based on main, and the diff of each one includes the PRs below it. Each PR names the commits that are its own and links a comparison that shows only those. They are meant to merge in the order below, and PRs 2 to 6 stay drafts until the one before them is in.

The work. All model state, on both threads, is keyed by the consumer's modelId, and a modelId can be reused. Late async work of a model that was disposed or replaced (a worker reply, queued tiles, a material transfer, a progress event, an in-flight dispose) therefore lands on the next model loaded under the same ID. The stack gives each model an internal uid that is never reused and routes everything by it, adds load({ signal }) (#173), and types the messages between the threads, where most of the bugs it fixes were hidden behind any.

The stack, bottom to top, in merge order:

  1. refactor(): route model calls through _invoke #325 refactor(): route model calls through _invoke: mechanical groundwork, no behavior change
  2. fix(): type calls to a model's worker, rebuild what the worker copies #326 fix(): type calls to a model's worker, rebuild what the worker copies
  3. feat(): load abort signal + harden the message layer #327 feat(): load abort signal + harden the message layer
  4. fix(): key models by an internal uid, dispose synchronously #328 fix(): key models by an internal uid, dispose synchronously: the core fix
  5. fix(edit): key editor state by the model's uid #329 fix(edit): key editor state by the model's uid
  6. refactor(): type the requests workers send to the main thread #330 refactor(): type the requests workers send to the main thread

Every commit in the stack type-checks and passes the test suite on its own, and each PR builds. The top of the stack matches #305's branch merged with today's main, apart from one fix that merge needs (see PR 4) and two reworded lines.


This PR's own diff: its last 8 commits, shown here on their own. The commits before them belong to the PRs below.

Description

PR 3 of 6. Adds a signal option to load() (#173), makes every way of aborting a load go through one path, and hardens the message layer between the threads so that a request always settles.

Aborting a load

  • load({ signal }): aborting the signal rejects load() with a LoadAbortedError and disposes the partial model. A signal that is already aborted rejects without doing any work.
  • abort(modelId) stays, fully supported, and does the same as the signal. Each load owns one AbortController that both go through. abort(modelId) only looks up the load running under that ID, so it keeps no bookkeeping of its own, and an abort can't outlive its load or reach a later load of the same ID. For an ID that isn't loading it does nothing. It used to send a request that spawned a worker.
  • Disposing a model while it loads aborts its load too. Before, the load carried on and, with autoCoordinate: false, fired onModelLoaded for the dead model.
  • The rejection is a LoadAbortedError instance in every case. It was the worker's serialized error string.
  • An abort that lands after the worker finished its part is no longer ignored: load() checks again after each step.
  • On the worker, a DELETE_MODEL that lands while its model is still being generated aborts the load and waits for it to unwind. It used to dispose the half-built model from under the generate loop.
  • dispose() returns the same promise when it is called again, so a load aborted by a dispose waits for that disposal instead of starting a second one.

Loading an ID that is taken

  • Loading a modelId that is already loaded or still loading throws. It silently clobbered the first model, and abort(modelId) needs an ID to name at most one load.
  • Only live models count. An ID whose model was disposed can be loaded again as on main, including while its worker still deletes it.

Message layer

  • Only CREATE_MODEL assigns a worker to a model. Any other request for a model without one rejects with "model … is not loaded". Before, it spawned a worker that was never released.
  • A request that can't be routed rejects. It stayed pending forever.
  • An answer goes back through the port its request came in on. It was routed by modelId, so to whichever worker held that ID by then.
  • A result that postMessage() can't copy, such as one holding a function, is answered with that error. It threw a DataCloneError as an unhandled rejection and the request never settled.
  • MessageBase and ThreadHandler type the message envelope, and fetch() keeps its request's type, in place of any.

Also, load()'s raw option is marked @deprecated in its docs, since compression is detected from the buffer. An explicit value still wins.

From the review of #305

  • abort(modelId) is kept, and shares the signal's code path.
  • load() doesn't throw while a disposed model is still being deleted on its worker. That window behaves here as it does on main: the race in it predates this PR, and PR 4 closes it by keying models by uid.

Additional context

Everything about aborting is in this PR. PR 4 only swaps the key these lines use, from modelId to uid.

Worth a close look:

  • The abort wiring in load(): one controller per load, fed by the signal, abort(modelId) and the model's dispose.
  • The worker-side delete during a load, in ThreadModelDeleter and ThreadModelCreator.

Tests: 178 pass, 24 of them new. load-abort.test.ts covers the signal, abort(modelId), disposing mid-load and taken IDs. thread-model-deleter.test.ts runs a delete during a load on the real worker controllers over school_arq.frag. connection.test.ts and fragments-connection.test.ts cover the message layer.


What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following:

  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Follow the Conventional Commits v1.0.0 standard for PR naming (e.g. feat(examples): add hello-world example).
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

🤖 Generated with Claude Code

ShaMan123 and others added 21 commits October 11, 2026 06:29
Every call to a model's worker goes through FragmentsModel._invoke()
instead of spelling out threads.invoke(model.modelId, …) at each of the
89 call sites. The model is now the one place that knows how its worker
is addressed, which is what the typing of these calls and the internal
uid build on.

Mechanical, with one behavior detail: the calls to a delta model go
through the delta model itself, looked up with _getDeltaModel(), instead
of invoking its modelId. A deltaModelId whose model is no longer loaded
now reads as "no edits" where it sent a request for a missing model.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
FragmentsModel._invoke() only takes names of VirtualFragmentsModel's
methods, with arguments matching their parameters, and resolves to their
return type. A renamed or retyped worker method no longer fails at
runtime only.

It showed worker methods declaring narrower parameters than they handle:
the highlight and visibility methods take no ids to mean every item, and
getItemsData() takes GUIDs too. Their signatures now say so. Results are
still cast at the call sites: they are copied between threads, so class
instances in them arrive as plain objects.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
FragmentsModel.getItemsGeometry() and getGeometries() returned MeshData
whose `transform`, typed as a THREE.Matrix4, was the plain object the
worker's copy arrives as, so calling a Matrix4 method on it threw. They
now rebuild it, as ItemGeometry.get() already did.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
_invoke is typed now, and every one of these arguments matches its worker
method, so the comments only switched off the argument checking.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
_invoke claimed to resolve to what the worker method returns, but the
worker's answer is a structured-clone copy: class instances in it arrive
without their prototype. And nothing checked the claim, because
FragmentsConnection.fetch/invoke resolved to `any`.

Cloned<T> describes that copy: methods are dropped, so a THREE.Matrix4 is
typed as `{ elements, isMatrix4 }` and no longer passes for one. invoke<R>()
resolves to Cloned<R>, with R (default any) the method's return type, and
FragmentsConnection.fetch keeps the request's type instead of dropping it,
so the execute and box requests now declare the fields the worker answers
with.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
_invoke accepted any public method of VirtualFragmentsModel, including
ones that break over the wire: dispose() deleted the worker-side model
behind the main thread's back, and getItemsByConfig() takes a function,
which can't be copied to the worker. It now takes only the methods listed
in RemoteMethods, which also documents what crosses the thread boundary.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
getHighlight() and getItemsMaterialDefinition() returned definitions whose
`color`, typed as a THREE.Color, was the plain copy the worker's answer
arrives as, so calling a THREE.Color method on it threw. resetColors()
meant to rebuild it but checked `isColor`, which the copy keeps as an own
property, so it never did, and getItemsMaterialDefinition() didn't call it.

MaterialManager.restoreColor() rebuilds the color from a copied definition
and is typed that way, so a definition can't be handed out without it. It
keeps the components as they are: the worker already converted them from
sRGB, and the old fallback would have converted them again. Definitions
the worker transfers for rendering go through it too.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…copy

EditManager.restoreTransforms() takes the geometries as they arrive from
the worker and returns them with their transform rebuilt, so dropping the
rebuild is now a type error rather than a cast that hides it. ItemGeometry
uses it instead of its own copy of the loop.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
getBuffer() is compressed by default, and compressed it resolves to a
Uint8Array, but it was cast to an ArrayBuffer, so `new DataView(buffer)`
type-checked and threw. The cast couldn't simply go: the worker method's
inferred type, ArrayBufferLike, absorbs Uint8Array too. The worker method
now declares both, which is also what IFragmentsModel says.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Item.getAttributes() cast the worker's attributes to `type?: number`, and
AttributeData and ItemAttributes.setType() took a number too, but the
types are the names the importer writes, such as "IFCLABEL", and the
worker declares them as strings. A numeric comparison against them never
matched. They are strings now, and the cast is gone.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
getSpatialStructure(), getMetadata(), getCRS() and getSequenced() on the
worker returned `any`, so the casts on the main thread were the only type
their results had. They now declare what they return.

That showed getSequenced() handing out results as the worker's copies:
"mergedBoxes" typed as a THREE.Box3, "geometry" transforms as THREE.Matrix4
and "highlight" colors as THREE.Color were all plain objects. Each kind of
result is now rebuilt from the copy, by a map keyed by the result kind, so
a kind that needs rebuilding can't be left out. It resolves to null when
the worker doesn't know the result kind, as its documentation says.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Most of them claimed exactly what _invoke already resolves to, each as a
separate unchecked claim, so a worker method changing its result would go
unnoticed. Where a result is handed out under a named type (ItemData,
SpatialTreeItem, the raw data maps, ...), a return annotation keeps that
name in the declarations and is checked against the worker's result.

The casts that stay are the index methods' and getMetadata()'s: their type
parameters are the caller's word for an index's or the metadata's shape,
which the worker can't check either.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
getMetadata() promises an object (IFragmentsModel types it as T), but the
worker answered null for a model whose file has no metadata, which the
main thread's cast passed through. It answers {} now, so the promise
holds without every caller having to check for null. getCRS() still
answers null for a model without a CRS.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The answer was posted outside the try/catch, so a result postMessage()
can't copy, such as one holding a function, threw a DataCloneError as an
unhandled rejection and the request never settled. The request is now
answered with that error instead.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A model is registered on its worker before its generate() loop ends, so a
DELETE_MODEL that landed mid-load, from disposing a model while it loads,
disposed the half-built model from under that loop. The delete now aborts
the load, waits for it to unwind and clean up after itself, and answers
after that.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Both threads key a model's state by its modelId, so a second load under an
ID that was loaded or still loading silently clobbered the first model.
load() now throws for it. abort(modelId) relies on it too: an ID names at
most one load in flight.

Only models in `models.list` count. An ID whose model was disposed can be
loaded again as before, including while its worker still deletes it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
abort(modelId) kept its own account of the loads in flight and of the
ones already aborted, in two sets of IDs next to the caller's signal. A
load now owns one AbortController that the signal and abort(modelId)
both go through. abort(modelId) only looks up the load running under
that ID, so it needs no bookkeeping of its own, and an abort can't
outlive its load or reach a later load of the same ID.

An abort also ends the load's wait for the worker's step right away
instead of when the worker's answer comes back, and goes on to dispose
the partial model. load() still rejects once that model is disposed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Disposing a model while it loads, with dispose(), disposeModel() or
FragmentsModels.dispose(), left its load running: load() carried on and,
with autoCoordinate off, fired onModelLoaded for the dead model.
dispose() now aborts the model's load through the same controller as the
signal and abort(modelId), so load() rejects with a LoadAbortedError.

dispose() returns the same promise when it is called again. That lets the
aborted load wait for the disposal that aborted it instead of starting a
second one.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
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.

1 participant