o11y 248.8.0 → 248.10.0

package/dist/modules/o11y/client/client.js

@@ -1,4 +1,4 @@
-import { simpleSchema, errorSchema, activitySchema, instrumentedEventSchema, idleDetectorReportSchema } from 'o11y_schema/sf_instrumentation';
+import { networkSchema, simpleSchema, errorSchema, activitySchema, instrumentedEventSchema, idleDetectorReportSchema } from 'o11y_schema/sf_instrumentation';
 import { utility, PublicSafety, schemaUtil, maxStringLengthAppLimit, metricsUtility, payloadUtility } from 'o11y/shared';
 
 class TaskerImpl {
@@ -247,6 +247,202 @@ class IdleDetectorImpl {
     }
 }
 
+const navigation_timing={namespace:"sfcore.performance",name:"NavigationTiming",pbjsSchema:{"nested":{"sfcore":{"nested":{"performance":{"nested":{"NavigationTiming":{"oneofs":{"_xhrDelay":{"oneof":["xhrDelay"]},"_renderBlockingStatus":{"oneof":["renderBlockingStatus"]},"_firstInterimResponseStart":{"oneof":["firstInterimResponseStart"]},"_srvDuration":{"oneof":["srvDuration"]},"_isCdnCached":{"oneof":["isCdnCached"]},"_dbDuration":{"oneof":["dbDuration"]},"_reqBatchCount":{"oneof":["reqBatchCount"]}},
+"fields":{"redirectCount":{"id":37,"type":"uint32"},"encodedBodySize":{"id":21,"type":"uint32"},"reqActionNames":{"rule":"repeated","id":28,"type":"string"},"unloadEventEnd":{"id":40,"type":"double"},"responseEnd":{"id":19,"type":"double"},"domainLookupEnd":{"id":12,"type":"double"},"unloadEventStart":{"id":39,"type":"double"},"domContentLoadedEventStart":{"id":32,"type":"double"},"type":{"id":38,"type":"string"},"firstInterimResponseStart":{"options":{"proto3_optional":true},"id":18,"type":"double"},
+"duration":{"id":3,"type":"double"},"decodedBodySize":{"id":22,"type":"uint32"},"redirectStart":{"id":8,"type":"double"},"connectEnd":{"id":15,"type":"double"},"isCdnCached":{"options":{"proto3_optional":true},"id":24,"type":"bool"},"requestStart":{"id":16,"type":"double"},"startTime":{"id":2,"type":"double"},"fetchStart":{"id":10,"type":"double"},"domContentLoadedEventEnd":{"id":33,"type":"double"},"srvReqId":{"id":29,"type":"string"},"reqBatchCount":{"options":{"proto3_optional":true},"id":27,"type":"uint32"},
+"renderBlockingStatus":{"options":{"proto3_optional":true},"id":6,"type":"string"},"workerStart":{"id":7,"type":"double"},"responseStart":{"id":17,"type":"double"},"xhrDelay":{"options":{"proto3_optional":true},"id":30,"type":"double"},"domInteractive":{"id":34,"type":"double"},"domComplete":{"id":31,"type":"double"},"domainLookupStart":{"id":11,"type":"double"},"responseStatus":{"id":23,"type":"uint32"},"redirectEnd":{"id":9,"type":"double"},"transferSize":{"id":20,"type":"uint32"},"srvDuration":{"options":{"proto3_optional":true},
+"id":26,"type":"double"},"dbDuration":{"options":{"proto3_optional":true},"id":25,"type":"double"},"connectStart":{"id":13,"type":"double"},"loadEventStart":{"id":35,"type":"double"},"secureConnectionStart":{"id":14,"type":"double"},"name":{"id":1,"type":"string"},"nextHopProtocol":{"id":5,"type":"string"},"initiatorType":{"id":4,"type":"string"},"loadEventEnd":{"id":36,"type":"double"}}}}}}}}}};
+
+const resource_timing={namespace:"sfcore.performance",name:"ResourceTiming",pbjsSchema:{"nested":{"sfcore":{"nested":{"performance":{"nested":{"ResourceTiming":{"oneofs":{"_xhrDelay":{"oneof":["xhrDelay"]},"_renderBlockingStatus":{"oneof":["renderBlockingStatus"]},"_firstInterimResponseStart":{"oneof":["firstInterimResponseStart"]},"_srvDuration":{"oneof":["srvDuration"]},"_isCdnCached":{"oneof":["isCdnCached"]},"_dbDuration":{"oneof":["dbDuration"]},"_reqBatchCount":{"oneof":["reqBatchCount"]}},
+"fields":{"encodedBodySize":{"id":21,"type":"uint32"},"reqActionNames":{"rule":"repeated","id":28,"type":"string"},"responseEnd":{"id":19,"type":"double"},"domainLookupEnd":{"id":12,"type":"double"},"firstInterimResponseStart":{"options":{"proto3_optional":true},"id":18,"type":"double"},"duration":{"id":3,"type":"double"},"decodedBodySize":{"id":22,"type":"uint32"},"redirectStart":{"id":8,"type":"double"},"connectEnd":{"id":15,"type":"double"},"isCdnCached":{"options":{"proto3_optional":true},"id":24,
+"type":"bool"},"requestStart":{"id":16,"type":"double"},"startTime":{"id":2,"type":"double"},"fetchStart":{"id":10,"type":"double"},"srvReqId":{"id":29,"type":"string"},"reqBatchCount":{"options":{"proto3_optional":true},"id":27,"type":"uint32"},"renderBlockingStatus":{"options":{"proto3_optional":true},"id":6,"type":"string"},"workerStart":{"id":7,"type":"double"},"responseStart":{"id":17,"type":"double"},"xhrDelay":{"options":{"proto3_optional":true},"id":30,"type":"double"},"domainLookupStart":{"id":11,
+"type":"double"},"responseStatus":{"id":23,"type":"uint32"},"redirectEnd":{"id":9,"type":"double"},"transferSize":{"id":20,"type":"uint32"},"srvDuration":{"options":{"proto3_optional":true},"id":26,"type":"double"},"dbDuration":{"options":{"proto3_optional":true},"id":25,"type":"double"},"connectStart":{"id":13,"type":"double"},"secureConnectionStart":{"id":14,"type":"double"},"name":{"id":1,"type":"string"},"nextHopProtocol":{"id":5,"type":"string"},"initiatorType":{"id":4,"type":"string"}}}}}}}}}};
+
+class FuzzyMapper {
+    constructor(_fuzzyKeyRange) {
+        this._fuzzyKeyRange = _fuzzyKeyRange;
+        this._map = new Map();
+        utility.requireArgument(_fuzzyKeyRange, '_fuzzyKeyRange', 'number');
+    }
+    add(key, fuzzyKey, value) {
+        const mapValue = this._map.get(key);
+        if (mapValue) {
+            mapValue.push({ fuzzyKey, value });
+        }
+        else {
+            this._map.set(key, [{ fuzzyKey, value }]);
+        }
+    }
+    pop(key, fuzzyKey) {
+        const mapValues = this._map.get(key);
+        if ((mapValues === null || mapValues === void 0 ? void 0 : mapValues.length) >= 1) {
+            let minDelta = Number.POSITIVE_INFINITY;
+            let minIndex = -1;
+            for (let index = 0; index < mapValues.length; index++) {
+                const { fuzzyKey: curFuzzyKey } = mapValues[index];
+                const curDelta = Math.abs(curFuzzyKey - fuzzyKey);
+                if (curDelta <= this._fuzzyKeyRange && curDelta < minDelta) {
+                    minDelta = curDelta;
+                    minIndex = index;
+                }
+            }
+            if (minIndex >= 0) {
+                const { value } = mapValues.splice(minIndex, 1)[0];
+                if (mapValues.length === 0) {
+                    this._map.delete(key);
+                }
+                return value;
+            }
+        }
+        return undefined;
+    }
+    clear() {
+        this._map.clear();
+    }
+}
+
+const basicInitiatorTypes = ['fetch', 'xmlhttprequest'];
+class PerformanceObservability {
+    constructor(_instr, _logPerformanceActivityName, logLevel) {
+        this._instr = _instr;
+        this._logPerformanceActivityName = _logPerformanceActivityName;
+        this._fuzzyMapper = new FuzzyMapper(50);
+        this._isStarted = false;
+        this._hasPerf =
+            typeof performance !== 'undefined' && typeof PerformanceObserver === 'function';
+        this._boundOobserverCallback = this._logPerformanceEntries.bind(this);
+        if (!logLevel || logLevel.toLowerCase() === 'full') {
+            this._logLevel = 1;
+        }
+        else if ((logLevel === null || logLevel === void 0 ? void 0 : logLevel.toLowerCase()) === 'basic') {
+            this._logLevel = 0;
+        }
+        else {
+            throw new Error(`Invalid log level: ${logLevel}`);
+        }
+    }
+    get isStarted() {
+        return this._isStarted;
+    }
+    get logLevel() {
+        return this._logLevel;
+    }
+    start() {
+        if (!this._hasPerf) {
+            return;
+        }
+        if (!this._isStarted) {
+            this._isStarted = true;
+            this._navigationObserver = new PerformanceObserver(this._boundOobserverCallback);
+            this._navigationObserver.observe({ type: 'navigation', buffered: true });
+            this._resourceObserver = new PerformanceObserver(this._boundOobserverCallback);
+            this._resourceObserver.observe({ type: 'resource', buffered: true });
+        }
+    }
+    stop() {
+        if (this._resourceObserver) {
+            this._resourceObserver.disconnect();
+            this._resourceObserver = undefined;
+        }
+        if (this._navigationObserver) {
+            this._navigationObserver.disconnect();
+            this._navigationObserver = undefined;
+        }
+        this._fuzzyMapper.clear();
+        this._isStarted = false;
+    }
+    addEntry(url, perfTime, data) {
+        this._fuzzyMapper.add(url, perfTime, data);
+    }
+    _resourceEntryToResourceTiming(prt) {
+        var _a, _b;
+        const rt = {
+            name: prt.name,
+            startTime: prt.startTime,
+            duration: prt.duration,
+            initiatorType: prt.initiatorType,
+            nextHopProtocol: prt.nextHopProtocol,
+            renderBlockingStatus: prt.renderBlockingStatus,
+            workerStart: prt.workerStart,
+            redirectStart: prt.redirectStart,
+            redirectEnd: prt.redirectEnd,
+            fetchStart: prt.fetchStart,
+            domainLookupStart: prt.domainLookupStart,
+            domainLookupEnd: prt.domainLookupEnd,
+            connectStart: prt.connectStart,
+            secureConnectionStart: prt.secureConnectionStart,
+            connectEnd: prt.connectEnd,
+            requestStart: prt.requestStart,
+            responseStart: prt.responseStart,
+            firstInterimResponseStart: prt.firstInterimResponseStart,
+            responseEnd: prt.responseEnd,
+            transferSize: prt.transferSize,
+            encodedBodySize: prt.encodedBodySize,
+            decodedBodySize: prt.decodedBodySize,
+            responseStatus: prt.responseStatus
+        };
+        const sts = prt.serverTiming;
+        if (Array.isArray(sts)) {
+            rt.dbDuration = (_a = sts.find((st) => st.name === 'db')) === null || _a === void 0 ? void 0 : _a.duration;
+            rt.srvDuration = (_b = sts.find((st) => st.name === 'Total')) === null || _b === void 0 ? void 0 : _b.duration;
+        }
+        return rt;
+    }
+    _shouldInclude(entry) {
+        if (this._logLevel === 1) {
+            return true;
+        }
+        return (basicInitiatorTypes.indexOf(entry.initiatorType) >= 0 ||
+            entry.entryType === 'navigation');
+    }
+    _logActivity(schema, payload) {
+        const options = {
+            perfStartOverride: payload.startTime,
+            perfStopOverride: payload.startTime + payload.duration
+        };
+        this._instr.startActivity(this._logPerformanceActivityName).stop(schema, payload, options);
+    }
+    _logPerformanceEntries(list) {
+        for (const entry of list.getEntriesByType('navigation')) {
+            const nt = entry;
+            if (this._shouldInclude(nt)) {
+                if (nt !== this._navTiming) {
+                    this._navTiming = nt;
+                    const payload = this._resourceEntryToResourceTiming(nt);
+                    const navOnly = {
+                        domComplete: nt.domComplete,
+                        domContentLoadedEventStart: nt.domContentLoadedEventStart,
+                        domContentLoadedEventEnd: nt.domContentLoadedEventEnd,
+                        domInteractive: nt.domInteractive,
+                        loadEventStart: nt.loadEventStart,
+                        loadEventEnd: nt.loadEventEnd,
+                        redirectCount: nt.redirectCount,
+                        type: nt.type,
+                        unloadEventStart: nt.unloadEventStart,
+                        unloadEventEnd: nt.unloadEventEnd
+                    };
+                    this._logActivity(navigation_timing, Object.assign(payload, navOnly));
+                }
+                break;
+            }
+        }
+        for (const entry of list.getEntriesByType('resource')) {
+            const rt = entry;
+            if (this._shouldInclude(rt)) {
+                const payload = this._resourceEntryToResourceTiming(rt);
+                const requestInfo = this._fuzzyMapper.pop(rt.name, rt.startTime);
+                Object.assign(payload, {
+                    srvReqId: requestInfo === null || requestInfo === void 0 ? void 0 : requestInfo.requestId,
+                    xhrDelay: requestInfo
+                        ? requestInfo.activityDuration - (rt.startTime + rt.duration)
+                        : undefined
+                });
+                this._logActivity(resource_timing, payload);
+            }
+        }
+    }
+}
+
 const defaultTraceIdLengthW3 = 32;
 const defaultTraceIdLengthB3 = 16;
 const defaultSpanIdLength = 16;
@@ -256,6 +452,7 @@ const headerTraceId = 'X-B3-TraceId';
 const headerSpanId = 'X-B3-SpanId';
 const headerSampled = 'X-B3-Sampled';
 const headerParentSpanId = 'X-B3-ParentSpanId';
+const headerRequestId = 'X-SFDC-Request-Id';
 const defaultActivityNameForFetch = 'fetch';
 const defaultActivityNameForXhrSend = 'xhr_send';
 class Tracing {
@@ -349,10 +546,14 @@ class Tracing {
                 Tracing._global.XMLHttpRequest.prototype.send = Tracing._originalXhrSend;
                 Tracing._originalXhrSend = undefined;
             }
+            if (Tracing._performanceObservability) {
+                Tracing._performanceObservability.stop();
+                Tracing._performanceObservability = undefined;
+            }
             Tracing._isNetworkInstrumentationEnabled = false;
         }
     }
-    _enableNetworkInstrumentation(instr, logErrors, activityName, useTracing, options, tasker) {
+    _enableNetworkInstrumentation(instr, logErrors, activityName, useTracing, options, tasker, logPerformance, logPerformanceActivityName) {
         if (typeof Tracing._global.fetch === 'function') {
             this._overrideFetch(instr, logErrors, activityName, useTracing, options, tasker);
             Tracing._isNetworkInstrumentationEnabled = true;
@@ -361,6 +562,11 @@ class Tracing {
             this._overrideXhr(instr, logErrors, activityName, useTracing, options, tasker);
             Tracing._isNetworkInstrumentationEnabled = true;
         }
+        if (logPerformance) {
+            Tracing._performanceObservability = new PerformanceObservability(instr, logPerformanceActivityName, logPerformance === true ? 'full' : logPerformance);
+            Tracing._performanceObservability.start();
+            Tracing._isNetworkInstrumentationEnabled = true;
+        }
     }
     static _getTraceHeaders(activity, options, method, url) {
         let traceHeaders = (activity === null || activity === void 0 ? void 0 : activity.getTraceHeaders(options)) || {};
@@ -384,12 +590,33 @@ class Tracing {
         }
         return traceHeaders || {};
     }
+    static _extractHeader(headerName, input, init) {
+        if ((init === null || init === void 0 ? void 0 : init.headers) instanceof Headers) {
+            return init.headers.get(headerName);
+        }
+        if (Array.isArray(init === null || init === void 0 ? void 0 : init.headers)) {
+            const header = init.headers.find((entry) => entry[0] === headerName);
+            return header === null || header === void 0 ? void 0 : header[1];
+        }
+        if (typeof (init === null || init === void 0 ? void 0 : init.headers) === 'object') {
+            return init.headers[headerName];
+        }
+        if (input instanceof Request) {
+            return input.headers.get(headerName);
+        }
+        return undefined;
+    }
     _overrideFetch(instr, logErrors, activityName, useTracing, tracingHeadersOptions, tasker) {
         Tracing._originalFetch = Tracing._global.fetch;
         const o11yFetch = async (resource, options, ...restArgs) => {
+            var _a;
             let activity;
+            let url;
+            let method;
+            let fetchTime;
             try {
                 tasker === null || tasker === void 0 ? void 0 : tasker.add();
+                method = options === null || options === void 0 ? void 0 : options.method;
                 const ofo = options === null || options === void 0 ? void 0 : options.o11y;
                 if (!(ofo === null || ofo === void 0 ? void 0 : ofo.skipInstr)) {
                     activity = instr.startActivity(activityName || defaultActivityNameForFetch);
@@ -407,12 +634,11 @@ class Tracing {
                             resource = urlObj.toString();
                         }
                     }
-                    catch (_a) { }
+                    catch (_b) { }
                 }
                 options === null || options === void 0 ? true : delete options.o11y;
+                url = resource === null || resource === void 0 ? void 0 : resource.toString();
                 if (useTracing) {
-                    let method = options === null || options === void 0 ? void 0 : options.method;
-                    let url = resource === null || resource === void 0 ? void 0 : resource.toString();
                     if (resource instanceof Request) {
                         if (!method) {
                             method = resource.method;
@@ -427,6 +653,7 @@ class Tracing {
                         };
                     }
                 }
+                fetchTime = utility.perfNow();
                 return await Tracing._originalFetch.call(Tracing._global, resource, options, ...restArgs);
             }
             catch (ex) {
@@ -441,16 +668,56 @@ class Tracing {
                 throw ex;
             }
             finally {
-                activity === null || activity === void 0 ? void 0 : activity.stop();
-                tasker === null || tasker === void 0 ? void 0 : tasker.done();
+                try {
+                    const activityDuration = Tracing._endActivity(activity, url, method);
+                    if ((_a = Tracing._performanceObservability) === null || _a === void 0 ? void 0 : _a.isStarted) {
+                        const requestId = Tracing._extractHeader(headerRequestId, resource, options);
+                        Tracing._performanceObservability.addEntry(url, fetchTime, {
+                            requestId,
+                            activityDuration
+                        });
+                    }
+                }
+                finally {
+                    tasker === null || tasker === void 0 ? void 0 : tasker.done();
+                }
             }
         };
         Tracing._global.fetch = o11yFetch;
     }
+    static _endActivity(activity, url, method) {
+        var _a;
+        if (activity) {
+            if (activity.getErrorCount() == 0 || ((_a = Tracing._performanceObservability) === null || _a === void 0 ? void 0 : _a.isStarted)) {
+                activity.discard();
+            }
+            else {
+                activity.stop(networkSchema, {
+                    mtd: method,
+                    url
+                });
+            }
+            return activity.getStopPerfTime() - activity.getStartPerfTime();
+        }
+        return undefined;
+    }
     _overrideXhr(instr, logErrors, activityName, useTracing, options, tasker) {
         Tracing._originalXhr = Tracing._global.XMLHttpRequest;
         Tracing._originalXhrOpen = Tracing._originalXhr.prototype.open;
         Tracing._originalXhrSend = Tracing._originalXhr.prototype.send;
+        function postProcess(xhr, failedAtInit) {
+            var _a;
+            if (xhr._o11y) {
+                const activityDuration = Tracing._endActivity(xhr._o11y.activity, xhr._o11y.url, xhr._o11y.method);
+                if (!failedAtInit && ((_a = Tracing._performanceObservability) === null || _a === void 0 ? void 0 : _a.isStarted)) {
+                    const requestId = xhr.getResponseHeader(headerRequestId);
+                    Tracing._performanceObservability.addEntry(xhr._o11y.url, xhr._o11y.sendTime, {
+                        requestId,
+                        activityDuration
+                    });
+                }
+            }
+        }
         Tracing._originalXhr.prototype.open = function (method, url, async, username, password) {
             this._o11y = {
                 method,
@@ -460,9 +727,9 @@ class Tracing {
         };
         Tracing._originalXhr.prototype.send = function (...args) {
             let activity;
+            const xhr = this;
             try {
                 tasker === null || tasker === void 0 ? void 0 : tasker.add();
-                const xhr = this;
                 xhr._o11y = xhr._o11y || {};
                 xhr._o11y.activity = activity = instr.startActivity(activityName || defaultActivityNameForXhrSend);
                 if (useTracing) {
@@ -471,6 +738,7 @@ class Tracing {
                         xhr.setRequestHeader(entry[0], entry[1]);
                     });
                 }
+                xhr._o11y.sendTime = utility.perfNow();
                 Tracing._originalXhrSend.call(this, ...args);
             }
             catch (ex) {
@@ -482,7 +750,7 @@ class Tracing {
                         instr.error(ex);
                     }
                 }
-                activity === null || activity === void 0 ? void 0 : activity.stop();
+                postProcess(xhr, true);
                 tasker === null || tasker === void 0 ? void 0 : tasker.done();
                 throw ex;
             }
@@ -491,24 +759,27 @@ class Tracing {
             construct(target) {
                 const newXhr = new target();
                 newXhr.addEventListener('load', () => {
-                    var _a, _b;
-                    (_b = (_a = newXhr._o11y) === null || _a === void 0 ? void 0 : _a.activity) === null || _b === void 0 ? void 0 : _b.stop();
+                    postProcess(newXhr);
                     tasker === null || tasker === void 0 ? void 0 : tasker.done();
                 });
                 newXhr.addEventListener('error', (__err) => {
                     var _a;
-                    const error = new Error('XHR Network-Level Error');
-                    const activity = (_a = newXhr._o11y) === null || _a === void 0 ? void 0 : _a.activity;
-                    if (activity) {
+                    try {
+                        const error = new Error('XHR Network-Level Error');
                         if (logErrors) {
-                            activity.error(error);
+                            const activity = (_a = newXhr._o11y) === null || _a === void 0 ? void 0 : _a.activity;
+                            if (activity) {
+                                activity.error(error);
+                            }
+                            else {
+                                instr.error(error);
+                            }
                         }
-                        activity.stop();
+                        postProcess(newXhr);
                     }
-                    else if (logErrors) {
-                        instr.error(error);
+                    finally {
+                        tasker === null || tasker === void 0 ? void 0 : tasker.done();
                     }
-                    tasker === null || tasker === void 0 ? void 0 : tasker.done();
                 });
                 newXhr.addEventListener('abort', () => {
                     var _a, _b;
@@ -530,7 +801,7 @@ class Tracing {
             if (utility.definedValueOrDefault(tracingOptions.useTasker, true)) {
                 tasker = (_a = this._idleDetector) === null || _a === void 0 ? void 0 : _a.declareNotifierTaskMulti('o11y network');
             }
-            this._enableNetworkInstrumentation(utility.definedValueOrDefault(tracingOptions.instrumentation, this._instr), utility.definedValueOrDefault(tracingOptions.logErrors, true), tracingOptions.activityName, utility.definedValueOrDefault(tracingOptions.useTracing, true), tracingOptions.tracingHeadersOptions, tasker);
+            this._enableNetworkInstrumentation(utility.definedValueOrDefault(tracingOptions.instrumentation, this._instr), utility.definedValueOrDefault(tracingOptions.logErrors, true), tracingOptions.activityName, utility.definedValueOrDefault(tracingOptions.useTracing, true), tracingOptions.tracingHeadersOptions, tasker, utility.definedValueOrDefault(tracingOptions.logPerformance, true), utility.definedValueOrDefault(tracingOptions.logPerformanceActivityName, 'perf-timing'));
         }
     }
     resetRequestCounter() {
@@ -767,6 +1038,9 @@ class ActivityImpl {
     getStopPerfTime() {
         return this._stopPerfTime;
     }
+    getErrorCount() {
+        return this._errorCount;
+    }
 }
 ActivityImpl._count = 0;
 
@@ -797,6 +1071,9 @@ class ActivityNoOp {
     getStopPerfTime() {
         return undefined;
     }
+    getErrorCount() {
+        return 0;
+    }
 }
 const activityNoOp = Object.freeze(new ActivityNoOp());
 
@@ -1496,6 +1773,9 @@ class RootActivityNoOp {
     getStopPerfTime() {
         return undefined;
     }
+    getErrorCount() {
+        return 0;
+    }
 }
 const rootActivityNoOp = Object.freeze(new RootActivityNoOp());
 
@@ -2159,7 +2439,7 @@ class ConsoleCollector {
     }
 }
 
-const version = '248.8.0';
+const version = '248.10.0';
 
 const idleDetector = new IdleDetectorImpl({
     logThreshold: 300,