@microsoft/sp-diagnostics 1.22.0-beta.2 → 1.22.0-beta.4

package/lib/Api/Qos/QosLogger.d.ts

@@ -0,0 +1,27 @@
+import type { IQos } from './IQos';
+import type { IQosStartEvent } from './IQosStartEvent';
+import type { IQosEndSchema } from '@msinternal/odsp-core-bundle';
+export type QosConstructor = new (event: IQosStartEvent) => IQos;
+/**
+ * QosLogger allows multiple QosMonitors to be deferred processed.
+ * @internal
+ */
+export default class QosLogger {
+    private static _instance;
+    private _qosEvents;
+    private _deferExecutor;
+    private _shouldProcessInRealTime;
+    private _qosLogger;
+    static get instance(): QosLogger;
+    constructor();
+    get shouldProcessInRealTime(): boolean;
+    set shouldProcessInRealTime(processInRealTime: boolean);
+    setLogger(qosLogger: new (event: IQosStartEvent) => IQos): void;
+    getQosEvent(key: string): IQos | undefined;
+    startQosMonitor(key: string, startData: IQosStartEvent): void;
+    writeQosEndResult(key: string, endData: IQosEndSchema): void;
+    private _startMonitor;
+    private _endMonitor;
+    private _initializeLogger;
+}
+//# sourceMappingURL=QosLogger.d.ts.map

package/lib/Api/Qos/QosLogger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QosLogger.d.ts","sourceRoot":"","sources":["../../../src/Api/Qos/QosLogger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAElE,MAAM,MAAM,cAAc,GAAG,KAAK,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;AAEjE;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,SAAS;IAC5B,OAAO,CAAC,MAAM,CAAC,SAAS,CAAY;IAEpC,OAAO,CAAC,UAAU,CAA8C;IAChE,OAAO,CAAC,cAAc,CAAwC;IAC9D,OAAO,CAAC,wBAAwB,CAAkB;IAClD,OAAO,CAAC,UAAU,CAA6B;IAE/C,WAAkB,QAAQ,IAAI,SAAS,CAMtC;;IAMD,IAAW,uBAAuB,IAAI,OAAO,CAE5C;IAED,IAAW,uBAAuB,CAAC,iBAAiB,EAAE,OAAO,EAG5D;IAEM,SAAS,CAAC,SAAS,EAAE,KAAK,KAAK,EAAE,cAAc,KAAK,IAAI,GAAG,IAAI;IAI/D,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAI1C,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,cAAc,GAAG,IAAI;IAM7D,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,IAAI;IAInE,OAAO,CAAC,aAAa;IAMrB,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,iBAAiB;CAU1B"}

package/lib/Api/Qos/QosLogger.js

@@ -0,0 +1,74 @@
+import ExecutionQueue from '../ExecutionQueue';
+/**
+ * QosLogger allows multiple QosMonitors to be deferred processed.
+ * @internal
+ */
+var QosLogger = /** @class */ (function () {
+    function QosLogger() {
+        this._qosEvents = new Map();
+        this._deferExecutor = new ExecutionQueue();
+        this._shouldProcessInRealTime = false;
+        this._initializeLogger();
+    }
+    Object.defineProperty(QosLogger, "instance", {
+        get: function () {
+            if (!this._instance) {
+                this._instance = new QosLogger();
+            }
+            return this._instance;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(QosLogger.prototype, "shouldProcessInRealTime", {
+        get: function () {
+            return this._shouldProcessInRealTime;
+        },
+        set: function (processInRealTime) {
+            this._shouldProcessInRealTime = processInRealTime;
+            this._deferExecutor.shouldExecuteInRealTime = processInRealTime;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    QosLogger.prototype.setLogger = function (qosLogger) {
+        this._qosLogger = qosLogger;
+    };
+    QosLogger.prototype.getQosEvent = function (key) {
+        return this._qosEvents.get(key);
+    };
+    QosLogger.prototype.startQosMonitor = function (key, startData) {
+        if (!this._qosEvents.has(key)) {
+            this._deferExecutor.addExecutionEntry('start', key, startData);
+        }
+    };
+    QosLogger.prototype.writeQosEndResult = function (key, endData) {
+        this._deferExecutor.addExecutionEntry('end', key, endData);
+    };
+    QosLogger.prototype._startMonitor = function (key, event) {
+        if (this._qosLogger) {
+            this._qosEvents.set(key, new this._qosLogger(event));
+        }
+    };
+    QosLogger.prototype._endMonitor = function (key, event) {
+        var qosEvent = this._qosEvents.get(key);
+        if (qosEvent) {
+            qosEvent.end(event);
+            this._qosEvents.delete(key);
+        }
+    };
+    QosLogger.prototype._initializeLogger = function () {
+        var _this = this;
+        var startHandler = (function (key, e) {
+            _this._startMonitor(key, e);
+        });
+        var endHandler = (function (key, e) {
+            _this._endMonitor(key, e);
+        });
+        this._deferExecutor.addHandler('start', startHandler);
+        this._deferExecutor.addHandler('end', endHandler);
+    };
+    return QosLogger;
+}());
+export default QosLogger;
+//# sourceMappingURL=QosLogger.js.map

package/lib/Api/Qos/QosMonitor.d.ts

@@ -0,0 +1,74 @@
+import { QosResultType } from './QosResultType';
+/**
+ * Qos logger
+ * This class represents the Qos monitor APIs
+ *
+ * @internal
+ */
+export default class QosMonitor {
+    private _id;
+    private _hasEnded;
+    private _endExtraData;
+    private _scenarioName;
+    private _endResultCode;
+    private _endResult;
+    private _copyToCosmos;
+    private _copyToInterana;
+    private _qosResultTypeValue;
+    static startRealTimeProcessing(): void;
+    /**
+     * Only used in unit tests
+     * @internal
+     */
+    static _shouldProcessInRealTime(processInRealTime: boolean): void;
+    /**
+     * 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: string, copyToCosmos?: boolean, copyToInterana?: boolean);
+    get name(): string;
+    get shortEventName(): string;
+    get resultCode(): string | undefined;
+    get resultType(): QosResultType | undefined;
+    get extraData(): Record<string, unknown> | undefined;
+    set extraData(value: Record<string, unknown> | undefined);
+    get hasEnded(): boolean;
+    /**
+     * QoS monitor ends with success
+     * You will see success tag: SPPages.ScenarioName.Success
+     */
+    writeSuccess(extraData?: {
+        [key: string]: any;
+    }): void;
+    /**
+     * QoS monitor ends with failure
+     * You will see failure tag: SPPages.ScenarioName.<failuretag>.Failure.
+     * <failuretag> will be filled with param tagName
+     */
+    writeUnexpectedFailure(tagNameSuffix?: string, ex?: Error, extraData?: {
+        [key: string]: any;
+    }): void;
+    writeExpectedFailure(tagNameSuffix?: string, ex?: Error, extraData?: {
+        [key: string]: any;
+    }): void;
+    private _writeQosEnd;
+    private _ensureCorrelationId;
+    private _ensureAuthoringSessionId;
+    private _ensureEndExtraData;
+    /**
+     * 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
+     */
+    private _logHostType;
+    private _isDebugSession;
+    private _shouldSkip;
+    private _writeToEngagement;
+}
+//# sourceMappingURL=QosMonitor.d.ts.map

package/lib/Api/Qos/QosMonitor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QosMonitor.d.ts","sourceRoot":"","sources":["../../../src/Api/Qos/QosMonitor.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAkBhD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,aAAa,CAAsC;IAC3D,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,cAAc,CAAqB;IAC3C,OAAO,CAAC,UAAU,CAA4B;IAC9C,OAAO,CAAC,aAAa,CAAU;IAC/B,OAAO,CAAC,eAAe,CAAU;IACjC,OAAO,CAAC,mBAAmB,CAIzB;WAEY,uBAAuB,IAAI,IAAI;IAM7C;;;OAGG;WACW,wBAAwB,CAAC,iBAAiB,EAAE,OAAO,GAAG,IAAI;IAIxE;;;;;;OAMG;gBACgB,YAAY,EAAE,MAAM,EAAE,YAAY,GAAE,OAAe,EAAE,cAAc,GAAE,OAAe;IAevG,IAAW,IAAI,IAAI,MAAM,CAExB;IAED,IAAW,cAAc,IAAI,MAAM,CAElC;IAED,IAAW,UAAU,IAAI,MAAM,GAAG,SAAS,CAE1C;IAED,IAAW,UAAU,IAAI,aAAa,GAAG,SAAS,CAEjD;IAED,IAAW,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAE1D;IAED,IAAW,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,EAE9D;IAED,IAAW,QAAQ,IAAI,OAAO,CAE7B;IAED;;;OAGG;IAEI,YAAY,CAAC,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,IAAI;IAI7D;;;;OAIG;IACI,sBAAsB,CAC3B,aAAa,GAAE,MAA4B,EAC3C,EAAE,CAAC,EAAE,KAAK,EAEV,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GACjC,IAAI;IASA,oBAAoB,CACzB,aAAa,GAAE,MAA0B,EACzC,EAAE,CAAC,EAAE,KAAK,EAEV,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GACjC,IAAI;IAIP,OAAO,CAAC,YAAY;IAyCpB,OAAO,CAAC,oBAAoB;IA4B5B,OAAO,CAAC,yBAAyB,CAuB/B;IAEF,OAAO,CAAC,mBAAmB;IAM3B;;;;;;;OAOG;IACH,OAAO,CAAC,YAAY;IAiBpB,OAAO,CAAC,eAAe;IAkBvB,OAAO,CAAC,WAAW;IAsBnB,OAAO,CAAC,kBAAkB;CA4B3B"}

package/lib/Api/Qos/QosMonitor.js

@@ -0,0 +1,304 @@
+import { _BrowserUtilities, _SPKillSwitch } from '@microsoft/sp-core-library';
+// Copyright (c) Microsoft. All rights reserved.
+import { Guid, Text, Validate } from '@microsoft/sp-core-library';
+import { getErrorMessage, getQosEndSchemaFromError, CustomError } from '@msinternal/odsp-core-bundle';
+import TraceLogger from '../Trace/TraceLogger';
+import { QosResultType } from './QosResultType';
+import QosLogger from './QosLogger';
+import EngagementLogger from '../Engagement/EngagementLogger';
+import Diagnostics from '../../Diagnostics';
+import DiagnosticsSettingsManager from '../../DiagnosticsSettingsManager';
+import { merge } from '@microsoft/sp-lodash-subset';
+var 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.Success] = 'Success',
+            _a[QosResultType.Failure] = 'Failure',
+            _a[QosResultType.ExpectedFailure] = 'ExpectedFailure',
+            _a);
+        this._ensureAuthoringSessionId = function () {
+            var _a, _b, _c, _d;
+            var authoringSessionId = (_b = (_a = DiagnosticsSettingsManager.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.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.getAuthoringSessionClientCountInfo();
+                if (authoringSessionClientCount && _this._endExtraData) {
+                    _this._endExtraData[AUTHORING_SESSION_CLIENT_COUNT] = authoringSessionClientCount;
+                }
+            }
+        };
+        Validate.isNonemptyString(scenarioName, 'scenarioName');
+        this._id = Guid.newGuid().toString();
+        if (!this._isDebugSession()) {
+            QosLogger.instance.startQosMonitor(this._id, { name: scenarioName });
+        }
+        this._scenarioName = scenarioName;
+        this._hasEnded = false;
+        this._copyToCosmos = copyToCosmos;
+        this._copyToInterana = copyToInterana;
+    }
+    QosMonitor.startRealTimeProcessing = function () {
+        if (!QosLogger.instance.shouldProcessInRealTime) {
+            this._shouldProcessInRealTime(true);
+        }
+    };
+    /**
+     * Only used in unit tests
+     * @internal
+     */
+    QosMonitor._shouldProcessInRealTime = function (processInRealTime) {
+        QosLogger.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
+    });
+    /**
+     * 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.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
+    extraData) {
+        if (tagNameSuffix === void 0) { tagNameSuffix = 'DefaultUnexpected'; }
+        this._writeQosEnd(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
+    extraData) {
+        if (tagNameSuffix === void 0) { tagNameSuffix = 'DefaultExpected'; }
+        this._writeQosEnd(QosResultType.ExpectedFailure, tagNameSuffix, ex, extraData);
+    };
+    QosMonitor.prototype._writeQosEnd = function (resultType, tagNameSuffix, ex, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    extraData) {
+        if (this._shouldSkip(resultType)) {
+            return;
+        }
+        this._ensureCorrelationId(resultType, extraData);
+        this._endResultCode = tagNameSuffix;
+        this._endResult = resultType;
+        var errorString = !ex ? undefined : getErrorMessage(ex);
+        if (ex instanceof CustomError) {
+            var endSchema = 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 = merge({}, this._endExtraData, endSchema.extraData);
+            }
+            QosLogger.instance.writeQosEndResult(this._id, endSchema);
+        }
+        else {
+            var endData = {
+                resultCode: this._endResultCode,
+                resultType: this._endResult,
+                error: errorString,
+                extraData: this._endExtraData
+            };
+            QosLogger.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;
+        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]); });
+        }
+        if (DiagnosticsSettingsManager.isInitialized && resultType !== QosResultType.Success) {
+            var capitalKey = 'CorrelationId';
+            var lowerKey = 'correlationId';
+            var correlationId = ((this._endExtraData &&
+                (this._endExtraData[capitalKey] || this._endExtraData[lowerKey])) ||
+                DiagnosticsSettingsManager.settings.correlationId);
+            if (correlationId) {
+                if (!this._endExtraData) {
+                    this._endExtraData = {};
+                }
+                this._endExtraData[capitalKey] = correlationId;
+            }
+        }
+        this._logHostType();
+        this._ensureAuthoringSessionId();
+    };
+    QosMonitor.prototype._ensureEndExtraData = function () {
+        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.isInitialized) {
+            var appHostType = _BrowserUtilities.getTeamsAppType();
+            // Skip logging for default SPO path for now to limit quota impact
+            if (appHostType) {
+                this._ensureEndExtraData();
+                var hostKey = 'appHostType';
+                // Unlikely, but avoid overwriting matching key value
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                if (!this._endExtraData[hostKey]) {
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    this._endExtraData[hostKey] = appHostType;
+                }
+            }
+        }
+    };
+    QosMonitor.prototype._isDebugSession = function () {
+        try {
+            if (!_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 !!_BrowserUtilities.safelyAccessSessionStorage('spfx-debug');
+            }
+        }
+        catch (_a) {
+            // 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) {
+        if (this._hasEnded && this._endResult !== undefined) {
+            var message = Text.format(QOS_MONISTOR_HAS_ENDED_ERROR_STRING, this.name, this._qosResultTypeValue[this._endResult], this._qosResultTypeValue[result]);
+            if (this._endResult !== result) {
+                TraceLogger.logError(LOG_SOURCE, new Error(message));
+            }
+            if (DEBUG) {
+                TraceLogger.logVerbose(LOG_SOURCE, message, 'skipEnd');
+            }
+            return true;
+        }
+        else {
+            this._hasEnded = true;
+            return this._isDebugSession();
+        }
+    };
+    QosMonitor.prototype._writeToEngagement = function () {
+        if (this._copyToInterana) {
+            EngagementLogger.log({
+                name: this.name,
+                isIntentional: !!(this.extraData || {}).isIntentional,
+                extraData: this.extraData || {}
+            });
+        }
+        if (this._copyToCosmos) {
+            // 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 = {
+                name: 'Spfx.Qos.ToEngagement',
+                extraData: this.extraData || {}
+            };
+            engagementData.extraData.qosName = this.name;
+            if (this.resultType) {
+                engagementData.extraData.qosResultType = this._qosResultTypeValue[this.resultType];
+            }
+            if (this.resultCode) {
+                engagementData.extraData.qosResultCode = this.resultCode;
+            }
+            EngagementLogger.log(engagementData);
+        }
+    };
+    return QosMonitor;
+}());
+export default QosMonitor;
+//# sourceMappingURL=QosMonitor.js.map

package/lib/Api/Qos/QosMonitorShareFailureWithCP.d.ts

@@ -0,0 +1,50 @@
+import type { IExtraDataForCustomerPromise } from './CustomerPromiseInterfaces/IExtraDataForCustomerPromise';
+import QosMonitor from './QosMonitor';
+/**
+ * Monitor which handles failures for QosMonitor and also invokes Customer Promise Handlers to record failure
+ * @internal
+ */
+export declare class QosMonitorShareFailureWithCP extends QosMonitor {
+    private _extraDataForCustomerPromise;
+    /**
+     * Creates a QoS monitor and also registers the Customer promise handlers to notify in case of failures
+     * @internal
+     *
+     * @param scenarioName  - Unique name of the QoS scenario
+     * @param copyToEngagement - indicate whether this data should be used as Engagement as well.
+     * @param extraDataForCustomerPromise - Holds extra information about Customer Promise handlers to invoke
+     * and error information where failures are logged
+     */
+    constructor(scenarioName: string, copyToEngagement: boolean | undefined, extraDataForCustomerPromise: IExtraDataForCustomerPromise[], copyToCosmos?: boolean);
+    /**
+     * QoS monitor ends with failure and invokes the Customer Promise handlers
+     * to log a failure
+     * @internal
+     *
+     * You will see failure tag: SPPages.ScenarioName.<failuretag>.Failure.
+     * <failuretag> will be filled with param tagName
+     */
+    writeUnexpectedFailure(tagNameSuffix?: string, ex?: Error, extraData?: {
+        [key: string]: any;
+    }): void;
+    /**
+     * QoS monitor ends with expected failure and invokes the Customer Promise handlers
+     * to log an expected failure
+     * @internal
+     *
+     * You will see success tag: ModernPublish.RenderPublishPage.<failuretag>.ExpectedFailure.
+     * <failuretag> will be filled with param tagName
+     */
+    writeExpectedFailure(tagNameSuffix?: string, ex?: Error, extraData?: {
+        [key: string]: any;
+    }, skipLoggingCustomerPromiseFailure?: boolean): void;
+    /**
+     * Invokes the registered Customer Promise Handlers by using the passed in serviceKey
+     * @param errorMessage - Information to indicate which scenario failed.
+     * @param errorScenario -Additional error details describing the failure from the module.
+     * @param resultType - ResultTypeEnum used to indicate expected or unexpected failure.
+     * @param extraData - Additional information to be logged, which might include pageType and/or errorStack
+     */
+    private _logCustomerPromiseFailure;
+}
+//# sourceMappingURL=QosMonitorShareFailureWithCP.d.ts.map

package/lib/Api/Qos/QosMonitorShareFailureWithCP.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QosMonitorShareFailureWithCP.d.ts","sourceRoot":"","sources":["../../../src/Api/Qos/QosMonitorShareFailureWithCP.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,0DAA0D,CAAC;AAC7G,OAAO,UAAU,MAAM,cAAc,CAAC;AAItC;;;GAGG;AACH,qBAAa,4BAA6B,SAAQ,UAAU;IAC1D,OAAO,CAAC,4BAA4B,CAAiC;IACrE;;;;;;;;OAQG;gBAED,YAAY,EAAE,MAAM,EACpB,gBAAgB,qBAAiB,EACjC,2BAA2B,EAAE,4BAA4B,EAAE,EAC3D,YAAY,GAAE,OAAe;IAK/B;;;;;;;OAOG;IACI,sBAAsB,CAC3B,aAAa,GAAE,MAA4B,EAC3C,EAAE,CAAC,EAAE,KAAK,EAEV,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GACjC,IAAI;IASP;;;;;;;OAOG;IACI,oBAAoB,CACzB,aAAa,GAAE,MAA0B,EACzC,EAAE,CAAC,EAAE,KAAK,EAEV,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAClC,iCAAiC,GAAE,OAAe,GACjD,IAAI;IAaP;;;;;;OAMG;IACH,OAAO,CAAC,0BAA0B;CA2BnC"}

package/lib/Api/Qos/QosMonitorShareFailureWithCP.js

@@ -0,0 +1,114 @@
+import { __extends } from "tslib";
+import QosMonitor from './QosMonitor';
+import { QosResultType } from './QosResultType';
+import { _Diagnostics } from '../../index';
+import { isAppendSuffixIfBrowserIsOfflineAtLoggingTimeKsActive } from '../../common/Killswitches';
+/**
+ * Monitor which handles failures for QosMonitor and also invokes Customer Promise Handlers to record failure
+ * @internal
+ */
+var QosMonitorShareFailureWithCP = /** @class */ (function (_super) {
+    __extends(QosMonitorShareFailureWithCP, _super);
+    /**
+     * Creates a QoS monitor and also registers the Customer promise handlers to notify in case of failures
+     * @internal
+     *
+     * @param scenarioName  - Unique name of the QoS scenario
+     * @param copyToEngagement - indicate whether this data should be used as Engagement as well.
+     * @param extraDataForCustomerPromise - Holds extra information about Customer Promise handlers to invoke
+     * and error information where failures are logged
+     */
+    function QosMonitorShareFailureWithCP(scenarioName, copyToEngagement, extraDataForCustomerPromise, copyToCosmos) {
+        if (copyToEngagement === void 0) { copyToEngagement = false; }
+        if (copyToCosmos === void 0) { copyToCosmos = false; }
+        var _this = _super.call(this, scenarioName, /* copyToCosmos */ copyToCosmos, /* copyToInterana */ copyToEngagement) || this;
+        _this._extraDataForCustomerPromise = extraDataForCustomerPromise;
+        return _this;
+    }
+    /**
+     * QoS monitor ends with failure and invokes the Customer Promise handlers
+     * to log a failure
+     * @internal
+     *
+     * You will see failure tag: SPPages.ScenarioName.<failuretag>.Failure.
+     * <failuretag> will be filled with param tagName
+     */
+    QosMonitorShareFailureWithCP.prototype.writeUnexpectedFailure = function (tagNameSuffix, ex, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    extraData) {
+        if (tagNameSuffix === void 0) { tagNameSuffix = 'DefaultUnexpected'; }
+        _super.prototype.writeUnexpectedFailure.call(this, tagNameSuffix, ex, extraData);
+        this._logCustomerPromiseFailure((ex === null || ex === void 0 ? void 0 : ex.message) || 'DefaultErrorMessage', tagNameSuffix, QosResultType.Failure, extraData);
+    };
+    /**
+     * QoS monitor ends with expected failure and invokes the Customer Promise handlers
+     * to log an expected failure
+     * @internal
+     *
+     * You will see success tag: ModernPublish.RenderPublishPage.<failuretag>.ExpectedFailure.
+     * <failuretag> will be filled with param tagName
+     */
+    QosMonitorShareFailureWithCP.prototype.writeExpectedFailure = function (tagNameSuffix, ex, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    extraData, skipLoggingCustomerPromiseFailure) {
+        if (tagNameSuffix === void 0) { tagNameSuffix = 'DefaultExpected'; }
+        if (skipLoggingCustomerPromiseFailure === void 0) { skipLoggingCustomerPromiseFailure = false; }
+        _super.prototype.writeExpectedFailure.call(this, tagNameSuffix, ex, extraData);
+        if (!skipLoggingCustomerPromiseFailure) {
+            this._logCustomerPromiseFailure((ex === null || ex === void 0 ? void 0 : ex.message) || 'DefaultErrorMessage', tagNameSuffix, QosResultType.ExpectedFailure, extraData);
+        }
+    };
+    /**
+     * Invokes the registered Customer Promise Handlers by using the passed in serviceKey
+     * @param errorMessage - Information to indicate which scenario failed.
+     * @param errorScenario -Additional error details describing the failure from the module.
+     * @param resultType - ResultTypeEnum used to indicate expected or unexpected failure.
+     * @param extraData - Additional information to be logged, which might include pageType and/or errorStack
+     */
+    QosMonitorShareFailureWithCP.prototype._logCustomerPromiseFailure = function (errorMessage, errorScenario, resultType, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    extraData) {
+        if (resultType === void 0) { resultType = QosResultType.Failure; }
+        if (this._extraDataForCustomerPromise) {
+            this._extraDataForCustomerPromise.forEach(function (extraHandlerInfo) {
+                var logFailure = extraHandlerInfo.logFailure, veto = extraHandlerInfo.veto;
+                var errorModuleName = extraHandlerInfo.errorModuleName +
+                    getAuthoringSuffix() +
+                    (!isAppendSuffixIfBrowserIsOfflineAtLoggingTimeKsActive() ? getOfflineSuffix() : '');
+                var errorDetailsForCP = {
+                    errorCode: errorModuleName,
+                    errorScenario: errorScenario,
+                    errorMessage: errorMessage,
+                    resultType: resultType,
+                    pageType: extraData === null || extraData === void 0 ? void 0 : extraData.pageType,
+                    errorStack: extraData === null || extraData === void 0 ? void 0 : extraData.errorStack,
+                    veto: veto
+                };
+                logFailure(errorDetailsForCP);
+            });
+        }
+    };
+    return QosMonitorShareFailureWithCP;
+}(QosMonitor));
+export { QosMonitorShareFailureWithCP };
+function getAuthoringSuffix() {
+    var extraDiagnosticInfo = _Diagnostics._getExtraDiagnosticInfo();
+    if (!extraDiagnosticInfo || !extraDiagnosticInfo.hasAuthoringStarted) {
+        return '';
+    }
+    else if (!extraDiagnosticInfo.authoringSessionClientCount) {
+        return extraDiagnosticInfo.isAuthoringUsingDDS
+            ? " in Legacy Authoring (DDS)"
+            : ' in Legacy Authoring (no DDS)';
+    }
+    else if (extraDiagnosticInfo.authoringSessionClientCount > 1) {
+        return ' with Multiple Users';
+    }
+    else {
+        return '';
+    }
+}
+function getOfflineSuffix() {
+    return window.navigator.onLine ? '' : ' (offline)';
+}
+//# sourceMappingURL=QosMonitorShareFailureWithCP.js.map

package/lib/Api/Qos/QosResultType.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Qos Result Type const object.
+ * @internal
+ */
+export declare const QosResultType: {
+    readonly Success: 0;
+    readonly Failure: 1;
+    readonly ExpectedFailure: 2;
+};
+/**
+ * Qos Result Type type.
+ * @internal
+ */
+export type QosResultType = typeof QosResultType[keyof typeof QosResultType];
+//# sourceMappingURL=QosResultType.d.ts.map