refactor: update message version comparison methods

[AndyTWF]

Description

• Modify message version comparison methods to return boolean instead of throwing errors.
• Add new methods like isSameAs and rename existing methods for clarity.

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).
• Updated the website documentation (if applicable).
• Browser tests created (if applicable).
• In repo demo app updated (if applicable).

Testing Instructions (Optional)

N/A

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

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.

---

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

[github-actions]

Coverage Report

Status	Category	Percentage	Covered / Total
🟢	Lines	93.56% (🎯 92%)	3139 / 3355
🟢	Statements	93.56% (🎯 92%)	3139 / 3355
🟢	Functions	94.94% (🎯 92%)	244 / 257
🟢	Branches	94.16% (🎯 93%)	839 / 891

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
src/core/message.ts	100%	100%	100%	100%

Generated in workflow #2058 for commit 1fd75f8 by the Vitest Coverage Report Action

[Copilot]

PR Overview

This PR refactors the message version comparison methods to return boolean values rather than throwing errors, and renames the methods for better clarity, while adding an alias for equality checking.

• Renamed versionBefore, versionAfter, and versionEqual to isOlderVersionOf, isNewerVersionOf, and isSameVersionAs respectively.
• Updated method implementations and their corresponding tests to return false instead of throwing.
• Updated usage in hooks and UI components to align with the new method names.

Reviewed Changes

File	Description
src/core/message.ts	Renaming and refactoring of version comparison methods and interface.
test/core/message.test.ts	Updated tests to reflect changes in method names and error handling.
test/react/hooks/use-messages.test.tsx	Updated stub method names to match the refactored methods.
demo/src/components/ChatBoxComponent/ChatBoxComponent.tsx	Updated the event listener to use the new equality method and proper event structure.

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

[Copilot]

PR Overview

This PR refactors message version comparison methods to improve clarity and behavior by returning booleans instead of throwing errors, and introduces the new alias method isSameAs.

• Renames versionBefore, versionAfter, and versionEqual to isOlderVersionOf, isNewerVersionOf, and isSameVersionAs, respectively.
• Updates method implementations to return false when messages differ instead of throwing errors.
• Aligns tests and hook/component usage to the updated method names and behaviors.

Reviewed Changes

File	Description
src/core/message.ts	Refactored message version comparison methods and added isSameAs alias.
test/core/message.test.ts	Updated tests to reflect the new behavior (returning false instead of throwing errors).
test/react/hooks/use-messages.test.tsx	Refactored test mocks to use the new method names.
demo/src/components/ChatBoxComponent/ChatBoxComponent.tsx	Updated component usage to reference the new method names.

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

[vladvelici]

I think having both isOlderVersionOf and isNewerVersionOf might create minor confusion if negating the comparison

c1 = a.isNewerVersionOf(b) is not the same as c2 = !a.isOlderVersionOf(b) because if a and b are different messages, c1 will be false but c2 will be true.

Maybe add a @remark not to negate those? Or maybe it's a non-issue... The docs do explain what the functions do.

[AndyTWF]

I think a remark to say don't negate them sounds good.

[AndyTWF]

Remark added

[vladvelici]

Left minor comments, approving now.

[ttypic]

Looks great!