feat: add LinkedIn Insight and GTM scripts

[wilsonrivera]

Summary by CodeRabbit

• New Features

  • Added support for Google Tag Manager and LinkedIn Insight analytics integration, including conditional loading of their tracking scripts based on environment variables.

• Chores

  • Updated environment variable example file with placeholders for analytics configuration.
  • Adjusted Content Security Policy to allow necessary sources for analytics scripts and images.

Checklist

• I have discussed my proposed changes in an issue and have received approval to proceed.
• I have followed the coding standards of the project.
• Tests or benchmarks have been added or updated.
• Documentation has been updated on https://github.com/wundergraph/cosmo-docs.
• I have read the Contributors Guide.

[coderabbitai]

Walkthrough

This change introduces support for Google Tag Manager and LinkedIn Insight analytics in the application. It adds environment variable placeholders for their IDs, updates the Content Security Policy to permit required domains, and conditionally injects the relevant tracking scripts into the Next.js custom Document component based on environment configuration.

Changes

Cohort / File(s)	Change Summary
Analytics Environment Variables studio/.env.local.example	Added placeholders for NEXT_PUBLIC_GOOGLE_TAG_MANAGER_ID and NEXT_PUBLIC_LINKEDIN_INSIGHT_ID under a new analytics config section for future analytics integration.
Content Security Policy Update studio/next.config.mjs	Modified CSP header to allow new image and script sources required for Google Tag Manager and LinkedIn Insight, updated spacing for correct formatting.
Analytics Script Injection studio/src/pages/_document.tsx	Conditionally injects Google Tag Manager and LinkedIn Insight tracking scripts and noscript fallbacks into the custom Document, based on presence of environment variables. No changes to component signature or existing logic.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 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 1a947b1 and 670b058.

📒 Files selected for processing (3)

• studio/.env.local.example (1 hunks)
• studio/next.config.mjs (1 hunks)
• studio/src/pages/_document.tsx (3 hunks)

🧰 Additional context used

🪛 Biome (2.1.2)

studio/src/pages/_document.tsx

[error] 28-28: Avoid passing content using the dangerouslySetInnerHTML prop.

Setting content using code can expose users to cross-site scripting (XSS) attacks

(lint/security/noDangerouslySetInnerHtml)

---

[error] 151-151: Avoid passing content using the dangerouslySetInnerHTML prop.

Setting content using code can expose users to cross-site scripting (XSS) attacks

(lint/security/noDangerouslySetInnerHtml)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: build_test
• GitHub Check: Analyze (go)
• GitHub Check: build_push_image
• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (7)

studio/.env.local.example (1)

20-23: LGTM! Well-organized analytics configuration.

The new analytics configuration section follows Next.js conventions with proper NEXT_PUBLIC_ prefixes for client-side environment variables. The section placement and naming are clear and organized.

studio/next.config.mjs (2)

60-64: LGTM! Necessary CSP update for LinkedIn tracking pixels.

The addition of *.ads.linkedin.com to the img-src directive is required for LinkedIn Insight tracking pixels to load properly. The spacing improvement also enhances readability.

---

67-69: LGTM! Proper CSP configuration for analytics scripts.

The addition of https://www.googletagmanager.com and https://snap.licdn.com to the script-src directive correctly allows the respective analytics scripts to execute. These are official domains from Google and LinkedIn for their analytics services.

studio/src/pages/_document.tsx (4)

18-19: LGTM! Clean environment variable extraction.

The environment variable extraction follows Next.js conventions and enables conditional rendering of analytics scripts.

---

24-37: LGTM! Standard GTM implementation with proper XSS protection.

The GTM script implementation follows Google's official documentation. The use of JSON.stringify() for the GTM ID properly escapes the value, preventing XSS attacks despite using dangerouslySetInnerHTML.

---

117-126: LGTM! Proper GTM noscript fallback.

The noscript iframe fallback ensures GTM tracking works for users with JavaScript disabled, following Google's recommended implementation.

---

146-182: LGTM! Standard LinkedIn Insight implementation with proper XSS protection.

The LinkedIn Insight implementation follows LinkedIn's official pattern. The use of JSON.stringify() for the partner ID properly escapes the value, making the dangerouslySetInnerHTML usage secure. The noscript pixel fallback ensures tracking works without JavaScript.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch wilson/eng-7398-gtm-linkedin-insight-tag

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 generate unit tests to generate unit tests 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 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.