fix: Update BatchUploader to include integration attributes and custom flags in AST events (#1058)

Author: alexs-mparticle

src/batchUploader.ts

@@ -1,6 +1,6 @@
 import { Batch } from '@mparticle/event-models';
 import Constants from './constants';
-import { SDKEvent, SDKLoggerApi } from './sdkRuntimeModels';
+import { SDKEvent, SDKEventCustomFlags, SDKLoggerApi } from './sdkRuntimeModels';
 import { convertEvents } from './sdkToEventsApiConverter';
 import { MessageType, EventType } from './types';
 import { getRampNumber, isEmpty } from './utils';
@@ -14,6 +14,7 @@ import {
 import { IMParticleUser } from './identity-user-interfaces';
 import { IMParticleWebSDKInstance } from './mp-instance';
 import { appendUserInfo } from './user-utils';
+import { IntegrationAttributes } from './store';
 /**
  * BatchUploader contains all the logic to store/retrieve events and batches
  * to/from persistence, and upload batches to mParticle.
@@ -147,7 +148,7 @@ export class BatchUploader {
         const now = Date.now();
         const { _Store, Identity, _timeOnSiteTimer, _Helpers  } = this.mpInstance;
         const { sessionId, deviceId, sessionStartDate, SDKConfig } = _Store;
-        const { generateUniqueId } = _Helpers;
+        const { generateUniqueId, getFeatureFlag } = _Helpers;
         const { getCurrentUser } = Identity;
 
         const event = {
@@ -169,7 +170,28 @@ export class BatchUploader {
             IsBackgroundAST: true
         } as SDKEvent;
 
+
+        let customFlags: SDKEventCustomFlags = {...event.CustomFlags};
+        let integrationAttributes: IntegrationAttributes = _Store.integrationAttributes;
+
+        // https://go.mparticle.com/work/SQDSDKS-5053
+        if (getFeatureFlag && getFeatureFlag(Constants.FeatureFlags.CaptureIntegrationSpecificIds)) {
+
+            // Attempt to recapture click IDs in case a third party integration
+            // has added or updated  new click IDs since the last event was sent.
+            this.mpInstance._IntegrationCapture.capture();
+            const transformedClickIDs = this.mpInstance._IntegrationCapture.getClickIdsAsCustomFlags();
+            customFlags = {...transformedClickIDs, ...customFlags};
+
+            const transformedIntegrationAttributes = this.mpInstance._IntegrationCapture.getClickIdsAsIntegrationAttributes();
+            integrationAttributes = {...transformedIntegrationAttributes, ...integrationAttributes};
+        }
+
+        event.CustomFlags = customFlags;
+        event.IntegrationAttributes = integrationAttributes;
+
         appendUserInfo(getCurrentUser(), event);
+
         return event;
     }
 

test/src/tests-batchUploader.ts

@@ -374,6 +374,129 @@ describe('batch uploader', () => {
             delete window.mParticle.config.appVersion;
             delete window.mParticle.config.package;
         });
+
+        it('should add integration attributes to AST event', async () => {
+            window.mParticle.config.appName = 'Test App';
+            window.mParticle.config.appVersion = '1.0.0';
+            window.mParticle.config.package = 'com.test.app';
+
+            window.mParticle.config.identifyRequest = {
+                userIdentities: {
+                    email: '[email protected]'
+                }
+            };
+
+            window.mParticle.config.flags.captureIntegrationSpecificIds = "True";
+
+            const consentState = window.mParticle.Consent.createConsentState();
+            const timestamp = new Date().getTime();
+            const ccpaConsent = window.mParticle.Consent.createCCPAConsent(
+                true,
+                timestamp,
+                'consentDoc',
+                'location',
+                'hardware'
+            );
+            const gdprConsent = window.mParticle.Consent.createGDPRConsent(
+                false,
+                timestamp,
+                'consentDoc',
+                'location',
+                'hardware'
+            );
+            consentState.setCCPAConsentState(ccpaConsent);
+            consentState.addGDPRConsentState('test purpose', gdprConsent);
+
+            // Mock the query params capture function because we cannot mock window.location.href
+            sinon.stub(window.mParticle.getInstance()._IntegrationCapture, 'getQueryParams').returns({
+                rtid: 'test-click-id',
+            });
+
+            window.mParticle.init(apiKey, window.mParticle.config);
+            await waitForCondition(hasIdentifyReturned);
+            window.mParticle.Identity.getCurrentUser().setUserAttribute('foo', 'value');
+            const user = window.mParticle.Identity.getCurrentUser();
+            user.setConsentState(consentState);
+
+            const now = Date.now();
+            clock = sinon.useFakeTimers({
+                now: now,
+                shouldAdvanceTime: true
+            });
+
+            // Mock navigator.sendBeacon
+            beaconSpy = sinon.spy(navigator, 'sendBeacon');
+
+            // Trigger visibility change
+            Object.defineProperty(document, 'visibilityState', {
+                configurable: true,
+                get: () => 'hidden'
+            });
+            document.dispatchEvent(new Event('visibilitychange'));
+
+            // Run all pending promises
+            await Promise.resolve();
+            clock.runAll();
+
+            // Verify that beacon was called
+            expect(beaconSpy.calledOnce, 'Expected beacon to be called once').to.be.true;
+
+            // Get the beacon call data
+            const beaconCall = beaconSpy.getCall(0);
+            expect(beaconCall, 'Expected beacon call to exist').to.exist;
+
+            // Get the Blob from the beacon call
+            const blob = beaconCall.args[1];
+            expect(blob).to.be.instanceof(Blob);
+
+            // Read the Blob content
+            const reader = new FileReader();
+            const blobContent = await new Promise((resolve) => {
+                reader.onload = () => resolve(reader.result);
+                reader.readAsText(blob);
+            });
+
+            // Parse the beacon data which is a batch
+            const batch = JSON.parse(blobContent as string);
+            expect(batch.user_identities.email).to.equal('[email protected]');
+            expect(batch.user_attributes.foo).to.equal('value');
+            expect(batch.application_info.application_name).to.equal('Test App');
+            expect(batch.application_info.application_version).to.equal('1.0.0');
+            expect(batch.application_info.package).to.equal('com.test.app');
+            expect(batch.consent_state).to.have.property('ccpa');
+            expect(batch.consent_state.ccpa).to.have.property('data_sale_opt_out');
+            expect(batch.consent_state.ccpa.data_sale_opt_out).to.have.property('consented');
+            expect(batch.consent_state.ccpa.data_sale_opt_out.consented).to.equal(true);
+            expect(batch.consent_state.ccpa.data_sale_opt_out).to.have.property('timestamp_unixtime_ms');
+            expect(batch.consent_state.ccpa.data_sale_opt_out).to.have.property('document');
+            expect(batch.consent_state.gdpr).to.have.property('test purpose');
+            expect(batch.consent_state.gdpr['test purpose']).to.have.property('consented');
+            expect(batch.consent_state.gdpr['test purpose'].consented).to.equal(false);
+            expect(batch.consent_state.gdpr['test purpose']).to.have.property('timestamp_unixtime_ms');
+            expect(batch.consent_state.gdpr['test purpose']).to.have.property('document');
+            expect(batch.integration_attributes).to.exist;
+            expect(batch.integration_attributes['1277']).to.exist;
+            expect(batch.integration_attributes['1277'].passbackconversiontrackingid).to.equal('test-click-id');
+
+            const astEvent = batch.events[batch.events.length - 1];
+
+            expect(astEvent.event_type).to.equal('application_state_transition');
+            expect(astEvent.data.active_time_on_site_ms).to.be.a('number');
+            expect(astEvent.data.application_transition_type).to.equal('application_background');
+            expect(astEvent.data.custom_attributes).to.exist;
+            expect(astEvent.data.is_first_run).to.be.a('boolean');
+            expect(astEvent.data.is_upgrade).to.be.a('boolean');
+            expect(astEvent.data.location).to.equal(null);
+            expect(astEvent.data.session_start_unixtime_ms).to.be.a('number');
+            expect(astEvent.data.session_uuid).to.exist;
+            expect(astEvent.data.source_message_id).to.be.a('string');
+            expect(astEvent.data.timestamp_unixtime_ms).to.be.a('number');
+
+            // reset to prevent other tests from potentially failing
+            delete window.mParticle.config.appName;
+            delete window.mParticle.config.appVersion;
+            delete window.mParticle.config.package;
+        });
         });
     });