[PUB-1011] Use more specific error codes for LiveObjects errors

[VeskeR]

Use 40003 for invalid parameter values, and 92000 for errors associated with invalid state message structure or content.

This PR also suggests introducing new client error code: 40024 - missing channel modes, for these lines, which were added in #1956, to notify the user that it is required to provide state channel modes to use LiveObjects. Previously used 40160 for this, but it's not entirely correct, as it's not a permission issue in this case, it's the API requirement to have state channel modes provided for a channel in order to use the LiveObjects feature. Thus a new, more fine-tuned, error code 40024 is suggested. If we decide to keep this new error code I will open a PR for it in https://github.com/ably/ably-common

Resolves PUB-1011

Summary by CodeRabbit

• Bug Fixes
  • Updated error codes for better clarity and specificity in error reporting across various operations, enhancing the feedback provided for invalid input scenarios.

[coderabbitai]

Walkthrough

The changes update error codes in various modules of the liveobjects plugin. Specifically, error codes are adjusted in error handling segments across several classes. The updates include changing codes from 40013 to 40003, from 50000 to 92000, and from 40160 to 40024, without modifying the overall control flow or public API declarations.

Changes

File(s)	Change Summary
src/.../batchcontextlivecounter.ts	In decrement, error code changed from 40013 to 40003 for non-numeric amounts.
src/.../livecounter.ts, src/.../livemap.ts	In message creation methods, error code updated from 40013 to 40003; in state operations, error code updated from 50000 to 92000.
src/.../liveobject.ts, src/.../objectid.ts	In invalid parameter and object ID validations, error code updated from 50000 to 92000.
src/.../liveobjects.ts	In _throwIfMissingChannelMode, error code changed from 40160 to 40024.

Possibly related PRs

• [DTP-1034] Emit Live Objects lifecycle events #1958: The changes in the main PR, specifically the error handling modifications in the LiveObject class, are related to the retrieved PR's significant updates to the same class, which enhance event handling but also involve error handling adjustments.
• [DTP-1033] Add LiveObjects edit API #1948: The changes in the main PR, specifically the modification of error codes in the decrement method of the BatchContextLiveCounter class, are related to similar updates made to the error handling in the decrement method of the LiveCounter class in the retrieved PR.

Suggested reviewers

• ttypic
• lawrence-forooghian
• mschristensen

Poem

I'm just a rabbit, hopping in the code,
Changing error codes on the winding road.
40013 becomes 40003 with a clever little twist,
While 50000 turns 92000 in a byte-filled mist.
My paws tap a happy tune beneath the digital sky,
Celebrating these fixes as the bytes flutter by! 🐇
Code rabbits unite—our changes now amplify!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8af90e8 and bf842fa.

📒 Files selected for processing (6)

• src/plugins/liveobjects/batchcontextlivecounter.ts (1 hunks)
• src/plugins/liveobjects/livecounter.ts (8 hunks)
• src/plugins/liveobjects/livemap.ts (10 hunks)
• src/plugins/liveobjects/liveobject.ts (1 hunks)
• src/plugins/liveobjects/liveobjects.ts (1 hunks)
• src/plugins/liveobjects/objectid.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (6)

• src/plugins/liveobjects/livecounter.ts
• src/plugins/liveobjects/batchcontextlivecounter.ts
• src/plugins/liveobjects/liveobject.ts
• src/plugins/liveobjects/liveobjects.ts
• src/plugins/liveobjects/livemap.ts
• src/plugins/liveobjects/objectid.ts

⏰ Context from checks skipped due to timeout of 90000ms (7)

• GitHub Check: test-node (20.x)
• GitHub Check: test-browser (webkit)
• GitHub Check: test-node (18.x)
• GitHub Check: test-browser (firefox)
• GitHub Check: test-node (16.x)
• GitHub Check: test-browser (chromium)
• GitHub Check: test-npm-package

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
  • Generate unit testing code for this file.
  • 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. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• 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 src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

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

Documentation and Community

• 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.