-
Notifications
You must be signed in to change notification settings - Fork 0
/
snsTrigger.js
891 lines (797 loc) · 38.1 KB
/
snsTrigger.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
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
const AWS = require('aws-sdk');
const URL = require('url');
const QUERYSTRING = require('querystring');
const SNStopicARN = 'arn:aws:sns:us-east-2:572049174311:lighthouse-lambda-test-request';
const authKey = 'Lfh81eOs38'
AWS.config.region = 'us-east-2';
exports.handler = function(event, context, callback) {
const sns = new AWS.SNS();
switch (event.httpMethod) {
case 'POST':
let params = QUERYSTRING.parse(event.body);
let messageObj = {};
let urlObj = validateAndParseURL(params);
messageObj.timestamp = Math.floor(Date.now()/1000);
messageObj.url = urlObj.href.split('?')[0];
messageObj.featureSwitch = urlObj.href.split('?')[1] || '';
if (params.featureSwitch) {
messageObj.featureSwitch += (messageObj.featureSwitch.length > 0) ? '&' + params.featureSwitch : params.featureSwitch;
}
if (params.customTest && params.customTest === 'true'){
messageObj.customTest = true;
}
publishSNSmessage(messageObj, SNStopicARN);
break;
case 'GET':
// -- "prototype only" redirect logic section which differs from production
if(event.queryStringParameters && event.queryStringParameters.noredirect === 'true'){
const apiURL = 'https://' + event.headers.Host + event.requestContext.path;
getCustomTestPage(apiURL);
} else {
callback(null, {
statusCode: '301',
headers: {
location: 'https://sxiiyc6p0i.execute-api.us-east-1.amazonaws.com/publish-to-sns?auth=Lfh81eOs38'
},
});
}
// -- end redirect logic section
if(event.queryStringParameters && event.queryStringParameters.auth === authKey){
const apiURL = 'https://' + event.headers.Host + event.requestContext.path;
getCustomTestPage(apiURL);
} else {
callback(null, {
statusCode: '401',
body: 'Invalid request. Please provide a valid "auth" value via query string',
headers: {
'Content-Type': 'text/plain'
},
});
}
break;
default:
callback('unhandled httpMethod...weird', null);
}
/**
* Uses lighthouse() to collect performance data on the provided url and then store it to dynamoDB
* @param {object} messageObject - Object containing the various.
* @param {string} timestamp - a UNIX Epoch timestamp used generate a quasi-unique ID value & provide rudimentary datetime sorting
*/
function publishSNSmessage(messageObject, ARN) {
sns.publish({
Message: JSON.stringify(messageObject),
TopicArn: ARN
}, function (err, data) {
if (err) {
console.log(err.stack);
callback(null, {
statusCode: '520',
body: 'error occurred',
headers: {
'Content-Type': 'text/plain'
},
});
}
console.log('push sent');
console.log(JSON.stringify(messageObject));
console.log(data);
callback(null, {
statusCode: '200',
body: JSON.stringify(messageObject),
headers: {
'Content-Type': 'application/json'
}
});
});
}
/**
* Parse and validate the URL provided to the service
* @param {object} paramsObj - a parameters object created from parsing the post body
* @return {object} a parsed url object
*/
function validateAndParseURL(paramsObj) {
let urlObj;
if (!paramsObj.url || paramsObj.url.length === 0) {
respondWithFailure();
} else {
urlObj = URL.parse(paramsObj.url);
if (!urlObj.protocol || !urlObj.host || !urlObj.href ) {
respondWithFailure();
} else {
return urlObj;
}
}
function respondWithFailure(){
callback(null, {
statusCode: '400',
body: 'Invalid request. Please include a valid URL',
headers: {
'Content-Type': 'text/plain'
},
});
}
}
/**
* Returns a UI page for performing custom tests
* @param {string} formURL - a string used to define the endpoint the form interacts with
* @return {string} an html page in string form
*/
function getCustomTestPage (url){
const dynamoDB_documentClient = new AWS.DynamoDB.DocumentClient();
let recentTests = [];
let scanningProperties = {
TableName: 'lighthouse_data',
Limit: 50
};
getTestsAndReturnPage();
function getTestsAndReturnPage (LastEvaluatedKey) {
if (LastEvaluatedKey) {
scanningProperties.ExclusiveStartKey = LastEvaluatedKey;
}
dynamoDB_documentClient.scan(scanningProperties, function(error, data) {
if (error) {
console.log('issue occurred in getRecentCustomTests() > dynamoDB_documentClient.scan()');
} else {
if (data.Items.length) {
recentTests.push.apply(recentTests, data.Items);
}
if (data.LastEvaluatedKey) {
getTestsAndReturnPage(data.LastEvaluatedKey);
} else {
// Go through the tests and delete the excessively verbose & unused 'details' property from each audit
//to limit the possibility of overrunning the AWS's response size limit for lambdas.
for (let i = recentTests.length - 1; i >= 0; i--){
let dataJSON = JSON.parse(recentTests[i].data);
if(dataJSON.audits){
dataJSON.audits.forEach((audit)=>{
if(audit.hasOwnProperty('details')){
delete audit.details;
}
});
recentTests[i].data = dataJSON;
}
}
callback(null, {
statusCode: '200',
body: generatePageHTML(url, recentTests),
headers: {
'Content-Type': 'text/html'
}
});
}
}
});
};
function generatePageHTML(urlString,arrOfRecentTests) {
let pageHTML = `<html>
<head>
<title>Kinja Performance Lighthouse - Custom Test Runner</title>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/materialize/1.0.0-rc.2/css/materialize.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/materialize/1.0.0-rc.2/js/materialize.min.js"></script>
<style type="text/css">
.header {text-align: center;}
.divider {
margin-top: 5rem;
margin-bottom: 4rem;
}
.indent {padding-left:1rem;}
#recentTests > div {text-align: center;}
#recentTests .collection {
margin-top: 2rem;
}
form {
max-width: 60%;
min-width: 480px;
margin-left: auto;
margin-right: auto;
display: flex;
flex-direction: column;
}
input[name="customTest"] {display:none;}
input[type="submit"] {
align-self: flex-end;
}
code {
padding: 2px 4px;
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
font-size: 0.9rem;
color: #567482;
background-color: #f3f6fa;
border-radius: 0.3rem;
}
.collection-item {
overflow-y: scroll;
display: flex;
flex-direction: column;
cursor: pointer;
transition: max-height 800ms ease;
}
.collection-item {max-height: 100px;}
.collection-item.expand {
max-height: 800px;
flex-flow: column;
cursor: default;
}
.collection-item {border-left:1px dotted transparent;}
.collection-item.shared-timestamp {border-left-color:cyan;}
.collection-item.expand .url { font-size: 12px; }
.label {
display: flex;
align-items: center;
}
.test-info { flex-basis: 75px; }
.test-info .type,
.test-info .timestamp {
float: left;
}
.test-info .variant,
.test-info .timestamp {
font-size: 9px;
}
.test-info .variant {text-align: center;}
.test-info .timestamp {
padding-left: 1em;
}
.label .url {
position: relative;
top: 0;
flex: 1;
padding-left: 15px;
box-sizing: content-box;
transition: flex-grow 300ms ease, top 350ms ease;
}
.label .url .tested-feature-switch-string{
color: DarkViolet;
}
.expand .label > .url {
flex-grow: 1;
text-align: center;
top: 15px;
transition: transition: flex-grow 300ms ease, top 100ms ease;
}
.collapse-control {
height: 0;
overflow: hidden;
align-self: center;
font-size: 2em;
cursor: pointer;
}
.expand .collapse-control{
height: auto;
overflow: visible;
}
.full-audit-to-clipboard {
cursor: pointer;
}
.singular-test {
display: none;
text-align: center;
padding: 30px 0;
flex: 1 auto;
flex-wrap: wrap;
}
.singular-test div {
max-width: 30%;
flex: 1 auto;
}
.singular-test .full-audit-to-clipboard {
max-width: 100%;
flex: 3 100%;
padding-top: 30px;
font-weight: 500;
opacity: 0.7;
transition: opacity 300ms linear;
}
.singular-test .full-audit-to-clipboard:hover {
opacity: 1;
}
.singular-test .full-audit-to-clipboard span {
font-size: 2em;
vertical-align: middle;
}
.expand .singular-test {
display: flex;
flex-direction: row;
flex-flow: row wrap;
justify-content: space-between;
}
.comparison-test {
display: none;
margin: 30px 0;
font-size: 12px;
text-align: center;
}
.expand .comparison-test {
display: table;
}
.comparison-test td,
.comparison-test th {
text-align: center;
}
.comparison-test th {
padding-bottom: 5px;
}
.comparison-test td.full-audit-to-clipboard {
font-size: 2em;
vertical-align: middle;
}
.comparison-test td.improved {
color: green;
}
.comparison-test td.declined {
color: red;
}
.comparison-test tbody tr:last-of-type {
border-bottom: none;
}
.row-title {
width: 25%;
font-size:9px;
text-align: left;
}
.collection-item.recent {background-color: #fffbc4;}
.expand.recent {background-color: transparent;}
/* .fixed-action-btn {display: none;} */
.modal {
width: 70%;
height: 80%;
overflow: hidden;
}
.modal-content {
height: 100%;
overflow: scroll;
}
.modal-close {
position: fixed;
top: 0;
right: 0.5em;
padding: 0;
font-size: 2em;
line-height: 1;
}
.modal section+section{
padding-top: 1rem;
}
.exactly ul li {
list-style-type: disc;
list-style-position: inside;
padding-left: 1rem;
}
.example ul,
.example ul li{ padding-left:0.5rem;}
.example .group1 { border-left: solid 2px blue;}
.example .group2 { border-left: solid 2px red;}
.example .group3 { border-left: solid 2px green;}
.group1+.group1,.group2+.group2,.group3+.group3 {
padding-bottom: 0.5rem;
}
.other-questions blockquote {
border-left-width: 0;
margin-top: 0.5rem;
margin-bottom: 2rem;
}
.other-questions > strong {
font-size: 16px;
}
</style>
</head>
<body class="container">
<section class="header">
<h3>Kinja Performance Lighthouse - Custom Test Runner</h3>
<p>This page will let you perform & retrieve data from custom lighthouse tests</p>
</section>
<section class="start-test">
<form id="initTest" action="${urlString}" method="POST">
<div class="required input-field">
<label for="url">URL to Test:</label>
<input type="text" id="url" name="url" required />
<small>required</small>
</div>
<div class="input-field">
<input type="text" id="featureSwitch" name="featureSwitch" />
<label for="featureSwitch">Feature Switch:</label>
</div>
<input type="text" id="customTest" name="customTest" value="true" />
<input type="submit" class="btn" />
</form>
</section>
<div class="divider"></div>
<section id="recentTests">
<div>
<h4> Recently Completed Tests</h4>
<em>Click a row see more information.</em><br />
<em>Tests are kept for 3 days before they expire in the database</em><br />
<em>The most recent tests that were initiated from this browser should be highlighted.</em>
</div>
<ul class="collection">
</ul>
</section>
<div class="fixed-action-btn">
<a class="btn-floating btn-large modal-trigger" href="#moreInfo" data-target="moreInfo">
<strong>?</strong>
</a>
</div>
<div id="moreInfo" class="modal">
<a class="btn-flat modal-close modal-trigger" href="#!">×</a>
<div class="modal-content">
<section>
<p align=center><em>Note: Firefox has some issue with this page for some reason, but Edge & Chrome work fine.<br />
...also I haven't tested Safari because nobody should ever use Safari.</em></p>
<h5>What is this?</h5>
<p>This is a tool which allows you to see what impact a feature switch is having on an individual page's performance. This is done through a <a href="https://docs.google.com/drawings/d/1GWVpjJvXxkx9H-ei5ONbuUC67VD2jgeMivX54cEGbfA/edit?usp=sharing" target="_blank" rel="noopener">custom implementation</a> of the testing tool <a href="https://developers.google.com/web/tools/lighthouse/" taget="_blank" rel="noopener">Lighthouse</a> running in an <a href="https://aws.amazon.com/lambda/" target="_blank" rel="noopener">AWS Lambda</a> instance.</p>
</section>
<section class="exactly">
<h5>What exactly does it test and why? </h5>
<p>When you provide a URL & Feature Switch, first the tool runs tests against 3 different versions of the provided URL to establish a performance baseline.<br/>
The 3 different versions are:
</p>
<ul>
<li><strong>default</strong> - Most closely matches what users see when coming to the site, but is the most unpredictable do to the variations in the size of ad content & speed of 3rd party services outside of kinja's control.</li>
<li><strong>adzone=kinjatest</strong> - Similar to the default version, but removes the variances caused by advertisements by always forcing our static test ads to be used.</li>
<li><strong>no3rdparty</strong> - Removes all potential variations by only permitting things that kinja has direct control over to load. Prevents things like calls to 3rd-party services responsible for analytics, ad verification, header bidding, etc. </li>
</ul>
<p>
It then runs tests against the same 3 different versions of the URL, but this time appends the feature switch to each test.
</p>
<p>
Once all 6 of the tests are completed, the tool matches up each version of the test with it's feature switched counter-part version and compares the results of the meterics:
</p>
<ul>
<li><a href="https://developers.google.com/web/tools/lighthouse/audits/first-meaningful-paint" target="_blank" rel="noopener"><strong>Time to First Meaningful Paint</strong></a> - How long it takes to before the primary content is painted on the page</li>
<li><strong>Total Byte Weight</strong> - Total size of the page after everything is loaded </li>
<li><a href="https://developers.google.com/web/tools/lighthouse/audits/dom-size" target="_blank" rel="noopener"><strong>DOM Nodes</strong></a> - Total number of nodes (individual parts) that exist on the page. This is used as a proxy to gauge the complexity of the page</li>
</ul>
</section>
<section class="example">
<h5>Example Test</h5>
<div class="indent">
<p><strong>URL: </strong> <code>https://gizmodo.com/</code></p>
<p><strong>feature switch: </strong> <code>freepizza=on</code></p>
<p>The different URLs tested:</p>
<ul class="indent">
<li class="group1">https://gizmodo.com/</li>
<li class="group1">https://gizmodo.com/?freepizza=on</li>
<li class="group2">https://gizmodo.com/?adzone=kinjatest</li>
<li class="group2">https://gizmodo.com/?adzone=kinjatest&freepizza=on</li>
<li class="group3">https://gizmodo.com/?no3rdparty</li>
<li class="group3">https://gizmodo.com/?no3rdparty&freepizza=on</li>
</ul>
<p>
The <span style="color:blue;">blue</span>, <span style="color:red;">red</span>, & <span style="color:green;">green</span> groups are then compared.
</p>
</div>
</section>
<section class="other-questions">
<h5>Other Questions</h5>
<strong>Can I test more then one feature switch at a time?</strong>
<blockquote>
Sort of. <br/>
The test runner will test whatever you provide in the "Feature Switch" field against the baseline values of the 3 different variations. That means in the example above, if you provide the "feature switch" value of <code>freepizza=on&icecream=chocolate</code> then URLs that would be tested would be: <br/>
<div class="indent">
https://gizmodo.com/<br/>
https://gizmodo.com/?freepizza=on&icecream=chocolate<br/>
https://gizmodo.com/?adzone=kinjatest&<br/>
https://gizmodo.com/?adzone=kinjatest&freepizza=on&icecream=chocolate<br/>
https://gizmodo.com/?no3rdparty<br/>
https://gizmodo.com/?no3rdparty&freepizza=on&icecream=chocolate<br/>
</div>
</blockquote>
<strong>Why are some of the </strong>
<strong>I clicked submit and my tests aren't there?</strong>
<blockquote>
When the page loads, it grabs all of the completed tests from the database, attempts to perform the matching & comparison analysis, and then displays the results on the page. <br/>
If you have just submitted a test, they generally take anywhere from 30 - 180 seconds to complete before they will be available in the database and if your tests aren't in the database prior to page loading, they will not be displayed. <br /><br />
Make sure that you have provided the correct "URL to Test". It's best to copy & paste directly from another browser window. Things like using <code>http</code> instead of <code>https</code> or adding or forgetting <code>www</code> can potential cause issues with running your tests. <br /><br />
If after making sure your fields are correct, having waited some time, and refreshing the page you tests are still not there, reach out to someone on the "Performance" team.
</blockquote>
<strong>Why don't tests show more information?</strong>
<blockquote>
The 3 metrics that are displayed have been picked as a simple way of tracking and understanding performance on our sites. That being said, all of the <a href="https://developers.google.com/web/tools/lighthouse/audits/critical-request-chains" target="_blank" rel="noopener">performance audit data</a> for each individual URL test is available in <a href="https://json.org/" target="_blank" rel="noopener">JSON</a> form. Click on the ⎘ icon under "Copy result JSON to Clipboard", and then paste the text into a editor or a <a href="https://beautifier.io/" target="_blank" rel="noopener">beautifier tool</a> to make it easier to read.<br/><br/>
Additionally, it is worth noting that Chrome has the Lighthouse tool built into it's included dev tools. This means that you can <a href="https://developers.google.com/web/tools/lighthouse/#devtools" target="_blank" rel="noopener">run tests against individual URLs using your browser.</a> It won't do the work of comparing different URLs, but it does provide significantly more information that our version excludes.
</blockquote>
<strong>What do the different icons mean?</strong>
<blockquote>
⚖ - Indicates a comparison test and is created when a value is provided in the "Feature Switch" field.<br />
🎯 - Indicates a singular test and is created when a value is not provided in the "Feature Switch" field.<br/>
⚠ - Indicates that a issue has occurred with a test. This is most commonly seen when only half of a comparison test has been completed.<br/>
</ul>
</blockquote>
</section>
</div>
</div>
<script>
// data injection
let arrayOfCustomTests = ${JSON.stringify(arrOfRecentTests)}
</script>
<script>
// Form handler
let startTestForm = document.getElementById('initTest');
startTestForm.addEventListener("submit", (e) => {
e.preventDefault();
if (startTestForm.featureSwitch.value.includes('?')) {
M.toast({
html: 'Test not submitted. Please do not include the "?" in the feature switch field'
});
} else {
ajaxPost(startTestForm, handleFormPost);
}
});
function ajaxPost (form, callback) {
let url = form.action,
xhr = new XMLHttpRequest();
let params = [].filter.call(form.elements, (el)=>{
return el.type === "text" && el.value.length>0;
}).map(function(el) {
return encodeURIComponent(el.name) + '=' + encodeURIComponent(el.value);
}).join('&');
console.log(params);
xhr.open("POST", url);
xhr.setRequestHeader("Content-type", "application/x-form-urlencoded");
xhr.onload = callback.bind(xhr);
xhr.send(params);
}
function handleFormPost(val) {
let toastMessage;
if (val.currentTarget.status === 200) {
let response = JSON.parse(val.currentTarget.response);
console.log(response);
document.cookie = 'recentTestsTimestamp='+response.timestamp;
startTestForm.reset();
toastMessage = 'Custom test successfully requested. Please check back here in a few moments for the results. Tests generally take anywhere from 30 - 180 seconds to complete and appear on this page.';
} else {
toastMessage = 'It looks like an issue occurred while submitting your test request. Try reloading the page and making sure your URL & feature switch fields are valid';
}
M.toast({
html: toastMessage
});
}
</script>
<script>
// Test Review Functionality
console.dir(arrayOfCustomTests);
const tableOfTests = document.getElementById('recentTests');
let lookupTable = {};
let testCohorts = {};
if (!arrayOfCustomTests.length>0) {
document.getElementById('recentTests').style.display = 'none';
} else {
let recentTestsTimestamp = document.cookie.replace( 'recentTestsTimestamp=', '');
arrayOfCustomTests.sort(sortByTimestampDecending);
function sortByTimestampDecending(a,b) {
let aTimestamp = a.result_id.split('-',1)[0] - 0;
let bTimestamp = b.result_id.split('-',1)[0] - 0;
return bTimestamp - aTimestamp
}
//setup methods to make life easier...
arrayOfCustomTests.forEach((customTest) => {
// create a global lookup table
lookupTable[customTest.result_id] = customTest.data;
// group the tests into cohorts based on timestamp/ttl
testCohorts[customTest.ttl] = testCohorts[customTest.ttl] || [];
testCohorts[customTest.ttl].push(customTest.result_id);
});
arrayOfCustomTests.forEach((testResult) => {
let cohort = testCohorts[testResult.ttl];
let timestamp = testResult.result_id.split('-',1)[0];
let url = testResult.result_id.replace(timestamp + '-', '');
let urlHtmlString = url;
let isFeatureSwitchComparisonTest = cohort.length > 3;
let isSubordinateTest = false;
let companionTestID;
let errorInTest;
let el = document.createElement('li');
el.setAttribute('data-timestamp', timestamp);
let typeIcon = '🎯'
let variant = getVariantType(testResult);
el.classList.add('collection-item');
if(isFeatureSwitchComparisonTest) {
// This test is part of a feature switch test, you must find it's matching variant and tie their data together for a comparison
companionTestID = cohort.find((cohortMemberID) => {
return variant === getVariantType(cohortMemberID) && cohortMemberID !== testResult.result_id
});
typeIcon = '⚖';
if( !companionTestID || !testResult.result_id ) {
errorInTest = true;
typeIcon = '⚠';
} else if(companionTestID.length > testResult.result_id.length){
isSubordinateTest = true;
}
//Add highlighting to the urlHtmlString
let workingArray = (variant !== 'base') ?
url.split(/(no3rdparty&|adzone=kinjatest&)/) :
url.split(/([?])/);
workingArray.splice(2,0,'<span class="tested-feature-switch-string">')
workingArray.push('</span>');
urlHtmlString = workingArray.join('');
}
if(isSubordinateTest){
//do nothing because we don't need duplicate test elements in the UI :)
} else {
if (timestamp == recentTestsTimestamp) {
el.classList.add('recent');
}
el.innerHTML = '<div class="label">'+
'<div class="test-info">' +
'<div class="type">' + typeIcon + '</div>'+
'<div class="timestamp">' + timestamp.slice(4) + '</div>'+
'<div class="variant">' + variant + '</div>'+
'</div>' +
'<div class="url">' + urlHtmlString + '</div>' +
'<div class="collapse-control">⌅</div>'+
'</div>'
el.addEventListener('click', (e) => {
let clickTarget = event.target;
// collapse item if that is all we're trying to do
if (clickTarget.classList.contains('collapse-control')){
el.classList.remove('expand');
return;
}
// copy JSON result for test to clipboard
if (clickTarget.classList.contains('full-audit-to-clipboard')) {
if (window.confirm("The full result JSON for tests is really really big. Are you sure you want to copy it to your clipboard?")) {
copyAuditToClipboard(clickTarget.getAttribute('data-result_id'));
}
return
}
// build test results data if needed
if (!el.classList.contains('built')) {
let perfValues = getBasePerfData(testResult.result_id);
let resultsElement
if (isFeatureSwitchComparisonTest && !errorInTest) {
let companionTestData = getBasePerfData(companionTestID);
let companionTestURL = companionTestID.replace(/[0-9]*-/,'');
//console.log('isFeatureSwitchComparisonTest = true');
let table = document.createElement('table');
table.classList.add('comparison-test');
let tableHead = document.createElement('thead');
tableHead.innerHTML = '<thead>'+
'<tr>'+
'<th></th>'+
'<th>First Meaningful <br/>Paint (in ms)</th>'+
'<th>Total Page <br/>Weight (in KB)</th>'+
'<th>DOM <br/>node count</th>'+
'<th>Copy result JSON<br/> to Clipboard</th>'+
'</tr>'+
'</thead>';
// create primary row
let primaryRow = document.createElement('tr');
primaryRow.innerHTML = _generateRowPartial(url, perfValues) +
'<td class="full-audit-to-clipboard" data-result_id="' + testResult.result_id + '">⎘</td>';
// create companion row
let companionRow = document.createElement('tr');
companionRow.innerHTML = _generateRowPartial(companionTestURL, companionTestData) +
'<td class="full-audit-to-clipboard" data-result_id="' + companionTestID + '">⎘</td>';
// create diff row
let diffObj = {
firstMeaningfulPaintValue: perfValues.firstMeaningfulPaintValue - companionTestData.firstMeaningfulPaintValue,
totalByteWeightValue: perfValues.totalByteWeightValue - companionTestData.totalByteWeightValue,
domNodesValue: perfValues.domNodesValue - companionTestData.domNodesValue
}
let diffRow = document.createElement('tr');
diffRow.innerHTML = _generateRowPartial('', diffObj) + '<td></td>';
diffRow.querySelectorAll('td').forEach((td)=>{
let className;
if(td.textContent - 0 < 0) {
className = 'improved';
} else if (td.textContent - 0 > 0) {
className = 'declined';
}
td.classList.add(className);
})
// create table element
let tableBody = document.createElement('tbody');
tableBody.append(primaryRow);
tableBody.append(companionRow);
tableBody.append(diffRow);
table.append(tableHead);
table.append(tableBody);
resultsElement = table;
function _generateRowPartial(rowTitle, perfValuesObj){
let str = '<td class="row-title">' + rowTitle+'</td>'+
'<td>' + perfValuesObj.firstMeaningfulPaintValue + '</td>'+
'<td>' + perfValuesObj.totalByteWeightValue + '</td>'+
'<td>' + perfValuesObj.domNodesValue + '</td>'
return str
}
} else {
let firstMeaningfulPaintMarkup = '<div> <strong>First Meaningful Paint (in ms)</strong><br/> ' + perfValues.firstMeaningfulPaintValue + '</div>';
let totalByteWeightMarkup = '<div> <strong>Total Page Weigth (in KB)</strong><br/> ' + perfValues.totalByteWeightValue + '</div>';
let domNodesMarkup = '<div> <strong>DOM node count </strong><br/> ' + perfValues.domNodesValue + '</div>';
let copyControl = '<div class="full-audit-to-clipboard" data-result_id="' + testResult.result_id + '"> Copy full result JSON to Clipboard <span>⎘</span></div>';
resultsElement = document.createElement('div');
resultsElement.innerHTML = firstMeaningfulPaintMarkup + totalByteWeightMarkup + domNodesMarkup + copyControl;
resultsElement.classList.add('singular-test');
}
el.append(resultsElement);
el.classList.add('built');
}
// expand the item if we haven't already
if (!el.classList.contains('expand')){
el.classList.add('expand');
}
});
el.addEventListener('mouseover', (e) => {
let tests = document.querySelectorAll('li.collection-item');
let timestamp = el.dataset.timestamp;
document.querySelectorAll('li.collection-item.shared-timestamp').forEach((oldSharedTimestampElement) => {
oldSharedTimestampElement.classList.remove('shared-timestamp');
});
document.querySelectorAll('li.collection-item[data-timestamp="'+timestamp+'"]').forEach((newSharedTimestampElement)=>{
newSharedTimestampElement.classList.add('shared-timestamp');
});
});
tableOfTests.querySelector('.collection').appendChild(el);
}
});
// Return the variant using either the "result_id" string or the "testResults" object itself
function getVariantType(inputValue){
let result_id;
if (typeof inputValue === 'object') {
result_id = inputValue.result_id;
} else if (typeof inputValue === 'string'){
result_id = inputValue;
}
if (result_id.includes('adzone=kinjatest')){
return 'adzone=kinjatest';
} else if (result_id.includes('no3rdparty')){
return 'no3rdparty';
} else {
return 'base'
}
}
// Return an object with the basic perf values we care for a particular test using "result_id"
function getBasePerfData(targetID){
let obj = {
firstMeaningfulPaintValue: Math.floor(_findAudit('first-meaningful-paint').rawValue),
totalByteWeightValue: Math.floor(_findAudit('total-byte-weight').rawValue / 1024),
domNodesValue: Math.floor(_findAudit('dom-size').rawValue)
}
return obj;
function _findAudit(id) {
return lookupTable[targetID].audits.find((audit) => {
return audit.id === id
});
}
}
// Copy all the test data to the clipboard for a particular test using "result_id"
function copyAuditToClipboard (targetID) {
let dataToCopy = lookupTable[targetID];
let textToCopy = JSON.stringify(dataToCopy);
let txt = document.createTextNode(textToCopy);
document.body.appendChild(txt);
try {
if (document.body.createTextRange) {
let d = document.body.createTextRange();
d.moveToElementText(txt);
d.select();
document.execCommand('copy');
} else {
let d = document.createRange();
d.selectNodeContents(txt);
window.getSelection().removeAllRanges();
window.getSelection().addRange(d);
document.execCommand('copy');
window.getSelection().removeAllRanges();
}
txt.remove();
M.toast({
html: 'JSON for ' + url + ' copied successfully',
displayLength : 2500
});
} catch (error) {
M.toast({
html: 'An error occured while copying the JSON for ' + url,
displayLength : 2500
});
}
}
}
M.AutoInit();
</script>
</body>
</html>
`
return pageHTML
}
}
};