Implement DRb-based server export in Aethyr::Server #70

Open
opened 2026-03-14 23:57:27 +00:00 by freemo · 0 comments
Owner

Metadata

  • Commit Message: feat(experiments): implement DRb server export
  • Branch: feature/m3-drb-server

Background and Context

The experiments system needs to connect to a running Aethyr server to execute programmatic commands. The specification describes a DRb (Distributed Ruby) service that exports $manager over a Unix socket at tmp/aethyr.drb, allowing the experiments Runner and other tools to interact with the live game engine.

Expected Behavior

When the Aethyr server starts, it exports $manager via DRb.start_service('drbunix:tmp/aethyr.drb', $manager). The experiments system can connect via DRbObject.new_with_uri('drbunix:tmp/aethyr.drb') to access the Manager and all its subsystems.

Acceptance Criteria

  • Server starts a DRb service on the Unix socket path tmp/aethyr.drb
  • $manager is accessible from a separate Ruby process via DRb
  • DRb service starts after all game objects are loaded
  • DRb socket file is cleaned up on server shutdown
  • Server functions normally when no DRb clients are connected

Subtasks

  • Code: Add require 'drb/drb' to the server initialization code
  • Code: Add DRb.start_service('drbunix:tmp/aethyr.drb', $manager) after Manager initialization in the server boot sequence
  • Code: Ensure the tmp/ directory exists before starting the DRb service
  • Code: Clean up the DRb socket file (tmp/aethyr.drb) during graceful shutdown
  • Code: Add a configuration option ServerConfig[:drb_enabled] (default: true) to allow disabling DRb
  • Docs: Update RDoc comments on the server startup sequence to document DRb integration
  • Docs: Update the Docusaurus running server documentation to mention the DRb interface
  • Tests (Cucumber): Add tests/unit/drb_export.feature covering: DRb service starts with correct URI, manager is accessible via DRb client, DRb can be disabled via config
  • Tests (Cucumber Integration): Add integration feature verifying DRb client can connect to a running server and query $manager
  • Tests (Profiling): Run bundle exec rake unit_profile and verify no performance regressions from DRb startup
  • 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**: `feat(experiments): implement DRb server export` - **Branch**: `feature/m3-drb-server` ## Background and Context The experiments system needs to connect to a running Aethyr server to execute programmatic commands. The specification describes a DRb (Distributed Ruby) service that exports `$manager` over a Unix socket at `tmp/aethyr.drb`, allowing the experiments Runner and other tools to interact with the live game engine. ## Expected Behavior When the Aethyr server starts, it exports `$manager` via `DRb.start_service('drbunix:tmp/aethyr.drb', $manager)`. The experiments system can connect via `DRbObject.new_with_uri('drbunix:tmp/aethyr.drb')` to access the Manager and all its subsystems. ## Acceptance Criteria - [ ] Server starts a DRb service on the Unix socket path `tmp/aethyr.drb` - [ ] $manager is accessible from a separate Ruby process via DRb - [ ] DRb service starts after all game objects are loaded - [ ] DRb socket file is cleaned up on server shutdown - [ ] Server functions normally when no DRb clients are connected ## Subtasks - [ ] Code: Add `require 'drb/drb'` to the server initialization code - [ ] Code: Add `DRb.start_service('drbunix:tmp/aethyr.drb', $manager)` after Manager initialization in the server boot sequence - [ ] Code: Ensure the `tmp/` directory exists before starting the DRb service - [ ] Code: Clean up the DRb socket file (`tmp/aethyr.drb`) during graceful shutdown - [ ] Code: Add a configuration option `ServerConfig[:drb_enabled]` (default: true) to allow disabling DRb - [ ] Docs: Update RDoc comments on the server startup sequence to document DRb integration - [ ] Docs: Update the Docusaurus running server documentation to mention the DRb interface - [ ] Tests (Cucumber): Add `tests/unit/drb_export.feature` covering: DRb service starts with correct URI, manager is accessible via DRb client, DRb can be disabled via config - [ ] Tests (Cucumber Integration): Add integration feature verifying DRb client can connect to a running server and query $manager - [ ] Tests (Profiling): Run `bundle exec rake unit_profile` and verify no performance regressions from DRb startup - [ ] 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-14 23:57:27 +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:13 +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#70
No description provided.