-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathOptimizely.js
792 lines (709 loc) · 25.5 KB
/
Optimizely.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
var mpOptimizelyKit = (function (exports) {
'use strict';
function Common() {}
var common = Common;
var optimizelyDefinedEvents = {
pages: {},
events: {}
};
function CommerceHandler(common) {
this.common = common || {};
}
CommerceHandler.prototype.logCommerceEvent = function(event) {
var expandedEcommerceEvents = mParticle.eCommerce.expandCommerceEvent(
event
);
expandedEcommerceEvents.forEach(function(expandedEvent) {
var optimizelyEvent = {
type: 'event',
eventName: event.EventName,
tags: {}
};
optimizelyEvent.tags = expandedEvent.EventAttributes || {};
if (
event.EventCategory ===
mParticle.CommerceEventType.ProductPurchase ||
event.EventCategory === mParticle.CommerceEventType.ProductRefund
) {
if (expandedEvent.EventName.indexOf('Total') > -1) {
if (
event.CustomFlags &&
event.CustomFlags['Optimizely.EventName']
) {
optimizelyEvent.eventName =
event.CustomFlags['Optimizely.EventName'];
} else {
optimizelyEvent.eventName = expandedEvent.EventName;
}
// Overall purchase event
if (
expandedEvent.EventAttributes &&
expandedEvent.EventAttributes['Total Amount']
) {
optimizelyEvent.tags.revenue =
expandedEvent.EventAttributes['Total Amount'] * 100;
}
// other individual product events should not have revenue tags
// which are added via the expandCommerceEvent method above
} else {
optimizelyEvent.eventName = expandedEvent.EventName;
if (optimizelyEvent.tags.revenue) {
delete optimizelyEvent.tags.revenue;
}
if (optimizelyEvent.tags.Revenue) {
delete optimizelyEvent.tags.Revenue;
}
}
} else {
optimizelyEvent.eventName = expandedEvent.EventName;
if (
event.CustomFlags &&
event.CustomFlags['Optimizely.EventName']
) {
optimizelyEvent.eventName =
event.CustomFlags['Optimizely.EventName'];
}
}
// Events that are added to the OptimizelyUI will be available on optimizelyEvents.events
// Ignore events not included in the Optimizely UI
if (optimizelyDefinedEvents.events[optimizelyEvent.eventName]) {
var eventCopy = {};
for (var key in optimizelyEvent) {
eventCopy[key] = optimizelyEvent[key];
}
window['optimizely'].push(eventCopy);
}
});
};
var commerceHandler = CommerceHandler;
function EventHandler(common) {
this.common = common || {};
}
EventHandler.prototype.logEvent = function(event) {
if (optimizelyDefinedEvents.events[event.EventName]) {
var optimizelyEvent = {
type: 'event',
eventName: event.EventName
};
if (event.EventAttributes) {
optimizelyEvent.tags = event.EventAttributes;
}
if (event.CustomFlags && event.CustomFlags['Optimizely.Value']) {
optimizelyEvent.tags.value = event.CustomFlags['Optimizely.Value'];
}
window['optimizely'].push(optimizelyEvent);
}
};
EventHandler.prototype.logPageView = function(event) {
if (optimizelyDefinedEvents.pages[event.EventName]) {
var optimizelyEvent = {
type: 'page',
pageName: event.EventName
};
if (event.EventAttributes) {
optimizelyEvent.tags = event.EventAttributes;
}
window['optimizely'].push(optimizelyEvent);
}
};
var eventHandler = EventHandler;
/*
The 'mParticleUser' is an object with methods get user Identities and set/get user attributes
Partners can determine what userIds are available to use in their SDK
Call mParticleUser.getUserIdentities() to return an object of userIdentities --> { userIdentities: {customerid: '1234', email: '[email protected]'} }
For more identity types, see http://docs.mparticle.com/developers/sdk/javascript/identity#allowed-identity-types
Call mParticleUser.getMPID() to get mParticle ID
For any additional methods, see http://docs.mparticle.com/developers/sdk/javascript/apidocs/classes/mParticle.Identity.getCurrentUser().html
*/
/*
identityApiRequest has the schema:
{
userIdentities: {
customerid: '123',
email: 'abc'
}
}
For more userIdentity types, see http://docs.mparticle.com/developers/sdk/javascript/identity#allowed-identity-types
*/
function IdentityHandler(common) {
this.common = common || {};
}
IdentityHandler.prototype.onIdentifyComplete = function(
mParticleUser,
identityApiRequest
) {};
IdentityHandler.prototype.onLoginComplete = function(
mParticleUser,
identityApiRequest
) {};
IdentityHandler.prototype.onLogoutComplete = function(
mParticleUser,
identityApiRequest
) {};
IdentityHandler.prototype.onModifyComplete = function(
mParticleUser,
identityApiRequest
) {};
IdentityHandler.prototype.onUserIdentified = function(
mParticleUser,
identityApiRequest
) {};
/* In previous versions of the mParticle web SDK, setting user identities on
kits is only reachable via the onSetUserIdentity method below. We recommend
filling out `onSetUserIdentity` for maximum compatibility
*/
IdentityHandler.prototype.onSetUserIdentity = function(
forwarderSettings,
id,
type
) {};
var identityHandler = IdentityHandler;
var initialization = {
name: 'Optimizely',
moduleId: 54,
initForwarder: function(settings, testMode, userAttributes, userIdentities, processEvent, eventQueue, isInitialized) {
if (!testMode) {
if (!window.optimizely) {
var optimizelyScript = document.createElement('script');
optimizelyScript.type = 'text/javascript';
optimizelyScript.async = true;
optimizelyScript.src = 'https://cdn.optimizely.com/js/' + settings.projectId + '.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(optimizelyScript);
optimizelyScript.onload = function() {
loadEventsAndPages();
if (window['optimizely'] && eventQueue.length > 0) {
for (var i = 0; i < eventQueue.length; i++) {
processEvent(eventQueue[i]);
}
eventQueue = [];
}
};
} else {
loadEventsAndPages();
}
} else {
loadEventsAndPages();
}
}
};
function loadEventsAndPages() {
var data,
events = {},
pages = {};
if (window.optimizely) {
data = window.optimizely.get('data');
for (var event in data.events) {
events[data.events[event].apiName] = 1;
}
for (var page in data.pages) {
pages[data.pages[page].apiName] = 1;
}
optimizelyDefinedEvents.events = events;
optimizelyDefinedEvents.pages = pages;
}
}
var initialization_1 = initialization;
var sessionHandler = {
onSessionStart: function(event) {
},
onSessionEnd: function(event) {
}
};
var sessionHandler_1 = sessionHandler;
function UserAttributeHandler(common) {
this.common = common = {};
}
UserAttributeHandler.prototype.onRemoveUserAttribute = function(key) {
var attribute = {};
attribute[key] = null;
window['optimizely'].push({
type: 'user',
attributes: attribute
});
};
UserAttributeHandler.prototype.onSetUserAttribute = function(key, value) {
var attribute = {};
attribute[key] = value;
window['optimizely'].push({
type: 'user',
attributes: attribute
});
};
var userAttributeHandler = UserAttributeHandler;
// =============== REACH OUT TO MPARTICLE IF YOU HAVE ANY QUESTIONS ===============
//
// Copyright 2018 mParticle, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
var name = initialization_1.name,
moduleId = initialization_1.moduleId,
MessageType = {
SessionStart: 1,
SessionEnd: 2,
PageView: 3,
PageEvent: 4,
CrashReport: 5,
OptOut: 6,
Commerce: 16,
Media: 20,
};
var constructor = function() {
var self = this,
isInitialized = false,
forwarderSettings,
reportingService,
eventQueue = [];
self.name = initialization_1.name;
self.moduleId = initialization_1.moduleId;
self.common = new common();
function initForwarder(
settings,
service,
testMode,
trackerId,
userAttributes,
userIdentities,
appVersion,
appName,
customFlags,
clientId
) {
forwarderSettings = settings;
if (window.mParticle.isTestEnvironment) {
reportingService = function() {};
} else {
reportingService = service;
}
try {
initialization_1.initForwarder(
settings,
testMode,
userAttributes,
userIdentities,
processEvent,
eventQueue,
isInitialized,
self.common,
appVersion,
appName,
customFlags,
clientId
);
self.eventHandler = new eventHandler(self.common);
self.identityHandler = new identityHandler(self.common);
self.userAttributeHandler = new userAttributeHandler(self.common);
self.commerceHandler = new commerceHandler(self.common);
isInitialized = true;
} catch (e) {
console.log('Failed to initialize ' + name + ' - ' + e);
}
}
function processEvent(event) {
var reportEvent = false;
if (isInitialized) {
try {
if (event.EventDataType === MessageType.SessionStart) {
reportEvent = logSessionStart(event);
} else if (event.EventDataType === MessageType.SessionEnd) {
reportEvent = logSessionEnd(event);
} else if (event.EventDataType === MessageType.CrashReport) {
reportEvent = logError(event);
} else if (event.EventDataType === MessageType.PageView) {
reportEvent = logPageView(event);
} else if (event.EventDataType === MessageType.Commerce) {
reportEvent = logEcommerceEvent(event);
} else if (event.EventDataType === MessageType.PageEvent) {
reportEvent = logEvent(event);
} else if (event.EventDataType === MessageType.Media) {
// Kits should just treat Media Events as generic Events
reportEvent = logEvent(event);
}
if (reportEvent === true && reportingService) {
reportingService(self, event);
return 'Successfully sent to ' + name;
} else {
return (
'Error logging event or event type not supported on forwarder ' +
name
);
}
} catch (e) {
return 'Failed to send to ' + name + ' ' + e;
}
} else {
eventQueue.push(event);
return (
"Can't send to forwarder " +
name +
', not initialized. Event added to queue.'
);
}
}
function logSessionStart(event) {
try {
sessionHandler_1.onSessionStart(event);
return true;
} catch (e) {
return {
error: 'Error starting session on forwarder ' + name + '; ' + e,
};
}
}
function logSessionEnd(event) {
try {
sessionHandler_1.onSessionEnd(event);
return true;
} catch (e) {
return {
error: 'Error ending session on forwarder ' + name + '; ' + e,
};
}
}
function logError(event) {
try {
self.eventHandler.logError(event);
return true;
} catch (e) {
return {
error: 'Error logging error on forwarder ' + name + '; ' + e,
};
}
}
function logPageView(event) {
try {
self.eventHandler.logPageView(event);
return true;
} catch (e) {
return {
error:
'Error logging page view on forwarder ' + name + '; ' + e,
};
}
}
function logEvent(event) {
try {
self.eventHandler.logEvent(event);
return true;
} catch (e) {
return {
error: 'Error logging event on forwarder ' + name + '; ' + e,
};
}
}
function logEcommerceEvent(event) {
try {
self.commerceHandler.logCommerceEvent(event);
return true;
} catch (e) {
return {
error:
'Error logging purchase event on forwarder ' +
name +
'; ' +
e,
};
}
}
function setUserAttribute(key, value) {
if (isInitialized) {
try {
self.userAttributeHandler.onSetUserAttribute(
key,
value,
forwarderSettings
);
return 'Successfully set user attribute on forwarder ' + name;
} catch (e) {
return (
'Error setting user attribute on forwarder ' +
name +
'; ' +
e
);
}
} else {
return (
"Can't set user attribute on forwarder " +
name +
', not initialized'
);
}
}
function removeUserAttribute(key) {
if (isInitialized) {
try {
self.userAttributeHandler.onRemoveUserAttribute(
key,
forwarderSettings
);
return (
'Successfully removed user attribute on forwarder ' + name
);
} catch (e) {
return (
'Error removing user attribute on forwarder ' +
name +
'; ' +
e
);
}
} else {
return (
"Can't remove user attribute on forwarder " +
name +
', not initialized'
);
}
}
function setUserIdentity(id, type) {
if (isInitialized) {
try {
self.identityHandler.onSetUserIdentity(
forwarderSettings,
id,
type
);
return 'Successfully set user Identity on forwarder ' + name;
} catch (e) {
return (
'Error removing user attribute on forwarder ' +
name +
'; ' +
e
);
}
} else {
return (
"Can't call setUserIdentity on forwarder " +
name +
', not initialized'
);
}
}
function onUserIdentified(user) {
if (isInitialized) {
try {
self.identityHandler.onUserIdentified(user);
return (
'Successfully called onUserIdentified on forwarder ' + name
);
} catch (e) {
return {
error:
'Error calling onUserIdentified on forwarder ' +
name +
'; ' +
e,
};
}
} else {
return (
"Can't set new user identities on forwader " +
name +
', not initialized'
);
}
}
function onIdentifyComplete(user, filteredIdentityRequest) {
if (isInitialized) {
try {
self.identityHandler.onIdentifyComplete(
user,
filteredIdentityRequest
);
return (
'Successfully called onIdentifyComplete on forwarder ' +
name
);
} catch (e) {
return {
error:
'Error calling onIdentifyComplete on forwarder ' +
name +
'; ' +
e,
};
}
} else {
return (
"Can't call onIdentifyCompleted on forwader " +
name +
', not initialized'
);
}
}
function onLoginComplete(user, filteredIdentityRequest) {
if (isInitialized) {
try {
self.identityHandler.onLoginComplete(
user,
filteredIdentityRequest
);
return (
'Successfully called onLoginComplete on forwarder ' + name
);
} catch (e) {
return {
error:
'Error calling onLoginComplete on forwarder ' +
name +
'; ' +
e,
};
}
} else {
return (
"Can't call onLoginComplete on forwader " +
name +
', not initialized'
);
}
}
function onLogoutComplete(user, filteredIdentityRequest) {
if (isInitialized) {
try {
self.identityHandler.onLogoutComplete(
user,
filteredIdentityRequest
);
return (
'Successfully called onLogoutComplete on forwarder ' + name
);
} catch (e) {
return {
error:
'Error calling onLogoutComplete on forwarder ' +
name +
'; ' +
e,
};
}
} else {
return (
"Can't call onLogoutComplete on forwader " +
name +
', not initialized'
);
}
}
function onModifyComplete(user, filteredIdentityRequest) {
if (isInitialized) {
try {
self.identityHandler.onModifyComplete(
user,
filteredIdentityRequest
);
return (
'Successfully called onModifyComplete on forwarder ' + name
);
} catch (e) {
return {
error:
'Error calling onModifyComplete on forwarder ' +
name +
'; ' +
e,
};
}
} else {
return (
"Can't call onModifyComplete on forwader " +
name +
', not initialized'
);
}
}
function setOptOut(isOptingOutBoolean) {
if (isInitialized) {
try {
self.initialization.setOptOut(isOptingOutBoolean);
return 'Successfully called setOptOut on forwarder ' + name;
} catch (e) {
return {
error:
'Error calling setOptOut on forwarder ' +
name +
'; ' +
e,
};
}
} else {
return (
"Can't call setOptOut on forwader " +
name +
', not initialized'
);
}
}
this.init = initForwarder;
this.process = processEvent;
this.setUserAttribute = setUserAttribute;
this.removeUserAttribute = removeUserAttribute;
this.onUserIdentified = onUserIdentified;
this.setUserIdentity = setUserIdentity;
this.onIdentifyComplete = onIdentifyComplete;
this.onLoginComplete = onLoginComplete;
this.onLogoutComplete = onLogoutComplete;
this.onModifyComplete = onModifyComplete;
this.setOptOut = setOptOut;
};
function getId() {
return moduleId;
}
function isObject(val) {
return (
val != null && typeof val === 'object' && Array.isArray(val) === false
);
}
function register(config) {
if (!config) {
window.console.log(
'You must pass a config object to register the kit ' + name
);
return;
}
if (!isObject(config)) {
window.console.log(
"'config' must be an object. You passed in a " + typeof config
);
return;
}
if (isObject(config.kits)) {
config.kits[name] = {
constructor: constructor,
};
} else {
config.kits = {};
config.kits[name] = {
constructor: constructor,
};
}
window.console.log(
'Successfully registered ' + name + ' to your mParticle configuration'
);
}
if (window && window.mParticle && window.mParticle.addForwarder) {
window.mParticle.addForwarder({
name: name,
constructor: constructor,
getId: getId,
});
}
var webKitWrapper = {
register: register,
};
var webKitWrapper_1 = webKitWrapper.register;
exports.default = webKitWrapper;
exports.register = webKitWrapper_1;
return exports;
}({}));