@microsoft/sp-diagnostics 1.23.1 → 1.24.0-beta.2

package/lib-commonjs/Api/Qos/QosMonitor.js

@@ -1,165 +1,87 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-var sp_core_library_1 = require("@microsoft/sp-core-library");
-// Copyright (c) Microsoft. All rights reserved.
-var sp_core_library_2 = require("@microsoft/sp-core-library");
-var odsp_core_bundle_1 = require("@msinternal/odsp-core-bundle");
-var TraceLogger_1 = tslib_1.__importDefault(require("../Trace/TraceLogger"));
-var QosResultType_1 = require("./QosResultType");
-var QosLogger_1 = tslib_1.__importDefault(require("./QosLogger"));
-var EngagementLogger_1 = tslib_1.__importDefault(require("../Engagement/EngagementLogger"));
-var Diagnostics_1 = tslib_1.__importDefault(require("../../Diagnostics"));
-var DiagnosticsSettingsManager_1 = tslib_1.__importDefault(require("../../DiagnosticsSettingsManager"));
-var sp_lodash_subset_1 = require("@microsoft/sp-lodash-subset");
-var LOG_SOURCE = {
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return QosMonitor;
+    }
+});
+const _interop_require_default = require("@swc/helpers/_/_interop_require_default");
+const _spcorelibrary = require("@microsoft/sp-core-library");
+const _odspcorebundle = require("@msinternal/odsp-core-bundle");
+const _TraceLogger = /*#__PURE__*/ _interop_require_default._(require("../Trace/TraceLogger"));
+const _QosResultType = require("./QosResultType");
+const _QosLogger = /*#__PURE__*/ _interop_require_default._(require("./QosLogger"));
+const _EngagementLogger = /*#__PURE__*/ _interop_require_default._(require("../Engagement/EngagementLogger"));
+const _Diagnostics = /*#__PURE__*/ _interop_require_default._(require("../../Diagnostics"));
+const _DiagnosticsSettingsManager = /*#__PURE__*/ _interop_require_default._(require("../../DiagnosticsSettingsManager"));
+const _splodashsubset = require("@microsoft/sp-lodash-subset");
+const LOG_SOURCE = {
     id: 'QosMonitor'
 };
-var QOS_MONISTOR_HAS_ENDED_ERROR_STRING = "QoS monitor '{0}' has ended with '{1}' already. Ignoring '{2}' tag.";
-var AUTHORING_SESSION_ID_KEY = 'AuthoringSessionId';
-var AUTHORING_OP_SEQUENCE_ID_KEY = 'AuthoringOpSequenceId';
-var AUTHORING_SESSION_CLIENT_COUNT = 'AuthoringSessionClientCount';
-/**
- * Qos logger
- * This class represents the Qos monitor APIs
- *
- * @internal
- */
-var QosMonitor = /** @class */ (function () {
-    /**
-     * Creates a QoS monitor (initializes it and logs the start event)
-     * @param scenarioName - Unique name of the QoS scenario
-     * You will see start tag: SPPages.ScenarioName.Start
-     * @param copyToCosmos - Indicate whether this data should be used as Engagement as well, and sent to COSMOS.
-     * @param copyToInterana - Indicate whether this data should be used as Engagement as well, and sent to Interana.
-     */
-    function QosMonitor(scenarioName, copyToCosmos, copyToInterana) {
-        var _a;
-        if (copyToCosmos === void 0) { copyToCosmos = false; }
-        if (copyToInterana === void 0) { copyToInterana = false; }
-        var _this = this;
-        this._qosResultTypeValue = (_a = {},
-            _a[QosResultType_1.QosResultType.Success] = 'Success',
-            _a[QosResultType_1.QosResultType.Failure] = 'Failure',
-            _a[QosResultType_1.QosResultType.ExpectedFailure] = 'ExpectedFailure',
-            _a);
-        this._ensureAuthoringSessionId = function () {
-            var _a, _b, _c, _d;
-            var authoringSessionId = (_b = (_a = DiagnosticsSettingsManager_1.default.settings) === null || _a === void 0 ? void 0 : _a.extraDiagnosticInfo) === null || _b === void 0 ? void 0 : _b.authoringSessionId;
-            if (authoringSessionId) {
-                _this._ensureEndExtraData();
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                _this._endExtraData[AUTHORING_SESSION_ID_KEY] = authoringSessionId;
-                var authoringOpSequenceId = (_d = (_c = DiagnosticsSettingsManager_1.default.settings) === null || _c === void 0 ? void 0 : _c.extraDiagnosticInfo) === null || _d === void 0 ? void 0 : _d.authoringOpSequenceId;
-                if (authoringOpSequenceId) {
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    _this._endExtraData[AUTHORING_OP_SEQUENCE_ID_KEY] = authoringOpSequenceId;
-                }
-                var authoringSessionClientCount = Diagnostics_1.default.getAuthoringSessionClientCountInfo();
-                if (authoringSessionClientCount && _this._endExtraData) {
-                    _this._endExtraData[AUTHORING_SESSION_CLIENT_COUNT] = authoringSessionClientCount;
-                }
-            }
-        };
-        sp_core_library_2.Validate.isNonemptyString(scenarioName, 'scenarioName');
-        this._id = sp_core_library_2.Guid.newGuid().toString();
-        if (!this._isDebugSession()) {
-            QosLogger_1.default.instance.startQosMonitor(this._id, { name: scenarioName });
-        }
-        this._scenarioName = scenarioName;
-        this._hasEnded = false;
-        this._copyToCosmos = copyToCosmos;
-        this._copyToInterana = copyToInterana;
-    }
-    QosMonitor.startRealTimeProcessing = function () {
-        if (!QosLogger_1.default.instance.shouldProcessInRealTime) {
+const QOS_MONISTOR_HAS_ENDED_ERROR_STRING = "QoS monitor '{0}' has ended with '{1}' already. Ignoring '{2}' tag.";
+const AUTHORING_SESSION_ID_KEY = 'AuthoringSessionId';
+const AUTHORING_OP_SEQUENCE_ID_KEY = 'AuthoringOpSequenceId';
+const AUTHORING_SESSION_CLIENT_COUNT = 'AuthoringSessionClientCount';
+class QosMonitor {
+    static startRealTimeProcessing() {
+        if (!_QosLogger.default.instance.shouldProcessInRealTime) {
             this._shouldProcessInRealTime(true);
         }
-    };
+    }
     /**
-     * Only used in unit tests
-     * @internal
-     */
-    QosMonitor._shouldProcessInRealTime = function (processInRealTime) {
-        QosLogger_1.default.instance.shouldProcessInRealTime = processInRealTime;
-    };
-    Object.defineProperty(QosMonitor.prototype, "name", {
-        get: function () {
-            return this._scenarioName;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(QosMonitor.prototype, "shortEventName", {
-        get: function () {
-            return 'Qos';
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(QosMonitor.prototype, "resultCode", {
-        get: function () {
-            return this._endResultCode;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(QosMonitor.prototype, "resultType", {
-        get: function () {
-            return this._endResult;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(QosMonitor.prototype, "extraData", {
-        get: function () {
-            return this._endExtraData;
-        },
-        set: function (value) {
-            this._endExtraData = value;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(QosMonitor.prototype, "hasEnded", {
-        get: function () {
-            return this._hasEnded;
-        },
-        enumerable: false,
-        configurable: true
-    });
+   * Only used in unit tests
+   * @internal
+   */ static _shouldProcessInRealTime(processInRealTime) {
+        _QosLogger.default.instance.shouldProcessInRealTime = processInRealTime;
+    }
+    get name() {
+        return this._scenarioName;
+    }
+    get shortEventName() {
+        return 'Qos';
+    }
+    get resultCode() {
+        return this._endResultCode;
+    }
+    get resultType() {
+        return this._endResult;
+    }
+    get extraData() {
+        return this._endExtraData;
+    }
+    set extraData(value) {
+        this._endExtraData = value;
+    }
+    get hasEnded() {
+        return this._hasEnded;
+    }
     /**
-     * QoS monitor ends with success
-     * You will see success tag: SPPages.ScenarioName.Success
-     */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    QosMonitor.prototype.writeSuccess = function (extraData) {
-        this._writeQosEnd(QosResultType_1.QosResultType.Success, undefined, undefined, extraData);
-    };
+   * QoS monitor ends with success
+   * You will see success tag: SPPages.ScenarioName.Success
+   */ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    writeSuccess(extraData) {
+        this._writeQosEnd(_QosResultType.QosResultType.Success, undefined, undefined, extraData);
+    }
     /**
-     * QoS monitor ends with failure
-     * You will see failure tag: SPPages.ScenarioName.<failuretag>.Failure.
-     * <failuretag> will be filled with param tagName
-     */
-    QosMonitor.prototype.writeUnexpectedFailure = function (tagNameSuffix, ex, 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+   * QoS monitor ends with failure
+   * You will see failure tag: SPPages.ScenarioName.<failuretag>.Failure.
+   * <failuretag> will be filled with param tagName
+   */ writeUnexpectedFailure(tagNameSuffix = 'DefaultUnexpected', ex, // eslint-disable-next-line @typescript-eslint/no-explicit-any
     extraData) {
-        if (tagNameSuffix === void 0) { tagNameSuffix = 'DefaultUnexpected'; }
-        this._writeQosEnd(QosResultType_1.QosResultType.Failure, tagNameSuffix, ex, extraData);
-    };
+        this._writeQosEnd(_QosResultType.QosResultType.Failure, tagNameSuffix, ex, extraData);
+    }
     /*
-     * QoS monitor ends with expected failure
-     * You will see success tag: ModernPublish.RenderPublishPage.<failuretag>.ExpectedFailure.
-     * <failuretag> will be filled with param tagName
-     */
-    QosMonitor.prototype.writeExpectedFailure = function (tagNameSuffix, ex, 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+   * QoS monitor ends with expected failure
+   * You will see success tag: ModernPublish.RenderPublishPage.<failuretag>.ExpectedFailure.
+   * <failuretag> will be filled with param tagName
+   */ writeExpectedFailure(tagNameSuffix = 'DefaultExpected', ex, // eslint-disable-next-line @typescript-eslint/no-explicit-any
     extraData) {
-        if (tagNameSuffix === void 0) { tagNameSuffix = 'DefaultExpected'; }
-        this._writeQosEnd(QosResultType_1.QosResultType.ExpectedFailure, tagNameSuffix, ex, extraData);
-    };
-    QosMonitor.prototype._writeQosEnd = function (resultType, tagNameSuffix, ex, 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        this._writeQosEnd(_QosResultType.QosResultType.ExpectedFailure, tagNameSuffix, ex, extraData);
+    }
+    _writeQosEnd(resultType, tagNameSuffix, ex, // eslint-disable-next-line @typescript-eslint/no-explicit-any
     extraData) {
         if (this._shouldSkip(resultType)) {
             return;
@@ -167,44 +89,40 @@ var QosMonitor = /** @class */ (function () {
         this._ensureCorrelationId(resultType, extraData);
         this._endResultCode = tagNameSuffix;
         this._endResult = resultType;
-        var errorString = !ex ? undefined : (0, odsp_core_bundle_1.getErrorMessage)(ex);
-        if (ex instanceof odsp_core_bundle_1.CustomError) {
-            var endSchema = (0, odsp_core_bundle_1.getQosEndSchemaFromError)(ex);
+        const errorString = !ex ? undefined : (0, _odspcorebundle.getErrorMessage)(ex);
+        if (ex instanceof _odspcorebundle.CustomError) {
+            const endSchema = (0, _odspcorebundle.getQosEndSchemaFromError)(ex);
             if (endSchema) {
                 endSchema.resultType = this._endResult;
                 // Make sure the extraData from `endSchema` takes priority so that
                 // extra data like correlation id from the error object is logged
                 // instead of the generic extra data from `_endExtraData`.
-                endSchema.extraData = (0, sp_lodash_subset_1.merge)({}, this._endExtraData, endSchema.extraData);
+                endSchema.extraData = (0, _splodashsubset.merge)({}, this._endExtraData, endSchema.extraData);
             }
-            QosLogger_1.default.instance.writeQosEndResult(this._id, endSchema);
-        }
-        else {
-            var endData = {
+            _QosLogger.default.instance.writeQosEndResult(this._id, endSchema);
+        } else {
+            const endData = {
                 resultCode: this._endResultCode,
                 resultType: this._endResult,
                 error: errorString,
                 extraData: this._endExtraData
             };
-            QosLogger_1.default.instance.writeQosEndResult(this._id, endData);
+            _QosLogger.default.instance.writeQosEndResult(this._id, endData);
         }
         this._writeToEngagement();
-    };
+    }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    QosMonitor.prototype._ensureCorrelationId = function (resultType, extraData) {
-        var _this = this;
+    _ensureCorrelationId(resultType, extraData) {
         if (extraData) {
             this._ensureEndExtraData();
             // Instead of slower ...[spread], copy over the incoming values manually
             // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            Object.keys(extraData).forEach(function (k) { return (_this._endExtraData[k] = extraData[k]); });
+            Object.keys(extraData).forEach((k)=>this._endExtraData[k] = extraData[k]);
         }
-        if (DiagnosticsSettingsManager_1.default.isInitialized && resultType !== QosResultType_1.QosResultType.Success) {
-            var capitalKey = 'CorrelationId';
-            var lowerKey = 'correlationId';
-            var correlationId = ((this._endExtraData &&
-                (this._endExtraData[capitalKey] || this._endExtraData[lowerKey])) ||
-                DiagnosticsSettingsManager_1.default.settings.correlationId);
+        if (_DiagnosticsSettingsManager.default.isInitialized && resultType !== _QosResultType.QosResultType.Success) {
+            const capitalKey = 'CorrelationId';
+            const lowerKey = 'correlationId';
+            const correlationId = this._endExtraData && (this._endExtraData[capitalKey] || this._endExtraData[lowerKey]) || _DiagnosticsSettingsManager.default.settings.correlationId;
             if (correlationId) {
                 if (!this._endExtraData) {
                     this._endExtraData = {};
@@ -214,27 +132,26 @@ var QosMonitor = /** @class */ (function () {
         }
         this._logHostType();
         this._ensureAuthoringSessionId();
-    };
-    QosMonitor.prototype._ensureEndExtraData = function () {
+    }
+    _ensureEndExtraData() {
         if (!this._endExtraData) {
             this._endExtraData = {};
         }
-    };
+    }
     /**
-     * Logs the application hosted in Teams in combination with which Teams application it was hosted on.
-     * Viva1p-TeamsNative: Viva home app loaded through Teams Desktop application, not including mobile
-     * Viva1p-TeamsWeb: Viva home app loaded through Teams Web browser, not including mobile
-     * MEEBridge-TeamsNative: VivaConnections MEEBridge app loaded through Teams mobile client.
-     * ClassHome-TeamsNative: ClassHome app loaded through Teams Desktop application, not including mobile
-     * ClassHome-TeamsWeb: ClassHome app loaded through Teams Web browser, not including mobile
-     */
-    QosMonitor.prototype._logHostType = function () {
-        if (DiagnosticsSettingsManager_1.default.isInitialized) {
-            var appHostType = sp_core_library_1._BrowserUtilities.getTeamsAppType();
+   * Logs the application hosted in Teams in combination with which Teams application it was hosted on.
+   * Viva1p-TeamsNative: Viva home app loaded through Teams Desktop application, not including mobile
+   * Viva1p-TeamsWeb: Viva home app loaded through Teams Web browser, not including mobile
+   * MEEBridge-TeamsNative: VivaConnections MEEBridge app loaded through Teams mobile client.
+   * ClassHome-TeamsNative: ClassHome app loaded through Teams Desktop application, not including mobile
+   * ClassHome-TeamsWeb: ClassHome app loaded through Teams Web browser, not including mobile
+   */ _logHostType() {
+        if (_DiagnosticsSettingsManager.default.isInitialized) {
+            const appHostType = _spcorelibrary._BrowserUtilities.getTeamsAppType();
             // Skip logging for default SPO path for now to limit quota impact
             if (appHostType) {
                 this._ensureEndExtraData();
-                var hostKey = 'appHostType';
+                const hostKey = 'appHostType';
                 // Unlikely, but avoid overwriting matching key value
                 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 if (!this._endExtraData[hostKey]) {
@@ -243,41 +160,38 @@ var QosMonitor = /** @class */ (function () {
                 }
             }
         }
-    };
-    QosMonitor.prototype._isDebugSession = function () {
+    }
+    _isDebugSession() {
         try {
-            if (!sp_core_library_1._SPKillSwitch.isActivated('761ccb86-4fa0-4f56-a05b-477bcc09bd9f' /* '08/01/2024', 'finnnavin: Let QoSMonitor run in debug, uploading is blocked at SDK-level.' */)) {
+            if (!_spcorelibrary._SPKillSwitch.isActivated('761ccb86-4fa0-4f56-a05b-477bcc09bd9f' /* '08/01/2024', 'finnnavin: Let QoSMonitor run in debug, uploading is blocked at SDK-level.' */ )) {
                 return false;
+            } else {
+                return !!_spcorelibrary._BrowserUtilities.safelyAccessSessionStorage('spfx-debug');
             }
-            else {
-                return !!sp_core_library_1._BrowserUtilities.safelyAccessSessionStorage('spfx-debug');
-            }
-        }
-        catch (_a) {
+        } catch  {
             // KillSwitches throw exceptions when not initialized.
             // Currently this only happens when spfx-debug is present, so telemetry isn't being logged by the handler, and we can return false.
             return false;
         }
-    };
-    QosMonitor.prototype._shouldSkip = function (result) {
+    }
+    _shouldSkip(result) {
         if (this._hasEnded && this._endResult !== undefined) {
-            var message = sp_core_library_2.Text.format(QOS_MONISTOR_HAS_ENDED_ERROR_STRING, this.name, this._qosResultTypeValue[this._endResult], this._qosResultTypeValue[result]);
+            const message = _spcorelibrary.Text.format(QOS_MONISTOR_HAS_ENDED_ERROR_STRING, this.name, this._qosResultTypeValue[this._endResult], this._qosResultTypeValue[result]);
             if (this._endResult !== result) {
-                TraceLogger_1.default.logError(LOG_SOURCE, new Error(message));
+                _TraceLogger.default.logError(LOG_SOURCE, new Error(message));
             }
             if (DEBUG) {
-                TraceLogger_1.default.logVerbose(LOG_SOURCE, message, 'skipEnd');
+                _TraceLogger.default.logVerbose(LOG_SOURCE, message, 'skipEnd');
             }
             return true;
-        }
-        else {
+        } else {
             this._hasEnded = true;
             return this._isDebugSession();
         }
-    };
-    QosMonitor.prototype._writeToEngagement = function () {
+    }
+    _writeToEngagement() {
         if (this._copyToInterana) {
-            EngagementLogger_1.default.log({
+            _EngagementLogger.default.log({
                 name: this.name,
                 isIntentional: !!(this.extraData || {}).isIntentional,
                 extraData: this.extraData || {}
@@ -287,7 +201,7 @@ var QosMonitor = /** @class */ (function () {
             // Engagement name requires certain format. Cannot just use QOS name.
             // Record Qos name in extra data 'qosName'
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            var engagementData = {
+            const engagementData = {
                 name: 'Spfx.Qos.ToEngagement',
                 extraData: this.extraData || {}
             };
@@ -298,10 +212,50 @@ var QosMonitor = /** @class */ (function () {
             if (this.resultCode) {
                 engagementData.extraData.qosResultCode = this.resultCode;
             }
-            EngagementLogger_1.default.log(engagementData);
+            _EngagementLogger.default.log(engagementData);
         }
-    };
-    return QosMonitor;
-}());
-exports.default = QosMonitor;
-//# sourceMappingURL=QosMonitor.js.map
+    }
+    /**
+   * Creates a QoS monitor (initializes it and logs the start event)
+   * @param scenarioName - Unique name of the QoS scenario
+   * You will see start tag: SPPages.ScenarioName.Start
+   * @param copyToCosmos - Indicate whether this data should be used as Engagement as well, and sent to COSMOS.
+   * @param copyToInterana - Indicate whether this data should be used as Engagement as well, and sent to Interana.
+   */ constructor(scenarioName, copyToCosmos = false, copyToInterana = false){
+        this._qosResultTypeValue = {
+            [_QosResultType.QosResultType.Success]: 'Success',
+            [_QosResultType.QosResultType.Failure]: 'Failure',
+            [_QosResultType.QosResultType.ExpectedFailure]: 'ExpectedFailure'
+        };
+        this._ensureAuthoringSessionId = ()=>{
+            const authoringSessionId = _DiagnosticsSettingsManager.default.settings?.extraDiagnosticInfo?.authoringSessionId;
+            if (authoringSessionId) {
+                this._ensureEndExtraData();
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                this._endExtraData[AUTHORING_SESSION_ID_KEY] = authoringSessionId;
+                const authoringOpSequenceId = _DiagnosticsSettingsManager.default.settings?.extraDiagnosticInfo?.authoringOpSequenceId;
+                if (authoringOpSequenceId) {
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    this._endExtraData[AUTHORING_OP_SEQUENCE_ID_KEY] = authoringOpSequenceId;
+                }
+                const authoringSessionClientCount = _Diagnostics.default.getAuthoringSessionClientCountInfo();
+                if (authoringSessionClientCount && this._endExtraData) {
+                    this._endExtraData[AUTHORING_SESSION_CLIENT_COUNT] = authoringSessionClientCount;
+                }
+            }
+        };
+        _spcorelibrary.Validate.isNonemptyString(scenarioName, 'scenarioName');
+        this._id = _spcorelibrary.Guid.newGuid().toString();
+        if (!this._isDebugSession()) {
+            _QosLogger.default.instance.startQosMonitor(this._id, {
+                name: scenarioName
+            });
+        }
+        this._scenarioName = scenarioName;
+        this._hasEnded = false;
+        this._copyToCosmos = copyToCosmos;
+        this._copyToInterana = copyToInterana;
+    }
+}
+
+//# sourceMappingURL=./QosMonitor.js.map