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

Add Facebook Pixel tracking script #72

Merged
merged 2 commits into from
Feb 10, 2025
Merged

Add Facebook Pixel tracking script #72

merged 2 commits into from
Feb 10, 2025

Conversation

ryan-gang
Copy link
Contributor

@ryan-gang ryan-gang commented Feb 5, 2025

Integrate Facebook Pixel for tracking page views and user interactions.

Summary by CodeRabbit

  • New Features
    • Enabled Facebook Pixel integration to automatically capture page view events, enhancing analytics tracking with asynchronous script loading for seamless performance.

Copy link

coderabbitai bot commented Feb 5, 2025

Walkthrough

The changes add a self-invoking function in the docs/facebook-pixel.js file that initializes the Facebook Pixel tracking. The function verifies whether the fbq function exists before defining it, sets up the necessary configuration including a version number and an empty event queue, loads the Facebook tracking script asynchronously, and finally triggers a 'PageView' event using a specified tracking ID.

Changes

File Summary
docs/facebook-pixel.js Added a self-invoking function for Facebook Pixel initialization. It checks if fbq exists, sets up a queue, loads the tracking script asynchronously, and sends a 'PageView' event.

Sequence Diagram(s)

sequenceDiagram
    participant User as Browser
    participant Page as Webpage
    participant Loader as FB Script Loader

    User->>Page: Load webpage
    Page->>Page: Check if fbq exists
    alt fbq does not exist
        Page->>Page: Define fbq function and initialize queue
        Page->>Loader: Load Facebook tracking script asynchronously
    end
    Page->>Page: Initialize with tracking ID
    Page->>Loader: Send 'PageView' event
Loading

Poem

Hoppin' through code with glee,
I set up a pixel, oh so free.
No duplicate tracks, just clear delight,
Async scripts load in the night.
With a PageView hop and a joyful cheer,
This rabbit's code brings tracking near!
🥕🐇 Happy coding!


📜 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 86c605c and 22ebb64.

📒 Files selected for processing (1)
  • docs/facebook-pixel.js (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/facebook-pixel.js

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

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

🧹 Nitpick comments (1)
docs/facebook-pixel.js (1)

4-5: Add development environment configuration.

Consider adding debug mode for development environments to help with tracking verification and debugging.

Apply this diff to add debug mode:

 if(!f._fbq)f._fbq=n;n.push=n;n.loaded=!0;n.version='2.0';
-n.queue=[];t=b.createElement(e);t.async=!0;
+n.queue=[];
+// Enable debug mode in development
+if (process.env.NODE_ENV === 'development') {
+  n.debug = true;
+}
+t=b.createElement(e);t.async=!0;
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3bfbfd9 and 86c605c.

📒 Files selected for processing (1)
  • docs/facebook-pixel.js (1 hunks)
🔇 Additional comments (2)
docs/facebook-pixel.js (2)

6-8: ⚠️ Potential issue

Add SRI hash and error handling for the external script.

The external script loading should include:

  1. Subresource Integrity (SRI) hash for security
  2. Error handling for script load failures

Apply this diff to enhance security and reliability:

-t.src=v;s=b.getElementsByTagName(e)[0];
+t.src=v;
+t.integrity='sha384-{{HASH}}';
+t.crossOrigin='anonymous';
+t.onerror = function() {
+  console.error('Failed to load Facebook Pixel script');
+};
+s=b.getElementsByTagName(e)[0];

9-10: 🛠️ Refactor suggestion

Use environment-specific pixel IDs.

The pixel ID should not be hardcoded and should vary based on the environment to prevent tracking in non-production environments.

Apply this diff to implement environment-specific configuration:

-fbq('init', '1218366289258395');
-fbq('track', 'PageView');
+const pixelId = process.env.FB_PIXEL_ID || '1218366289258395';
+if (/^\d{15,16}$/.test(pixelId)) {
+  fbq('init', pixelId);
+  fbq('track', 'PageView');
+} else {
+  console.error('Invalid Facebook Pixel ID');
+}

Please verify if the pixel ID format is correct:

docs/facebook-pixel.js Outdated Show resolved Hide resolved
@ryan-gang ryan-gang merged commit 30292c4 into master Feb 10, 2025
2 checks passed
@ryan-gang ryan-gang deleted the add-pixel branch February 10, 2025 07:57
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