Address architectural issues #1–#7 from codebase review - #48
Merged
Merged
Conversation
#1 – Centralize element labels in ElementRegistry Add a `label: TReadOnlyProperty<string>` field to ElementDescriptor so the registry is the single source of truth for element display names. Export `getElementLabel()`. Remove the duplicate `buildTypeLabels()`/`TYPE_LABELS` map from EditContainerNode and the now-unused StringManager import there. #2 – Rename continuousSpectrumSource → ContinuousSpectrumSource Fix the lone camelCase type key to match the PascalCase convention used by all other element types. Add a `case "continuousSpectrumSource":` fall-through shim in elementSerialization.ts so scenes saved by older versions continue to load without data loss. #3 – Replace 4-arg buildEditControls signature with EditControlContext bag Introduce `EditControlContext { signConvention, useCurvatureDisplay }` in EditControlsResult.ts. Update ElementDescriptor, the exported buildEditControls() functions in ElementRegistry/EditControlFactory, and the call site in EditContainerNode. Registry entries that previously prefixed unused params with `_` now destructure only what they need from the bag. Adding a new display preference requires a single interface change, not touching every builder signature. #4 – Replace instanceof checks in OpticsScene.simulate() with interfaces Add IAcquirable and ICompound to OpticsTypes.ts, with corresponding type guards (isAcquirable, isCompound). DetectorElement implements IAcquirable; FiberOpticElement implements ICompound. OpticsScene.simulate() uses the guards instead of `instanceof DetectorElement` / `instanceof FiberOpticElement`, removing its dependency on those concrete classes. #5 – Make OpticsScene.getElement() O(1) Add a `_elementById: Map<string, OpticalElement>` maintained by addElement / removeElement / clearElements. getElement() is now a single Map lookup instead of a full array scan. #6 – Fix SpatialIndex.getAllElements() O(n²) dedup Replace the `all.includes(el)` linear scan inside a loop with a `Set<OpticalElement>` accumulator, reducing the fast-path dedup from O(n²) to O(n). #7 – Extract syncBidirectional helper in SimScreenView Replace three near-identical `let blockXSync = false` bidirectional-sync patterns with a single generic `syncBidirectional(propA, propB)` helper. The helper also writes propA's initial value to propB, removing the separate initialization lines that preceded two of the three blocks. https://claude.ai/code/session_01H65WqMzMK88Jkra4gAjhE7
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
#1 – Centralize element labels in ElementRegistry
Add a
label: TReadOnlyProperty<string>field to ElementDescriptor so theregistry is the single source of truth for element display names. Export
getElementLabel(). Remove the duplicatebuildTypeLabels()/TYPE_LABELSmap from EditContainerNode and the now-unused StringManager import there.
#2 – Rename continuousSpectrumSource → ContinuousSpectrumSource
Fix the lone camelCase type key to match the PascalCase convention used by
all other element types. Add a
case "continuousSpectrumSource":fall-throughshim in elementSerialization.ts so scenes saved by older versions continue to
load without data loss.
#3 – Replace 4-arg buildEditControls signature with EditControlContext bag
Introduce
EditControlContext { signConvention, useCurvatureDisplay }inEditControlsResult.ts. Update ElementDescriptor, the exported
buildEditControls() functions in ElementRegistry/EditControlFactory, and the
call site in EditContainerNode. Registry entries that previously prefixed
unused params with
_now destructure only what they need from the bag.Adding a new display preference requires a single interface change, not
touching every builder signature.
#4 – Replace instanceof checks in OpticsScene.simulate() with interfaces
Add IAcquirable and ICompound to OpticsTypes.ts, with corresponding type
guards (isAcquirable, isCompound). DetectorElement implements IAcquirable;
FiberOpticElement implements ICompound. OpticsScene.simulate() uses the
guards instead of
instanceof DetectorElement/instanceof FiberOpticElement,removing its dependency on those concrete classes.
#5 – Make OpticsScene.getElement() O(1)
Add a
_elementById: Map<string, OpticalElement>maintained by addElement /removeElement / clearElements. getElement() is now a single Map lookup
instead of a full array scan.
#6 – Fix SpatialIndex.getAllElements() O(n²) dedup
Replace the
all.includes(el)linear scan inside a loop with aSet<OpticalElement>accumulator, reducing the fast-path dedup from O(n²)to O(n).
#7 – Extract syncBidirectional helper in SimScreenView
Replace three near-identical
let blockXSync = falsebidirectional-syncpatterns with a single generic
syncBidirectional(propA, propB)helper.The helper also writes propA's initial value to propB, removing the
separate initialization lines that preceded two of the three blocks.
https://claude.ai/code/session_01H65WqMzMK88Jkra4gAjhE7