@microsoft/applicationinsights-channel-js 2.8.0-nightly.2202-06 → 2.8.0-nightly.2204-06

package/dist-esm/Sender.js

@@ -1,5 +1,5 @@
 /*
- * Application Insights JavaScript SDK - Channel, 2.8.0-nightly.2202-06
+ * Application Insights JavaScript SDK - Channel, 2.8.0-nightly.2204-06
  * Copyright (c) Microsoft and contributors. All rights reserved.
  */
 var _a;
@@ -8,8 +8,8 @@ import { SessionStorageSendBuffer, ArraySendBuffer } from "./SendBuffer";
 import { DependencyEnvelopeCreator, EventEnvelopeCreator, ExceptionEnvelopeCreator, MetricEnvelopeCreator, PageViewEnvelopeCreator, PageViewPerformanceEnvelopeCreator, TraceEnvelopeCreator } from "./EnvelopeCreator";
 import { Serializer } from "./Serializer"; // todo move to channel
 import { DisabledPropertyName, RequestHeaders, PageView, Event, Trace, Exception, Metric, PageViewPerformance, RemoteDependencyData, ProcessLegacy, BreezeChannelIdentifier, SampleRate, isInternalApplicationInsightsEndpoint, utlCanUseSessionStorage } from "@microsoft/applicationinsights-common";
-import { _InternalMessageId, LoggingSeverity, getWindow, getNavigator, getJSON, BaseTelemetryPlugin, objForEachKey, isNullOrUndefined, arrForEach, dateNow, dumpObj, getExceptionName, getIEVersion, throwError, objKeys, isBeaconsSupported, isFetchSupported, useXDomainRequest, isXhrSupported, isArray } from "@microsoft/applicationinsights-core-js";
-import { Offline } from "./Offline";
+import { getWindow, getNavigator, getJSON, BaseTelemetryPlugin, objForEachKey, isNullOrUndefined, arrForEach, dateNow, dumpObj, getExceptionName, getIEVersion, objKeys, isBeaconsSupported, isFetchSupported, useXDomainRequest, isXhrSupported, isArray, createUniqueNamespace, mergeEvtNamespace, _throwInternal, _warnToConsole } from "@microsoft/applicationinsights-core-js";
+import { createOfflineListener } from "./Offline";
 import { Sample } from "./TelemetryProcessors/Sample";
 import dynamicProto from "@microsoft/dynamicproto-js";
 var FetchSyncRequestSizeLimitBytes = 65000; // approx 64kb (the current Edge, Firefox and Chrome max limit)
@@ -60,43 +60,25 @@ var Sender = /** @class */ (function (_super) {
         _this.priority = 1001;
         _this.identifier = BreezeChannelIdentifier;
         /**
-         * How many times in a row a retryable error condition has occurred.
+         * The configuration for this sender instance
          */
-        var _consecutiveErrors;
-        /**
-         * The time to retry at in milliseconds from 1970/01/01 (this makes the timer calculation easy).
-         */
-        var _retryAt;
-        /**
-         * The time of the last send operation.
-         */
-        var _lastSend;
-        /**
-         * Flag indicating that the sending should be paused
-         */
-        var _paused = false;
-        /**
-         * Handle to the timer for delayed sending of batches of data.
-         */
-        var _timeoutHandle;
+        _this._senderConfig = _getDefaultAppInsightsChannelConfig();
+        // Don't set the defaults here, set them in the _initDefaults() as this is also called during unload
+        var _consecutiveErrors; // How many times in a row a retryable error condition has occurred.
+        var _retryAt; // The time to retry at in milliseconds from 1970/01/01 (this makes the timer calculation easy).
+        var _lastSend; // The time of the last send operation.
+        var _paused; // Flag indicating that the sending should be paused
+        var _timeoutHandle; // Handle to the timer for delayed sending of batches of data.
         var _serializer;
         var _stamp_specific_redirects;
-        var _headers = {};
-        // Keep track of the outstanding sync fetch payload total (as sync fetch has limits)
-        var _syncFetchPayload = 0;
-        /**
-         * The sender to use if the payload size is too large
-         */
-        var _fallbackSender;
-        /**
-         * The identified sender to use for the synchronous unload stage
-         */
-        var _syncUnloadSender;
-        _this._senderConfig = _getDefaultAppInsightsChannelConfig();
+        var _headers;
+        var _syncFetchPayload = 0; // Keep track of the outstanding sync fetch payload total (as sync fetch has limits)
+        var _fallbackSender; // The sender to use if the payload size is too large
+        var _syncUnloadSender; // The identified sender to use for the synchronous unload stage
+        var _offlineListener;
+        var _evtNamespace;
         dynamicProto(Sender, _this, function (_self, _base) {
-            function _notImplemented() {
-                throwError("Method not implemented.");
-            }
+            _initDefaults();
             _self.pause = function () {
                 _clearScheduledTimer();
                 _paused = true;
@@ -112,15 +94,16 @@ var Sender = /** @class */ (function (_super) {
                     _setupTimer();
                 }
             };
-            _self.flush = function () {
+            _self.flush = function (isAsync, callBack, sendReason) {
+                if (isAsync === void 0) { isAsync = true; }
                 if (!_paused) {
                     // Clear the normal schedule timer as we are going to try and flush ASAP
                     _clearScheduledTimer();
                     try {
-                        _self.triggerSend(true, null, 1 /* ManualFlush */);
+                        _self.triggerSend(isAsync, null, sendReason || 1 /* ManualFlush */);
                     }
                     catch (e) {
-                        _self.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.FlushFailed, "flush failed, telemetry will not be collected: " + getExceptionName(e), { exception: dumpObj(e) });
+                        _throwInternal(_self.diagLog(), 1 /* CRITICAL */, 22 /* FlushFailed */, "flush failed, telemetry will not be collected: " + getExceptionName(e), { exception: dumpObj(e) });
                     }
                 }
             };
@@ -131,7 +114,7 @@ var Sender = /** @class */ (function (_super) {
                             _self.triggerSend(true, _doUnloadSend, 2 /* Unload */);
                         }
                         catch (e) {
-                            _self.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.FailedToSendQueuedTelemetry, "failed to flush with beacon sender on page unload, telemetry will not be collected: " + getExceptionName(e), { exception: dumpObj(e) });
+                            _throwInternal(_self.diagLog(), 1 /* CRITICAL */, 20 /* FailedToSendQueuedTelemetry */, "failed to flush with beacon sender on page unload, telemetry will not be collected: " + getExceptionName(e), { exception: dumpObj(e) });
                         }
                     }
                     else {
@@ -139,11 +122,13 @@ var Sender = /** @class */ (function (_super) {
                     }
                 }
             };
-            _self.teardown = _notImplemented;
             _self.addHeader = function (name, value) {
                 _headers[name] = value;
             };
             _self.initialize = function (config, core, extensions, pluginChain) {
+                if (_self.isInitialized()) {
+                    _throwInternal(_self.diagLog(), 1 /* CRITICAL */, 28 /* SenderNotInitialized */, "Sender is already initialized");
+                }
                 _base.initialize(config, core, extensions, pluginChain);
                 var ctx = _self._getTelCtx();
                 var identifier = _self.identifier;
@@ -154,6 +139,8 @@ var Sender = /** @class */ (function (_super) {
                 _self._sender = null;
                 _stamp_specific_redirects = 0;
                 var diagLog = _self.diagLog();
+                _evtNamespace = mergeEvtNamespace(createUniqueNamespace("Sender"), core.evtNamespace && core.evtNamespace());
+                _offlineListener = createOfflineListener(_evtNamespace);
                 var defaultConfig = _getDefaultAppInsightsChannelConfig();
                 objForEachKey(defaultConfig, function (field, value) {
                     _self._senderConfig[field] = function () { return ctx.getConfig(identifier, field, value()); };
@@ -162,7 +149,7 @@ var Sender = /** @class */ (function (_super) {
                     ? new SessionStorageSendBuffer(diagLog, _self._senderConfig) : new ArraySendBuffer(diagLog, _self._senderConfig);
                 _self._sample = new Sample(_self._senderConfig.samplingPercentage(), diagLog);
                 if (!_validateInstrumentationKey(config)) {
-                    diagLog.throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.InvalidInstrumentationKey, "Invalid Instrumentation key " + config.instrumentationKey);
+                    _throwInternal(diagLog, 1 /* CRITICAL */, 100 /* InvalidInstrumentationKey */, "Invalid Instrumentation key " + config.instrumentationKey);
                 }
                 if (!isInternalApplicationInsightsEndpoint(_self._senderConfig.endpointUrl()) && _self._senderConfig.customHeaders() && _self._senderConfig.customHeaders().length > 0) {
                     arrForEach(_self._senderConfig.customHeaders(), function (customHeader) {
@@ -215,12 +202,12 @@ var Sender = /** @class */ (function (_super) {
                     }
                     // validate input
                     if (!telemetryItem) {
-                        itemCtx.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.CannotSendEmptyTelemetry, "Cannot send empty telemetry");
+                        _throwInternal(itemCtx.diagLog(), 1 /* CRITICAL */, 7 /* CannotSendEmptyTelemetry */, "Cannot send empty telemetry");
                         return;
                     }
                     // validate event
                     if (telemetryItem.baseData && !telemetryItem.baseType) {
-                        itemCtx.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.InvalidEvent, "Cannot send telemetry without baseData and baseType");
+                        _throwInternal(itemCtx.diagLog(), 1 /* CRITICAL */, 70 /* InvalidEvent */, "Cannot send telemetry without baseData and baseType");
                         return;
                     }
                     if (!telemetryItem.baseType) {
@@ -229,13 +216,13 @@ var Sender = /** @class */ (function (_super) {
                     }
                     // ensure a sender was constructed
                     if (!_self._sender) {
-                        itemCtx.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.SenderNotInitialized, "Sender was not initialized");
+                        _throwInternal(itemCtx.diagLog(), 1 /* CRITICAL */, 28 /* SenderNotInitialized */, "Sender was not initialized");
                         return;
                     }
                     // check if this item should be sampled in, else add sampleRate tag
                     if (!_isSampledIn(telemetryItem)) {
                         // Item is sampled out, do not send it
-                        itemCtx.diagLog().throwInternal(LoggingSeverity.WARNING, _InternalMessageId.TelemetrySampledAndNotSent, "Telemetry item was sampled out and not sent", { SampleRate: _self._sample.sampleRate });
+                        _throwInternal(itemCtx.diagLog(), 2 /* WARNING */, 33 /* TelemetrySampledAndNotSent */, "Telemetry item was sampled out and not sent", { SampleRate: _self._sample.sampleRate });
                         return;
                     }
                     else {
@@ -247,7 +234,7 @@ var Sender = /** @class */ (function (_super) {
                     var defaultEnvelopeIkey = telemetryItem.iKey || _self._senderConfig.instrumentationKey();
                     var aiEnvelope_1 = Sender.constructEnvelope(telemetryItem, defaultEnvelopeIkey, itemCtx.diagLog(), convertUndefined);
                     if (!aiEnvelope_1) {
-                        itemCtx.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.CreateEnvelopeError, "Unable to create an AppInsights envelope");
+                        _throwInternal(itemCtx.diagLog(), 1 /* CRITICAL */, 47 /* CreateEnvelopeError */, "Unable to create an AppInsights envelope");
                         return;
                     }
                     var doNotSendItem_1 = false;
@@ -257,13 +244,13 @@ var Sender = /** @class */ (function (_super) {
                             try {
                                 if (callBack && callBack(aiEnvelope_1) === false) {
                                     doNotSendItem_1 = true;
-                                    itemCtx.diagLog().warnToConsole("Telemetry processor check returns false");
+                                    _warnToConsole(itemCtx.diagLog(), "Telemetry processor check returns false");
                                 }
                             }
                             catch (e) {
                                 // log error but dont stop executing rest of the telemetry initializers
                                 // doNotSendItem = true;
-                                itemCtx.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.TelemetryInitializerFailed, "One of telemetry initializers failed, telemetry item will not be sent: " + getExceptionName(e), { exception: dumpObj(e) }, true);
+                                _throwInternal(itemCtx.diagLog(), 1 /* CRITICAL */, 64 /* TelemetryInitializerFailed */, "One of telemetry initializers failed, telemetry item will not be sent: " + getExceptionName(e), { exception: dumpObj(e) }, true);
                             }
                         });
                         delete telemetryItem.tags[ProcessLegacy];
@@ -285,7 +272,7 @@ var Sender = /** @class */ (function (_super) {
                     _setupTimer();
                 }
                 catch (e) {
-                    itemCtx.diagLog().throwInternal(LoggingSeverity.WARNING, _InternalMessageId.FailedAddingTelemetryToBuffer, "Failed adding telemetry to the sender's buffer, some telemetry will be lost: " + getExceptionName(e), { exception: dumpObj(e) });
+                    _throwInternal(itemCtx.diagLog(), 2 /* WARNING */, 12 /* FailedAddingTelemetryToBuffer */, "Failed adding telemetry to the sender's buffer, some telemetry will be lost: " + getExceptionName(e), { exception: dumpObj(e) });
                 }
                 // hand off the telemetry item to the next plugin
                 _self.processNext(telemetryItem, itemCtx);
@@ -333,16 +320,21 @@ var Sender = /** @class */ (function (_super) {
                         /* Ignore this error for IE under v10 */
                         var ieVer = getIEVersion();
                         if (!ieVer || ieVer > 9) {
-                            _self.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.TransmissionFailed, "Telemetry transmission failed, some telemetry will be lost: " + getExceptionName(e), { exception: dumpObj(e) });
+                            _throwInternal(_self.diagLog(), 1 /* CRITICAL */, 40 /* TransmissionFailed */, "Telemetry transmission failed, some telemetry will be lost: " + getExceptionName(e), { exception: dumpObj(e) });
                         }
                     }
                 }
             };
+            _self._doTeardown = function (unloadCtx, unloadState) {
+                _self.onunloadFlush();
+                _offlineListener.unload();
+                _initDefaults();
+            };
             /**
              * error handler
              */
             _self._onError = function (payload, message, event) {
-                _self.diagLog().throwInternal(LoggingSeverity.WARNING, _InternalMessageId.OnError, "Failed to send telemetry.", { message: message });
+                _throwInternal(_self.diagLog(), 2 /* WARNING */, 26 /* OnError */, "Failed to send telemetry.", { message: message });
                 _self._buffer.clearSent(payload);
             };
             /**
@@ -372,7 +364,7 @@ var Sender = /** @class */ (function (_super) {
                 }
                 if (retry.length > 0) {
                     _resendPayload(retry);
-                    _self.diagLog().throwInternal(LoggingSeverity.WARNING, _InternalMessageId.TransmissionFailed, "Partial success. " +
+                    _throwInternal(_self.diagLog(), 2 /* WARNING */, 40 /* TransmissionFailed */, "Partial success. " +
                         "Delivered: " + payload.length + ", Failed: " + failed.length +
                         ". Will retry to send " + retry.length + " our of " + results.itemsReceived + " items");
                 }
@@ -425,19 +417,19 @@ var Sender = /** @class */ (function (_super) {
                     }
                     if (!_self._senderConfig.isRetryDisabled() && _isRetriable(status)) {
                         _resendPayload(payload);
-                        _self.diagLog().throwInternal(LoggingSeverity.WARNING, _InternalMessageId.TransmissionFailed, ". " +
+                        _throwInternal(_self.diagLog(), 2 /* WARNING */, 40 /* TransmissionFailed */, ". " +
                             "Response code " + status + ". Will retry to send " + payload.length + " items.");
                     }
                     else {
                         _self._onError(payload, errorMessage);
                     }
                 }
-                else if (Offline.isOffline()) { // offline
+                else if (_offlineListener && !_offlineListener.isOnline()) { // offline
                     // Note: Don't check for status == 0, since adblock gives this code
                     if (!_self._senderConfig.isRetryDisabled()) {
                         var offlineBackOffMultiplier = 10; // arbritrary number
                         _resendPayload(payload, offlineBackOffMultiplier);
-                        _self.diagLog().throwInternal(LoggingSeverity.WARNING, _InternalMessageId.TransmissionFailed, ". Offline - Response Code: ".concat(status, ". Offline status: ").concat(Offline.isOffline(), ". Will retry to send ").concat(payload.length, " items."));
+                        _throwInternal(_self.diagLog(), 2 /* WARNING */, 40 /* TransmissionFailed */, ". Offline - Response Code: ".concat(status, ". Offline status: ").concat(!_offlineListener.isOnline(), ". Will retry to send ").concat(payload.length, " items."));
                     }
                 }
                 else {
@@ -525,8 +517,8 @@ var Sender = /** @class */ (function (_super) {
                             }
                         }
                         if (droppedPayload.length > 0) {
-                            _fallbackSender(droppedPayload, true);
-                            _self.diagLog().throwInternal(LoggingSeverity.WARNING, _InternalMessageId.TransmissionFailed, ". " + "Failed to send telemetry with Beacon API, retried with normal sender.");
+                            _fallbackSender && _fallbackSender(droppedPayload, true);
+                            _throwInternal(_self.diagLog(), 2 /* WARNING */, 40 /* TransmissionFailed */, ". " + "Failed to send telemetry with Beacon API, retried with normal sender.");
                         }
                     }
                 }
@@ -578,7 +570,7 @@ var Sender = /** @class */ (function (_super) {
                     else {
                         // Payload is going to be too big so just try and send via XHR
                         _fallbackSender && _fallbackSender(payload, true);
-                        _self.diagLog().throwInternal(LoggingSeverity.WARNING, _InternalMessageId.TransmissionFailed, ". " + "Failed to send telemetry with Beacon API, retried with xhrSender.");
+                        _throwInternal(_self.diagLog(), 2 /* WARNING */, 40 /* TransmissionFailed */, ". " + "Failed to send telemetry with Beacon API, retried with xhrSender.");
                     }
                 }
             }
@@ -695,7 +687,7 @@ var Sender = /** @class */ (function (_super) {
                     }
                 }
                 catch (e) {
-                    _self.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.InvalidBackendResponse, "Cannot parse the response. " + getExceptionName(e), {
+                    _throwInternal(_self.diagLog(), 1 /* CRITICAL */, 43 /* InvalidBackendResponse */, "Cannot parse the response. " + getExceptionName(e), {
                         response: response
                     });
                 }
@@ -797,7 +789,7 @@ var Sender = /** @class */ (function (_super) {
                 // If the protocol doesn't match, we can't send the telemetry :(.
                 var hostingProtocol = _window && _window.location && _window.location.protocol || "";
                 if (_self._senderConfig.endpointUrl().lastIndexOf(hostingProtocol, 0) !== 0) {
-                    _self.diagLog().throwInternal(LoggingSeverity.WARNING, _InternalMessageId.TransmissionFailed, ". " +
+                    _throwInternal(_self.diagLog(), 2 /* WARNING */, 40 /* TransmissionFailed */, ". " +
                         "Cannot send XDomain request. The endpoint URL protocol doesn't match the hosting page protocol.");
                     buffer.clear();
                     return;
@@ -831,7 +823,7 @@ var Sender = /** @class */ (function (_super) {
                         manager.eventsSendRequest(sendRequest, isAsync);
                     }
                     catch (e) {
-                        _self.diagLog().throwInternal(LoggingSeverity.CRITICAL, _InternalMessageId.NotificationException, "send request notification failed: " + getExceptionName(e), { exception: dumpObj(e) });
+                        _throwInternal(_self.diagLog(), 1 /* CRITICAL */, 74 /* NotificationException */, "send request notification failed: " + getExceptionName(e), { exception: dumpObj(e) });
                     }
                 }
             }
@@ -848,6 +840,25 @@ var Sender = /** @class */ (function (_super) {
                 var regexp = new RegExp(UUID_Regex);
                 return regexp.test(config.instrumentationKey);
             }
+            function _initDefaults() {
+                _self._sender = null;
+                _self._buffer = null;
+                _self._appId = null;
+                _self._sample = null;
+                _headers = {};
+                _offlineListener = null;
+                _consecutiveErrors = 0;
+                _retryAt = null;
+                _lastSend = null;
+                _paused = false;
+                _timeoutHandle = null;
+                _serializer = null;
+                _stamp_specific_redirects = 0;
+                _syncFetchPayload = 0;
+                _fallbackSender = null;
+                _syncUnloadSender = null;
+                _evtNamespace = null;
+            }
         });
         return _this;
     }
@@ -866,7 +877,6 @@ var Sender = /** @class */ (function (_super) {
 // Removed Stub for Sender.prototype.resume.
 // Removed Stub for Sender.prototype.flush.
 // Removed Stub for Sender.prototype.onunloadFlush.
-// Removed Stub for Sender.prototype.teardown.
 // Removed Stub for Sender.prototype.initialize.
 // Removed Stub for Sender.prototype.processTelemetry.
 // Removed Stub for Sender.prototype._xhrReadyStateChange.