Skip to content

feat: enrich event stream with Kit userAttributes #79

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.

Sign up for GitHub

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

Merged
alexs-mparticle merged 6 commits into from
Mar 25, 2026
Merged

feat: enrich event stream with Kit userAttributes #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
eddcbd4
feat: enrich event stream with Kit userAttributes
mattbodle Mar 25, 2026
bd92fc5
Revert changes to dist files
jamesnrokt Mar 25, 2026
2cae9a7
Update tests.js
jamesnrokt Mar 25, 2026
c463fe6
fix: resolve merge conflicts between almondine-snowplow and development
alexs-mparticle Mar 25, 2026
0dbe200
fix: revert dist files from merge commit
alexs-mparticle Mar 25, 2026
be54780
fix: reset dist files to match development branch
alexs-mparticle Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions src/Rokt-Kit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -552,16 +552,22 @@ var constructor = function () {
}
}

function _enrichEvent(event) {
return mergeObjects({}, event, {
UserAttributes: self.userAttributes,
});
}

function _sendEventStream(event) {
if (window.Rokt && typeof window.Rokt.__event_stream__ === 'function') {
if (self.eventStreamQueue.length) {
var queuedEvents = self.eventStreamQueue;
self.eventStreamQueue = [];
for (var i = 0; i < queuedEvents.length; i++) {
window.Rokt.__event_stream__(queuedEvents[i]);
window.Rokt.__event_stream__(_enrichEvent(queuedEvents[i]));
}
}
window.Rokt.__event_stream__(event);
window.Rokt.__event_stream__(_enrichEvent(event));
} else {
self.eventStreamQueue.push(event);
}
Expand Down
137 changes: 136 additions & 1 deletion test/src/tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4649,7 +4649,10 @@ describe('Rokt Forwarder', () => {
window.mParticle.forwarder.process(testEvent);

receivedEvents.length.should.equal(1);
receivedEvents[0].should.deepEqual(testEvent);
receivedEvents[0].EventName.should.equal('Test Event');
receivedEvents[0].EventCategory.should.equal(EventType.Other);
receivedEvents[0].EventDataType.should.equal(MessageType.PageEvent);
receivedEvents[0].UserAttributes.should.deepEqual({});
});

it('should queue event when window.Rokt.__event_stream__ is not defined', async () => {
Expand Down Expand Up @@ -4850,6 +4853,138 @@ describe('Rokt Forwarder', () => {
});
});

it('should enrich event with Kit userAttributes before sending to event stream', async () => {
var receivedEvents = [];
window.Rokt.__event_stream__ = function (event) {
receivedEvents.push(event);
};

await window.mParticle.forwarder.init(
{ accountId: '123456' },
reportService.cb,
true,
null,
{}
);

await waitForCondition(() => window.mParticle.Rokt.attachKitCalled);

window.mParticle.forwarder.userAttributes = {
firstName: 'John',
lastName: 'Doe',
};

window.mParticle.forwarder.process({
EventName: 'Test Event',
EventCategory: EventType.Other,
EventDataType: MessageType.PageEvent,
});

receivedEvents.length.should.equal(1);
receivedEvents[0].UserAttributes.should.deepEqual({
firstName: 'John',
lastName: 'Doe',
});
});

it('should override event UserAttributes with Kit userAttributes', async () => {
var receivedEvents = [];
window.Rokt.__event_stream__ = function (event) {
receivedEvents.push(event);
};

await window.mParticle.forwarder.init(
{ accountId: '123456' },
reportService.cb,
true,
null,
{}
);

await waitForCondition(() => window.mParticle.Rokt.attachKitCalled);

window.mParticle.forwarder.userAttributes = {
firstName: 'Jane',
};

window.mParticle.forwarder.process({
EventName: 'Test Event',
EventCategory: EventType.Other,
EventDataType: MessageType.PageEvent,
UserAttributes: {
firstName: 'Stale',
obsoleteAttr: 'should-not-appear',
},
});

receivedEvents.length.should.equal(1);
receivedEvents[0].UserAttributes.should.deepEqual({
firstName: 'Jane',
});
});

it('should not mutate the original event when enriching with userAttributes', async () => {
var receivedEvents = [];
window.Rokt.__event_stream__ = function (event) {
receivedEvents.push(event);
};

await window.mParticle.forwarder.init(
{ accountId: '123456' },
reportService.cb,
true,
null,
{}
);

await waitForCondition(() => window.mParticle.Rokt.attachKitCalled);

window.mParticle.forwarder.userAttributes = {
firstName: 'John',
};

var originalEvent = {
EventName: 'Test Event',
EventCategory: EventType.Other,
EventDataType: MessageType.PageEvent,
};

window.mParticle.forwarder.process(originalEvent);

originalEvent.should.not.have.property('UserAttributes');
receivedEvents[0].UserAttributes.should.deepEqual({
firstName: 'John',
});
});

it('should send empty UserAttributes when Kit has no userAttributes', async () => {
var receivedEvents = [];
window.Rokt.__event_stream__ = function (event) {
receivedEvents.push(event);
};

await window.mParticle.forwarder.init(
{ accountId: '123456' },
reportService.cb,
true,
null,
{}
);

await waitForCondition(() => window.mParticle.Rokt.attachKitCalled);

window.mParticle.forwarder.userAttributes = {};

window.mParticle.forwarder.process({
EventName: 'Test Event',
EventCategory: EventType.Other,
EventDataType: MessageType.PageEvent,
});

receivedEvents.length.should.equal(1);
receivedEvents[0].UserAttributes.should.deepEqual({});
});

it('should flush queued events in FIFO order when __event_stream__ becomes available', async () => {
await window.mParticle.forwarder.init(
{ accountId: '123456' },
Expand Down
Loading