v2.0: Tag-Based Domain Model — unified Tag foundation#50
Merged
Conversation
- tests/suite/MockTag.m: minimal concrete Tag subclass for test scaffolding - tests/suite/TestTag.m: 19 MATLAB unittest cases covering constructor, Criticality enum, all 6 abstract-by-convention stubs, resolveRefs no-op, and the Pitfall 1 exactly-6-stubs gate - tests/test_tag.m: 14-assertion Octave flat-style port - Tests are RED: fail with 'class not found: Tag' until Task 2 Covers REQ IDs: TAG-01, TAG-02, META-01, META-03, META-04
- libs/SensorThreshold/Tag.m: 8 inline-defaulted properties + name-value
constructor with invalidKey/unknownOption validation; set.Criticality
enum guard (low|medium|high|safety); exactly 6 abstract-by-convention
error('Tag:notImplemented') stubs (getXY, valueAt, getTimeRange,
getKind, toStruct, static fromStruct) enforcing the Pitfall 1 budget;
resolveRefs as a default no-op hook (NOT abstract)
- Adjust TestTag.m and test_tag.m to call abstract stubs on a direct
Tag('k') instance rather than the super-call syntax getXY@Tag(...).
Tag is not declared Abstract, so direct instantiation is portable
across MATLAB and Octave; the super-call form is only valid inside a
subclass method body
- Octave: all 18 test_tag assertions pass; Sensor + event integration
legacy tests remain green
- No edits to Sensor.m, Threshold.m, StateChannel.m, CompositeThreshold.m,
or any registry (strangler-fig MIGRATE-02 constraint upheld)
Covers REQ IDs: TAG-01, TAG-02, META-01, META-03, META-04
- SUMMARY.md documents the 6-stub Pitfall 1 gate, the throw-from-base decision, and the MATLAB/Octave test-portability adjustment - STATE.md advances current plan to 02, records metrics and decision - ROADMAP.md phase-1004 progress updated (1/3 plans complete) - REQUIREMENTS.md marks TAG-01, TAG-02, META-01, META-03, META-04 complete Plan commits: 7a0eb0c (test RED) + ff8639e (feat GREEN)
- tests/suite/TestTagRegistry.m: 21 MATLAB unittest cases covering CRUD (register/get/unregister/clear), duplicate-key hard error (Pitfall 7), query (find/findByLabel/findByKind, META-02), introspection (list/printTable), and two-phase loadFromStructs (TAG-06/TAG-07) including order-insensitive gate and unresolvedRef wrap (Pitfall 8). - tests/suite/MockTagThrowingResolve.m: MockTag subclass whose resolveRefs always throws, used to drive the Pitfall 8 wrap gate. Overrides toStruct so kind='mockThrowingResolve' dispatches back. - tests/test_tag_registry.m: Octave flat-style port exercising 11 assertions including forward+reverse loadFromStructs. All tests fail because TagRegistry.m does not exist yet — this is the RED half of the TDD pair; Task 2 will implement the class.
Singleton catalog of Tag entities with the ThresholdRegistry-shaped API plus three intentional deltas needed by the v2.0 domain model: - register() HARD-ERRORS on duplicate key with TagRegistry:duplicateKey (Pitfall 7 gate). Prevents silent identity overwrites that plagued the legacy ThresholdRegistry. - loadFromStructs() runs two-phase deserialization (Pitfall 8 gate): Pass 1 instantiates every tag via instantiateByKind + register (so duplicate keys in input surface as duplicateKey), Pass 2 calls tag.resolveRefs(catalog) inside try/catch and rewraps any failure as TagRegistry:unresolvedRef. Order-insensitive; never silently swallows a resolve error. - findByKind() replaces findByDirection() since Tag is multi-kind. Also ships: - findByLabel(label) for META-02 label-driven discovery. - instantiateByKind(s) dispatch table (Phase 1004 cases: 'mock', 'mockThrowingResolve'; Phase 1005+ will extend for sensor/state/ monitor/composite). - list() / printTable() / viewer() introspection mirroring the ThresholdRegistry layout with the Direction column replaced by Kind. - Persistent containers.Map() singleton via a private catalog() helper. Zero edits to any legacy class (Sensor.m, Threshold.m, StateChannel.m, CompositeThreshold.m, SensorRegistry.m, ThresholdRegistry.m, ExternalSensorRegistry.m, ThresholdRule.m) — strangler-fig constraint upheld (MIGRATE-02). Tests: tests/test_tag_registry.m -> All 11 test_tag_registry tests passed. Legacy Octave regressions still green (test_tag 18, test_sensor 8, test_event_integration 4, test_composite_threshold 12).
- SUMMARY: 1004-02-SUMMARY.md documenting TagRegistry API, Pitfall 7 duplicate-key hard-error gate, Pitfall 8 two-phase loader + unresolvedRef wrap gate, TAG-07 round-trip evidence, META-02 findByLabel coverage, and confirmation that zero legacy files were edited. - STATE.md: advanced Current Plan 2 -> 3, recorded 6min metric, logged 3 key decisions (hard-error duplicate, two-phase loader, instantiateByKind placement), stopped-at pointer moved to Plan 03. - ROADMAP.md: phase 1004 progress updated (2/3 plans, in progress). - REQUIREMENTS.md: marked TAG-03, TAG-04, TAG-05, TAG-06, TAG-07, META-02 complete and updated the traceability table.
- tests/suite/TestGoldenIntegration.m (MATLAB unittest class) - tests/test_golden_integration.m (Octave flat-style) - Both locked with "DO NOT REWRITE" Pitfall 11 marker - Exercises Sensor + Threshold + CompositeThreshold + EventDetector + FastSense - 5 golden assertions (resolve, default events, debounced events, composite status, addSensor wiring) - Fixture matches test_event_integration.m Y pattern (events at t=4 peak 16, t=13 peak 22) - Written against legacy API only — rewritten to Tag API only in Phase 1011 - Octave 11: 9 assertions pass; legacy suite (test_sensor, test_event_integration, test_composite_threshold) still green
- Enumerate all 10 production/test files (≤20 budget, 50% margin)
- Forbidden-path grep: zero edits to Sensor/Threshold/StateChannel/
CompositeThreshold/SensorRegistry/ThresholdRegistry/ThresholdRule/
ExternalSensorRegistry/loadModule*/FastSense/EventDetector/
DashboardWidget/install/run_all_tests (PASS)
- Pitfall 1 (≤6 Tag abstracts): 6 exactly, no methods(Abstract) block
- Pitfall 5 (file budget): 10/20
- Pitfall 7 (duplicateKey hard error): 1 error site in TagRegistry
- Pitfall 8 (unresolvedRef wrap): 1 wrap site in TagRegistry
- Pitfall 11 (DO NOT REWRITE marker): 2 hits across both golden files
- Octave legacy-suite smoke: 62 assertions green (event_integration +
sensor + composite_threshold + tag + tag_registry + golden_integration)
- Auto-discovery verified: both MATLAB TestSuite.fromFolder and Octave
dir('test_*.m') pick up golden test with zero runner edits
…eTag + FastSense.addTag
- tests/suite/TestStateTag.m — 17 test methods covering constructor, ZOH numeric scalar+vector (7-point StateChannel golden fixture), ZOH cellstr scalar+vector, empty-state error, getKind=='state', getTimeRange empty/non-empty, and toStruct/fromStruct round-trip for numeric AND cellstr Y - tests/test_statetag.m — Octave flat-style mirror with 29 assertions - RED confirmed: Octave:undefined-function for StateTag
- TestSensorTag.m: 19 MATLAB unittest methods covering TAG-08 surface (constructor/isa-Tag/getXY/valueAt/getTimeRange/load/toDisk-toMemory round-trip/DataStore dependent property/toStruct-fromStruct) - test_sensortag.m: Octave flat-style mirror with ~23 assertions - Temp MAT-file fixture helper (writeTempMat_) with auto-teardown - Verified RED: octave run reports SensorTag undefined (Phase 1005-01 GREEN target)
- libs/SensorThreshold/SensorTag.m (253 SLOC): classdef SensorTag < Tag
with private Sensor_ delegate (HAS-A composition, NOT inheritance).
- Tag contract:
* getKind() returns literal 'sensor'
* getXY() / getTimeRange() forward to delegate (zero-copy via MATLAB COW)
* valueAt(t) ZOH-style via binary_search(X, t, 'right') clamped to [1, N]
* toStruct() emits kind + Tag universals + optional sensor extras block;
X/Y intentionally omitted (runtime data, not serialization state)
* fromStruct() round-trips Name/Labels/Criticality/Units/ID/Source/...
- Data-role delegation: load(matFile), toDisk, toMemory, isOnDisk all
forward to inner Sensor. DataStore is a Dependent property mirror.
- Constructor splits varargin into Tag NV / Sensor NV / inline (X, Y);
raises SensorTag:unknownOption for unknown keys or dangling values.
- Pitfall 5 gate: legacy Sensor.m / StateChannel.m byte-for-byte unchanged
(git hash-object verified 77d048f / c67ff02 — matches pre-task HEAD).
- All 4 Octave test suites GREEN (test_sensortag, test_sensor, test_tag,
test_tag_registry).
- 1005-01-SUMMARY.md: Phase 1005 Plan 01 summary; TAG-08 covered; Pitfall 5 legacy-untouched gate PASS (git hash-object verified); all 4 Octave test suites GREEN (test_sensortag + 3 regression). - STATE.md: advance plan counter 1 -> 2; record 4min duration metric; add composition-delegate decision; update session stop marker. - ROADMAP.md: refresh Phase 1005 plan progress table (1/3 complete). - REQUIREMENTS.md: mark TAG-08 complete (SensorTag data carrier).
- libs/SensorThreshold/StateTag.m (219 lines) — concrete Tag subclass with zero-order-hold lookup matching StateChannel byte-for-byte - ZOH semantics: scalar + vector paths, numeric + cellstr Y - Empty-state guard: StateTag:emptyState (hygiene over cryptic bounds) - toStruct/fromStruct with cellstr-wrap defense (Pitfall 4) - Legacy StateChannel.m + Sensor.m byte-for-byte unchanged (Pitfall 5) - All 4 Octave suites green: test_statetag, test_state_channel, test_tag, test_tag_registry
- Add 1005-02-SUMMARY.md (TAG-09 coverage matrix, Pitfall 5 gate PASS) - STATE.md: advance Plan 02 -> 03, progress 96% (25/26), record 8min metric, 3 decisions - ROADMAP.md: Phase 1005 plan-progress row updated (2/3 plans complete) - REQUIREMENTS.md: TAG-09 marked complete
…nsion - TestFastSenseAddTag.m: 9 methods covering non-Tag input, post-render guard, SensorTag->addLine, StateTag->staircase, cellstr deferred error, unsupported kind error, strangler-fig mix with addSensor, empty StateTag no-op, and Pitfall 1 grep gate - test_fastsense_addtag.m: Octave flat mirror with 10 assertion blocks - TestTagRegistry.m: +2 round-trip tests (SensorTag + StateTag) verifying loadFromStructs end-to-end through instantiateByKind dispatch - test_tag_registry.m: +2 matching Octave assertions; counter bumped 11->13
… kinds
- FastSense.addTag(tag, varargin): polymorphic dispatcher switching on
tag.getKind() (NO isa on subclass names — Pitfall 1 gate PASS). Routes
'sensor' to addLine with DisplayName, 'state' to addStateTagAsStaircase_.
Error IDs: FastSense:invalidTag, FastSense:unsupportedTagKind,
FastSense:stateTagCellstrNotSupported; reuses FastSense:alreadyRendered.
- FastSense.addStateTagAsStaircase_: inline 2N-1 interleaved step-function
expansion; cellstr Y raises stateTagCellstrNotSupported (deferred);
empty X/Y is a silent no-op.
- TagRegistry.instantiateByKind: +2 cases ('sensor', 'state') dispatching
to SensorTag.fromStruct / StateTag.fromStruct; error message updated
to list Phase 1005 valid kinds.
- Legacy addLine/addSensor/addBand bodies byte-for-byte unchanged
(diff shows zero '-' lines in FastSense.m); legacy Sensor.m and
StateChannel.m also unchanged (Pitfall 5 gate PASS).
…hed; MonitorTag property collision fix - Tag base gains EventStore property + addManualEvent(tStart,tEnd,label,msg) + eventsAttached() query - MonitorTag removes duplicate EventStore property (inherits from Tag) - addManualEvent creates Event with Category=manual_annotation, registers via EventBinding - eventsAttached is a query (Pitfall 4 compliant) not a stored property - test_tag_manual_event: 6/6 tests pass
… + severityToColor_ - ShowEventMarkers (default true) + EventStore public properties - Tags_ + EventMarkerHandles_ private properties - addTag appends tag handle to Tags_ after switch dispatch - renderEventLayer_ separate private method: batches by severity, early-out on 0-event - severityToColor_ maps 1=ok/green, 2=warn/yellow, 3=alarm/red with Theme fallback - render() calls renderEventLayer_() after custom markers loop (zero new conditionals in line loop) - test_fastsense_event_overlay: 5/5 tests pass - Octave fix: line() uses Parent NV pair not positional axes arg
…er_ plan - SUMMARY.md with 2 tasks, 5 files, 2 deviation auto-fixes - STATE.md advanced to plan 3 of 3, 98% progress - ROADMAP.md updated, EVENT-06 + EVENT-07 marked complete
…, median 0.117s) - Add bench test: 12 SensorTag lines + ShowEventMarkers=true + 0 events - 3-run median timing with 10s CI ceiling assertion - Validates renderEventLayer_ early-out adds near-zero overhead
…Phase 1010 closed) - SUMMARY: 0-event bench median 0.117s, all 5 Pitfall gates PASS, all 7 EVENT reqs confirmed - STATE: Phase 1010 3/3 plans complete, ready for verification - ROADMAP: Phase 1010 marked complete
- 19 suite test files deleted (TestSensor, TestThreshold, TestThresholdRule, TestCompositeThreshold, TestStateChannel, TestSensorRegistry, TestThresholdRegistry, TestExternalSensorRegistry, TestSensorResolve, TestSensorTodisk, TestAlignState, TestDeclarativeCondition, TestDetectEventsFromSensor, TestResolveSegments, TestAddSensor, TestLoadModuleData, TestLoadModuleMetadata, TestGroupViolations, TestEventIntegration) - 16 flat test files deleted (test_sensor, test_threshold, test_threshold_rule, test_composite_threshold, test_state_channel, test_sensor_registry, test_threshold_registry, test_sensor_resolve, test_sensor_todisk, test_align_state, test_declarative_condition, test_detect_events_from_sensor, test_resolve_segments, test_add_sensor, test_group_violations, test_event_integration) - 2 legacy benchmark files deleted (benchmark_resolve, benchmark_resolve_stress) - TestAddThreshold/test_add_threshold KEPT (tests FastSense.addThreshold, not Sensor) - TestGoldenIntegration/test_golden_integration PRESERVED for Plan 05 rewrite - All Tag-based tests preserved (TestTag, TestTagRegistry, TestSensorTag, etc.)
…, update install.m - Replace Sensor_ composition delegate with inlined X_/Y_/DataStore_/ID_/Source_/MatFile_/KeyName_ properties - Reimplement load/toDisk/toMemory/isOnDisk directly on SensorTag - Update install.m: remove SensorThreshold/private MEX probe, verify SensorTag instead of Sensor - Rewrite jit_warmup to use Tag API (SensorTag/StateTag/MonitorTag/addTag)
- SUMMARY.md documenting 37 deleted files - STATE.md advanced to plan 2/5, 91% progress - ROADMAP.md updated with plan progress - REQUIREMENTS.md: MIGRATE-03 marked complete
…rivate helpers - Delete: Sensor, Threshold, ThresholdRule, CompositeThreshold, StateChannel, SensorRegistry, ThresholdRegistry, ExternalSensorRegistry - Delete: loadModuleData, loadModuleMetadata, detectEventsFromSensor - Delete: entire libs/SensorThreshold/private/ directory (10 .m + 4 .mex files)
…sses plan - SUMMARY.md with inlining details and deletion inventory - STATE.md updated: plan 2/5, decision recorded, metrics logged - ROADMAP.md progress updated
…tection libs - FastSense.m: delete addSensor() method + resolveThresholdStyle helper - SensorDetailPlot.m: remove Sensor property, keep Tag-only path - EventDetector.m: remove 6-arg legacy overload, keep 2-arg Tag detect() - LiveEventPipeline.m: remove Sensors property, processSensor, buildSensorData, updateStoreSensorData
… API to Tag API - Replace Sensor() with SensorTag() across 41+ example files - Replace StateChannel() with StateTag() - Replace SensorRegistry/ThresholdRegistry with TagRegistry - Replace addSensor() with addTag() - Remove Threshold/addThreshold/addCondition/resolve patterns - Convert s.X/s.Y assignments to updateData() or constructor args - Convert s.Y reads to getXY() temp variable patterns - Remove orphaned legacy method refs (ResolvedViolations, countViolations, etc.)
…+ widgets - DashboardWidget.m: remove Sensor property, map 'Sensor' NV to 'Tag' for backward compat - FastSenseWidget.m: remove all Sensor dispatch, LastSensorRef, addSensor calls - DashboardSerializer.m: SensorRegistry.get -> TagRegistry.get in .m export - DashboardBuilder.m: SensorRegistry.get -> TagRegistry.get - DashboardEngine.m: update comment to reference TagRegistry - DetachedMirror.m: update SensorRegistry comments to TagRegistry - 7 widget fromStruct methods: SensorRegistry.get -> TagRegistry.get, obj.Sensor -> obj.Tag - 5 widget constructors: ThresholdRegistry.get -> TagRegistry.get - TagRegistry.m: remove ThresholdRegistry from See also - EventViewer.m: replace addSensor + buildSensor with addLine + buildSensorData
…r API to Tag API
- Replace Sensor() with SensorTag() in 5 benchmark files
- Replace Sensor/StateChannel/SensorRegistry refs in 41 test files
- Remove detectEventsFromSensor legacy test (bridge deleted in 1011)
- Rename test methods containing 'Sensor(' to avoid false grep hits
- Convert s.X/s.Y patterns to updateData() or constructor args
- Remove addStateChannel/addThreshold/resolve legacy patterns
- SUMMARY.md: 21 files cleaned across Dashboard, FastSense, EventDetection - STATE.md: advanced to plan 4 of 5, 96% progress - ROADMAP.md: updated plan progress for phase 1011
- SUMMARY.md: 100 files migrated, zero legacy refs verified - STATE.md: advance to plan 5 of 5, 98% progress - ROADMAP.md: updated plan progress
- SensorTag replaces Sensor (inline X/Y constructor) - MonitorTag+EventStore replaces detectEventsFromSensor for event detection - MonitorTag MinDuration replaces EventDetector debounce - CompositeTag AND replaces CompositeThreshold AND aggregation - FastSense.addTag replaces addSensor - All 5 assertion groups preserved with equivalent semantics - Same fixture data: Y=[5 5 5 12 14 16 14 5 5 5 5 5 18 20 22 5 5 5 5 5] - Same expected values: event1 start=4 end=7 peak=16, event2 start=13 peak=22
…libs/ and fix broken tests - IncrementalEventDetector.process() stubbed (legacy pipeline dead code) - EventConfig.addSensor/runDetection/escalateEvents stubbed (legacy pipeline) - test_event_detector rewritten to MonitorTag+EventStore pattern - test_event_detector_tag rewritten to MonitorTag+EventStore pattern - test_live_event_pipeline_tag: fixed constructor args for new API, removed Threshold tests - test_live_pipeline/test_incremental_detector: skipped (legacy pipeline removed) - test_status_widget: removed threshold-dependent tests (deleted feature) - test_sensor_detail_plot_tag: removed .Sensor property refs (removed in Plan 03) - test_fastsense_addtag: fixed SensorTag X property access (private) - test_add_threshold: fixed broken continuation line
… PLAN) - Phase 1011 COMPLETE: v2.0 Tag-Based Domain Model migration finished - Golden test rewritten to SensorTag/MonitorTag/CompositeTag/EventStore - Grep audit: zero legacy hits in libs/, examples/, benchmarks/ - Test suite: 73/75 (97.3%) -- 2 pre-existing unrelated failures - MIGRATE-03 requirement fulfilled
- Archive roadmap to .planning/milestones/v2.0-ROADMAP.md - Archive requirements to .planning/milestones/v2.0-REQUIREMENTS.md - Delete active REQUIREMENTS.md (fresh for next milestone) - Evolve PROJECT.md with v2.0 shipped status - 8 phases, 27 plans, 45 requirements, 119 commits Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
8 phase directories moved from .planning/phases/ to .planning/milestones/v2.0-phases/ Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
# Conflicts: # .planning/STATE.md # tests/suite/TestCompositeThreshold.m
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
1 participant
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.
Summary
Tagfoundation —SensorTag,StateTag,MonitorTag,CompositeTagreplace legacySensor/Threshold/StateChannel/CompositeThresholdappendData, and opt-in disk persistenceEventBindingregistry withEvent.TagKeysmany-to-many; FastSense renders toggleable round markers at event timestampsStats
Performance gates (all passed)
Sensor.resolve; appendData 11.1x speedup; consumer tick 0.3% overheadKnown tech debt (3 items, non-blocking)
EventDetector.detect(tag, threshold)references deleted Threshold API — dead code.mexport doesn't handlesource.type='tag'— JSON path worksThreshold(in 42 suite filesTest plan
🤖 Generated with Claude Code