Skip to content

feat: auto-preload selectPlacements for configured accounts #85

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
mattbodle wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: auto-preload selectPlacements for configured accounts #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 43 additions & 0 deletions src/Rokt-Kit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@ var name = 'Rokt';
var moduleId = 181;
var EVENT_NAME_SELECT_PLACEMENTS = 'selectPlacements';

var PRELOAD_CONFIGS = {
'2550745407543340151': {
requiredAttributes: ['email', 'firstname', 'cartitems'],
identifier: 'RoktExperience',
},
};

var constructor = function () {
var self = this;
var PerformanceMarks = {
Expand All @@ -40,6 +47,8 @@ var constructor = function () {
self.placementEventAttributeMappingLookup = {};
self.eventQueue = [];
self.integrationName = null;
self.accountId = null;
self.hasPreloaded = false;

function getEventAttributeValue(event, eventAttributeKey) {
var attributes = event && event.EventAttributes;
Expand Down Expand Up @@ -221,6 +230,7 @@ var constructor = function () {
filteredUserAttributes
) {
var accountId = settings.accountId;
self.accountId = accountId;
var roktExtensions = extractRoktExtensions(settings.roktExtensions);
self.userAttributes = filteredUserAttributes || {};
self.onboardingExpProvider = settings.onboardingExpProvider;
Expand Down Expand Up @@ -517,6 +527,8 @@ var constructor = function () {
var mappedValue = self.placementEventMappingLookup[hashedEvent];
window.mParticle.Rokt.setLocalSessionAttribute(mappedValue, true);
}

tryPreloadIfReady();
}

function _sendEventStream(event) {
Expand All @@ -528,10 +540,12 @@ var constructor = function () {
function onUserIdentified(filteredUser) {
self.filters.filteredUser = filteredUser;
self.userAttributes = filteredUser.getAllUserAttributes();
tryPreloadIfReady();
}

function setUserAttribute(key, value) {
self.userAttributes[key] = value;
tryPreloadIfReady();
}

function removeUserAttribute(key) {
Expand Down Expand Up @@ -583,6 +597,7 @@ var constructor = function () {
// Attaches the kit to the Rokt manager
window.mParticle.Rokt.attachKit(self);
processEventQueue();
tryPreloadIfReady();
}

// mParticle Kit Callback Methods
Expand Down Expand Up @@ -651,6 +666,34 @@ var constructor = function () {
return !!(self.isInitialized && self.launcher);
}

function tryPreloadIfReady() {
if (!isKitReady() || self.hasPreloaded) {
return;
}
var config = PRELOAD_CONFIGS[self.accountId];
if (!config) {
return;
}
var mergedAttributes = mergeObjects(
returnUserIdentities(self.filters && self.filters.filteredUser),
self.userAttributes,
returnLocalSessionAttributes()
);
for (var i = 0; i < config.requiredAttributes.length; i++) {
if (mergedAttributes[config.requiredAttributes[i]] == null) {
return;
}
}
self.hasPreloaded = true;
selectPlacements({
identifier: config.identifier,
omitUrl: true,
preload: true,
}).catch(function (err) {
console.error('Rokt Kit: preload failed', err);
});
}

function isPartnerInLocalLauncherTestGroup() {
return (
window.mParticle.config &&
Expand Down
118 changes: 118 additions & 0 deletions test/src/tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2895,6 +2895,124 @@ describe('Rokt Forwarder', () => {
});
});

describe('#tryPreloadIfReady', () => {
var ULTA_ACCOUNT_ID = '2550745407543340151';
var preloadCallOptions;
var preloadCallCount;

beforeEach(() => {
preloadCallOptions = null;
preloadCallCount = 0;

window.mParticle.Rokt.setLocalSessionAttribute = function (
key,
value
) {
mParticle._Store.localSessionAttributes[key] = value;
};
window.mParticle.Rokt.getLocalSessionAttributes = function () {
return mParticle._Store.localSessionAttributes || {};
};
mParticle._Store.localSessionAttributes = {};

window.mParticle.forwarder.isInitialized = true;
window.mParticle.forwarder.accountId = ULTA_ACCOUNT_ID;
window.mParticle.forwarder.hasPreloaded = false;
window.mParticle.forwarder.launcher = {
selectPlacements: function (options) {
preloadCallCount++;
preloadCallOptions = options;
return Promise.resolve();
},
};
window.mParticle.forwarder.filters = {
filterUserAttributes: function (attributes) {
return attributes;
},
filteredUser: {
getMPID: function () {
return '123';
},
getUserIdentities: function () {
return { userIdentities: {} };
},
},
};
});

it('should not preload for an unknown account id', () => {
window.mParticle.forwarder.accountId = '999999';
window.mParticle.forwarder.userAttributes = {
email: 'test@example.com',
firstname: 'Jane',
cartitems: '2',
};

window.mParticle.forwarder.setUserAttribute('email', 'test@example.com');

preloadCallCount.should.equal(0);
});

it('should not preload when only some required attributes are present', () => {
window.mParticle.forwarder.setUserAttribute('email', 'test@example.com');
window.mParticle.forwarder.setUserAttribute('firstname', 'Jane');

preloadCallCount.should.equal(0);
});

it('should preload when all required attributes are set via setUserAttribute', async () => {
window.mParticle.forwarder.setUserAttribute('email', 'test@example.com');
window.mParticle.forwarder.setUserAttribute('firstname', 'Jane');
window.mParticle.forwarder.setUserAttribute('cartitems', '3');

preloadCallCount.should.equal(1);
preloadCallOptions.identifier.should.equal('RoktExperience');
preloadCallOptions.omitUrl.should.equal(true);
preloadCallOptions.preload.should.equal(true);
});

it('should preload when all required attributes are provided via onUserIdentified', () => {
window.mParticle.forwarder.onUserIdentified({
getAllUserAttributes: function () {
return {
email: 'test@example.com',
firstname: 'Jane',
cartitems: '3',
};
},
getMPID: function () {
return '123';
},
getUserIdentities: function () {
return { userIdentities: {} };
},
});

preloadCallCount.should.equal(1);
preloadCallOptions.identifier.should.equal('RoktExperience');
preloadCallOptions.omitUrl.should.equal(true);
preloadCallOptions.preload.should.equal(true);
});

it('should only preload once per session even when attributes are updated again', () => {
window.mParticle.forwarder.setUserAttribute('email', 'test@example.com');
window.mParticle.forwarder.setUserAttribute('firstname', 'Jane');
window.mParticle.forwarder.setUserAttribute('cartitems', '3');
window.mParticle.forwarder.setUserAttribute('cartitems', '5');

preloadCallCount.should.equal(1);
});

it('should not preload if the kit is not initialized', () => {
window.mParticle.forwarder.isInitialized = false;
window.mParticle.forwarder.setUserAttribute('email', 'test@example.com');
window.mParticle.forwarder.setUserAttribute('firstname', 'Jane');
window.mParticle.forwarder.setUserAttribute('cartitems', '3');

preloadCallCount.should.equal(0);
});
});

describe('#fetchOptimizely', () => {
// Helper functions for setting up Optimizely mocks
function setupValidOptimizelyMock(experiments) {
Expand Down