microsoft / microsoft/duroxide-node
select/race flattens activity errors into the winner's value instead of surfacing a failure
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 36
- Forks
- 20
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 4
Description
Summary
When an activity participates in ctx.race() / ctx.raceTyped() and fails, the select resolves successfully with the branch's raw error string as its value instead of surfacing a failure. The orchestration receives { index: 0, value: "<error message>" } and has no way to distinguish a failed activity from a successful activity that legitimately returned that same string.
This is inconsistent with the SDK's own semantics elsewhere:
- A directly yielded activity that fails is delivered via
driveStepWithError→gen.throw(...)— the orchestration sees a thrown error (handlers.rsbuilds the step payload withisError,lib/duroxide.jscallsgen.throwwhenisErroris set). ctx.all()/ctx.allTyped()(join) deliberately preserves the distinction:make_join_futurewraps each branch as{ok: v}/{err: e}("Unlike make_select_future, this preserves the ok/err distinction so JS can tell success from failure").
Only select flattens. The comment in src/handlers.rs documents it as intentional:
/// Convert a ScheduledTask into a type-erased future returning a raw string for use in select.
/// Activity/sub-orch errors are flattened (Ok and Err both become the raw string value).
fn make_select_future(...) -> ... {
match task {
ScheduledTask::Activity { .. } => Box::pin(async move {
...
match future.await {
Ok(v) => v,
Err(e) => e, // <-- error becomes the winning *value*
}
}),
...
The same flattening applies to ActivityWithRetry, SubOrchestration*, and GetValueFromInstance branches.
Why this is a footgun
The failure is silent. Orchestration code like:
const winner = yield ctx.race(
ctx.scheduleActivity("CallModel", input), // may fail
ctx.dequeueEvent("cancel"),
);
if (winner.index === 0) {
const result = JSON.parse(winner.value); // error string flows in here
...
}
happily treats the error message as the activity's result. Any error-handling try/catch around the yield — which works correctly for the direct-yield form — never fires. If the activity's legitimate return type is a plain string, the two cases are indistinguishable even in principle.
We hit this in PilotSwarm while converting a directly-yielded long-running activity into race(activityTask, dequeueEvent(stopQueue)) for a stop-button feature: the conversion silently disabled the entire activity retry path until we noticed the flattening in the bridge source and added a shape-sniffing workaround (parse the value; if it isn't the expected JSON payload, re-throw it as an error). That workaround only works because our activity returns structured JSON, not strings.
Repro
runtime.registerActivity("Boom", async () => { throw new Error("kaboom"); });
runtime.registerOrchestration("RaceBoom", function* (ctx) {
try {
const winner = yield ctx.race(
ctx.scheduleActivity("Boom", null),
ctx.scheduleTimer(60_000),
);
// Reached with winner = { index: 0, value: "kaboom" } — no throw.
return `unexpected success: ${JSON.stringify(winner)}`;
} catch (err) {
return `caught: ${err.message}`; // never reached
}
});
Expected (to match direct-yield semantics): the catch fires, or the winner carries an explicit error marker.
Actual: the orchestration completes with unexpected success: {"index":0,"value":"kaboom"}.
Possible fixes
- Throw into the generator when the select winner is a failed branch — consistent with the direct-yield contract. (Losing branches are already cancel-requested; only the winner's disposition changes.)
- Preserve the marker like join does: resolve select with
{ index, ok }/{ index, err }(or{ index, value, isError }). Breaking change for existing callers, but the current shape is unreliable anyway. - At minimum, document the flattening prominently on
race()/raceTyped()in the README and JSDoc — today it's only visible in a Rust source comment.
Option 1 seems most consistent; option 2 is more expressive if you'd rather races never throw.
Environment
- duroxide-node 0.1.27 (npm), also verified against current
mainsources (src/handlers.rsmake_select_future/ScheduledTask::Selecthandling) - macOS arm64, Node 20+
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with src/handlers.rs, especially make_select_future and ScheduledTask::Select, then compare the direct-error path in handlers.rs and lib/duroxide.js with make_join_future. Run the provided RaceBoom repro and inspect race() / raceTyped() entry points. Done means a failed winning branch cannot be mistaken for a successful value and the existing select behavior is covered by regression validation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, rust
- Domain
- backend, distributed-systems
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100