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

565-feat: Connect google analytics #698

Merged
merged 7 commits into from
Jan 16, 2025
Merged

Conversation

ansivgit
Copy link
Collaborator

@ansivgit ansivgit commented Dec 23, 2024

What type of PR is this? (select all that apply)

  • πŸ• Feature
  • πŸ› Bug Fix
  • 🚧 Breaking Change
  • πŸ§‘β€πŸ’» Code Refactor
  • πŸ“ Documentation Update

Description

Added custom Analitics.tsx component with GA tag.

Related Tickets & Documents

Added/updated tests?

  • πŸ‘Œ Yes
  • πŸ™…β€β™‚οΈ No, because they aren't needed
  • πŸ™‹β€β™‚οΈ No, because I need help

[optional] Are there any post deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

Summary by CodeRabbit

  • New Features

    • Added Google Analytics tracking to the application
    • Integrated analytics component into the main application layout
  • Dependencies

    • Added @next/third-parties package to support analytics functionality

@ansivgit ansivgit self-assigned this Dec 23, 2024
@github-actions github-actions bot changed the title Feat/565 connect google analytics 565-feat: Connect google analytics Dec 23, 2024
Copy link
Collaborator

@SpaNb4 SpaNb4 left a comment

Choose a reason for hiding this comment

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

lgtm!

image

@ansivgit ansivgit marked this pull request as ready for review December 30, 2024 08:55
Copy link
Contributor

coderabbitai bot commented Dec 30, 2024

πŸ“ Walkthrough

Walkthrough

The pull request introduces Google Analytics tracking to the Next.js application by adding the @next/third-parties package and creating an Analytics component. The implementation tracks page views conditionally based on the environment, ensuring analytics are only active in non-production settings.

Changes

File Change Summary
package.json Added @next/third-parties dependency (v^15.0.2)
src/app/analytics.tsx Created new Analytics component for Google Analytics tracking
src/app/layout.tsx Integrated Analytics component into root layout

Assessment against linked issues

Objective Addressed Explanation
Connect Google Analytics [#565] βœ…
Track external links ❓ Current implementation only tracks page views

The implementation successfully adds Google Analytics tracking to the application, meeting the primary objective of issue #565. However, the current code does not explicitly handle tracking external links, which was mentioned in the additional context.


πŸ“œ Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between a7470b6 and b8827f4.

β›” Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
πŸ“’ Files selected for processing (2)
  • package.json (1 hunks)
  • src/app/layout.tsx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • src/app/layout.tsx
  • package.json
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Build rs.school
  • GitHub Check: CI

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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: 0

🧹 Nitpick comments (1)
src/app/analytics.tsx (1)

19-20: Consider externalizing the GA ID.
It’s standard practice to store environment-specific tokens, like G-THXM004SPR, in environment variables (e.g. process.env) for better maintainability.

πŸ“œ Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between cfa2259 and b4a76d7.

β›” Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
πŸ“’ Files selected for processing (3)
  • package.json (1 hunks)
  • src/app/analytics.tsx (1 hunks)
  • src/app/layout.tsx (2 hunks)
πŸ”‡ Additional comments (5)
src/app/analytics.tsx (2)

1-1: Directive for client-side usage is appropriate.
Since this component depends on browser APIs (window.dataLayer), 'use client' is correctly specified.


7-16: Ensure robust handling of window.dataLayer.
Although this logic works correctly in a client component, consider verifying that window.dataLayer is not overwritten by other scripts.

If you wish, I can generate a script to check for potential collisions with other scripts manipulating window.dataLayer.

src/app/layout.tsx (2)

2-2: New import declaration is well-structured.
The import from ./analytics is clear and consistent with the project structure.


46-46: Correct usage of <Analytics /> in layout.
Integrating <Analytics /> at the bottom of <body> ensures that the rest of the layout is rendered first, which is suitable for analytics tracking.

package.json (1)

26-26: Verify the stability of @next/third-parties dependency.
Check if there are known issues with version ^15.0.2 to ensure long-term reliability.

Use this script to scan for potential advisories:

βœ… Verification successful

@next/third-parties dependency is stable and properly used

The package shows no security vulnerabilities, is being used correctly for Google Analytics integration, and is locked to a specific version (15.0.2) in package-lock.json. The dependency is part of the official Next.js ecosystem, making it a reliable choice.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Checking for known vulnerabilities or updates in @next/third-parties
gh api graphql -f query='
{
  securityVulnerabilities(first: 5, ecosystem: NPM, package: "@next/third-parties") {
    nodes {
      advisory {
        summary
        severity
        publishedAt
      }
      vulnerableVersionRange
      firstPatchedVersion {
        identifier
      }
    }
  }
}
'

Length of output: 353


Script:

#!/bin/bash
# Let's check the usage of @next/third-parties in the codebase
rg "@next/third-parties" -A 2

# Also check package-lock.json for current resolved version
rg '"@next/third-parties"' package-lock.json

Length of output: 1020

Copy link

Lighthouse Report:

  • Performance: 92 / 100
  • Accessibility: 100 / 100
  • Best Practices: 100 / 100
  • SEO: 100 / 100

View detailed report

@ansivgit ansivgit merged commit 4f130bd into main Jan 16, 2025
3 checks passed
@ansivgit ansivgit deleted the feat/565-connect-google-analytics branch January 16, 2025 08:58
Copy link

Lighthouse Report:

  • Performance: 83 / 100
  • Accessibility: 100 / 100
  • Best Practices: 100 / 100
  • SEO: 100 / 100

View detailed report

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Connect Google Analytics
4 participants