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

Solved type error using a custom method #10630

Merged
merged 28 commits into from
Feb 20, 2025
Merged

Conversation

Tanuj1718
Copy link
Contributor

@Tanuj1718 Tanuj1718 commented Feb 16, 2025

Proposed Changes

Screen.Recording.2025-02-16.at.12.48.25.PM.1.mov

@ohcnetwork/care-fe-code-reviewers

Merge Checklist

  • Add specs that demonstrate bug / test a new feature.
  • Update product documentation.
  • Ensure that UI text is kept in I18n files.
  • Prep screenshot or demo video for changelog entry, and attach it to issue.
  • Request for Peer Reviews
  • Completion of QA

Summary by CodeRabbit

  • New Features
    • Introduced a method to stop the camera stream when closing the avatar editing interface.
  • Bug Fixes
    • Improved error handling during image capturing, now displaying an error toast if capturing fails.
  • Refactor
    • Enhanced the closure process for the avatar editing interface, ensuring that the camera shuts down reliably. This update improves overall performance and resource management for a smoother user experience.
  • Type Safety Improvements
    • Updated variable types for better type safety regarding the webcam reference and preview image state.

@Tanuj1718 Tanuj1718 requested a review from a team as a code owner February 16, 2025 08:57
Copy link
Contributor

coderabbitai bot commented Feb 16, 2025

Walkthrough

This update refactors the camera stopping logic in the AvatarEditModal component. A new stopCamera method is introduced, which accesses the webcam's media stream and stops all its tracks. The method is implemented using useCallback to maintain a stable reference across re-renders, and it is now invoked in the close button’s onClick handler, encapsulating the logic previously executed directly. Additionally, type safety improvements were made for webRef and previewImage.

Changes

File Path Change Summary
src/components/Common/AvatarEditModal.tsx Added a new stopCamera method using useCallback to stop the camera stream; updated the button’s onClick to use this method instead of calling webRef.current.stopCamera() directly. Changed webRef type from any to Webcam and updated previewImage state type to `string

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant A as AvatarEditModal
    participant W as Webcam Stream

    U->>A: Clicks close button
    A->>A: Invoke stopCamera()
    A->>W: Retrieve current media stream & stop all tracks
    W-->>A: Camera stream stopped
Loading

Possibly related PRs

Poem

I'm just a rabbit with a hop and a skip,
In code, I dance with each enhanced tip.
The camera stops with a single, clear call,
Now smooth and tidy, no need for a brawl.
Hoppin' through merges, I celebrate with a flip!
🐇✨
Code leaps forward, on its joyful trip!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4db802e and 99444b7.

📒 Files selected for processing (1)
  • src/components/Common/AvatarEditModal.tsx (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/components/Common/AvatarEditModal.tsx
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: cypress-run (1)

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.

Copy link

netlify bot commented Feb 16, 2025

Deploy Preview for care-ohc ready!

Name Link
🔨 Latest commit 99444b7
🔍 Latest deploy log https://app.netlify.com/sites/care-ohc/deploys/67b717b3ef8f220008fbc12c
😎 Deploy Preview https://deploy-preview-10630.preview.ohc.network
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
src/components/Common/AvatarEditModal.tsx (1)

416-420: Improve state management in the close button handler.

The current implementation sets isCameraOpen to false both in the handler and in stopCamera, which could lead to inconsistent state.

Consider this improved implementation:

onClick={() => {
  setPreviewImage(null);
-  setIsCameraOpen(false);
  stopCamera();
}}

This ensures that all camera-related state management is centralized in the stopCamera method.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 21ecdf5 and ffdbb95.

📒 Files selected for processing (1)
  • src/components/Common/AvatarEditModal.tsx (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Test
  • GitHub Check: lint
  • GitHub Check: cypress-run (1)
  • GitHub Check: CodeQL-Build
  • GitHub Check: OSSAR-Scan
🔇 Additional comments (1)
src/components/Common/AvatarEditModal.tsx (1)

93-99: Implementation successfully addresses the type error.

The custom stopCamera method effectively solves the type error by properly accessing and stopping the media stream. The implementation follows best practices for camera resource cleanup.

Also applies to: 416-420

@Jacobjeevan
Copy link
Contributor

@Tanuj1718 For the future, please use a descriptive title. Current one is just vague.

@nihal467
Copy link
Member

LGTM

@Jacobjeevan Jacobjeevan merged commit 213fb25 into ohcnetwork:develop Feb 20, 2025
15 checks passed
Copy link

@Tanuj1718 Your efforts have helped advance digital healthcare and TeleICU systems. 🚀 Thank you for taking the time out to make CARE better. We hope you continue to innovate and contribute; your impact is immense! 🙌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
reviewed reviewed by a core member tested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Getting typeError while uploading cover photo in facility
4 participants