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

website: Add GA tag to header for google search console indexing #2536

Merged
merged 1 commit into from
Feb 27, 2025

Conversation

OchiengPaul442
Copy link
Contributor

@OchiengPaul442 OchiengPaul442 commented Feb 27, 2025

Summary of Changes (What does this PR do?)

  • Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Status of maturity (all need to be checked before merging):

  • I've tested this locally
  • I consider this code done
  • This change ready to hit production in its current state

Screenshots (optional)

Summary by CodeRabbit

  • New Features
    • Updated analytics integration for more reliable tracking.
    • Enhanced SEO with additional metadata to improve search visibility and social sharing.

Copy link

coderabbitai bot commented Feb 27, 2025

📝 Walkthrough

Walkthrough

The update refactors the Google Analytics integration in the layout.tsx file. The dynamic import for the Google Analytics component is removed and replaced with two <Script> components embedded in the <head> section. One script loads the Google Tag Manager script, while the other initializes the GA tracking through a newly defined gtag function. Additionally, several SEO meta tags have been added, and the GA variable handling has been updated by removing GA_MEASUREMENT_ID in favor of a new GA_ID.

Changes

File Change Summary
src/.../layout.tsx Removed dynamic import for Google Analytics; added two <Script> components in the <head> for loading GTM and initializing GA; replaced GA_MEASUREMENT_ID with GA_ID; added SEO meta tags (title, description, keywords, author, Open Graph properties); maintained existing maintenance status logic.

Sequence Diagram(s)

sequenceDiagram
    participant Browser
    participant LayoutComponent
    participant GTM_Script
    participant GA_InitScript

    Browser->>LayoutComponent: Request page load
    LayoutComponent->>Browser: Sends HTML with updated <head> tags
    Browser->>GTM_Script: Loads Google Tag Manager script via <Script>
    Browser->>GA_InitScript: Executes GA initialization via <Script>
Loading

Possibly related PRs

Suggested reviewers

  • Baalmart
  • Codebmk

Poem

In code we weave a brand new thread,
Dynamic import laid quietly to rest.
Scripts in the head now smoothly play,
GA and SEO shine through the day.
Fresh updates guide the path, in code we trust and stay!

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.
✨ Finishing Touches
  • 📝 Generate Docstrings

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.
  • @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 or @coderabbitai title 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

@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/website2/src/app/layout.tsx (1)

36-41: Good variable setup, but consider environment variable handling.

The GA_ID setup with a fallback is a good practice, but hardcoding the fallback GA ID in the source code might not be ideal for security and maintainability.

The SEO-related variables are well structured, with clear and descriptive content.

Consider moving the fallback GA ID to an environment variable or configuration file:

- const GA_ID = process.env.NEXT_PUBLIC_GA_MEASUREMENT_ID || 'G-79ZVCLEDSG';
+ const GA_ID = process.env.NEXT_PUBLIC_GA_MEASUREMENT_ID || process.env.NEXT_PUBLIC_GA_FALLBACK_ID;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 09d3e67 and ef4baf4.

📒 Files selected for processing (1)
  • src/website2/src/app/layout.tsx (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-push-website2-deploy-preview
🔇 Additional comments (3)
src/website2/src/app/layout.tsx (3)

4-4: Nice addition of the Script component.

Adding the next/script import is appropriate for handling external scripts like Google Analytics. The Script component offers better performance control compared to traditional script tags.


46-68: Excellent SEO metadata implementation.

The comprehensive SEO metadata setup follows best practices:

  • Primary SEO tags with appropriate content
  • Open Graph tags for social sharing on Facebook and other platforms
  • Twitter Card metadata for Twitter sharing

This will significantly improve the site's visibility in search engines and appearance when shared on social media.


69-84:

❓ Verification inconclusive

Well-implemented Google Analytics integration.

The Google Analytics implementation follows best practices:

  1. Using beforeInteractive strategy ensures the scripts load early
  2. Proper setup of the dataLayer and gtag function
  3. Configuration includes page path tracking for SPA behavior

This implementation is correctly placed in the <head> section, which is required for Google Search Console verification as noted in your comment.


🏁 Script executed:

#!/bin/bash
# Check if there are other GA implementations in the codebase that might conflict
echo "Checking for potential conflicting Google Analytics implementations..."
rg -i "googletagmanager|gtag|google analytics" --type tsx --type jsx

Length of output: 249


Below is an updated review comment incorporating the findings from a re-run of the GA search command with explicit file globs. Note that the initial search flagged an error for TSX files; using explicit globs (i.e. "*.tsx" and "*.jsx") ensures complete coverage when looking for possible duplicate GA implementations. Please manually verify the search results if needed.

Google Analytics Integration Verification

  • The implementation in src/website2/src/app/layout.tsx adheres to best practices:
    • It uses the beforeInteractive strategy to ensure the GA scripts load early.
    • The setup correctly configures dataLayer and defines the gtag function.
    • The configuration properly tracks the SPA page path.
  • A search across .tsx and .jsx files (using explicit globs) did not reveal any conflicting GA implementations.
  • Action: If needed, re-run the following command for manual verification:
    #!/bin/bash
    echo "Checking for potential conflicting GA implementations in .tsx and .jsx files..."
    rg -i "googletagmanager|gtag|google analytics" --glob "*.tsx" --glob "*.jsx" || echo "No conflicts found."

Overall, the GA integration is well implemented, with no apparent conflicts beyond the current file.

Copy link
Contributor

New Website2 changes available for preview here

@Baalmart Baalmart merged commit 0d8b950 into staging Feb 27, 2025
29 checks passed
@Baalmart Baalmart deleted the website-doc-readme branch February 27, 2025 14:03
@Baalmart Baalmart mentioned this pull request Feb 27, 2025
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants