Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Demo: Refactor demo app to reduce single component complexity. #433

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

splindsay-92
Copy link
Contributor

Everything was packed into this one container, so it made it confusing to understand the separation of features. This is a first pass, for now I have just moved things into their own components, but we should look at ensuring each is fully isolated and reusable.

Testing Instructions (Optional)

  • Please check out the demo app and play with it, everything should still work correctly.

@splindsay-92 splindsay-92 requested a review from AndyTWF December 10, 2024 10:29
@github-actions github-actions bot temporarily deployed to staging/pull/433/typedoc December 10, 2024 10:30 Inactive
Copy link

github-actions bot commented Dec 10, 2024

Coverage Report

Status Category Percentage Covered / Total
🟢 Lines 93.85% (🎯 92%) 3313 / 3530
🟢 Statements 93.85% (🎯 92%) 3313 / 3530
🟢 Functions 95.76% (🎯 92%) 249 / 260
🟢 Branches 94.45% (🎯 93%) 851 / 901
File CoverageNo changed files found.
Generated in workflow #1937 for commit b460e38 by the Vitest Coverage Report Action

Copy link

coderabbitai bot commented Dec 10, 2024

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

@splindsay-92 splindsay-92 force-pushed the demo/refactor-chat-container branch from cf9d0d6 to 7f9e668 Compare December 10, 2024 10:59
@github-actions github-actions bot temporarily deployed to staging/pull/433/typedoc December 10, 2024 11:00 Inactive
Copy link
Member

@owenpearson owenpearson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks much better! i think most of these comments are just relating to stuff you copied out of Chat.tsx so feel free to ignore if that's the case

const { send } = useMessages();
const { start, stop } = useTyping();
const { currentStatus } = useChatConnection();
const shouldDisable: boolean = currentStatus !== ConnectionStatus.Connected;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're doing this two different ways in this component and in ReactionComponent; here we calculate whether we're not connected each render and in ReactionComponent we have a useEffect and store the result in component state (I think this approach is slightly better). Should we unify the approach, or otherwise, if we anticipate users needing to do this often, should useChatConnection just return a connected boolean as part of the returned object?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeh we've discussed this before, though there are a few ways we could solve this so for now I will standardise the check and add a ticket to improve this.

className="chat-window"
>
{messages.map((msg) => {
console.log(msg);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't think you meant to commit this line 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good spot, left in after some debugging :D

demo/src/components/ChatBoxComponent/ChatBoxComponent.tsx Outdated Show resolved Hide resolved
@splindsay-92 splindsay-92 force-pushed the demo/refactor-chat-container branch from 7f9e668 to 2eb9e7b Compare December 10, 2024 22:08
@github-actions github-actions bot temporarily deployed to staging/pull/433/typedoc December 10, 2024 22:09 Inactive
@splindsay-92 splindsay-92 force-pushed the demo/refactor-chat-container branch from 2eb9e7b to 5de8b6e Compare December 11, 2024 13:24
@github-actions github-actions bot temporarily deployed to staging/pull/433/typedoc December 11, 2024 13:26 Inactive
@vladvelici
Copy link
Contributor

I've had a look at this. I noticed the chat window was no longer full height. I've had a go at adjusting some CSS #447 to make it full height again

Will finish reviewing tomorrow, I'm keen to get this merged before doing any more work on the demo app in the message reactions branch

@splindsay-92 splindsay-92 force-pushed the demo/refactor-chat-container branch from 5de8b6e to aa737b9 Compare January 9, 2025 13:58
@github-actions github-actions bot temporarily deployed to staging/pull/433/typedoc January 9, 2025 13:59 Inactive
@github-actions github-actions bot temporarily deployed to staging/pull/433/typedoc January 13, 2025 10:30 Inactive
@splindsay-92 splindsay-92 force-pushed the demo/refactor-chat-container branch from 3248514 to e4c9304 Compare January 14, 2025 17:07
@github-actions github-actions bot temporarily deployed to staging/pull/433/typedoc January 14, 2025 17:08 Inactive
splindsay-92 and others added 2 commits January 15, 2025 15:54
Refactored the demo app Chat container component.
Everything was packed into this one container, so it made it confusing to understand the separation of features.
This is a first pass, for now I have just moved things into their own components, but we should look at ensuring each is fully isolated and reusable.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants