Skip to content

Conversation

AshishViradiya153
Copy link
Contributor

@AshishViradiya153 AshishViradiya153 commented May 30, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Improved reliability of video tracking events during page unloads and visibility changes, ensuring events are sent even if the page is closing or becomes hidden.
    • Prevented duplicate tracking of unload-related video events for more accurate analytics.

@AshishViradiya153 AshishViradiya153 requested a review from mfts as a code owner May 30, 2025 12:17
Copy link

vercel bot commented May 30, 2025

@AshishViradiya153 is attempting to deploy a commit to the mftsio Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented May 30, 2025

Walkthrough

A new mechanism was added to the VideoTracker class to improve the reliability of event tracking during page unloads. This includes a flag to prevent duplicate unload event tracking and enhanced logic to send tracking data using sendBeacon or fetch with keepalive for unload and visibility changes.

Changes

File(s) Change Summary
lib/tracking/video-tracking.ts Added hasTrackedUnload flag, updated trackEvent with useBeacon parameter, refactored unload/visibility tracking logic, and modified cleanup to avoid duplicate unload events.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VideoTracker
    participant Navigator
    participant Server

    User->>VideoTracker: Changes visibility (hidden/visible) or triggers unload
    alt Visibility changes to hidden and not tracked
        VideoTracker->>VideoTracker: Set hasTrackedUnload = true
        alt Video is playing
            VideoTracker->>VideoTracker: trackEvent("played", useBeacon=true)
            VideoTracker->>Navigator: sendBeacon or fetch with keepalive
            Navigator->>Server: Deliver "played" event
        end
        VideoTracker->>VideoTracker: trackEvent("blur", useBeacon=true)
        VideoTracker->>Navigator: sendBeacon or fetch with keepalive
        Navigator->>Server: Deliver "blur" event
    else Visibility changes to visible
        VideoTracker->>VideoTracker: Reset hasTrackedUnload = false
        VideoTracker->>VideoTracker: trackEvent("focus")
        VideoTracker->>Navigator: fetch (normal)
        Navigator->>Server: Deliver "focus" event
    end
    alt cleanup called and video playing and not tracked
        VideoTracker->>VideoTracker: trackEvent("played", useBeacon=true)
        VideoTracker->>Navigator: sendBeacon or fetch with keepalive
        Navigator->>Server: Deliver "played" event
    end
Loading

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-05-30T12_19_10_563Z-debug-0.log

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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: 1

🧹 Nitpick comments (1)
lib/tracking/video-tracking.ts (1)

81-86: Consider handling promise rejections from the async trackEvent method.

The trackEvent method is now async, but the debounced handlers don't await or handle potential rejections. While fire-and-forget might be intentional for tracking, unhandled promise rejections could cause issues.

Consider wrapping the async call with error handling:

     const createDebouncedHandler = (wait: number, immediate = false) =>
       debounce(
         (eventType: EventType, endTime?: number) => {
           console.log(
             `[VideoTracker] Tracking event: ${eventType} - ${endTime}`,
           );
-          return this.trackEvent(eventType, endTime);
+          return this.trackEvent(eventType, endTime).catch((error) => {
+            console.error(`[VideoTracker] Failed to track event ${eventType}:`, error);
+          });
         },
         wait,
         immediate,
       );
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 101cc58 and aefdc80.

📒 Files selected for processing (1)
  • lib/tracking/video-tracking.ts (4 hunks)
🔇 Additional comments (3)
lib/tracking/video-tracking.ts (3)

63-63: LGTM!

The hasTrackedUnload flag is properly initialized and will help prevent duplicate unload event tracking.


341-352: LGTM!

The visibility change tracking logic is well-implemented. It properly uses the beacon API for reliability during page hide events and prevents duplicate tracking with the hasTrackedUnload flag.


361-364: LGTM!

The cleanup logic correctly tracks the final "played" event using the beacon API and prevents duplicate tracking with the hasTrackedUnload flag.

Copy link
Owner

@mfts mfts left a comment

Choose a reason for hiding this comment

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

nice!

Copy link

vercel bot commented Jun 3, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
papermark ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 3, 2025 4:38pm

@mfts mfts merged commit 21df277 into mfts:main Jun 3, 2025
4 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jun 3, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants