Improve error messages for better user experience

[mattheworiordan]

Summary

This PR improves error messages throughout the codebase to be more descriptive and user-friendly, providing clearer guidance on what went wrong and how to resolve issues.

⚠️ This PR is autogenerated as a proof of concept for an RFC
This forms part of the PoC for RFC: Automated Error Documentation System.

Changes

This commit updates error message strings to be more descriptive and user-friendly,
providing clearer guidance on what went wrong and how to resolve issues.

Changes include:
src/common/lib/client/auth.ts | 3 ++-
src/common/lib/client/baseclient.ts | 3 ++-
src/common/lib/client/realtimechannel.ts | 3 ++-
src/common/lib/client/realtimepresence.ts | 6 ++++--
src/common/lib/client/rest.ts | 6 ++++--
src/common/lib/transport/connectionmanager.ts | 3 ++-
src/common/lib/transport/transport.ts | 3 ++-
src/common/lib/types/basemessage.ts | 3 ++-
src/common/types/http.ts | 6 ++++--
src/platform/nodejs/lib/util/crypto.ts | 3 ++-
src/platform/web/lib/util/crypto.ts | 3 ++-
src/plugins/objects/batchcontextlivecounter.ts | 5 +++--
src/plugins/objects/objectid.ts | 3 ++-
13 files changed, 33 insertions(+), 17 deletions(-)

Benefits

• Better developer experience with clearer error messages
• More actionable guidance for debugging issues
• Consistent error messaging patterns across the SDK

Testing

• All existing tests continue to pass
• Error messages have been reviewed for clarity and accuracy

This improvement is part of an ongoing initiative to enhance error messaging across all Ably SDKs and services.

Repository Context

This repository is part of Ably's ecosystem. Here's context about all repositories:

For more context, see: https://github.com/ably/ably-os

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch error-inline-updates-ably-js-1756019882611

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

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

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[AndyTWF]

Appreciate this is a PoC so not reviewing this from the point of view of merging, but just how we should improve ably-os (which I assume will fall to ecosystems!):

• We need some guardrails about what is acceptable to put in an error message. The first error message contains the raw key - which could then easily get caught and logged unintentionally.

Other than that, the changes seem reasonable.