voxel51 / fiftyone

The open-source tool for building high-quality datasets and computer vision models
https://fiftyone.ai
Apache License 2.0
8.66k stars 548 forks source link

event tracker #4489

Closed ritch closed 3 months ago

ritch commented 3 months ago

Note: event tracking is disabled by default. Only environments that inject window.analytics will make use of these new event tracking features.

When enabled all operator executions and all view changes will be tracked in the associated event aggregator.

Adds a new ctx.ops.track_event(event_name, properties) operator for manually tracking events in operators/panels.

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!WARNING]

Rate limit exceeded

@ritch has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 48 minutes and 47 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 381a400851b7302a7a65a70986610019cc84c159 and 167e011a4333c191652b500158f8890999b91653.

Walkthrough

This update introduces a comprehensive analytics feature to the codebase, focusing on tracking user interactions and events. By leveraging Recoil state management and integrating Segment analytics, the system enables detailed event tracking and user behavior analysis across various application components. Key additions include React hooks for event tracking, state management enhancements, and utility scripts for configuring analytics, ESLint, Babel, and Vite.

Changes

File(s) Change Summary
app/packages/analytics/.eslintrc Disables the rule react-hooks/rules-of-hooks.
app/packages/analytics/.gitignore Adds exclusions for build artifacts, dependencies, and logs.
app/packages/analytics/.prettierignore Adds the build directory to Prettier ignore list.
app/packages/analytics/README.md Provides documentation for FiftyOne Analytics package.
app/packages/analytics/babel.config.js Configures Babel presets for Node.js and TypeScript.
app/packages/analytics/vite.config.ts Configures Vite for ES module format and ES2015 target.
app/packages/analytics/src/index.ts Exports modules for event tracking and analytics state management.
app/packages/analytics/src/keys.ts Exports DEFAULT_WRITE_KEYS for "dev" and "prod" environments.
app/packages/analytics/src/state.ts Introduces Recoil atom analyticsInfo for holding AnalyticsInfo.
app/packages/analytics/src/useAnalyticsInfo.ts Introduces useAnalyticsInfo hook for managing AnalyticsInfo state.
app/packages/analytics/src/useTrackEvent.ts Adds useTrackEvent hook for tracking events.
app/packages/analytics/src/usingAnalytics.ts Adds functionality for managing analytics via Analytics class.
app/packages/app/src/components/Nav.tsx Modifies useGA and introduces hooks from recoil.
app/packages/app/src/pages/datasets/DatasetPage.tsx Includes <EventTracker /> component.
app/packages/components/src/components/ErrorBoundary/ErrorBoundary.tsx Adds TrackFallback function for enhanced error tracking using useEffect.
app/packages/core/src/components/Actions/ActionsRow.tsx Introduces useTrackEvent to track "open_color_settings" events.
app/packages/core/src/components/Actions/DynamicGroup.tsx Adds useTrackEvent to track dynamic group actions.
app/packages/core/src/components/Actions/Tagger.tsx Uses useTrackEvent to track events in submitWrapper function.
app/packages/core/src/components/EventTracker.tsx Adds components for tracking view state changes using Recoil.
app/packages/embeddings/src/Embeddings.tsx Adds a line to throw "hello world" error inside useEffect hook.
app/packages/operators/src/built-in-operators.ts Adds TrackEvent class defining a new operator for event tracking.
app/packages/operators/src/operators.ts Adds trackOperatorExecution and integrates it in executeOperatorWithContext for event logging.
app/packages/operators/src/state.ts Incorporates useAnalyticsInfo() in useExecutionContext function.
app/packages/spaces/src/components/AddPanelItem.tsx Utilizes useTrackEvent to track panel item clicks.
app/packages/state/src/recoil/index.ts Adds export for info module.
app/packages/state/src/recoil/info.ts Introduces info atom.
fiftyone/operators/operations.py Adds track_event method for event tracking in the App.

Sequence Diagram(s)

sequenceDiagram
    participant ReactComponent as React Component
    participant Hook as useTrackEvent
    participant Recoil as Recoil State
    participant Analytics as Analytics Service

    ReactComponent->>Hook: Call useTrackEvent()
    Hook->>Recoil: Access analyticsInfo atom
    ReactComponent->>Hook: Track Event
    Hook->>Analytics: Send Event Data
    Analytics-->>Hook: Event Tracking Confirmation
    Hook-->>ReactComponent: Event Tracking Complete

Poem

In Recoil's state, the atoms play, Tracking events day by day. With hooks and calls, the analytics bloom, In every component, there's now room. Errors tracked, views all seen, Our codebase shines with a data sheen. 🌟🐇


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.