aethyr/Aethyr
2
0
Fork 0
Code Issues 281 Pull requests Projects Releases Packages Wiki Activity Actions

Implement es_write_mode configuration key for phased migration #150

New issue
Open
opened 2026-03-15 23:08:30 +00:00 by freemo · 0 comments
freemo commented 2026-03-15 23:08:30 +00:00
Owner
Copy link

Metadata

  • Commit Message: feat(config): implement es_write_mode configuration key for phased migration
  • Branch: feature/m1-es-write-mode

Background and Context

The specification defines ServerConfig[:es_write_mode] with values :off, :secondary, :dual_primary, :primary, :es_only to control persistence behavior across the four migration phases. Currently, only a boolean event_sourcing_enabled exists. The write mode key replaces the boolean and enables the transition from Phase 1 through Phase 4.

Current Behavior

ServerConfig[:event_sourcing_enabled] is a boolean (true/false). Guard checks throughout the codebase use if ServerConfig[:event_sourcing_enabled] && defined?(Sequent).

Expected Behavior

ServerConfig[:es_write_mode] accepts one of :off, :secondary, :dual_primary, :primary, :es_only. The old boolean key is deprecated and returns true if mode is not :off. Guard checks use the new key.

Acceptance Criteria

  • ServerConfig[:es_write_mode] implemented with validation for allowed values
  • ServerConfig[:event_sourcing_enabled] deprecated (wrapper returning es_write_mode != :off)
  • conf/config.yaml uses :es_write_mode: :off (replacing :event_sourcing_enabled: false)
  • Guard checks in Manager, StorageMachine, and GameObject updated to use new key
  • All existing tests pass with backward-compatible behavior

Subtasks

  • Add :es_write_mode to ServerConfig in config.rb with validation
  • Deprecate :event_sourcing_enabled with wrapper method
  • Update conf/config.yaml default
  • Update guard checks in Manager, StorageMachine, GameObject
  • Tests (Cucumber): Scenario for each write mode value
  • Tests (Cucumber): Verify backward compat with old boolean config
  • Update docs/developer/event-sourcing-api.md configuration section
  • 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 server boots with each es_write_mode setting and routes writes correctly.
  • 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(config): implement es_write_mode configuration key for phased migration` - **Branch:** `feature/m1-es-write-mode` ## Background and Context The specification defines `ServerConfig[:es_write_mode]` with values `:off`, `:secondary`, `:dual_primary`, `:primary`, `:es_only` to control persistence behavior across the four migration phases. Currently, only a boolean `event_sourcing_enabled` exists. The write mode key replaces the boolean and enables the transition from Phase 1 through Phase 4. ## Current Behavior `ServerConfig[:event_sourcing_enabled]` is a boolean (`true`/`false`). Guard checks throughout the codebase use `if ServerConfig[:event_sourcing_enabled] && defined?(Sequent)`. ## Expected Behavior `ServerConfig[:es_write_mode]` accepts one of `:off`, `:secondary`, `:dual_primary`, `:primary`, `:es_only`. The old boolean key is deprecated and returns `true` if mode is not `:off`. Guard checks use the new key. ## Acceptance Criteria - `ServerConfig[:es_write_mode]` implemented with validation for allowed values - `ServerConfig[:event_sourcing_enabled]` deprecated (wrapper returning `es_write_mode != :off`) - `conf/config.yaml` uses `:es_write_mode: :off` (replacing `:event_sourcing_enabled: false`) - Guard checks in Manager, StorageMachine, and GameObject updated to use new key - All existing tests pass with backward-compatible behavior ## Subtasks - [ ] Add `:es_write_mode` to `ServerConfig` in `config.rb` with validation - [ ] Deprecate `:event_sourcing_enabled` with wrapper method - [ ] Update `conf/config.yaml` default - [ ] Update guard checks in Manager, StorageMachine, GameObject - [ ] Tests (Cucumber): Scenario for each write mode value - [ ] Tests (Cucumber): Verify backward compat with old boolean config - [ ] Update `docs/developer/event-sourcing-api.md` configuration section - [ ] 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 server boots with each es_write_mode setting and routes writes correctly. - [ ] 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:39 +00:00
freemo self-assigned this 2026-03-16 01:27:00 +00:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
feature/m2-headless-renderer
dependabot/bundler/rdoc-6.3.2
dependabot/bundler/rexml-3.2.5
dependabot/bundler/json-tw-2.3
inprogress
dependabot/bundler/rake-tw-13.0
No results found.
Labels
Clear labels   
Blocked

Cannot proceed, depends on unresolved issue

  
Duplicate

Issue is a duplicate of an existing one

  
MoSCoW/Could Have

Desirable but not necessary, included if time permits

  
MoSCoW/Must Have

Essential, project cannot ship without it

  
MoSCoW/Should Have

Important but not strictly essential

  
Points/1

Estimated effort: 1 story points

  
Points/13

Estimated effort: 13 story points

  
Points/2

Estimated effort: 2 story points

  
Points/21

Estimated effort: 21 story points

  
Points/3

Estimated effort: 3 story points

  
Points/5

Estimated effort: 5 story points

  
Points/8

Estimated effort: 8 story points

  
Priority/Backlog

Not yet prioritized

  
Priority/Critical

Must be addressed immediately

  
Priority/High

Important, should be completed soon

  
Priority/Low

Nice to have, not time-sensitive

  
Priority/Medium

Normal priority, valid and should be addressed

  
State/Completed

Issue resolved and all PRs merged

  
State/In progress

Someone is actively working on this issue

  
State/In review

Implementation complete, PR submitted for review

  
State/Paused

Work temporarily suspended, typically blocked

  
State/Unverified

Issue created but not yet reviewed by a maintainer

  
State/Verified

Maintainer confirmed valid and actionable

  
State/Wont Do

Deliberate decision not to address this issue

  
Type/Bug

A defect in existing functionality

  
Type/Epic

Large body of work broken into multiple issues

  
Type/Feature

A new capability or user story

  
Type/Legendary

Major strategic pillar composed of multiple Epics

  
Type/Task

Technical or administrative work (not bug or feature)

  
Type/Testing

Test-only work item (TDD, test infrastructure, coverage)

No labels
Blocked
Duplicate
MoSCoW/Could Have
MoSCoW/Must Have
MoSCoW/Should Have
Points/1
Points/13
Points/2
Points/21
Points/3
Points/5
Points/8
Priority/Backlog
Priority/Critical
Priority/High
Priority/Low
Priority/Medium
State/Completed
State/In progress
State/In review
State/Paused
State/Unverified
State/Verified
State/Wont Do
Type/Bug
Type/Epic
Type/Feature
Type/Legendary
Type/Task
Type/Testing
Milestone
Clear milestone
No items
No milestone
v1.0.0
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
freemo
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.

Blocks
#148 Epic: ES Infrastructure and Configuration
aethyr/Aethyr
Reference: aethyr/Aethyr#150
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?