Skip to content

Update PostHog import to use React hook #7135

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

Merged
merged 1 commit into from
May 23, 2025

Conversation

jnsdls
Copy link
Member

@jnsdls jnsdls commented May 23, 2025

Update PostHog import to use React hook

This PR updates the PostHog implementation in the useTrack hook to use the React-specific hook from PostHog instead of the direct import. The changes include:

  • Replaced the direct import of posthog with usePostHog from posthog-js/react
  • Added the PostHog instance as a dependency to the useCallback hook
  • Added a null check before calling posthog.capture() to handle cases where PostHog might not be initialized

These changes ensure proper React integration with PostHog and prevent potential issues with the hook's dependency array.


PR-Codex overview

This PR updates the useTrack hook to use the usePostHog hook from posthog-js/react instead of directly importing posthog. It also modifies the dependency array for the useCallback hook to include posthog.

Detailed summary

  • Replaced direct import of posthog with usePostHog from posthog-js/react.
  • Updated the useCallback hook to include posthog in its dependency array.
  • Ensured the capture method is called on posthog if it exists.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

  • Refactor
    • Improved internal tracking logic to enhance stability and reliability of analytics event capture. No changes to user-facing functionality.

@vercel vercel bot temporarily deployed to Preview – docs-v2 May 23, 2025 03:58 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 23, 2025 03:58 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 23, 2025 03:58 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 23, 2025 03:58 Inactive
Copy link

vercel bot commented May 23, 2025

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

Name Status Preview Comments Updated (UTC)
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 23, 2025 4:41am
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Skipped (Inspect) May 23, 2025 4:41am
login ⬜️ Skipped (Inspect) May 23, 2025 4:41am
thirdweb_playground ⬜️ Skipped (Inspect) May 23, 2025 4:41am
wallet-ui ⬜️ Skipped (Inspect) May 23, 2025 4:41am

Copy link

changeset-bot bot commented May 23, 2025

⚠️ No Changeset found

Latest commit: 005acce

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented May 23, 2025

Walkthrough

The useTrack hook was refactored to use the usePostHog hook from posthog-js/react instead of directly importing the PostHog instance. The tracking logic is now wrapped in useCallback with updated dependency management and improved error handling for the PostHog instance.

Changes

File(s) Change Summary
apps/dashboard/src/hooks/analytics/useTrack.ts Refactored to use usePostHog for obtaining the PostHog instance, updated callback dependencies, and error handling.

Sequence Diagram(s)

sequenceDiagram
    participant Component
    participant useTrack
    participant usePostHog
    participant PostHog

    Component->>useTrack: Call useTrack()
    useTrack->>usePostHog: Get PostHog instance
    useTrack->>Component: Return tracking callback

    Component->>useTrack: Invoke tracking callback (event, data)
    useTrack->>PostHog: posthog?.capture(event, data)
    PostHog-->>useTrack: (Optional: handle error silently)
Loading

📜 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 cde2dd9 and 005acce.

📒 Files selected for processing (1)
  • apps/dashboard/src/hooks/analytics/useTrack.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: E2E Tests (pnpm, esbuild)
  • GitHub Check: Size
  • GitHub Check: E2E Tests (pnpm, webpack)
  • GitHub Check: E2E Tests (pnpm, vite)
  • GitHub Check: Lint Packages
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (5)
apps/dashboard/src/hooks/analytics/useTrack.ts (5)

2-2: Improved React integration with PostHog

Importing usePostHog from posthog-js/react is the correct approach for React components/hooks, as it's specifically designed to work with React's component lifecycle.


14-14: Good use of the React-specific hook

Using usePostHog() instead of directly importing the PostHog instance follows React best practices for accessing external libraries within hooks.


15-44: Well-implemented callback with proper dependency management

Wrapping the tracking function in useCallback with posthog as a dependency ensures the function is only recreated when the PostHog instance changes, which is proper React hook usage.


38-38: Good defensive programming with optional chaining

Using optional chaining (posthog?.capture) is a smart addition that prevents errors when the PostHog instance might not be initialized, improving reliability.


43-43: Correct dependency management

Including posthog in the dependency array follows React's rules of hooks and ensures the callback is recreated if the PostHog instance changes.

✨ Finishing Touches
  • 📝 Generate Docstrings

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

@jnsdls jnsdls marked this pull request as ready for review May 23, 2025 03:59
@jnsdls jnsdls requested review from a team as code owners May 23, 2025 03:59
@github-actions github-actions bot added the Dashboard Involves changes to the Dashboard. label May 23, 2025
Copy link
Member Author

jnsdls commented May 23, 2025


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copy link

codecov bot commented May 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.63%. Comparing base (cde2dd9) to head (005acce).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7135   +/-   ##
=======================================
  Coverage   55.63%   55.63%           
=======================================
  Files         902      902           
  Lines       58190    58190           
  Branches     4098     4098           
=======================================
  Hits        32373    32373           
  Misses      25712    25712           
  Partials      105      105           
Flag Coverage Δ
packages 55.63% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

github-actions bot commented May 23, 2025

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 56.62 KB (0%) 1.2 s (0%) 264 ms (+87.96% 🔺) 1.4 s
thirdweb (cjs) 309.13 KB (0%) 6.2 s (0%) 1.2 s (+0.36% 🔺) 7.4 s
thirdweb (minimal + tree-shaking) 5.69 KB (0%) 114 ms (0%) 98 ms (+683.36% 🔺) 212 ms
thirdweb/chains (tree-shaking) 531 B (0%) 11 ms (0%) 49 ms (+1061.54% 🔺) 59 ms
thirdweb/react (minimal + tree-shaking) 19.5 KB (0%) 390 ms (0%) 95 ms (+192% 🔺) 485 ms

@graphite-app graphite-app bot changed the base branch from Make_free_plan_badge_clickable_to_upgrade to graphite-base/7135 May 23, 2025 04:17
Copy link
Contributor

graphite-app bot commented May 23, 2025

Merge activity

@graphite-app graphite-app bot changed the base branch from graphite-base/7135 to main May 23, 2025 04:33
# Update PostHog import to use React hook

This PR updates the PostHog implementation in the `useTrack` hook to use the React-specific hook from PostHog instead of the direct import. The changes include:

- Replaced the direct import of `posthog` with `usePostHog` from `posthog-js/react`
- Added the PostHog instance as a dependency to the `useCallback` hook
- Added a null check before calling `posthog.capture()` to handle cases where PostHog might not be initialized

These changes ensure proper React integration with PostHog and prevent potential issues with the hook's dependency array.
@graphite-app graphite-app bot force-pushed the Update_PostHog_import_to_use_React_hook branch from 140d003 to 005acce Compare May 23, 2025 04:34
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 23, 2025 04:34 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 23, 2025 04:34 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 23, 2025 04:34 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 23, 2025 04:34 Inactive
@graphite-app graphite-app bot merged commit 005acce into main May 23, 2025
24 checks passed
@graphite-app graphite-app bot deleted the Update_PostHog_import_to_use_React_hook branch May 23, 2025 04:42
@vercel vercel bot temporarily deployed to Production – docs-v2 May 23, 2025 04:42 Inactive
@vercel vercel bot temporarily deployed to Production – wallet-ui May 23, 2025 04:42 Inactive
@vercel vercel bot temporarily deployed to Production – thirdweb_playground May 23, 2025 04:42 Inactive
@vercel vercel bot temporarily deployed to Production – login May 23, 2025 04:42 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dashboard Involves changes to the Dashboard.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants