ractor-wrapper 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ceddba72640a063108102f44bf7cf8276305dcfcc4b2807ec24c474997d5dc4
-  data.tar.gz: ec46f0323abf7a8468ae8f4b8db82e47d4f6f906ed169d8853f86c82ba50414b
+  metadata.gz: 0c9842a8f90ab6b20838f2f79a5b70dd63caf6dd895bb933c116f44f9d994079
+  data.tar.gz: 496a5dbd7b8f62aeb889c34e48adb09ec879fc2c382cea8192cf7935a6fec237
 SHA512:
-  metadata.gz: 91057acf2a760454fe5864f113f63eadabf54e229b23816784ebdca931be280e85152879ad986ba68100ca49a88d854b856f0af19d69b316a4bcfef09b3d7cdc
-  data.tar.gz: 29b1f2b0713bae3737d168578e832d2c4edabf13181ef927dc8473e5b2eee02357eb61c938eccdf1afec5e803af5add40e35c550530d067178e5493cf67abf84
+  metadata.gz: 20fb9f04c4824370c120133c72a8927f1131aab29bf134b367b2afc36c19b5be8b42e864ec776f437bd7424b39203c9524a31972a8e4633e2f5915d03168c513
+  data.tar.gz: 07d84754548dfc770381aa517812f9d702ae5b7f1ccaea0ec36f7fc8be3a8049080606ba52d34f47b4749d1665f8a06a992a97a394e5ca2c17e08c92672fbc20

data/.yardopts

@@ -8,3 +8,4 @@
 README.md
 LICENSE.md
 CHANGELOG.md
+DESIGN.md

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Release History
 
+### v0.5.0 / 2026-04-26
+
+* ADDED: Reworked server flow to use fibers, to reduce deadlocks on nested calls
+* DOCS: Added design doc
+
+### v0.4.0 / 2026-03-30
+
+This release includes two major changes: it greatly improves robustness in the case of server crashes, and it reworks the method call configuration interface. This involves several breaking changes, and I expect the interface will continue to be a bit unstable for now as I'm working through use cases and edge cases. The README has also been expanded to include more information on the configuration options and the known issues.
+
+* ADDED: Uses a separate `Ractor::Wrapper::Configuration` class for block-based initialization. Removed the configuration mutation methods from `Ractor::Wrapper` itself.
+* BREAKING CHANGE: The method configuration interface now uses symbolic settings values instead of booleans for more flexibility
+* ADDED: Support for suppressing return values for methods and blocks that unintentionally return something they shouldn't
+* BREAKING CHANGE: Raises `Ractor::Wrapper::StoppedError` instead of `Ractor::ClosedError` if a method is called via the wrapper after the wrapper has stopped
+* BREAKING CHANGE: `Wrapper#join` now returns normally rather than raising, if an isolated wrapper terminated due to a crash
+* BREAKING FIX: `Wrapper#join` no longer hangs if a local wrapper crashes, but returns to indicate that the wrapper has stopped (albeit non-normally)
+* FIXED: Internal cleanup is more robust if a crash occurs in the wrapper
+* FIXED: Method calls raise `Ractor::Wrapper::CrashedError` instead of hanging if the wrapper crashes during handling
+* FIXED: Prevented port leaks if a method call send or a block yield send fails
+* FIXED: Methods that return or yield self return/yield the stub instead
+* FIXED: The `recover_object` method now raises `Ractor::Wrapper::Error` if recovery failed
+* DOCS: Updates to README
+
 ### v0.3.0 / 2026-01-05
 
 This is a major update, and the library, while still experimental, is finally somewhat usable. The examples in the README now actually work!

data/CLAUDE.md

@@ -0,0 +1,79 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Commands
+
+This project uses [Toys](https://dazuma.github.io/toys) for task management (not Rake).
+
+```bash
+# Run full CI pipeline
+toys ci
+
+# Run individual components
+toys test      # Tests only
+toys rubocop   # Linting and code style only
+toys yardoc    # Documentation only
+toys build     # Build gem only
+
+# Run a single test file
+toys test test/test_wrapper.rb
+```
+
+## Architecture
+
+The entire library lives in `lib/ractor/wrapper.rb`. The public entry point is `Ractor::Wrapper`, which wraps a non-shareable object and exposes it to other Ractors via a shareable `Stub` proxy.
+
+### Core classes
+
+- **`Ractor::Wrapper`** — Public API. Wraps an object and manages its lifecycle. Accepts options like `use_current_ractor:`, `threads:`, `name:`, and per-method settings via `configure_method`.
+- **`Ractor::Wrapper::Stub`** — Frozen, shareable proxy passed to other Ractors. Uses `method_missing` to forward calls back to the wrapper via message passing.
+- **`Ractor::Wrapper::MethodSettings`** — Frozen configuration controlling copy vs. move semantics for arguments and return values, and block handling behavior.
+- **`Ractor::Wrapper::Server`** — Private backend. Receives `CallMessage` objects and dispatches them to the wrapped object, then returns results via `ReturnMessage`, `ExceptionMessage`, or one of the yield message types (`FiberYieldMessage` or `BlockingYieldMessage`).
+
+### Two execution modes
+
+1. **Isolated mode** (default) — the wrapped object is moved into a new Ractor. Other Ractors interact with it through the Stub. After `join`, the object can be recovered via `recover_object`.
+2. **Local mode** (`use_current_ractor: true`) — the server runs as Thread(s) inside the current Ractor. The object is never moved. Used for objects that cannot be transferred between Ractors (e.g., SQLite3 connections).
+
+### Concurrency within the server
+
+- **Sequential** (default) — one call at a time, no worker threads.
+- **Concurrent** — multiple worker threads (set via `threads:`), for thread-safe wrapped objects.
+
+### Message protocol
+
+All inter-Ractor communication uses frozen message structs defined in the file: `CallMessage`, `ReturnMessage`, `ExceptionMessage`, `FiberYieldMessage`, `BlockingYieldMessage`, `FiberReturnMessage`, `FiberExceptionMessage`, `StopMessage`, `JoinMessage`, `WorkerStoppedMessage`. Block calls round-trip via one of two paths:
+
+- **Fiber-suspend path** (most cases): the server sends a `FiberYieldMessage` (carrying the `fiber_id` of the suspended method-handling fiber) to the caller Ractor. The caller executes the block and sends a `FiberReturnMessage` or `FiberExceptionMessage` back to the server's main port; the main loop looks up the fiber by id and resumes it with the reply.
+- **Blocking-fallback path** (nested-fiber/spawned-thread cases): the server allocates a temporary reply port, sends a `BlockingYieldMessage` carrying that port, and blocks on it. The caller responds with a `ReturnMessage` or `ExceptionMessage` directly to that temporary port. This path can deadlock under re-entrant calls but is preserved where the fiber-suspend path is not safe.
+
+### Lifecycle
+
+1. Wrapper starts → Server enters **running** phase (accepts calls).
+2. `async_stop` or `stop` called → Server enters **stopping** phase (rejects new calls, drains workers).
+3. All workers finish → Server enters **cleanup** phase and shuts down.
+4. `join` returns → In isolated mode, `recover_object` retrieves the wrapped object.
+
+## Code Style
+
+- Ruby 4.0+ target
+- Double-quoted strings (`Style/StringLiterals: double_quotes`)
+- Trailing commas in multiline arrays and hashes
+- Bracket-style symbol and word arrays (`[:foo, :bar]` not `%i[foo bar]`)
+- Max line length: 120
+- `Style/DocumentationMethod: Enabled` — public methods require YARD docs
+- Tests use Minitest spec style with assertions (not expectations)
+- Top-level constants must be prefixed with `::` (e.g. `::File`, `::Regexp`, `::Gem::Version`) to avoid ambiguous resolution within nested namespaces. Relative constants defined within the current namespace should not be prefixed. Note that Kernel method calls such as `Array(x)`, `Integer(x)`, `Float(x)` look like constants but are not and do not get the prefix.
+
+## Testing
+
+- Minitest spec style: `describe`/`it` blocks with `assert_*` assertions (not expectations)
+- Test files follow the `test_*.rb` naming convention
+
+## General coding instructions
+
+- Unless instructed otherwise, always use red-green test-driven development when making code changes. For each step in a coding task, first write tests and confirm they fail. Then write code to make the tests pass.
+- Unless instructed otherwise, always git commit after a step is complete and the tests pass.
+- Conventional Commits format required (`fix:`, `feat:`, `docs:`, etc.)
+- Prefer Ruby for any one-off scripts you need to write as part of your work.