Skip to content

feat: Add placement event mapping for event attributes #57

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
prestonstarkey wants to merge 8 commits into
base: development
Choose a base branch
from
Open

feat: Add placement event mapping for event attributes #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
31b8be7
LE - add placement event mapping rules on attributes
prestonstarkey Jan 26, 2026
d4877d7
LE - update to use AttributeSelector
prestonstarkey Feb 3, 2026
34a6d44
LE - update unit tests
prestonstarkey Feb 4, 2026
66792ad
LE - update names
prestonstarkey Feb 4, 2026
114f325
LE - add unit test for missing conditions
prestonstarkey Feb 6, 2026
1a360e7
LE - update condition checks to use isString utility
prestonstarkey Feb 9, 2026
6a0d4e3
LE - add unit tests
prestonstarkey Feb 10, 2026
e7c4ee7
LE - remove comment and fix lint
prestonstarkey Feb 10, 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
160 changes: 157 additions & 3 deletions src/Rokt-Kit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,138 @@ var constructor = function () {
self.userAttributes = {};
self.testHelpers = null;
self.placementEventMappingLookup = {};
self.placementEventAttributeMappingLookup = {};
self.eventQueue = [];

function getEventAttributeValue(event, eventAttributeKey) {
var attributes = event && event.EventAttributes;
if (!attributes) {
return null;
}

if (typeof attributes[eventAttributeKey] === 'undefined') {
return null;
}

return attributes[eventAttributeKey];
}

function doesEventAttributeConditionMatch(condition, actualValue) {
if (!condition || !isString(condition.operator)) {
return false;
}

var operator = condition.operator.toLowerCase();
var expectedValue = condition.attributeValue;

if (operator === 'exists') {
return actualValue !== null;
}

if (actualValue == null) {
return false;
}

if (operator === 'equals') {
return String(actualValue) === String(expectedValue);
}

if (operator === 'contains') {
return String(actualValue).indexOf(String(expectedValue)) !== -1;
}

Comment on lines +71 to +78
Copy link
Collaborator

@alexs-mparticle alexs-mparticle Feb 9, 2026

Choose a reason for hiding this comment

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

I would consider adding some additional test cases to add some potential edge cases. Something like 2 === "2" would likley pass as intended but what if you're testing true === 'True'or even"TRUE" === 'True'"`?

I think you have some guard clauses that should catch this, but also make sure something like "0" === "false" or "0" === "" is covered in tests.

return false;
}

function doesEventMatchRule(event, rule) {
if (!rule || !isString(rule.eventAttributeKey)) {
return false;
}

var conditions = rule.conditions;
if (!Array.isArray(conditions)) {
return false;
}

var actualValue = getEventAttributeValue(event, rule.eventAttributeKey);

if (conditions.length === 0) {
return actualValue !== null;
}
for (var i = 0; i < conditions.length; i++) {
if (!doesEventAttributeConditionMatch(conditions[i], actualValue)) {
return false;
}
}

return true;
}

function generateMappedEventAttributeLookup(
placementEventAttributeMapping
) {
var mappedAttributeKeys = {};
if (!Array.isArray(placementEventAttributeMapping)) {
return mappedAttributeKeys;
}
for (var i = 0; i < placementEventAttributeMapping.length; i++) {
var mapping = placementEventAttributeMapping[i];
if (
!mapping ||
!isString(mapping.value) ||
!isString(mapping.map)
) {
continue;
}

var mappedAttributeKey = mapping.value;
var eventAttributeKey = mapping.map;

if (!mappedAttributeKeys[mappedAttributeKey]) {
mappedAttributeKeys[mappedAttributeKey] = [];
}

mappedAttributeKeys[mappedAttributeKey].push({
eventAttributeKey: eventAttributeKey,
conditions: Array.isArray(mapping.conditions)
? mapping.conditions
: [],
});
}
return mappedAttributeKeys;
}

function applyPlacementEventAttributeMapping(event) {
var mappedAttributeKeys = Object.keys(
self.placementEventAttributeMappingLookup
);
for (var i = 0; i < mappedAttributeKeys.length; i++) {
var mappedAttributeKey = mappedAttributeKeys[i];
var rulesForMappedAttributeKey =
self.placementEventAttributeMappingLookup[mappedAttributeKey];
if (isEmpty(rulesForMappedAttributeKey)) {
continue;
}

// Require ALL rules for the same key to match (AND).
var allMatch = true;
for (var j = 0; j < rulesForMappedAttributeKey.length; j++) {
if (!doesEventMatchRule(event, rulesForMappedAttributeKey[j])) {
allMatch = false;
break;
}
}
if (!allMatch) {
continue;
}

window.mParticle.Rokt.setLocalSessionAttribute(
mappedAttributeKey,
true
);
}
}

/**
* Generates the Rokt launcher script URL with optional domain override and extensions
* @param {string} domain - The CNAME domain to use for overriding the launcher url
Expand Down Expand Up @@ -92,6 +222,12 @@ var constructor = function () {
placementEventMapping
);

var placementEventAttributeMapping = parseSettingsString(
settings.placementEventAttributeMapping
);
self.placementEventAttributeMappingLookup =
generateMappedEventAttributeLookup(placementEventAttributeMapping);

// Set dynamic OTHER_IDENTITY based on server settings
// Convert to lowercase since server sends TitleCase (e.g., 'Other' -> 'other')
if (settings.hashedEmailUserIdentityType) {
Expand All @@ -115,6 +251,8 @@ var constructor = function () {
hashEventMessage: hashEventMessage,
parseSettingsString: parseSettingsString,
generateMappedEventLookup: generateMappedEventLookup,
generateMappedEventAttributeLookup:
generateMappedEventAttributeLookup,
};
attachLauncher(accountId, launcherOptions);
return;
Expand Down Expand Up @@ -172,13 +310,18 @@ var constructor = function () {

function returnLocalSessionAttributes() {
if (
isEmpty(self.placementEventMappingLookup) ||
!window.mParticle.Rokt ||
typeof window.mParticle.Rokt.getLocalSessionAttributes !==
'function'
) {
return {};
}
if (
isEmpty(self.placementEventMappingLookup) &&
isEmpty(self.placementEventAttributeMappingLookup)
) {
return {};
}
return window.mParticle.Rokt.getLocalSessionAttributes();
}

Expand Down Expand Up @@ -268,7 +411,7 @@ var constructor = function () {
console.error('Rokt Kit: Not initialized');
return Promise.reject(new Error('Rokt Kit: Not initialized'));
}
if (!extensionName || typeof extensionName !== 'string') {
if (!extensionName || !isString(extensionName)) {
return Promise.reject(
new Error('Rokt Kit: Invalid extension name')
);
Expand Down Expand Up @@ -306,12 +449,19 @@ var constructor = function () {
}

if (
isEmpty(self.placementEventMappingLookup) ||
typeof window.mParticle.Rokt.setLocalSessionAttribute !== 'function'
) {
return;
}

if (!isEmpty(self.placementEventAttributeMappingLookup)) {
applyPlacementEventAttributeMapping(event);
}

if (isEmpty(self.placementEventMappingLookup)) {
return;
}

var hashedEvent = hashEventMessage(
event.EventDataType,
event.EventCategory,
Expand Down Expand Up @@ -580,6 +730,10 @@ function isEmpty(value) {
return value == null || !(Object.keys(value) || value).length;
}

function isString(value) {
return typeof value === 'string';
}

if (window && window.mParticle && window.mParticle.addForwarder) {
window.mParticle.addForwarder({
name: name,
Expand Down
Loading