Fix control mode: default to off and add fallback#6
Merged
Conversation
Re-add control connection support for multiplexed WebSocket operations, with two key fixes over the original implementation: - Default controlMode to false (opt-in) instead of true, so servers without /control endpoint support work without any changes - Add graceful fallback in execFile: if control connection fails, transparently falls back to regular per-command WebSocket execution
9506118 to
4741bab
Compare
Contributor
Author
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. 🤖 Generated with Claude Code |
Pre-connection WebSocket errors were emitting on the EventEmitter with no listener attached, crashing the Node.js process before the try/catch fallback in execFile could catch the promise rejection. Split error handling by connection phase: pre-connection errors only reject the promise (caught by fallback), post-connection errors emit on the EventEmitter for active operation listeners.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
controlModetofalse(opt-in) instead oftrue— servers that don't support the/controlWebSocket endpoint no longer crash the SDKexecFile— if a control connection fails, transparently falls back to regular per-command WebSocket executionContext
Control mode was merged in #4 with
controlMode: trueas the default. This broke thesprite-envrelease pipeline because the example generator runsexec()against sprites that don't have control connection support. The WebSocket upgrade to/v1/sprites/{name}/controlfails and the unhandled error crashes the process.See: https://github.com/superfly/sprite-env/actions/runs/21733080553/job/62692018553
Test plan
npm run test:unit— 25 tests)node --test dist/control.test.ts— 8 tests)sprite-envsubmodule pointer forsdks/jsand verify example generation succeeds