Freeze EventHandler — document no-new-event-types policy #193

New issue

Open

opened 2026-03-15 23:08:55 +00:00 by freemo · 0 comments

freemo commented

2026-03-15 23:08:55 +00:00

Owner

Metadata

Commit Message: chore(deprecation): freeze EventHandler, document no-new-event-types policy
Branch: feature/m1-freeze-event-handler

Background and Context

First step of EventHandler deprecation: document that no new event types may be added.

Acceptance Criteria

Deprecation comment on EventHandler class
Developer docs include "Do not add new event types to EventHandler" guidance
Existing event types documented

Subtasks

Add deprecation comment to EventHandler class
Document existing event types and migration plan
Update docs/developer/architecture.md
Run bundle exec rake unit, fix any failures
Docs: Update YARD comments on affected classes and methods. Update relevant Docusaurus documentation pages if applicable.
Tests (Cucumber Integration): Add integration feature in tests/integration/ verifying EventHandler accepts no new event types and logs warnings on attempts.
Tests (Profiling): Run bundle exec rake unit_profile and verify no performance regressions.
Quality: Verify coverage >=97% via bundle exec rake unit. If coverage is <97% then review the current unit test coverage report at build/tests/unit/coverage/ and use it to write new Cucumber based unit tests to improve code coverage. Specifically, write Cucumber/Gherkin style unit tests that are descriptively named and specifically improve coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun bundle exec rake unit to verify all tests pass and coverage is above >=97%. Only mark this as complete once coverage is >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%.
Quality: Run bundle exec rake (default task: unit tests with coverage) and bundle exec rake integration, fix any errors if needed ensuring both pass across entire code base, do not ignore any failure even if it seems unrelated to this commit, fix it.

Definition of Done

This issue is complete when all subtasks are completed, commit created with prescribed message on prescribed branch, PR submitted, reviewed, and merged.

## Metadata - **Commit Message:** `chore(deprecation): freeze EventHandler, document no-new-event-types policy` - **Branch:** `feature/m1-freeze-event-handler` ## Background and Context First step of EventHandler deprecation: document that no new event types may be added. ## Acceptance Criteria - Deprecation comment on `EventHandler` class - Developer docs include "Do not add new event types to EventHandler" guidance - Existing event types documented ## Subtasks - [ ] Add deprecation comment to `EventHandler` class - [ ] Document existing event types and migration plan - [ ] Update `docs/developer/architecture.md` - [ ] Run `bundle exec rake unit`, fix any failures - [ ] Docs: Update YARD comments on affected classes and methods. Update relevant Docusaurus documentation pages if applicable. - [ ] Tests (Cucumber Integration): Add integration feature in `tests/integration/` verifying EventHandler accepts no new event types and logs warnings on attempts. - [ ] Tests (Profiling): Run `bundle exec rake unit_profile` and verify no performance regressions. - [ ] Quality: Verify coverage >=97% via `bundle exec rake unit`. If coverage is <97% then review the current unit test coverage report at `build/tests/unit/coverage/` and use it to write new Cucumber based unit tests to improve code coverage. Specifically, write Cucumber/Gherkin style unit tests that are descriptively named and specifically improve coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun `bundle exec rake unit` to verify all tests pass and coverage is above >=97%. Only mark this as complete once coverage is >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%. - [ ] Quality: Run `bundle exec rake` (default task: unit tests with coverage) and `bundle exec rake integration`, fix any errors if needed ensuring both pass across **entire** code base, do not ignore any failure even if it seems unrelated to this commit, fix it. ## Definition of Done This issue is complete when all subtasks are completed, commit created with prescribed message on prescribed branch, PR submitted, reviewed, and merged.