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

chore: Updating posthog #2631

Merged
merged 1 commit into from
Oct 31, 2024
Merged

chore: Updating posthog #2631

merged 1 commit into from
Oct 31, 2024

Conversation

perkinsjr
Copy link
Collaborator

@perkinsjr perkinsjr commented Oct 31, 2024

What does this PR do?

Update posthog to the latest version

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Test A
  • Test B

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features

    • Updated the posthog-js dependency for improved performance and potential new features in both the dashboard and landing projects.
  • Bug Fixes

    • The new version may include various bug fixes enhancing overall stability.

Copy link

vercel bot commented Oct 31, 2024

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

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 31, 2024 6:47pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 31, 2024 6:47pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 31, 2024 6:47pm
workflows ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 31, 2024 6:47pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 31, 2024 6:47pm

Copy link

changeset-bot bot commented Oct 31, 2024

⚠️ No Changeset found

Latest commit: 31a2d8a

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 Oct 31, 2024

📝 Walkthrough

Walkthrough

The pull request includes updates to the package.json files for two projects: @unkey/dashboard and landing. In both cases, the posthog-js dependency version has been upgraded from ^1.130.1 to ^1.179.0. No other changes have been made to dependencies, scripts, or the overall structure of the package.json files.

Changes

File Change Summary
apps/dashboard/package.json Updated posthog-js dependency from ^1.130.1 to ^1.179.0
apps/www/package.json Updated posthog-js dependency from ^1.130.1 to ^1.179.0

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Dashboard
    participant Landing

    User->>Dashboard: Load Dashboard
    Dashboard->>posthog-js: Initialize tracking
    Dashboard->>User: Display Dashboard

    User->>Landing: Load Landing Page
    Landing->>posthog-js: Initialize tracking
    Landing->>User: Display Landing Page
Loading

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

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

github-actions bot commented Oct 31, 2024

Thank you for following the naming conventions for pull request titles! 🙏

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c531755 and 31a2d8a.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • apps/dashboard/package.json (1 hunks)
  • apps/www/package.json (1 hunks)
🔇 Additional comments (1)
apps/dashboard/package.json (1)

93-93: LGTM with verification needed.

The update from posthog-js@^1.130.1 to posthog-js@^1.179.0 follows semver and should be backward compatible. However, given the significant version jump, please verify:

  1. Review the PostHog changelog for any notable changes
  2. Ensure compatibility with posthog-node@^4.2.0
  3. Test key PostHog functionality:
    • Event tracking
    • User identification
    • Feature flags (if used)

Let's verify the PostHog usage in the codebase:

✅ Verification successful

PostHog update verification complete - Basic features only

Based on the codebase analysis, the PostHog usage is limited to basic features that are stable across versions:

  • Page view tracking using capture("$pageview")
  • Page leave tracking using capture("$pageleave")
  • User identification with basic properties
  • Standard initialization with minimal configuration

Since:

  1. No feature flags are used (confirmed by empty search results)
  2. Only stable PostHog APIs are used
  3. The version update maintains the same major version (1.x)
  4. The implementation is consistent across apps

The version update from ^1.130.1 to ^1.179.0 should be safe, requiring only verification of these basic tracking features in the testing environment.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Find PostHog initialization and usage patterns to determine what needs testing

# Test: Find PostHog initialization and configuration
echo "PostHog initialization patterns:"
rg -l "posthog\.(init|register|identify)" 

# Test: Find event tracking usage
echo "\nPostHog event tracking:"
rg "posthog\.capture"

# Test: Find feature flag usage
echo "\nPostHog feature flags:"
rg "posthog\.(getFeatureFlag|isFeatureEnabled)"

Length of output: 959


Script:

#!/bin/bash
# Let's check the PostHog initialization code to understand the features being used

echo "PostHog initialization in dashboard:"
cat apps/dashboard/providers/PostHogProvider.tsx

echo -e "\nPostHog initialization in www:"
cat apps/www/providers/PostHogProvider.tsx

echo -e "\nPostHog initialization in play:"
cat apps/play/app/providers.tsx

# Let's also check if there are any direct imports of posthog-js
echo -e "\nDirect posthog-js imports:"
rg "from ['\"]posthog-js['\"]"

Length of output: 4079

apps/www/package.json Show resolved Hide resolved
@perkinsjr perkinsjr merged commit 00a2e2b into main Oct 31, 2024
28 of 29 checks passed
@perkinsjr perkinsjr deleted the update-posth branch October 31, 2024 18:49
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.

1 participant