Track Python Panel closes

[Br2850]

What changes are proposed in this pull request?

• Add an analytics event listener to track Python panel closes with close_panel

How is this patch tested? If it is not, please explain why.

• Minor changes, should pass tests from merge into develop

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

• No. You can skip the rest of this section.
• Yes. Give a description of this change to be included in the release
  notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

• App: FiftyOne application changes
• Build: Build and test infrastructure changes
• Core: Core fiftyone Python library changes
• Documentation: FiftyOne documentation changes
• Other

Summary by CodeRabbit

• New Features

  • Introduced tracking for when the custom panel is closed, enhancing user interaction insights.
  • Updated the interface to allow for tracking context changes within the custom panel.

• Bug Fixes

  • Improved functionality related to panel state changes and event tracking.

[coderabbitai]

Walkthrough

The changes introduce a new function, trackPanelClose, to the useCustomPanelHooks module and integrate it into the CustomPanel.tsx file. This function tracks the closing of the panel by sending an event with the panel name. Additionally, the CustomPanelProps interface is updated to include a new parameter for tracking context changes. The overall structure and logic of the existing functions remain unchanged.

Changes

File Path	Change Summary
app/packages/operators/src/CustomPanel.tsx	- Added import of trackPanelClose. - Integrated trackPanelClose(panelName) in useEffect for panel close effect.
app/packages/operators/src/useCustomPanelHooks.ts	- Added trackPanelClose(panelName) function. - Updated CustomPanelProps interface to include onChangeCtx?: string;. - Integrated useCtxChangePanelEvent for context change tracking.

Possibly related PRs

• event tracker #4489: This PR introduces the useTrackEvent hook, which is directly related to the changes in the main PR where useTrackEvent is utilized to track panel close events.
• fix missing python panel load error trace #4516: This PR modifies the CustomPanel.tsx file, which is also affected in the main PR. Both PRs involve changes to the CustomPanel component, although the specific changes differ.
• fixes and enhancements for modal spaces #4771: This PR includes modifications to the ActionsRow.tsx file, which also imports useTrackEvent from @fiftyone/analytics, similar to the changes made in the main PR.

Suggested reviewers

• ritch

Poem

In the panel's close, we track with glee,
A name to remember, as happy as can be!
With hooks and props, our code takes flight,
Custom panels shining, oh what a sight!
Hopping through changes, we dance and play,
In the land of code, we're here to stay! 🐇✨

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6f7485a and 01764ea.

📒 Files selected for processing (1)

• app/packages/operators/src/CustomPanel.tsx (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• app/packages/operators/src/CustomPanel.tsx

---

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
• Mastodon
• Reddit
• LinkedIn

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

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.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

app/packages/operators/src/CustomPanel.tsx (1)

40-40: LGTM: Panel close tracking implemented correctly

The addition of trackPanelClose(panelName) within the useEffect hook correctly implements the tracking of panel closes, which aligns with the PR objectives. The placement ensures that the tracking occurs when the panel is unmounted.

Consider adding a comment explaining the purpose of this tracking for better code readability:

// Track panel close event for analytics
trackPanelClose(panelName);

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6f5a12c and 6f7485a.

📒 Files selected for processing (2)

• app/packages/operators/src/CustomPanel.tsx (2 hunks)
• app/packages/operators/src/useCustomPanelHooks.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

app/packages/operators/src/CustomPanel.tsx (1)

Pattern **/*.{ts,tsx}: Review the Typescript and React code for conformity with best practices in React, Recoil, Graphql, and Typescript. Highlight any deviations.

app/packages/operators/src/useCustomPanelHooks.ts (1)

Pattern **/*.{ts,tsx}: Review the Typescript and React code for conformity with best practices in React, Recoil, Graphql, and Typescript. Highlight any deviations.

🔇 Additional comments (2)

app/packages/operators/src/CustomPanel.tsx (2)

15-19: LGTM: Import changes align with PR objectives

The addition of trackPanelClose import from ./useCustomPanelHooks is consistent with the PR's goal of tracking Python panel closes. The import is correctly placed and follows the existing import structure.

---

Line range hint 1-168: Overall: Changes successfully implement panel close tracking

The modifications in this file effectively implement the tracking of Python panel closes as per the PR objectives. The changes are minimal, focused, and well-integrated into the existing code structure. They follow React and TypeScript best practices and don't introduce unnecessary complexity.

Key points:

1. The trackPanelClose function is correctly imported and used.
2. The tracking is implemented in the appropriate lifecycle hook (useEffect).
3. The changes don't affect the overall functionality of the CustomPanel component.

These changes enhance the analytics capabilities of the FiftyOne application without introducing any apparent issues or significant alterations to the existing codebase.

[kaixi-wang]

We should really get into the habit of including tests for all prs. It would be good to verify that metrics log as expected.

[imanjra]

LGTM