Create :legacy_output bridge event for gradual player.output() migration #185

Open
opened 2026-03-15 23:08:51 +00:00 by freemo · 0 comments
Owner

Metadata

  • Commit Message: feat(events): create :legacy_output bridge event for gradual player.output() migration
  • Branch: feature/m1-legacy-output-bridge

Background and Context

With 111+ player.output() call sites, migration must be gradual. A :legacy_output bridge allows converting sites incrementally: code broadcasts the event, a subscriber on Player calls output() internally.

Acceptance Criteria

  • broadcast(:legacy_output, {publisher: self, message: text, message_type: type}) available
  • Player subscribes handler that calls output() on :legacy_output
  • Helper method publish_output(player, message, **opts) available
  • Existing behavior unchanged for callers using bridge

Subtasks

  • Define :legacy_output event format
  • Create LegacyOutputSubscriber on Player
  • Create publish_output helper in shared module
  • Tests (Cucumber): Verify bridge delivers output
  • Tests (Cucumber): Verify message_type preserved
  • 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 legacy_output bridge correctly routes player.output calls through Wisper.
  • 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 above are completed and checked off.
  • A Git commit is created where the first line of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation.
  • The commit is pushed to the remote on the branch matching the Branch in Metadata exactly.
  • The commit is submitted as a pull request to master, reviewed, and merged before this issue is marked done.
## Metadata - **Commit Message:** `feat(events): create :legacy_output bridge event for gradual player.output() migration` - **Branch:** `feature/m1-legacy-output-bridge` ## Background and Context With 111+ `player.output()` call sites, migration must be gradual. A `:legacy_output` bridge allows converting sites incrementally: code broadcasts the event, a subscriber on Player calls `output()` internally. ## Acceptance Criteria - `broadcast(:legacy_output, {publisher: self, message: text, message_type: type})` available - Player subscribes handler that calls `output()` on `:legacy_output` - Helper method `publish_output(player, message, **opts)` available - Existing behavior unchanged for callers using bridge ## Subtasks - [ ] Define `:legacy_output` event format - [ ] Create `LegacyOutputSubscriber` on Player - [ ] Create `publish_output` helper in shared module - [ ] Tests (Cucumber): Verify bridge delivers output - [ ] Tests (Cucumber): Verify message_type preserved - [ ] 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 legacy_output bridge correctly routes player.output calls through Wisper. - [ ] 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 above are completed and checked off. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata exactly. - The commit is submitted as a **pull request** to `master`, reviewed, and **merged** before this issue is marked done.
freemo added this to the v1.0.0 milestone 2026-03-15 23:19:45 +00:00
freemo self-assigned this 2026-03-16 01:27:07 +00:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference: aethyr/Aethyr#185
No description provided.