Skip to content

feat: log custom event logging for selectPlacement #52

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

Open
jaissica12 wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat: log custom event logging for selectPlacement #52

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
477b9ae
feat: log custom event logging for selectPlacement
jaissica12 Jan 16, 2026
2a0a5f3
add check in logSelectPlacementsEvent
jaissica12 Jan 16, 2026
f81b579
rename devPassedAttributes to debugAttributes, add helper to stringif…
jaissica12 Jan 21, 2026
5297654
fix typo and update tests
jaissica12 Jan 21, 2026
3bb1261
rename debugAttributes to initialAttributes and selectPlacementsAttri…
jaissica12 Jan 23, 2026
f76a5f9
cleanup EVENT_TYPE_OTHER var
jaissica12 Jan 23, 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
44 changes: 44 additions & 0 deletions src/Rokt-Kit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

var name = 'Rokt';
var moduleId = 181;
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The event name 'selectplacements' is all lowercase without spaces. Consider using a more conventional format like 'Select Placements' (Title Case), 'selectPlacements' (camelCase), or 'select_placements' (snake_case) for better readability and consistency with typical event naming conventions. If this specific format is intentional (e.g., for compatibility with external systems), consider adding a comment explaining why.

Suggested change
var moduleId = 181;
var moduleId = 181;
// The event name must remain in this exact lowercase format to match Rokt's expected event identifier.

Copilot uses AI. Check for mistakes.
var EVENT_NAME_SELECT_PLACEMENTS = 'selectplacements';

var constructor = function () {
var self = this;
Expand Down Expand Up @@ -199,10 +200,12 @@ var constructor = function () {
* @param {Object} options - The options object for selecting placements containing:
* - identifier {string}: The placement identifier
* - attributes {Object}: Optional attributes to merge with existing attributes
* - initialAttributes {Object}: Original attributes passed by developer
* @returns {Promise<void>} A Promise resolving to the Rokt launcher's selectPlacements method with processed attributes
*/
function selectPlacements(options) {
var attributes = (options && options.attributes) || {};
var initialAttributes = (options && options.initialAttributes) || {};
var placementAttributes = mergeObjects(self.userAttributes, attributes);

var filters = self.filters || {};
Expand Down Expand Up @@ -255,9 +258,46 @@ var constructor = function () {
attributes: selectPlacementsAttributes,
});

// Log custom event for selectPlacements call
logSelectPlacementsEvent(initialAttributes, selectPlacementsAttributes);

return self.launcher.selectPlacements(selectPlacementsOptions);
}

/**
* Logs a custom event when selectPlacements is called
* This enables visibility and troubleshooting
* @param {Object} initialAttributes - The attributes passed by the developer
* @param {Object} selectPlacementsAttributes - The final merged attributes sent to Rokt
*/
function logSelectPlacementsEvent(
initialAttributes,
selectPlacementsAttributes
) {
if (
!window.mParticle ||
typeof window.mParticle.logEvent !== 'function'
) {
return;
}

var EVENT_TYPE_OTHER = window.mParticle.EventType.Other;

// Build event attributes with both passed and final attributes as JSON strings
// initialAttributes: attributes passed by the developer
// finalAttributes: final attributes sent to selectPlacements
var eventAttributes = {
initialAttributes: stringifyIfObject(initialAttributes),
finalAttributes: stringifyIfObject(selectPlacementsAttributes),
};

window.mParticle.logEvent(
EVENT_NAME_SELECT_PLACEMENTS,
EVENT_TYPE_OTHER,
eventAttributes
);
}

/**
* Enables optional Integration Launcher extensions before selecting placements
* @param {string} extensionName - Name of the extension to enable
Expand Down Expand Up @@ -580,6 +620,10 @@ function isEmpty(value) {
return value == null || !(Object.keys(value) || value).length;
}

function stringifyIfObject(value) {
return isObject(value) ? JSON.stringify(value) : '{}';
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JSON.stringify can throw an error if the object contains circular references or other non-serializable values. Consider wrapping this in a try-catch block to handle such cases gracefully, or document that the caller should ensure attributes are JSON-serializable.

Suggested change
return isObject(value) ? JSON.stringify(value) : '{}';
if (!isObject(value)) {
return '{}';
}
try {
return JSON.stringify(value);
} catch (e) {
return '{}';
}

Copilot uses AI. Check for mistakes.
}

if (window && window.mParticle && window.mParticle.addForwarder) {
window.mParticle.addForwarder({
name: name,
Expand Down
144 changes: 144 additions & 0 deletions test/src/tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,15 @@ describe('Rokt Forwarder', () => {
mParticle.generateHash = function (input) {
return 'hashed-<' + input + '>-value';
};
// Mock for logEvent to capture custom event logging
mParticle.loggedEvents = [];
mParticle.logEvent = function (eventName, eventType, eventAttributes) {
mParticle.loggedEvents.push({
eventName: eventName,
eventType: eventType,
eventAttributes: eventAttributes,
});
};
// -------------------START EDITING BELOW:-----------------------
var MockRoktForwarder = function () {
var self = this;
Expand Down Expand Up @@ -734,6 +743,7 @@ describe('Rokt Forwarder', () => {
window.mParticle.Rokt.attachKitCalled = true;
return Promise.resolve();
};
mParticle.loggedEvents = [];
window.mParticle.Rokt.setLocalSessionAttribute = function (
key,
value
Expand Down Expand Up @@ -2495,6 +2505,140 @@ describe('Rokt Forwarder', () => {
);
});
});

describe('#logSelectPlacementsEvent', () => {
it('should log a custom event with initialAttributes and finalAttributes', async () => {
await window.mParticle.forwarder.init(
{
accountId: '123456',
},
reportService.cb,
true,
null,
{
'cached-user-attr': 'cached-value',
}
);

await window.mParticle.forwarder.selectPlacements({
identifier: 'test-placement',
attributes: {
'new-attr': 'new-value',
},
initialAttributes: {
'original-attr': 'original-value',
},
});

mParticle.loggedEvents.length.should.equal(1);
mParticle.loggedEvents[0].eventName.should.equal(
'selectplacements'
);
mParticle.loggedEvents[0].eventType.should.equal(8); // EventType.Other

const eventAttributes =
mParticle.loggedEvents[0].eventAttributes;
eventAttributes.should.have.property('initialAttributes');
eventAttributes.should.have.property('finalAttributes');

// initialAttributes should contain original attributes from developer
const initialAttrs = JSON.parse(
eventAttributes.initialAttributes
);
initialAttrs.should.deepEqual({
'original-attr': 'original-value',
});
});

it('should include finalAttributes with merged user attributes, identities, and mpid', async () => {
await window.mParticle.forwarder.init(
{
accountId: '123456',
},
reportService.cb,
true,
null,
{
'cached-user-attr': 'cached-value',
}
);

await window.mParticle.forwarder.selectPlacements({
identifier: 'test-placement',
attributes: {
'new-attr': 'new-value',
},
initialAttributes: {
'new-attr': 'new-value',
},
});

const eventAttributes =
mParticle.loggedEvents[0].eventAttributes;
const finalAttrs = JSON.parse(eventAttributes.finalAttributes);

// finalAttributes should include merged attributes and mpid
finalAttrs.should.have.property('mpid', '123');
finalAttrs.should.have.property('new-attr', 'new-value');
finalAttrs.should.have.property(
'cached-user-attr',
'cached-value'
);
});

it('should handle empty initialAttributes', async () => {
await window.mParticle.forwarder.init(
{
accountId: '123456',
},
reportService.cb,
true,
null,
{}
);

await window.mParticle.forwarder.selectPlacements({
identifier: 'test-placement',
attributes: {
attr: 'value',
},
});

mParticle.loggedEvents.length.should.equal(1);
const eventAttributes =
mParticle.loggedEvents[0].eventAttributes;
const initialAttrs = JSON.parse(
eventAttributes.initialAttributes
);
initialAttrs.should.deepEqual({});
});

it('should skip logging when mParticle.logEvent is not available', async () => {
var originalLogEvent = window.mParticle.logEvent;
window.mParticle.logEvent = undefined;

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

await window.mParticle.forwarder.selectPlacements({
identifier: 'test-placement',
attributes: {
attr: 'value',
},
});

window.Rokt.selectPlacementsCalled.should.equal(true);
mParticle.loggedEvents.length.should.equal(0);
window.mParticle.logEvent = originalLogEvent;
});
});
});

describe('#use', () => {
Expand Down
Loading