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

Barcode scanner issue fixed #721

Merged
merged 2 commits into from
Mar 12, 2025
Merged

Barcode scanner issue fixed #721

merged 2 commits into from
Mar 12, 2025

Conversation

chiragchhatrala
Copy link
Collaborator

@chiragchhatrala chiragchhatrala commented Mar 11, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved the camera upload experience by ensuring that camera resources are automatically released when the upload is canceled or the interface is closed, leading to a more stable and reliable operation.

@chiragchhatrala chiragchhatrala requested a review from JhumanJ March 11, 2025 08:52
Copy link
Contributor

coderabbitai bot commented Mar 11, 2025

Walkthrough

The changes update the CameraUpload component to improve resource management by introducing a new beforeUnmount lifecycle hook. This hook invokes the cleanupCurrentStream method, which now stops all tracks from the media stream. Additionally, the media stream is stored in a variable when the camera is opened. The cancelCamera method has been simplified to rely solely on the cleanup process, ensuring that all active media streams are properly terminated when the component is unmounted or the camera is canceled.

Changes

File Change Summary
client/components/.../CameraUpload.vue Added beforeUnmount lifecycle hook calling cleanupCurrentStream; modified cleanupCurrentStream to stop all media tracks; stored mediaStream during camera open; simplified cancelCamera to delegate to cleanup

Sequence Diagram(s)

sequenceDiagram
    participant U as User/Component Lifecycle
    participant C as CameraUpload
    participant M as MediaStream
    participant T as Track

    U->>C: Component unmounts or cancelCamera() called
    C->>C: Execute beforeUnmount() / cancelCamera()
    C->>C: Call cleanupCurrentStream()
    C->>M: Retrieve mediaStream & getTracks()
    loop For each track
        M->>T: Stop track
    end
Loading

Poem

I’m the bunny of clean code delight,
Hopping in to set things right.
On unmount, I bid tracks goodbye,
With swift cleanup, I fly high.
Code is neat—I hop with joy!


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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
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: 0

🧹 Nitpick comments (1)
client/components/forms/components/CameraUpload.vue (1)

173-194: Consider additional error handling in cleanup method.

The cleanupCurrentStream method is now the central place for resource cleanup, but it doesn't have try/catch blocks to handle potential errors during cleanup operations. Media API operations can sometimes throw exceptions that should be caught to prevent them from interrupting the cleanup process.

 async cleanupCurrentStream() {
+  try {
     if (this.quaggaInitialized) {
       Quagga.stop()
       this.quaggaInitialized = false
     }

     if (this.mediaStream) {
       this.mediaStream.getTracks().forEach(track => track.stop())
       this.mediaStream = null
     }

     if (this.webcam) {
       this.webcam.stop()
     }

     const webcamElement = document.getElementById("webcam")
     if (webcamElement && webcamElement.srcObject) {
       const tracks = webcamElement.srcObject.getTracks()
       tracks.forEach(track => track.stop())
       webcamElement.srcObject = null
     }
+  } catch (error) {
+    console.error('Error during stream cleanup:', error)
+  }
 },
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a516219 and 4f46baa.

📒 Files selected for processing (1)
  • client/components/forms/components/CameraUpload.vue (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build the Nuxt app
🔇 Additional comments (4)
client/components/forms/components/CameraUpload.vue (4)

168-170: Good addition of lifecycle hook for resource cleanup!

Adding the beforeUnmount lifecycle hook ensures that media resources are properly cleaned up when the component is unmounted, preventing potential memory leaks and resource issues. This is a critical improvement for proper resource management.


190-192: Enhanced stream cleanup implementation.

Stopping each track individually before setting srcObject to null is the correct approach for thoroughly releasing camera resources. Without this explicit track stopping, users might experience issues like the camera light remaining on after navigation or component destruction.


235-235: Good practice storing stream reference.

Storing the media stream in a component property allows for proper cleanup later. This is a key part of the fix that enables more reliable resource management.


299-301: Improved camera cancellation flow.

Simplifying the cancelCamera method to rely on the centralized cleanupCurrentStream method reduces code duplication and ensures consistent cleanup behavior across different component lifecycle events. This is a good refactoring approach.

@JhumanJ JhumanJ merged commit c3c66e0 into main Mar 12, 2025
7 checks passed
@JhumanJ JhumanJ deleted the 1ada6-barcode-scanner-issue branch March 12, 2025 07:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants