Add message.with(event) method for applying message events to a Message

[vladvelici]

Context

CHA-702

Description

Add a new method with() on Message. message.with(event) is a convenience method that produces a new Message with the event applied to it. It can be used to easily apply update and delete events to a message.

Usage example

let messages : Message[] = []; // my messages

// when receiving an update or delete event:
const idx = message.findIndex(m => m.serial == event.message.serial);
if (idx !== -1) {
  messages[idx] = messages[idx].with(event);
}

When message reactions arrive, this method will also correctly apply reactions events to a message.

---

Another change is that the demo app now shows deleted messages with an "Edit" button. Since we have always supported what I'll call "restore by edit" it makes sense to show it in the UI, as well as to correctly support showing the messages that have been updated after a delete (previously those update events were ignored, considered out of scope for the chat window).

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)

Read the code including demo app for how it's used.

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

[github-actions]

Coverage Report

Status	Category	Percentage	Covered / Total
🟢	Lines	93.68% (🎯 92%)	3192 / 3407
🟢	Statements	93.68% (🎯 92%)	3192 / 3407
🟢	Functions	95.78% (🎯 92%)	250 / 261
🟢	Branches	94.27% (🎯 93%)	857 / 909

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
src/core/events.ts	100%	100%	100%	100%
src/core/message.ts	100%	100%	100%	100%
src/core/messages.ts	92.63%	92.15%	100%	92.63%	411-413, 443-447, 459-463, 578-580, 613-615

Generated in workflow #1970 for commit 9623b5a by the Vitest Coverage Report Action

[splindsay-92]

LGTM