Skip to content

fix(client): stop defaulting TransportWebSocket to the deprecated CONST_DEFAULT_SERVICE (#2590) - #2591

Open
kairavb wants to merge 2 commits into
rocketride-org:developfrom
kairavb:fix/RR-2590-deprecated-const-default-service
Open

kairavb wants to merge 2 commits into
rocketride-org:developfrom
kairavb:fix/RR-2590-deprecated-const-default-service

Conversation

@kairavb

@kairavb kairavb commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Both SDKs' TransportWebSocket defaulted their constructor to CONST_DEFAULT_SERVICE, a constant
    explicitly marked deprecated in favor of CONST_DEFAULT_WEB_CLOUD (currently just an alias, same
    value) — swapped both to the non-deprecated name
  • Fixed the Python constants.py module docstring's own usage example, which was pointing readers
    at the deprecated constant
  • No behavior change: both constants resolve to the same value today; the deprecated constant
    itself stays exported in both SDKs' public API (__all__ unchanged) — nothing removed

Type

Bug fix (non-breaking change which fixes an issue)

Testing

  • Tests added or updated
  • Tested locally
  • ./builder test passes

Ran the full suite for both affected packages:

./builder client-python:test --verbose
493 passed, 9 skipped, 25 subtests passed in 159.02s

./builder client-typescript:test --verbose
tests/TransportWebSocket.test.ts PASS — 32/32 (node ws + browser WebSocket variants)
Tests: 12 skipped, 321 passed, 333 total

All skips are pre-existing and unrelated (missing LLM API keys, non-ASCII filesystem encoding, no
OTLP collector configured, chat/LLM integration tests needing external services).

Checklist

  • Commit messages follow conventional commits
  • No secrets or credentials included
  • Wiki updated (if applicable)
  • Breaking changes documented (if applicable)

Linked Issue

Fixes #2590

Summary by CodeRabbit

  • Bug Fixes
    • WebSocket connections in the Python and TypeScript clients now use the current web cloud endpoint by default, rather than the deprecated default endpoint. Connections that specify a URI continue to use that URI.
  • Documentation
    • Updated the Python usage example to use the current default endpoint constant. The timeout example remains unchanged.

@github-actions github-actions Bot added module:client-python Python SDK and MCP client module:client-typescript TypeScript client SDK labels Oct 9, 2026
@github-actions

github-actions Bot commented Oct 9, 2026

Copy link
Copy Markdown
Contributor
🤖 Internal: Discord sync marker

Auto-managed by the Discord notification workflow. Stores the linked Discord message ID and forum thread ID. Do not edit or delete.

@coderabbitai

coderabbitai Bot commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: rocketride-org/rocketride-server/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 693b980a-ba37-4ad1-95ed-62cd6a11dc9e

📥 Commits

Reviewing files that changed from the base of the PR and between 7eb1d2e and 78aab0e.


📒 Files selected for processing (1)
  • packages/client-python/src/rocketride/core/constants.py

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.



📝 Walkthrough

Walkthrough

The Python and TypeScript WebSocket transports now default to CONST_DEFAULT_WEB_CLOUD. The Python module documentation identifies CONST_DEFAULT_SERVICE as a deprecated alias and uses CONST_DEFAULT_WEB_CLOUD in its example.

Changes

SDK default URI updates

Layer / File(s) Summary
Update SDK default URI references
packages/client-python/src/rocketride/core/constants.py, packages/client-python/src/rocketride/core/transport_websocket.py, packages/client-typescript/src/client/core/TransportWebSocket.ts
Both SDK transports import and use CONST_DEFAULT_WEB_CLOUD as the default URI. The Python module documentation identifies CONST_DEFAULT_SERVICE as a deprecated alias, and its usage example passes CONST_DEFAULT_WEB_CLOUD.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Refactor · Severity of issue fixed: Low


Merge Risk: ⚪ Minimal · up to 78aab

This change aligns the WebSocket defaults and Python example with the non-deprecated constant without changing the effective URI or public exports. No actionable merge risk remains beyond normal checks.

Pre-merge checks | Passed 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: both SDKs now use CONST_DEFAULT_WEB_CLOUD instead of the deprecated CONST_DEFAULT_SERVICE for TransportWebSocket defaults.
Linked Issues check Passed Issue #2590 requires both SDK WebSocket transports to use CONST_DEFAULT_WEB_CLOUD. The Python and TypeScript transport changes meet this requirement. The Python module example also uses CONST_DEFAULT_…
Out of Scope Changes check Passed The changes affect only the two WebSocket transport files and the Python constants documentation. Each change supports issue #2590. No unrelated behavior change or public constant removal is reported.
Docstring Coverage Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 3 files.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

joshuadarron
joshuadarron previously approved these changes Oct 9, 2026

@joshuadarron joshuadarron left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Verified:

  • CONST_DEFAULT_SERVICE is a plain alias of CONST_DEFAULT_WEB_CLOUD in both SDKs (constants.py:69, constants.ts:60), so the default URI is byte-identical and nothing changes at runtime.
  • After this PR, nothing in either SDK's src/ uses the deprecated name. It is still exported (__all__ and the TS module) for backward compatibility.
  • client.py / client.ts already default to CONST_DEFAULT_WEB_CLOUD, so the transport now matches its callers.
  • CI is green: builds, ESLint, and PR checks.

Non-blocking nit: constants.py:31 in the module docstring's attribute list still describes CONST_DEFAULT_SERVICE as "Default RocketRide service URI" with no deprecation note. Worth listing CONST_DEFAULT_WEB_CLOUD there and marking the old name deprecated, to match the comment at line 68.

…ULT_SERVICE deprecated in constants.py docstring
@kairavb

kairavb commented Oct 10, 2026

Copy link
Copy Markdown
Contributor Author

Addressed the docstring nit from your review — thanks!

@joshuadarron joshuadarron left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-approving after 78aab0e0, which addresses my earlier nit: the constants.py docstring now lists CONST_DEFAULT_WEB_CLOUD as the default URI and marks CONST_DEFAULT_SERVICE as a deprecated alias, matching the comment at line 68 and the TS @deprecated JSDoc. The transport changes are the same as in 7eb1d2e2, which I already verified, and CI is green.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

module:client-python Python SDK and MCP client module:client-typescript TypeScript client SDK

Projects

None yet

Development

Successfully merging this pull request may close these issues.

SDK clients still default to the deprecated CONST_DEFAULT_SERVICE constant (TypeScript + Python)

2 participants