Fix Reacts trait reaction execution raising 'need to fix this' #80

Open
opened 2026-03-15 02:12:58 +00:00 by freemo · 0 comments
Owner

Metadata

  • Commit Message: fix(engine): fix Reacts trait reaction execution
  • Branch: bugfix/m3-reacts-execution

Background and Context

The Reacts trait's reaction execution currently raises a 'need to fix this' error when NPCs attempt to execute reaction scripts. This is a known defect in the core engine that prevents NPC scripted behavior from functioning correctly. The issue is in lib/aethyr/core/objects/traits/reacts.rb where the reaction command dispatch is incomplete.

Expected Behavior

When an NPC with loaded .rx reaction scripts receives a matching event, the reaction's test expression is evaluated and, if truthy, the reaction body is executed to produce a command string that the NPC then performs. No errors should be raised during normal reaction execution.

Acceptance Criteria

  • NPC reaction scripts execute without raising errors
  • The helper NPC in the tutorial room responds to player speech
  • Reaction test expressions correctly gate reaction execution
  • Reaction command strings are properly dispatched through the NPC's command handler

Subtasks

  • Code: Locate the 'need to fix this' raise in lib/aethyr/core/objects/traits/reacts.rb and identify the incomplete dispatch logic
  • Code: Implement proper command dispatch for NPC reaction command strings, routing them through the NPC's input handler or direct command execution
  • Code: Ensure the Reactor engine's react_to method correctly collects and returns command strings from matching reactions
  • Code: Verify the helper.rx reaction script works end-to-end (NPC responds to 'hi', 'help', etc.)
  • Docs: Update RDoc comments on the Reacts trait's react_to and command dispatch methods
  • Tests (Cucumber): Add tests/unit/reacts_execution.feature covering: successful reaction execution, test expression gating, command string dispatch, multiple reactions on same action
  • Tests (Cucumber Integration): Add integration feature in tests/integration/ verifying NPC reaction behavior with a live server and helper NPC
  • Tests (Profiling): Run bundle exec rake unit_profile and verify no performance regressions in reaction dispatch
  • Quality: Verify coverage >=85% via bundle exec rake unit. If coverage is <85% 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 >=85%. Only mark this as complete once coverage is >=85%, if not repeat this task as many times as is needed until coverage reaches >=85%.
  • 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**: `fix(engine): fix Reacts trait reaction execution` - **Branch**: `bugfix/m3-reacts-execution` ## Background and Context The Reacts trait's reaction execution currently raises a 'need to fix this' error when NPCs attempt to execute reaction scripts. This is a known defect in the core engine that prevents NPC scripted behavior from functioning correctly. The issue is in `lib/aethyr/core/objects/traits/reacts.rb` where the reaction command dispatch is incomplete. ## Expected Behavior When an NPC with loaded `.rx` reaction scripts receives a matching event, the reaction's test expression is evaluated and, if truthy, the reaction body is executed to produce a command string that the NPC then performs. No errors should be raised during normal reaction execution. ## Acceptance Criteria - [ ] NPC reaction scripts execute without raising errors - [ ] The helper NPC in the tutorial room responds to player speech - [ ] Reaction test expressions correctly gate reaction execution - [ ] Reaction command strings are properly dispatched through the NPC's command handler ## Subtasks - [ ] Code: Locate the 'need to fix this' raise in `lib/aethyr/core/objects/traits/reacts.rb` and identify the incomplete dispatch logic - [ ] Code: Implement proper command dispatch for NPC reaction command strings, routing them through the NPC's input handler or direct command execution - [ ] Code: Ensure the Reactor engine's `react_to` method correctly collects and returns command strings from matching reactions - [ ] Code: Verify the `helper.rx` reaction script works end-to-end (NPC responds to 'hi', 'help', etc.) - [ ] Docs: Update RDoc comments on the `Reacts` trait's `react_to` and command dispatch methods - [ ] Tests (Cucumber): Add `tests/unit/reacts_execution.feature` covering: successful reaction execution, test expression gating, command string dispatch, multiple reactions on same action - [ ] Tests (Cucumber Integration): Add integration feature in `tests/integration/` verifying NPC reaction behavior with a live server and helper NPC - [ ] Tests (Profiling): Run `bundle exec rake unit_profile` and verify no performance regressions in reaction dispatch - [ ] Quality: Verify coverage >=85% via `bundle exec rake unit`. If coverage is <85% 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 >=85%. Only mark this as complete once coverage is >=85%, if not repeat this task as many times as is needed until coverage reaches >=85%. - [ ] 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.1.0 milestone 2026-03-15 02:12:58 +00:00
freemo self-assigned this 2026-03-15 04:25:23 +00:00
freemo modified the milestone from v1.1.0 to v1.2.0 2026-03-16 00:28:16 +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#80
No description provided.