Materialisation: Add message deletion functionality to Chat

splindsay-92 commented 2 weeks ago

Context

CHA-516

Description

These changes are dependant on both ably-js changes to support the new fields (updated in this PR), and additional realtime work that has not yet been completed.

Once the above is done, the tests should be able to pass, as such, please do not merge this PR until the above is done.

Added the ability to delete a chat message to the Messages feature.
Updated the Chat React hooks to support the new feature.
Updated the demo app to allow deletion of messages in a chat room.

Checklist

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

Testing Instructions (Optional)

Explain how to test the changes in this PR.
Provide specific steps or commands to execute.

Summary by CodeRabbit

Release Notes

New Features
- Introduced message deletion functionality in the Ably Chat SDK, allowing users to delete messages with optional parameters for context and metadata.
- Enhanced the MessageComponent to support message deletion with an interactive trash icon.
- Updated the useMessages hook to include a deleteMessage method for easier message management.
Bug Fixes
- Improved error handling in message event processing and tests related to message deletion and retrieval.
Documentation
- Updated the README and documentation for the useMessages hook to reflect the new message deletion capabilities, including example code.
Tests
- Added comprehensive tests for message deletion and retrieval scenarios to ensure robust functionality, including error handling for unexpected message types.

github-actions[bot] commented 2 weeks ago

Coverage Report

Status	Category	Percentage	Covered / Total
🟢	Lines	92.78% (🎯 92%)	2817 / 3036
🟢	Statements	92.78% (🎯 92%)	2817 / 3036
🟢	Functions	92.3% (🎯 92%)	216 / 234
🟢	Branches	93.76% (🎯 93%)	782 / 834

File Coverage

File	Stmts	% Branch	% Funcs	% Lines	Uncovered Lines
Changed Files
src/core/chat-api.ts	100%	78.94%	100%	100%
src/core/details-metadata.ts	0%	0%	0%	0%	1
src/core/message.ts	100%	100%	100%	100%
src/core/messages.ts	93.67%	92.45%	100%	93.67%	403-405, 438-442, 454-458, 575-577
src/core/metadata.ts	0%	0%	0%	0%	1
src/react/hooks/use-messages.ts	84.28%	94.73%	14.28%	84.28%	120-130

Generated in workflow #1651 for commit e8eeb74 by the Vitest Coverage Report Action

coderabbitai[bot] commented 1 week ago

Walkthrough

The pull request introduces a feature in the Ably Chat SDK that enables users to delete messages. This includes updates to documentation, core functionalities, and components, such as the addition of a delete method on the room.messages property. New interfaces for deletion parameters have been created, and modifications to the test suite ensure comprehensive coverage of the deletion functionality.

Changes

File Path	Change Summary
README.md	Added section on "Deleting messages" detailing the `delete` method on `room.messages`, including parameters and return values.
demo/src/components/MessageComponent/MessageComponent.tsx	Updated `MessageProps` to include `onMessageDelete` method, added hover state and trash icon for message deletion, and modified component signature.
demo/src/containers/Chat/Chat.tsx	Imported `MessageEvents`, updated message listener logic to handle created and deleted messages, and added `deleteMessage` function to the `useMessages` hook.
src/core/chat-api.ts	Introduced `DeleteMessageParams` and `DeleteMessageResponse` interfaces, added `deleteMessage` method, and updated `getMessages` method API endpoint and return fields.
src/core/index.ts	Added `DetailsMetadata` and `DeleteMessageParams` to exports, updated exports from `message.js`.
src/core/messages.ts	Added `DeleteMessageParams` interface, updated `MessageEventsMap`, and implemented `delete` method in `Messages` interface and `DefaultMessages` class.
src/react/README.md	Updated documentation for `useMessages` hook to include `deleteMessage` method.
src/react/hooks/use-messages.ts	Added `deleteMessage` method to `UseMessagesResponse` interface, implemented using `useCallback`.
test/core/chat.integration.test.ts	Updated error message in `waitForConnectionLifecycle` function.
test/core/messages.integration.test.ts	Added tests for message deletion and retrieval in history, utilizing `MessageEvents` enum.
test/core/messages.test.ts	Added test for deleting messages and improved event handling in tests.
test/react/hooks/use-messages.integration.test.tsx	Added test for deleting messages, validating deletion and metadata.
test/react/hooks/use-messages.test.tsx	Updated test case names and added assertions for `deleteMessage` functionality.
demo/package.json	Updated `ably` dependency to a local tarball and added `react-icons` dependency.
src/core/details-metadata.ts	Introduced `DetailsMetadata` type for message metadata.
src/core/message.ts	Modified `Message` interface to change `isDeleted` and `isUpdated` methods to getter properties.
test/core/message.test.ts	Added tests for `isDeleted` and `isUpdated` properties, changing method calls to property accesses.
src/core/metadata.ts	Removed `DetailsMetadata` type declaration.
test/core/message-parser.test.ts	Added test cases for error handling in `parseMessage` function for unhandled actions and undefined properties.

Poem

In the chat where messages flow,
A new feature starts to glow.
With a click, the trash can's near,
Deleting words, we shed a tear.
Softly marked, they fade away,
In our hearts, they still may stay. 🐇✨

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

ably / ably-chat-js