-
Notifications
You must be signed in to change notification settings - Fork 16
/
shin.js
1468 lines (1418 loc) · 46.4 KB
/
shin.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
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* @Author: strick
* @Date: 2021-02-23 11:01:46
* @LastEditTime: 2023-01-09 11:29:48
* @LastEditors: strick
* @Description: 前端监控 SDK
* @FilePath: /strick/shin-admin/public/shin.js
*/
/* eslint-disable */
/**
* FMP 计算
*/
(function (window) {
var IGNORE_TAG_SET = ["SCRIPT", "STYLE", "META", "HEAD", "LINK"];
var TAG_WEIGHT_MAP = {
SVG: 2,
IMG: 2,
CANVAS: 4,
OBJECT: 4,
EMBED: 4,
VIDEO: 4
};
var WW = window.innerWidth;
var WH = window.innerHeight;
var cacheTrees = []; // 缓存每次更新的DOM元素
var FMP_ATTRIBUTE = '_ts';
var fmpObserver;
var callbackCount = 0;
/**
* 开始监控DOM的变化
*/
function initFMP() {
fmpObserver = new MutationObserver(() => {
var mutationsList = [];
// 为 HTML 元素打标记,记录是哪一次的 DOM 更新
var doTag = function(target, callbackCount) {
var childrenLen = target.children ? target.children.length : 0;
// 结束递归
if(childrenLen === 0)
return;
for (var children = target.children, i = childrenLen - 1; i >= 0; i--) {
var child = children[i];
var tagName = child.tagName;
if (child.getAttribute(FMP_ATTRIBUTE) === null &&
IGNORE_TAG_SET.indexOf(tagName) === -1 // 过滤掉忽略的元素
) {
child.setAttribute(FMP_ATTRIBUTE, callbackCount);
mutationsList.push(child); // 记录更新的元素
}
// 继续递归
doTag(child, callbackCount);
}
};
// 从 body 元素开始遍历
document.body && doTag(document.body, callbackCount++);
cacheTrees.push({
ts: performance.now(),
children: mutationsList
});
// console.log("mutationsList", performance.now(), mutationsList);
});
fmpObserver.observe(document, {
childList: true, // 监控子元素
subtree: true // 监控后代元素
});
}
initFMP();
/**
* 是否超出屏幕外
*/
function isOutScreen(node) {
var { left, top } = node.getBoundingClientRect();
return WH < top || WW < left;
}
/**
* 读取 FMP 信息
*/
function getFMP() {
fmpObserver.disconnect(); // 停止监听
var maxObj = {
score: -1, //最高分
elements: [], // 首屏元素
ts: 0 // DOM变化时的时间戳
};
// 遍历DOM数组,并计算它们的得分
cacheTrees.forEach(tree => {
var score = 0;
// 首屏内的元素
var firstScreenElements = [];
tree.children.forEach((node) => {
// 只记录元素
if(node.nodeType !== 1 || IGNORE_TAG_SET.indexOf(node.tagName) >= 0) {
return;
}
var { height } = node.getBoundingClientRect();
// 过滤高度为 0,在首屏外的元素
if(height > 0 && !isOutScreen(node)) {
firstScreenElements.push(node);
}
});
// 若首屏中的一个元素是另一个元素的后代,则过滤掉该祖先元素
firstScreenElements = firstScreenElements.filter(node => {
// 只要找到一次包含关系,就过滤掉
var notFind = !firstScreenElements.some(item => node !== item && node.contains(item));
// 计算总得分
if(notFind) {
score += caculateScore(node);
}
return notFind;
});
// 得到最高值
if(maxObj.score < score) {
maxObj.score = score;
maxObj.elements = firstScreenElements;
maxObj.ts = tree.ts;
}
});
// 在得分最高的首屏元素中,找出最长的耗时
return getElementMaxTimeConsuming(maxObj.elements, maxObj.ts);
}
/**
* 计算元素分值
*/
function caculateScore(node) {
var { width, height } = node.getBoundingClientRect();
var weight = TAG_WEIGHT_MAP[node.tagName] || 1;
if (
weight === 1 &&
window.getComputedStyle(node)['background-image'] && // 读取CSS样式中的背景图属性
window.getComputedStyle(node)['background-image'] !== "initial"
) {
weight = TAG_WEIGHT_MAP["IMG"]; //将有图片背景的普通元素 权重设置为img
}
return width * height * weight;
}
/**
* 读取首屏内元素的最长耗时
*/
function getElementMaxTimeConsuming(elements, observerTime) {
// 记录静态资源的响应结束时间
var resources = {};
// 遍历静态资源的时间信息
performance.getEntries().forEach(item => {
resources[item.name] = item.responseEnd;
});
var maxObj = {
ts: observerTime,
element: ''
};
elements.forEach(node => {
var stage = node.getAttribute(FMP_ATTRIBUTE);
ts = stage ? cacheTrees[stage].ts : 0; // 从缓存中读取时间
switch(node.tagName) {
case 'IMG':
ts = resources[node.src];
break;
case 'VIDEO':
ts = resources[node.src];
!ts && (ts = resources[node.poster]); // 读取封面
break;
default:
// 读取背景图地址
var match = window.getComputedStyle(node)['background-image'].match(/url\(\"(.*?)\"\)/);
if(!match) break;
var src;
// 判断是否包含协议
if (match && match[1]) {
src = match[1];
}
if (src.indexOf("http") == -1) {
src = location.protocol + match[1];
}
ts = resources[src];
break;
};
// console.log(node, ts)
if(ts > maxObj.ts) {
maxObj.ts = ts;
maxObj.element = node;
}
});
return maxObj;
}
window.getFMP = getFMP;
}(this));
(function (window) {
"use strict";
/**
* https://developer.mozilla.org/zh-CN/docs/Web/API/Window/performance
*/
var performance =
window.performance ||
window.webkitPerformance ||
window.msPerformance ||
window.mozPerformance ||
{};
performance.now = (function () {
return (
performance.now ||
performance.webkitNow ||
performance.msNow ||
performance.oNow ||
performance.mozNow ||
function () {
return new Date().getTime();
}
);
})();
/**
* 默认属性
*/
var defaults = {
refer: window.location.href, //上一页地址
firstScreen: 0, //首屏时间 ms
lcp: {
time: 0, // 时间
url: '', // 资源地址
element: '' // 参照的元素
}, // 最大内容可见的对象,time:时间 ms,url:参照的资源地址
fid: 0, // 用户第一次与页面交互(例如当他们单击链接、点按按钮等操作)直到浏览器对交互作出响应的时间
setFirstScreen: function() { //自定义首屏时间
this.firstScreen = _calcCurrentTime();
},
//可自定义的参数
param: {
isRecord: true, // 是否打开错误
isDebug: false, //默认是非调试环境,而在调试中时,将不会重写 console.log
isCrash: false, //是否监控页面奔溃
validateCrash: null, //自定义奔溃规则,例如页面白屏判断的条件,返回值包括 {success: true, prompt:'提示'}
src: "//127.0.0.1:8000/api/ma.gif", //请求发送数据的地址(监控)
// swSrc: '/sw.js', //Web Worker地址,用于监控页面奔溃
psrc: "//127.0.0.1:8000/api/pe.gif", //请求发送数据的地址(性能)
pkey: "", //性能监控的项目key
subdir: "", //一个项目下的子目录
rate: 5, //随机采样率,用于性能搜集
version: '', // 版本,便于追查出错源
identity: '', //可自定义的身份信息字段
}
};
var shin = defaults;
/**
* 判断是否在APP中
*/
function isApp() {
var reg = /xxx\s?\//i;
return reg.test(navigator.userAgent);
}
/**
* 在客户端中埋入可识别的身份信息,例如userId
* 这段代码可自行修改
*/
function injectIdentity(identity) {
// 若不是热拉APP或已经指定身份信息,则返回
if(!isApp() || identity) return;
// 在JSBridge成功调用后的回调函数
window.getMonitorUserSuccess = function(result) {
try {
var json = JSON.parse(result);
shin.param.identity = json.data.userId;
}catch(e) {
// console.error(e.message);
}
};
// 通过JSBridge读取用户信息
var iframe = document.createElement('iframe');
iframe.style.display = 'none';
iframe.src = 'xxx://com.user/getInfo?callback=getMonitorUserSuccess';
/**
* 需要加个定时器,因为调用document.body时,DOM还未存在
* Uncaught TypeError: Cannot read property 'appendChild' of null
*/
setTimeout(() => {
document.body && document.body.appendChild(iframe);
}, 500);
}
/**
* 自定义参数
*/
shin.setParam = function(params) {
if (!params) {
return;
}
// 默认值重置
for (var key in params) {
this.param[key] = params[key];
}
//为原生对象注入自定义行为
injectConsole(this.param.isDebug);
// 埋入身份信息
injectIdentity(this.param.identity);
// 记录用户行为
recordPage(this.param.isRecord);
};
/**
* 记录用户行为
*/
var recordEventsMatrix = [[]];
function recordPage(isRecord) {
if (!isRecord) { return; }
var script = document.createElement('script');
script.src = '//cdn.jsdelivr.net/npm/rrweb@latest/dist/rrweb.min.js';
// 开始监控页面行为
script.onload = function() {
rrweb.record({
emit(event, isCheckout) {
// isCheckout 是一个标识,告诉你重新制作了快照
if (isCheckout) {
// 最多保留 3 段行为记录
var deleteCount = recordEventsMatrix.length - 2;
deleteCount > 0 && recordEventsMatrix.splice(0, deleteCount);
recordEventsMatrix.push([]);
}
var lastEvents = recordEventsMatrix[recordEventsMatrix.length - 1];
lastEvents.push(event);
},
checkoutEveryNms: 10 * 1000, // 每 10 秒重新制作快照
});
};
document.head.append(script);
}
/**
* 读取最近 20 秒的行为记录
*/
function getRecentRecord() {
var len = recordEventsMatrix.length;
if(len === 0) return '';
var events;
if(len.length >= 2) {
events = recordEventsMatrix[len - 2].concat(recordEventsMatrix[len - 1]);
}else {
events = recordEventsMatrix[len - 1];
}
return JSON.stringify(events);
}
/**
* 白屏计算规则
*/
function _isWhiteScreen() {
var visibles = [];
var nodes = []; //遍历到的节点的关键信息,用于查明白屏原因
// 深度优先遍历子元素
var dfs = (node) => {
var tagName = node.tagName.toLowerCase();
var rect = node.getBoundingClientRect();
// 选取节点的属性作记录
var attrs = {
id: node.id,
tag: tagName,
className: node.className,
display: node.style.display,
height: rect.height
};
if(node.src) {
attrs.src = node.src; // 记录图像的地址
}
if(node.href) {
attrs.href = node.href; // 记录链接的地址
}
nodes.push(attrs);
// 若已找到一个有高度的元素,则结束搜索
if(visibles.length > 0) return;
// 若元素隐藏,则结束搜索
if (node.style.display === 'none') return;
// 若元素有高度并且不是 body 元素,则结束搜索
if(rect.height > 0 && tagName !== 'body') {
visibles.push(node);
return;
}
node.children && [].slice.call(node.children).forEach((child) => {
var tagName = child.tagName.toLowerCase();
// 过滤脚本和样式元素
if(tagName === 'script' || tagName === 'link') return;
dfs(child);
});
};
dfs(document.body);
return {
visibles: visibles,
nodes: nodes
};
}
/**
* 基于 Web Worker 心跳的方案,监控页面奔溃情况
*/
function monitorCrash(param) {
var isCrash = param.isCrash,
validateCrash = param.validateCrash;
if(!isCrash || !window.Worker)
return;
// var worker = new Worker(param.swSrc);
var HEARTBEAT_INTERVAL = 5 * 1000; // 每五秒发一次心跳
// var sessionId = getIdentity();
var crashHeartbeat = function () {
// 是否自定义了规则
if(validateCrash) {
var result = validateCrash();
// 符合自定义的奔溃规则
if (result && !result.success) {
handleError({
type: ERROR_CRASH,
desc: {
prompt: result.prompt,
url: location.href,
},
});
// 关闭定时器
clearInterval(timer);
// worker = null;
}
} else {
// 兜底白屏算法,可根据自身业务定义
var whiteObj = _isWhiteScreen();
if(whiteObj.visibles.length > 0) {
return;
}
// 查询第一个div
var currentDiv = document.querySelector('div');
// 增加 html 字段是为了验证是否出现了误报
handleError({
type: ERROR_CRASH,
desc: {
prompt: '页面没有高度',
url: location.href,
html: currentDiv ? _removeQuote(currentDiv.innerHTML) : '',
fontSize: document.documentElement.style.fontSize, // 根节点的字体大小
nodes: whiteObj.nodes
},
});
clearInterval(timer);
}
// worker && worker.postMessage({
// type: 'heartbeat',
// id: sessionId,
// data: { //在页面奔溃时,上报数据,需要将上报地址一起传递
// src: param.src,
// m: _paramify({
// category: ACTION_ERROR,
// data: {
// type: ERROR_CRASH,
// desc: {
// url: location.href
// },
// }
// })
// }
// });
}
// window.addEventListener("beforeunload", function() {
// worker.postMessage({
// type: 'unload',
// id: sessionId
// });
// });
var timer = setInterval(crashHeartbeat, HEARTBEAT_INTERVAL);
crashHeartbeat(); // 立即执行一次
// heartbeat();
// 5分钟后自动取消定时器
setTimeout(function() {
// 关闭定时器
clearInterval(timer);
}, 1000 * 300);
}
/**
* 标记时间,单位毫秒
* Date.now() 会受系统程序执行阻塞的影响
* performance.now() 的时间是以恒定速率递增的,不受系统时间的影响(系统时间可被人为或软件调整)
*/
shin.now = function () {
return performance.now();
};
// ----------------------------------------性能采集----------------------------------------
// var firstScreenHeight = window.innerHeight; //第一屏高度
// var doc = window.document;
/**
* 计算当前时间与 fetchStart 之间的差值
*/
function _calcCurrentTime() {
return _getTiming().now;
}
/**
* 判断当前宿主环境是否支持 PerformanceObserver
* 并且支持某个特定的类型
*/
function checkSupportPerformanceObserver(type) {
if(!PerformanceObserver) return false;
var types = PerformanceObserver.supportedEntryTypes;
// 浏览器兼容判断
if(types.indexOf(type) === -1) {
return false;
}
return true;
}
/**
* 去除双引号
*/
function _removeQuote(html) {
return html.replace(/"/g, '');
}
/**
* 浏览器 LCP 计算
* LCP(Largest Contentful Paint)最大内容在可视区域内变得可见的时间
* https://developer.mozilla.org/en-US/docs/Web/API/LargestContentfulPaint
*/
function getLCP() {
var lcpType = 'largest-contentful-paint';
var isSupport = checkSupportPerformanceObserver(lcpType);
// 浏览器兼容判断
if(!isSupport) {
return;
}
var po = new PerformanceObserver(function(entryList) {
var entries = entryList.getEntries();
var lastEntry = entries[entries.length - 1];
shin.lcp = {
time: _rounded(lastEntry.renderTime || lastEntry.loadTime), // 取整
url: lastEntry.url,
element: lastEntry.element ? _removeQuote(lastEntry.element.outerHTML) : ''
};
});
// buffered 为 true 表示调用 observe() 之前的也算进来
po.observe({type: lcpType, buffered: true});
/**
* 当有按键或点击(包括滚动)时,就停止 LCP 的采样
* once 参数是指事件被调用一次后就会被移除
*/
['keydown', 'click'].forEach((type) => {
window.addEventListener(type, function() {
// 断开此观察者的连接
po.disconnect();
}, { once: true, capture: true });
});
}
getLCP();
/**
* 浏览器 FID 计算
* FID(First Input Delay)用户第一次与页面交互到浏览器对交互作出响应的时间
* https://developer.mozilla.org/en-US/docs/Glossary/First_input_delay
*/
function getFID() {
var fidType = 'first-input';
var isSupport = checkSupportPerformanceObserver(fidType);
// 浏览器兼容判断
if(!isSupport) {
return;
}
new PerformanceObserver(function(entryList, obs) {
const firstInput = entryList.getEntries()[0];
// 测量第一个输入事件的延迟
shin.fid = _rounded(firstInput.processingStart - firstInput.startTime);
/**
* 测量第一个输入事件的持续时间
* 仅在处理程序中同步完成重要事件处理工作时使用
*/
// const firstInputDuration = firstInput.duration;
// 获取本次事件目标的一些信息,比如id。
// const targetId = firstInput.target ? firstInput.target.id : 'unknown-target';
// 处理第一个输入延迟,也许还有它的持续时间
// 断开此观察者的连接,因为回调仅触发一次
obs.disconnect();
}).observe({type: fidType, buffered: true});
}
getFID();
/**
* 监控页面奔溃情况
* 计算首屏时间
* 记录首屏图片的载入时间
* 用户在没有滚动时候看到的内容渲染完成并且可以交互的时间
* 2023-01-06 删除,因为默认会采用 LCP 或 FMP 的计算结果
*/
// doc.addEventListener("DOMContentLoaded", function () {
// var isFindLastImg = false,
// allFirsrImgsLoaded = false,
// firstScreenImgs = [];
// //用一个定时器差值页面中的图像元素
// var interval = setInterval(function() {
// //如果自定义了 firstScreen 的值,就销毁定时器
// if(shin.firstScreen) {
// clearInterval(interval);
// return;
// }
// if(isFindLastImg) {
// allFirsrImgsLoaded = firstScreenImgs.every(function(img) {
// return img.complete;
// });
// //当所有的首屏图像都载入后,关闭定时器并记录首屏时间
// if(allFirsrImgsLoaded) {
// shin.firstScreen = _calcCurrentTime();
// clearInterval(interval);
// }
// return;
// }
// var imgs = doc.querySelectorAll('img');
// imgs = [].slice.call(imgs); //转换成数组
// //遍历页面中的图像
// imgs.forEach(function(img) {
// if(isFindLastImg)
// return;
// //当图像离顶部的距离超过屏幕宽度时,被认为找到了首屏的最后一张图
// var rect = img.getBoundingClientRect();
// if((rect.top + rect.height) > firstScreenHeight) {
// isFindLastImg = true;
// return;
// }
// //若未超过,则认为图像在首屏中
// firstScreenImgs.push(img);
// });
// }, 0);
// },
// false
// );
/**
* 读取 timing 对象,兼容新版和旧版
*/
function _getTiming() {
var timing = performance.getEntriesByType('navigation')[0] || performance.timing;
var now = 0;
if(!timing) {
return { now: now };
}
var navigationStart;
if(timing.startTime === undefined) {
navigationStart = timing.navigationStart;
/**
* 之所以老版本的用 Date,是为了防止出现负数
* 当 performance.now 是最新版本时,数值的位数要比 timing 中的少很多
*/
now = new Date().getTime() - navigationStart;
}else {
navigationStart = timing.startTime;
now = shin.now() - navigationStart;
}
return { timing: timing, navigationStart: navigationStart, now: _rounded(now) };
}
/**
* 请求时间统计
* https://github.com/addyosmani/timing.js
*/
shin.getTimes = function() {
//出于对浏览器兼容性的考虑,仍然引入即将淘汰的 performance.timing
var currentTiming = _getTiming();
var timing = currentTiming.timing;
// var timing = performance.timing;
var api = {}; //时间单位 ms
if(!timing) {
return api;
}
var navigationStart = currentTiming.navigationStart;
/**
* http://javascript.ruanyifeng.com/bom/performance.html
* 页面加载总时间,有可能为0,未触发load事件
* 这几乎代表了用户等待页面可用的时间
* loadEventEnd(加载结束)-navigationStart(导航开始)
*/
api.loadTime = timing.loadEventEnd - navigationStart;
/**
* Unload事件耗时
*/
api.unloadEventTime = timing.unloadEventEnd - timing.unloadEventStart;
/**
* 执行 onload 回调函数的时间
* 是否太多不必要的操作都放到 onload 回调函数里执行了,考虑过延迟加载、按需加载的策略么?
*/
api.loadEventTime = timing.loadEventEnd - timing.loadEventStart;
/**
* 首次可交互时间
*/
api.interactiveTime = timing.domInteractive - timing.fetchStart;
/**
* 用户可操作时间(DOM Ready时间)
* 在初始HTML文档已完全加载和解析时触发(无需等待图像和iframe完成加载)
* 紧跟在DOMInteractive之后。
* https://www.dareboost.com/en/doc/website-speed-test/metrics/dom-content-loaded-dcl
*/
api.domReadyTime = timing.domContentLoadedEventEnd - timing.fetchStart;
/**
* 白屏时间
*/
var paint = performance.getEntriesByType('paint');
if(paint && timing.entryType && paint[0]) {
api.firstPaint = paint[0].startTime - timing.fetchStart;
api.firstPaintStart = paint[0].startTime; // 记录白屏时间点
}else {
api.firstPaint = timing.responseEnd - timing.fetchStart;
}
/**
* FCP(First Contentful Paint)首次有实际内容渲染的时间
*/
if (paint && timing.entryType && paint[1]) {
api.firstContentfulPaint = paint[1].startTime - timing.fetchStart;
api.firstContentfulPaintStart = paint[1].startTime; // 记录白屏时间点
} else {
api.firstContentfulPaint = 0;
}
/**
* 解析DOM树结构的时间
* DOM中的所有脚本,包括具有async属性的脚本,都已执行。加载 DOM 中定义的所有页面静态资源(图像、iframe等)
* LoadEventStart紧跟在Complete之后。 在大多数情况下,这2个指标是相等的。
* 在加载事件开始之前可能引入的唯一额外延迟将由onReadyStateChange的处理引起。
* https://www.dareboost.com/en/doc/website-speed-test/metrics/dom-complete
*/
api.parseDomTime = timing.domComplete - timing.domInteractive;
/**
* 请求完毕至DOM加载耗时
* 在加载DOM并执行网页的阻塞脚本时触发
* 在这个阶段,具有defer属性的脚本还没有执行,某些样式表加载可能仍在处理并阻止页面呈现
* https://www.dareboost.com/en/doc/website-speed-test/metrics/dom-interactive
*/
api.initDomTreeTime = timing.domInteractive - timing.responseEnd;
/**
* 准备新页面耗时
*/
api.readyStart = timing.fetchStart - navigationStart;
/**
* 重定向次数(新)
*/
api.redirectCount = timing.redirectCount || 0;
/**
* 传输内容压缩百分比(新)
*/
api.compression = (1 - timing.encodedBodySize / timing.decodedBodySize) * 100 || 0;
/**
* 重定向的时间
* 拒绝重定向!比如,http://example.com/ 就不该写成 http://example.com
*/
api.redirectTime = timing.redirectEnd - timing.redirectStart;
/**
* DNS缓存耗时
*/
api.appcacheTime = timing.domainLookupStart - timing.fetchStart;
/**
* DNS查询耗时
* DNS 预加载做了么?页面内是不是使用了太多不同的域名导致域名查询的时间太长?
* 可使用 HTML5 Prefetch 预查询 DNS ,见:[HTML5 prefetch](http://segmentfault.com/a/1190000000633364)
*/
api.lookupDomainTime = timing.domainLookupEnd - timing.domainLookupStart;
/**
* SSL连接耗时
*/
var sslTime = timing.secureConnectionStart;
api.connectSslTime = sslTime > 0 ? timing.connectEnd - sslTime : 0;
/**
* TCP连接耗时
*/
api.connectTime = timing.connectEnd - timing.connectStart;
/**
* 内容加载完成的时间
* 页面内容经过 gzip 压缩了么,静态资源 css/js 等压缩了么?
*/
api.requestTime = timing.responseEnd - timing.requestStart;
/**
* 请求文档
* 开始请求文档到开始接收文档
*/
api.requestDocumentTime = timing.responseStart - timing.requestStart;
/**
* 接收文档(内容传输耗时)
* 开始接收文档到文档接收完成
*/
api.responseDocumentTime = timing.responseEnd - timing.responseStart;
/**
* 读取页面第一个字节的时间,包含重定向时间
* TTFB 即 Time To First Byte 的意思
* 维基百科:https://en.wikipedia.org/wiki/Time_To_First_Byte
*/
api.TTFB = timing.responseStart - timing.redirectStart;
/**
* 仅用来记录当前 performance.now() 获取到的时间格式
* 用于追溯计算
*/
api.now = shin.now();
//全部取整
for (var key in api) {
api[key] = _rounded(api[key]);
}
// 读取FMP信息 TODO
var fmp = getFMP();
shin.fmp = {
time: _rounded(fmp.ts - navigationStart),
element: fmp.element ? _removeQuote(fmp.element.outerHTML) : ''
};
/**
* 浏览器读取到的性能参数,用于排查,并保留两位小数
*/
api.timing = {};
for(key in timing) {
var timingValue = timing[key];
var type = typeof timingValue;
if(type === "function")
continue;
api.timing[key] = timingValue;
if(type === "number")
api.timing[key] = _rounded(timingValue, 2);
}
return api;
};
/**
* 组装性能变量
*/
function _paramifyPerformance(obj) {
obj.token = shin.param.token;
obj.pkey = shin.param.pkey;
obj.identity = getIdentity();
obj.referer = window.location.href; //来源地址
// 取 FMP、LCP 和用户可操作时间中的最大值
obj.firstScreen = Math.max.call(undefined, shin.fmp.time, shin.lcp.time, obj.domReadyTime);
obj.timing.lcp = shin.lcp; //记录LCP对象
obj.timing.fmp = shin.fmp; //记录FMP对象
obj.timing.fid = shin.fid; //记录FID对象
// 静态资源列表
var resources = performance.getEntriesByType('resource');
var newResources = [];
resources && resources.forEach(function(value) {
// 过滤 fetch 请求
if(value.initiatorType === 'fetch') return;
// 只存储 1 分钟内的资源
if(value.startTime > 60000) return;
newResources.push({
name: value.name,
duration: Math.round(value.duration),
startTime: Math.round(value.startTime),
})
});
obj.resource = newResources;
return JSON.stringify(obj);
}
/**
* 均匀获得两个数字之间的随机数
*/
function _randomNum(max, min){
return Math.floor(Math.random() * (max - min + 1) + min);
}
/**
* iOS 设备不支持 beforeunload 事件,需要使用 pagehide 事件
* 在页面卸载之前,推送性能信息
*/
var isIOS = !!navigator.userAgent.match(/\(i[^;]+;( U;)? CPU.+Mac OS X/);
var eventName = isIOS ? "pagehide" : "beforeunload";
var isNeedHideEvent = true; // 是否需要触发隐藏事件
window.addEventListener(eventName, function() {
isNeedHideEvent && sendBeacon();
}, false);
// 在 load 事件中,上报性能参数
window.addEventListener('load', function() {
/**
* 监控页面奔溃情况
* 原先是在 DOMContentLoaded 事件内触发,经测试发现,当因为脚本错误出现白屏时,两个事件的触发时机会很接近
* 在线上监控时发现会有一些误报,HTML是有内容的,那很可能是 DOMContentLoaded 触发时,页面内容还没渲染好
*/
setTimeout(function() {
monitorCrash(shin.param);
}, 1000);
// 加定时器是避免在上报性能参数时,loadEventEnd 为 0,因为事件还没执行完毕
setTimeout(function() {
sendBeacon();
}, 0);
}, false);
// var SHIN_PERFORMANCE_DATA = "shin_performance_data";
// var heartbeat; //心跳定时器
/**
* 发送数据
*/
function sendBeacon(existData) {
// 如果传了数据就使用该数据,否则读取性能参数,并格式化为字符串
var data = existData || _paramifyPerformance(shin.getTimes());
var rate = _randomNum(10, 1); // 选取1~10之间的整数
if(shin.param.rate >= rate && shin.param.pkey) {
navigator.sendBeacon(shin.param.psrc, data);
}
// clearTimeout(heartbeat);
// localStorage.removeItem(SHIN_PERFORMANCE_DATA); //移除性能缓存
isNeedHideEvent = false;
}
/**
* 发送已存在的性能数据
*/
// function sendExistData() {
// var exist = localStorage.getItem(SHIN_PERFORMANCE_DATA);
// if(!exist)
// return;
// setTimeout(function() {
// sendBeacon(exist);
// }, 0);
// }
// sendExistData();
/**
* 一个心跳回调函数,缓存性能参数
* 适用于不能触发 pagehide 和 beforeunload 事件的浏览器
* 2022-01-06 删除,因为在 load 事件中也会上报性能参数,并且也是为了减少对 FMP 的计算次数,消除不必要的性能损耗,避免错误的计算结果
*/
// function intervalHeartbeat() {
// localStorage.setItem(SHIN_PERFORMANCE_DATA, _paramifyPerformance(shin.getTimes()));
// }
// heartbeat = setInterval(intervalHeartbeat, 200);
// ----------------------------------------常量声明----------------------------------------
// 定义行为类型
var ACTION_ERROR = "error";
var ACTION_AJAX = "ajax";
var ACTION_EVENT = "event";
var ACTION_PRINT = "console";
var ACTION_REDIRECT = "redirect";
// 定义的错误类型码
var ERROR_RUNTIME = 'runtime';
var ERROR_SCRIPT = 'script';
var ERROR_STYLE = 'style';
var ERROR_IMAGE = 'image';
var ERROR_AUDIO = 'audio';
var ERROR_VIDEO = 'video';
var ERROR_PROMISE = 'promise';
var ERROR_VUE = 'vue';
var ERROR_REACT = 'react';
var ERROR_CRASH = 'crash';
var LOAD_ERROR_TYPE = {
SCRIPT: ERROR_SCRIPT,
LINK: ERROR_STYLE,
IMG: ERROR_IMAGE,
AUDIO: ERROR_AUDIO,
VIDEO: ERROR_VIDEO
};
// ----------------------------------------错误采集----------------------------------------
/**
* 上报错误
* @param {Object} errorLog 错误日志
*/
function handleError(errorLog) {
// console.log(errorLog);
shin.send({
category: ACTION_ERROR,
data: errorLog
});
}
/**
* 监控资源异常,即无法响应的资源
* 2022-12-13 删除,因为错误资源会被error事件捕获到
*/
// window.addEventListener(
// "load",
// function () {
// // 罗列资源列表,PerformanceResourceTiming类型
// var resources = performance.getEntriesByType("resource");
// // 映射initiatorType和错误类型
// var hashError = {
// script: ERROR_SCRIPT,
// link: ERROR_STYLE,
// // img: ERROR_IMAGE
// };
// resources && resources.forEach(function(value) {
// var type = hashError[value.initiatorType];
// /**
// * 非监控资源、响应时间在20秒内、监控资源是ma.gif或shin.js,则结束当前循环
// */
// if(!type || //非监控资源
// value.duration < 20000 || //20秒内
// value.name.indexOf("ma.gif") >= 0 ||
// value.name.indexOf("shin.js") >= 0) {
// return;
// }
// // 若是CSS文件,则过滤脚本文件
// if(type === ERROR_STYLE &&
// value.name.indexOf(".js") >= 0) {
// return;
// }
// handleError({
// type: type,