o11y 248.9.0 → 248.11.0

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

@@ -1,5 +1,5 @@
-import { networkSchema, simpleSchema, errorSchema, activitySchema, instrumentedEventSchema, idleDetectorReportSchema } from 'o11y_schema/sf_instrumentation';
-import { utility, PublicSafety, schemaUtil, maxStringLengthAppLimit, metricsUtility, payloadUtility } from 'o11y/shared';
+import { networkSchema, simpleSchema, payloadDiagsSchema, errorSchema, activitySchema, instrumentedEventSchema, idleDetectorReportSchema } from 'o11y_schema/sf_instrumentation';
+import { utility, PublicSafety, schemaUtil, maxStringLengthAppLimit, payloadUtility, metricsUtility } from 'o11y/shared';
 
 class TaskerImpl {
     get isBusy() {
@@ -247,10 +247,16 @@ class IdleDetectorImpl {
     }
 }
 
-const network_request={namespace:"sfcore.network",name:"NetworkRequest",pbjsSchema:{"nested":{"sfcore":{"nested":{"network":{"nested":{"NetworkRequest":{"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"}}}}}}}}}};
+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) {
@@ -296,15 +302,15 @@ class FuzzyMapper {
 }
 
 const basicInitiatorTypes = ['fetch', 'xmlhttprequest'];
-class PerformanceOfResources {
-    constructor(_instr, _logResourceTimingActivityName, logLevel) {
+class PerformanceObservability {
+    constructor(_instr, _logPerformanceActivityName, logLevel) {
         this._instr = _instr;
-        this._logResourceTimingActivityName = _logResourceTimingActivityName;
+        this._logPerformanceActivityName = _logPerformanceActivityName;
         this._fuzzyMapper = new FuzzyMapper(50);
         this._isStarted = false;
         this._hasPerf =
             typeof performance !== 'undefined' && typeof PerformanceObserver === 'function';
-        this._observerCallback = this._logResourceTimingEntries.bind(this);
+        this._boundOobserverCallback = this._logPerformanceEntries.bind(this);
         if (!logLevel || logLevel.toLowerCase() === 'full') {
             this._logLevel = 1;
         }
@@ -318,20 +324,29 @@ class PerformanceOfResources {
     get isStarted() {
         return this._isStarted;
     }
+    get logLevel() {
+        return this._logLevel;
+    }
     start() {
         if (!this._hasPerf) {
             return;
         }
         if (!this._isStarted) {
             this._isStarted = true;
-            this._observer = new PerformanceObserver(this._observerCallback);
-            this._observer.observe({ entryTypes: ['resource'], buffered: 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._observer) {
-            this._observer.disconnect();
-            this._observer = undefined;
+        if (this._resourceObserver) {
+            this._resourceObserver.disconnect();
+            this._resourceObserver = undefined;
+        }
+        if (this._navigationObserver) {
+            this._navigationObserver.disconnect();
+            this._navigationObserver = undefined;
         }
         this._fuzzyMapper.clear();
         this._isStarted = false;
@@ -339,10 +354,9 @@ class PerformanceOfResources {
     addEntry(url, perfTime, data) {
         this._fuzzyMapper.add(url, perfTime, data);
     }
-    _resourceEntryToNetworkType(prt) {
+    _resourceEntryToResourceTiming(prt) {
         var _a, _b;
-        const requestInfo = this._fuzzyMapper.pop(prt.name, prt.startTime);
-        const nr = {
+        const rt = {
             name: prt.name,
             startTime: prt.startTime,
             duration: prt.duration,
@@ -365,36 +379,65 @@ class PerformanceOfResources {
             transferSize: prt.transferSize,
             encodedBodySize: prt.encodedBodySize,
             decodedBodySize: prt.decodedBodySize,
-            responseStatus: prt.responseStatus,
-            srvReqId: requestInfo === null || requestInfo === void 0 ? void 0 : requestInfo.requestId,
-            xhrDelay: requestInfo
-                ? requestInfo.activityDuration - (prt.startTime + prt.duration)
-                : undefined
+            responseStatus: prt.responseStatus
         };
         const sts = prt.serverTiming;
         if (Array.isArray(sts)) {
-            nr.dbDuration = (_a = sts.find((st) => st.name === 'db')) === null || _a === void 0 ? void 0 : _a.duration;
-            nr.srvDuration = (_b = sts.find((st) => st.name === 'Total')) === null || _b === void 0 ? void 0 : _b.duration;
+            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 nr;
+        return rt;
     }
     _shouldInclude(entry) {
         if (this._logLevel === 1) {
             return true;
         }
-        return basicInitiatorTypes.indexOf(entry.initiatorType) >= 0;
+        return (basicInitiatorTypes.indexOf(entry.initiatorType) >= 0 ||
+            entry.entryType === 'navigation');
     }
-    _logResourceTimingEntries(list) {
+    _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')) {
-            if (this._shouldInclude(entry)) {
-                const payload = this._resourceEntryToNetworkType(entry);
-                const options = {
-                    perfStartOverride: payload.startTime,
-                    perfStopOverride: payload.startTime + payload.duration
-                };
-                this._instr
-                    .startActivity(this._logResourceTimingActivityName)
-                    .stop(network_request, payload, options);
+            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);
             }
         }
     }
@@ -503,14 +546,14 @@ class Tracing {
                 Tracing._global.XMLHttpRequest.prototype.send = Tracing._originalXhrSend;
                 Tracing._originalXhrSend = undefined;
             }
-            if (Tracing._performanceOfResources) {
-                Tracing._performanceOfResources.stop();
-                Tracing._performanceOfResources = undefined;
+            if (Tracing._performanceObservability) {
+                Tracing._performanceObservability.stop();
+                Tracing._performanceObservability = undefined;
             }
             Tracing._isNetworkInstrumentationEnabled = false;
         }
     }
-    _enableNetworkInstrumentation(instr, logErrors, activityName, useTracing, options, tasker, logResourceTiming, logResourceTimingActivityName) {
+    _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;
@@ -519,9 +562,9 @@ class Tracing {
             this._overrideXhr(instr, logErrors, activityName, useTracing, options, tasker);
             Tracing._isNetworkInstrumentationEnabled = true;
         }
-        if (logResourceTiming) {
-            Tracing._performanceOfResources = new PerformanceOfResources(instr, logResourceTimingActivityName, logResourceTiming === true ? 'full' : logResourceTiming);
-            Tracing._performanceOfResources.start();
+        if (logPerformance) {
+            Tracing._performanceObservability = new PerformanceObservability(instr, logPerformanceActivityName, logPerformance === true ? 'full' : logPerformance);
+            Tracing._performanceObservability.start();
             Tracing._isNetworkInstrumentationEnabled = true;
         }
     }
@@ -627,9 +670,9 @@ class Tracing {
             finally {
                 try {
                     const activityDuration = Tracing._endActivity(activity, url, method);
-                    if ((_a = Tracing._performanceOfResources) === null || _a === void 0 ? void 0 : _a.isStarted) {
+                    if ((_a = Tracing._performanceObservability) === null || _a === void 0 ? void 0 : _a.isStarted) {
                         const requestId = Tracing._extractHeader(headerRequestId, resource, options);
-                        Tracing._performanceOfResources.addEntry(url, fetchTime, {
+                        Tracing._performanceObservability.addEntry(url, fetchTime, {
                             requestId,
                             activityDuration
                         });
@@ -645,7 +688,7 @@ class Tracing {
     static _endActivity(activity, url, method) {
         var _a;
         if (activity) {
-            if (activity.getErrorCount() == 0 || ((_a = Tracing._performanceOfResources) === null || _a === void 0 ? void 0 : _a.isStarted)) {
+            if (activity.getErrorCount() == 0 || ((_a = Tracing._performanceObservability) === null || _a === void 0 ? void 0 : _a.isStarted)) {
                 activity.discard();
             }
             else {
@@ -666,9 +709,9 @@ class Tracing {
             var _a;
             if (xhr._o11y) {
                 const activityDuration = Tracing._endActivity(xhr._o11y.activity, xhr._o11y.url, xhr._o11y.method);
-                if (!failedAtInit && ((_a = Tracing._performanceOfResources) === null || _a === void 0 ? void 0 : _a.isStarted)) {
+                if (!failedAtInit && ((_a = Tracing._performanceObservability) === null || _a === void 0 ? void 0 : _a.isStarted)) {
                     const requestId = xhr.getResponseHeader(headerRequestId);
-                    Tracing._performanceOfResources.addEntry(xhr._o11y.url, xhr._o11y.sendTime, {
+                    Tracing._performanceObservability.addEntry(xhr._o11y.url, xhr._o11y.sendTime, {
                         requestId,
                         activityDuration
                     });
@@ -758,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, utility.definedValueOrDefault(tracingOptions.logResourceTiming, true), utility.definedValueOrDefault(tracingOptions.logResourceTimingActivityName, 'perf-res-timing'));
+            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() {
@@ -1454,7 +1497,16 @@ class InstrumentationImpl {
         });
     }
     _logInternal(loggerName, schema, data, timestamp, rootId) {
-        return this._nextGen.addLog(loggerName, schema, data, timestamp, rootId);
+        const sequence = this._nextGen.addLog(loggerName, schema, data, timestamp, rootId);
+        if (!utility.isProduction) {
+            const extraFields = payloadUtility.getExtraFields(schema, data);
+            if (!utility.isProduction && extraFields.length > 0) {
+                this.error('Extra fields', payloadDiagsSchema, {
+                    extras: extraFields
+                });
+            }
+        }
+        return sequence;
     }
     error(error, userSchemaOrText, userData, options) {
         return this._safety.tryCatch(() => {
@@ -2358,6 +2410,7 @@ class Index {
 }
 const time = utility.time.bind(utility);
 
+const lightningLoggerSchemaId = 'sfcore.customCmp.CustomComponentLog';
 const bgColorMap = {
     Error: 'Crimson',
     Activity: 'CadetBlue',
@@ -2374,29 +2427,75 @@ const defaultColor = 'black';
 const defaultBgColor = 'Gainsboro';
 class ConsoleCollector {
     constructor(environment) {
+        this._simpleFilters = new Set();
+        this._regexFilters = [];
         if (environment) {
             this._log('ConsoleCollector', environment);
         }
     }
     collect(schema, data, logMeta) {
+        const id = schemaUtil.getSchemaId(schema);
+        if (!this._shouldLog(id)) {
+            return;
+        }
+        if (id === lightningLoggerSchemaId) {
+            this._logCustom(data);
+            return;
+        }
         let label, color, bgColor;
-        if (schema.namespace === 'sf.instrumentation') {
+        if (schemaUtil.isInternal(schema)) {
             label = schema.name;
             color = colorMap[schema.name] || defaultColor;
             bgColor = bgColorMap[schema.name] || defaultBgColor;
         }
         else {
-            label = schemaUtil.getSchemaId(schema);
+            label = id;
         }
         this._log(label, data, logMeta, color, bgColor);
     }
+    _shouldLog(schemaId) {
+        if (this._simpleFilters.size == 0 && this._regexFilters.length == 0) {
+            return true;
+        }
+        return (this._simpleFilters.has(schemaId) || this._regexFilters.some((r) => r.test(schemaId)));
+    }
+    addFilter(filter) {
+        if (filter instanceof RegExp) {
+            this._regexFilters.push(filter);
+        }
+        else {
+            this._simpleFilters.add(filter);
+        }
+    }
+    removeFilter(filter) {
+        if (filter instanceof RegExp) {
+            const index = this._regexFilters.findIndex((r) => r.source === filter.source);
+            if (index >= 0) {
+                this._regexFilters.splice(index, 1);
+            }
+        }
+        else {
+            this._simpleFilters.delete(filter);
+        }
+    }
+    clearFilters() {
+        this._simpleFilters.clear();
+        this._regexFilters.splice(0, this._regexFilters.length);
+    }
+    getFilters() {
+        const filters = Array.from(this._simpleFilters);
+        return filters.concat(this._regexFilters).sort();
+    }
     _log(label, first, second, color = defaultColor, bgColor = defaultBgColor) {
         const css = `color:${color};background-color:${bgColor}`;
         console.log(`%cO11Y%c ${label}`, 'color:white;background-color:#FF6600;font-weight:bold', css, first || '', second || '');
     }
+    _logCustom(data) {
+        console.log('%clightning/logger', 'color:white;background-color:#00a1e0;font-weight:bold', data || '');
+    }
 }
 
-const version = '248.9.0';
+const version = '248.11.0';
 
 const idleDetector = new IdleDetectorImpl({
     logThreshold: 300,