Build GDBM vs ES state verification tooling #164

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

Metadata

  • Commit Message: feat(event-sourcing): build verification tool to compare GDBM and ES state
  • Branch: feature/m2-es-verification

Background and Context

Before transitioning to Phase 3 (ES as primary read source), we need confidence that GDBM and ES contain the same data. A verification tool loads all objects from GDBM and checks each against the ES aggregate/projection state, reporting discrepancies.

Acceptance Criteria

  • SequentSetup.verify_consistency compares all GDBM objects against ES
  • Reports: missing in ES, missing in GDBM, attribute mismatches
  • Returns structured report
  • Accessible from aethyr_setup as a new menu option
  • Admin command averify triggers verification from in-game

Subtasks

  • Implement SequentSetup.verify_consistency method
  • Compare players, rooms, and game objects across stores
  • Generate structured discrepancy report
  • Add option to aethyr_setup menu
  • Add averify admin command with handler and action
  • Tests (Cucumber): Scenario for consistent state (no discrepancies)
  • Tests (Cucumber): Scenario for detected discrepancies
  • 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 verification tooling detects intentional state divergence between GDBM and ES.
  • 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(event-sourcing): build verification tool to compare GDBM and ES state` - **Branch:** `feature/m2-es-verification` ## Background and Context Before transitioning to Phase 3 (ES as primary read source), we need confidence that GDBM and ES contain the same data. A verification tool loads all objects from GDBM and checks each against the ES aggregate/projection state, reporting discrepancies. ## Acceptance Criteria - `SequentSetup.verify_consistency` compares all GDBM objects against ES - Reports: missing in ES, missing in GDBM, attribute mismatches - Returns structured report - Accessible from `aethyr_setup` as a new menu option - Admin command `averify` triggers verification from in-game ## Subtasks - [ ] Implement `SequentSetup.verify_consistency` method - [ ] Compare players, rooms, and game objects across stores - [ ] Generate structured discrepancy report - [ ] Add option to `aethyr_setup` menu - [ ] Add `averify` admin command with handler and action - [ ] Tests (Cucumber): Scenario for consistent state (no discrepancies) - [ ] Tests (Cucumber): Scenario for detected discrepancies - [ ] 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 verification tooling detects intentional state divergence between GDBM and ES. - [ ] 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.2.0 milestone 2026-03-15 23:19:46 +00:00
freemo modified the milestone from v1.2.0 to v1.0.0 2026-03-15 23:30:08 +00:00
freemo self-assigned this 2026-03-16 01:27:04 +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#164
No description provided.