feat: Allow skip initialization on meta

[david8z]

PR Description

Some tools like hubspot tracking initialize meta with their own external id.

To avoid the double initialization we want to delegate fb initialization to hubspot.

On this PR we aim to conditionally disbale meta intialization through rudderstack.

Summary by CodeRabbit

• New Features
  • Introduced a configuration option for Facebook Pixel that allows users to control its automatic initialization.
  • Enhanced the readiness verification to ensure the integration is fully loaded and initialized before it is considered ready.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce a new property, skipInitialization, in the FacebookPixel class. This option allows users to control whether the Facebook Pixel should be initialized during execution. The initialization logic in the init method now checks the value of skipInitialization to either proceed with or skip registering the pixel. Additionally, the isReady method has been updated to verify that the Facebook Pixel has been properly initialized by checking for the pixel ID in the state of the fbq object.

Changes

File(s)	Change Summary
packages/.../integrations/FacebookPixel/browser.js	Added skipInitialization property to control pixel initialization, updated the init method to check this flag, and modified isReady logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FP as FacebookPixel
    participant FBQ as fbq

    User->>FP: Instantiate with skipInitialization flag
    alt skipInitialization is false
        FP->>FBQ: Initialize pixel using user payload
    else skipInitialization is true
        FP-->>User: Skip initialization
    end
    FP->>FP: Execute isReady check (verify fbq pixel ID exists)

Loading

Suggested reviewers

• sanpj2292
• chandumlg
• utsabc
• saikumarrs

---

📜 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 6ad55ef and 9b6d3c8.

📒 Files selected for processing (1)

• packages/analytics-js-integrations/src/integrations/FacebookPixel/browser.js (3 hunks)

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: david8z
PR: rudderlabs/rudder-sdk-js#2037
File: packages/analytics-js-integrations/src/integrations/FacebookPixel/browser.js:120-121
Timestamp: 2025-02-10T13:32:41.446Z
Learning: In Facebook Pixel integration, the isReady method should always check for actual pixel initialization state using fbq.getState().pixels, even when skipInitialization is true, as the pixel might be initialized by other tools.

packages/analytics-js-integrations/src/integrations/FacebookPixel/browser.js (1)

Learnt from: david8z
PR: rudderlabs/rudder-sdk-js#2037
File: packages/analytics-js-integrations/src/integrations/FacebookPixel/browser.js:120-121
Timestamp: 2025-02-10T13:32:41.446Z
Learning: In Facebook Pixel integration, the isReady method should always check for actual pixel initialization state using fbq.getState().pixels, even when skipInitialization is true, as the pixel might be initialized by other tools.

🔇 Additional comments (3)

packages/analytics-js-integrations/src/integrations/FacebookPixel/browser.js (3)

51-51: Addition of skipInitialization configuration option looks good!

This property allows delegating Facebook Pixel initialization to other tools like HubSpot, addressing the double initialization issue mentioned in the PR objectives.

---

78-82: Implementation of skipInitialization logic is well structured.

The code still loads the Facebook Pixel script but bypasses the initialization process when skipInitialization is true. This approach ensures the script is available for other tools to initialize while preventing duplicate initialization.

---

120-121: Good implementation of initialization detection.

The isReady method now properly verifies that the Facebook Pixel has been initialized by checking if the pixel ID exists in the state of the fbq object. This is important as the pixel might be initialized by other tools when skipInitialization is true.

✨ 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

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

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (2)

packages/analytics-js-integrations/src/integrations/FacebookPixel/browser.js (2)

118-119: Add safer null checking for getState().

The current implementation might throw if getState() returns undefined.

Apply this diff to add safer null checking:

-    const isInitialized = (window.fbq?.getState?.().pixels || []).some(p => p.id === this.pixelId); 
+    const isInitialized = (window.fbq?.getState?.()?.pixels || []).some(p => p.id === this.pixelId); 
     return this.isLoaded() && isInitialized;

---

117-120: Consider enhancing initialization verification.

While the isReady check verifies FB initialization, it doesn't guarantee that HubSpot will eventually initialize FB. Consider:

1. Adding a timeout mechanism to prevent indefinite waiting
2. Implementing a fallback initialization if HubSpot fails to initialize FB
3. Adding logging to help debug initialization issues

This will make the integration more robust and easier to troubleshoot.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d7df880 and 7da20c0.

📒 Files selected for processing (1)

• packages/analytics-js-integrations/src/integrations/FacebookPixel/browser.js (3 hunks)

[coderabbitai]

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7da20c0 and 6ad55ef.

📒 Files selected for processing (1)

• packages/analytics-js-integrations/src/integrations/FacebookPixel/browser.js (4 hunks)

🔇 Additional comments (2)

packages/analytics-js-integrations/src/integrations/FacebookPixel/browser.js (2)

51-51: LGTM!

The skipInitialization property is correctly added and follows the established pattern for configuration properties.

---

79-82: LGTM! The initialization skip logic is well-implemented.

The code correctly loads the FB SDK while skipping the initialization, allowing external tools like HubSpot to handle the initialization process.

[github-actions]

Hello! This PR has been open for 20 days without any activity. Therefore, it's considered as stale and is scheduled to be closed in 10 days. If you're still working on this, please remove the 'Stale' label or add a comment to keep it open. Thanks for your contribution!