feature-change: Remove reserved keyname space in headers and metadata.

[splindsay-92]

Context

• It was decided that we would no longer reserve any namespaces in headers or extras.
• CHA-625

Description

• Removed restrictions on ably-chat in headers and metadata.

Checklist

• QA'd by the author.
• Unit tests created (if applicable).
• Integration tests created (if applicable).
• Follow coding style guidelines found here.
• TypeDoc updated (if applicable).
• (Optional) Update documentation for new features.
• Browser tests created (if applicable).
• In repo demo app updated (if applicable).

Summary by CodeRabbit

• New Features

  • Simplified message sending and reaction processes by removing validation checks for reserved keys, enhancing user experience.

• Bug Fixes

  • Eliminated warnings related to the reserved key ably-chat in documentation and validation, improving clarity.

• Tests

  • Updated test suites by removing obsolete test cases related to reserved keys, ensuring focus on core functionalities.

[github-actions]

Coverage Report

Status	Category	Percentage	Covered / Total
🟢	Lines	92.55% (🎯 92%)	2696 / 2913
🟢	Statements	92.55% (🎯 92%)	2696 / 2913
🟢	Functions	92.57% (🎯 92%)	212 / 229
🟢	Branches	93.9% (🎯 93%)	755 / 804

File Coverage

File	Stmts	% Branch	% Funcs	% Lines	Uncovered Lines
Changed Files
src/core/headers.ts	0%	0%	0%	0%	1
src/core/messages.ts	93.39%	92%	100%	93.39%	359-361, 394-398, 410-414, 515-516
src/core/metadata.ts	0%	0%	0%	0%	1
src/core/room-reactions.ts	97.89%	95.65%	100%	97.89%	186-187

Generated in workflow #1628 for commit 93b6e8e by the Vitest Coverage Report Action

[coderabbitai]

Walkthrough

The changes involve updates to several TypeScript files within the core functionality of the application. Documentation comments have been modified to remove references to the reserved key prefix ably-chat, which has led to the simplification of validation logic in various interfaces and methods. Additionally, corresponding test cases that checked for the handling of this reserved key have been removed to align with the updated functionality.

Changes

File	Change Summary
src/core/headers.ts	Updated documentation comment for Headers type to remove references to reserved key ably-chat.
src/core/messages.ts	Updated SendMessageParams interface and send method to remove comments and validation checks regarding reserved keys.
src/core/metadata.ts	Updated documentation comment for Metadata type to remove note about reserved key ably-chat.
src/core/room-reactions.ts	Updated SendReactionParams interface and send method to remove comments and validation checks regarding reserved keys.
test/core/messages.test.ts	Removed test cases related to handling of reserved header prefixes and reserved metadata keys.
test/core/room-reactions.test.ts	Removed test cases related to handling of reserved prefixes in reaction headers and reserved keys in reaction metadata.

Poem

In the code where rabbits play,
We’ve cleared the paths, oh what a day!
No more worries of keys reserved,
Simplicity now, we’ve well-deserved.
With each hop, our functions sing,
In the garden of code, let joy take wing! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6dad644 and 93b6e8e.

📒 Files selected for processing (6)

• src/core/headers.ts (0 hunks)
• src/core/messages.ts (0 hunks)
• src/core/metadata.ts (0 hunks)
• src/core/room-reactions.ts (0 hunks)
• test/core/messages.test.ts (0 hunks)
• test/core/room-reactions.test.ts (0 hunks)

💤 Files with no reviewable changes (6)

• src/core/headers.ts
• src/core/messages.ts
• src/core/metadata.ts
• src/core/room-reactions.ts
• test/core/messages.test.ts
• test/core/room-reactions.test.ts

---

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