feat: Capture Integration Ids and assign to events #926

alexs-mparticle · 2024-10-04T15:11:54Z

Instructions

PR target branch should be against development
PR title name should follow this format: https://github.com/mParticle/mparticle-workflows/blob/main/.github/workflows/pr-title-check.yml
PR branch prefix should follow this format: https://github.com/mParticle/mparticle-workflows/blob/main/.github/workflows/pr-branch-check-name.yml

Summary

Adds support to capture select Integration Ids passed as query parameters or cookies and add them to Event Custom Flags for processing.
Relevant Facebook Documentation: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/fbp-and-fbc

Testing Plan

Was this tested locally? If not, explain why.
Using a sample app, pass in Facebook Click IDs via a query parameter, or Facebook Pixel ID as a cookie value and verify they appear in the Custom Flags for Events

Reference Issue (For mParticle employees only. Ignore if you are an outside contributor)

Closes https://go.mparticle.com/work/SQDSDKS-6806

src/mp-instance.js

src/integrationCapture.ts

src/sdkRuntimeModels.ts

src/serverModel.ts

test/jest/integration-capture.spec.ts

test/src/tests-feature-flags.ts

src/serverModel.ts

brewdente

I did a read through with @alexs-mparticle and everything looks clean and pretty straightforward. The tests are comprehensive and verified in his environment that it works.

src/integrationCapture.ts

src/utils.ts

src/integrationCapture.ts

src/utils.ts

rmi22186 · 2024-10-04T18:52:23Z

test/jest/integration-capture.spec.ts

+
+describe('Integration Capture', () => {
+    describe('constructor', () => {
+        it('should initialize with clickIds as undefined', () => {


I go back and forth with saying this should be undefined vs it being defined with a default value of {}. But not a hill i'm going to die on :)

rmi22186

very minor nits. looks great!

test/jest/utils.spec.ts

test/src/tests-feature-flags.ts

src/integrationCapture.ts

test/jest/integration-capture.spec.ts

src/integrationCapture.ts

src/mp-instance.js

src/integrationCapture.ts

rmi22186

tiny nits

src/integrationCapture.ts

src/serverModel.ts

src/utils.ts

sonarcloud · 2024-10-08T14:56:16Z

Quality Gate failed

Failed conditions
11.1% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

# [2.29.0](v2.28.3...v2.29.0) (2024-10-08) ### Bug Fixes * Fix typo in identity interface ([#923](#923)) ([f1e0ec9](f1e0ec9)) ### Features * Capture Integration Ids and assign to events ([#926](#926)) ([a916262](a916262))

mparticle-automation · 2024-10-08T17:21:37Z

🎉 This PR is included in version 2.29.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

alexs-mparticle added 5 commits September 30, 2024 16:24

Initial implementation of Capturing Integrations

e1c1200

Add Utilities

744e3e5

Add Integration Capture Module

f98ceda

Add Tests for Integration Capture

e0dd96e

Fix failing tests

03a8ae9

alexs-mparticle commented Oct 4, 2024

View reviewed changes

src/mp-instance.js Outdated Show resolved Hide resolved

alexs-mparticle added 2 commits October 4, 2024 11:54

Remove unnecessary lines

1f00693

Add sustained engineering task for the future

82fb49c