@microsoft/1ds-post-js 3.2.5 → 3.2.7

package/README.md

@@ -15,7 +15,7 @@ ms.reviewedBy: ramthi
 
 ## npm
 
-Packages available [here](https://msasg.visualstudio.com/Shared%20Data/_artifacts/feed/1DS-SDK/Npm/%40microsoft%2F1ds-post-js/overview/3.2.5).
+Packages available [here](https://msasg.visualstudio.com/Shared%20Data/_artifacts/feed/1DS-SDK/Npm/%40microsoft%2F1ds-post-js/overview/3.2.7).
 
 ## Basic Usage
 
@@ -66,6 +66,9 @@ appInsightsCore.initialize(coreConfig, []);
 | enableCompoundKey | [Optional] Enables support for objects with compound keys which indirectly represent an object eg. event: { "somedata.embeddedvalue": 123 }  where the "key" of the object contains a "." as part of it's name.  Defaults to false. | boolean
 | disableOptimizeObj | [Optional] Switch to disable the v8 `optimizeObject()` calls used to provide better serialization performance. Defaults to false. | boolean
 | transports | [Optional] Either an array or single value identifying the requested `TransportType` (const enum) type that should be used. This is used during initialization to identify the requested send transport, it will be ignored if a httpXHROverride is provided. | number or number[]
+| useSendBeacon | [Optional] A flag to enable or disable the usage of the sendBeacon() API if available by the runtime. If running on ReactNative this defaults to `false` for all other cases it defaults to `true`.
+| disableFetchKeepAlive | [Optional] A flag to disable the usage of the [fetch with keep-alive](https://javascript.info/fetch-api#keepalive) support.
+| unloadTransports | [Optional] Either an array or single value identifying the requested TransportType type(s) that should be used during unload or events marked as sendBeacon. This is used during initialization to identify the requested send transport, it will be ignored if a httpXHROverride is provided and alwaysUseXhrOverride is true.
 | avoidOptions<br/><sub><i>(Since 3.1.10+)</i></sub><br /><sub>Default: false (Since 3.2.0)<br />Previously true</sub> | [Optional] Avoid adding request headers to the outgoing request that would cause a pre-flight (OPTIONS) request to be sent for each request. | boolean
 | xhrTimeout<br/><sub><i>(Since 3.1.11+)</i></sub>  | [Optional] Specify a timeout (in ms) to apply to requests when sending requests using XHR or fetch() requests only, does not affect sendBeacon() or XDR (XDomainRequest) usage. Defaults to undefined and therefore the runtime defaults (normally zero for browser environments) | number
 | disableXhrSync<br/><sub><i>(Since 3.1.11+)</i></sub> | [Optional] When using [Xhr](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest) for sending requests disable sending as synchronous during unload or synchronous flush. __You should enable this feature for IE (when there is no sendBeacon() or fetch (with keep-alive) support) and you have clients that end up blocking the UI during page unloading__. <span style="color:red">This will cause ALL XHR requests to be sent asynchronously which during page unload may result in the lose of telemetry</span>. This does not affect any other request type (fetch(), sendBeacon() or XDR (XDomainRequest)) | boolean<br/>Default: undefined

package/bundle/{ms.post-3.2.5.gbl.js → ms.post-3.2.7.gbl.js}

@@ -1,5 +1,5 @@
 /*!
- * 1DS JS SDK POST plugin, 3.2.5
+ * 1DS JS SDK POST plugin, 3.2.7
  * Copyright (c) Microsoft and contributors. All rights reserved.
  * (Microsoft Internal Only)
  */
@@ -1266,7 +1266,7 @@
     }
 
     var _objDefineProperty = ObjDefineProperty;
-    var version = '2.8.6';
+    var version = '2.8.8';
     var instanceName = "." + newId(6);
     var _dataUid = 0;
     function _createAccessor(target, prop, value) {
@@ -2159,7 +2159,7 @@
     var STR_EMPTY = "";
 
     var _a$1;
-    var Version = '3.2.5';
+    var Version = '3.2.7';
     var FullVersionString = "1DS-Web-JS-" + Version;
     var strDisabledPropertyName = "Microsoft_ApplicationInsights_BypassAjaxInstrumentation";
     var strWithCredentials = "withCredentials";
@@ -2582,7 +2582,7 @@
             var _theSanitizer = valueSanitizer;
             var _isReservedCache = {};
             dynamicProto(Serializer, this, function (_self) {
-                _self.createPayload = function (retryCnt, isTeardown, isSync, useSendBeacon, sendReason, sendType) {
+                _self.createPayload = function (retryCnt, isTeardown, isSync, isReducedPayload, sendReason, sendType) {
                     return {
                         apiKeys: [],
                         payloadBlob: "",
@@ -2594,7 +2594,7 @@
                         retryCnt: retryCnt,
                         isTeardown: isTeardown,
                         isSync: isSync,
-                        isBeacon: useSendBeacon,
+                        isBeacon: isReducedPayload,
                         sendType: sendType,
                         sendReason: sendReason
                     };
@@ -2872,6 +2872,17 @@
             }
         }
     }
+    function _prependTransports(theTransports, newTransports) {
+        if (newTransports) {
+            if (isNumber(newTransports)) {
+                theTransports = [newTransports].concat(theTransports);
+            }
+            else if (isArray(newTransports)) {
+                theTransports = newTransports.concat(theTransports);
+            }
+        }
+        return theTransports;
+    }
     var HttpManager = /** @class */ (function () {
         function HttpManager(maxEventsPerBatch, maxConnections, maxRequestRetriesBeforeBackoff, actions, timeoutOverride) {
             this._responseHandlers = [];
@@ -2896,6 +2907,8 @@
             var _useHeaders = false;
             var _xhrTimeout;
             var _disableXhrSync;
+            var _disableFetchKeepAlive;
+            var _canHaveReducedPayload;
             dynamicProto(HttpManager, this, function (_self) {
                 var _sendCredentials = true;
                 _self.initialize = function (endpointUrl, core, postChannel, httpInterface, channelConfig) {
@@ -2917,12 +2930,17 @@
                         enableCompoundKey = !!channelConfig.enableCompoundKey;
                     }
                     _xhrTimeout = channelConfig.xhrTimeout;
-                    _disableXhrSync = channelConfig.disableXhrSync;
+                    _disableXhrSync = !!channelConfig.disableXhrSync;
+                    _disableFetchKeepAlive = !!channelConfig.disableFetchKeepAlive;
                     _useBeacons = !isReactNative();
                     _serializer = new Serializer(_core, valueSanitizer, stringifyObjects, enableCompoundKey);
+                    if (!isNullOrUndefined(channelConfig.useSendBeacon)) {
+                        _useBeacons = !!channelConfig.useSendBeacon;
+                    }
                     var syncHttpInterface = httpInterface;
                     var beaconHttpInterface = channelConfig.alwaysUseXhrOverride ? httpInterface : null;
                     var fetchSyncHttpInterface = channelConfig.alwaysUseXhrOverride ? httpInterface : null;
+                    var beaconUnloadTransports = [3 , 2 ];
                     if (!httpInterface) {
                         _customHttpInterface = false;
                         var location_1 = getLocation();
@@ -2932,29 +2950,27 @@
                         var theTransports = [];
                         if (isReactNative()) {
                             theTransports = [2 , 1 ];
+                            beaconUnloadTransports = [2 , 1 , 3 ];
                         }
                         else {
                             theTransports = [1 , 2 , 3 ];
                         }
-                        var configTransports = channelConfig.transports;
-                        if (configTransports) {
-                            if (isNumber(configTransports)) {
-                                theTransports = [configTransports].concat(theTransports);
-                            }
-                            else if (isArray(configTransports)) {
-                                theTransports = configTransports.concat(theTransports);
-                            }
-                        }
+                        theTransports = _prependTransports(theTransports, channelConfig.transports);
                         httpInterface = _getSenderInterface(theTransports, false);
-                        syncHttpInterface = _getSenderInterface(theTransports, true);
                         if (!httpInterface) {
                             _warnToConsole(_logger, "No available transport to send events");
                         }
+                        syncHttpInterface = _getSenderInterface(theTransports, true);
                     }
+                    if (!beaconHttpInterface) {
+                        beaconUnloadTransports = _prependTransports(beaconUnloadTransports, channelConfig.unloadTransports);
+                        beaconHttpInterface = _getSenderInterface(beaconUnloadTransports, true);
+                    }
+                    _canHaveReducedPayload = !_customHttpInterface && ((_useBeacons && isBeaconsSupported()) || (!_disableFetchKeepAlive && isFetchSupported(true)));
                     _sendInterfaces = (_a = {},
                         _a[0 ] = httpInterface,
                         _a[1 ] = syncHttpInterface || _getSenderInterface([1 , 2 , 3 ], true),
-                        _a[2 ] = beaconHttpInterface || _getSenderInterface([3 , 2 ], true) || syncHttpInterface || _getSenderInterface([1 ], true),
+                        _a[2 ] = beaconHttpInterface || syncHttpInterface || _getSenderInterface([1 ], true),
                         _a[3 ] = fetchSyncHttpInterface || _getSenderInterface([2 , 3 ], true) || syncHttpInterface || _getSenderInterface([1 ], true),
                         _a);
                 };
@@ -2972,7 +2988,7 @@
                                 sendPostFunc = _xhrSendPost;
                             }
                         }
-                        else if (transportType === 2  && isFetchSupported(syncSupport)) {
+                        else if (transportType === 2  && isFetchSupported(syncSupport) && (!syncSupport || (syncSupport && !_disableFetchKeepAlive))) {
                             sendPostFunc = _fetchSendPost;
                         }
                         else if (_useBeacons && transportType === 3  && isBeaconsSupported()) {
@@ -3296,12 +3312,13 @@
                             var thePayload = null;
                             var serializationStart = getTime();
                             var sendInterface = _sendInterfaces[sendType] || (isSynchronous_1 ? _sendInterfaces[1 ] : _sendInterfaces[0 ]);
-                            var isBeaconTransport = (_isUnloading || _isBeaconPayload(sendType) || (sendInterface && sendInterface._transport === 3 )) && _canUseSendBeaconApi();
+                            var sendTransport = sendInterface && sendInterface._transport;
+                            var isReducedPayload = _canHaveReducedPayload && (_isUnloading || _isBeaconPayload(sendType) || (sendTransport === 3  || (sendInterface._isSync && sendTransport === 2 )));
                             while (_canSendPayload(theBatches, sendType, retryCount)) {
                                 var theBatch = theBatches.shift();
                                 if (theBatch && theBatch.count() > 0) {
                                     if (!_killSwitch.isTenantKilled(theBatch.iKey())) {
-                                        thePayload = thePayload || _serializer.createPayload(retryCount, isTeardown, isSynchronous_1, isBeaconTransport, sendReason, sendType);
+                                        thePayload = thePayload || _serializer.createPayload(retryCount, isTeardown, isSynchronous_1, isReducedPayload, sendReason, sendType);
                                         if (!_serializer.appendPayload(thePayload, theBatch, maxEventsPerBatch)) {
                                             _doPayloadSend(thePayload, serializationStart, getTime(), sendReason);
                                             serializationStart = getTime();
@@ -3384,9 +3401,6 @@
                     }
                     return requestDetails;
                 }
-                function _canUseSendBeaconApi() {
-                    return !_customHttpInterface && _useBeacons && isBeaconsSupported();
-                }
                 function _setTimingValue(timings, name, value) {
                     timings[name] = timings[name] || {};
                     timings[name][_postManager.identifier] = value;
@@ -3427,11 +3441,10 @@
                                 headers: requestDetails_1.hdrs,
                                 _thePayload: thePayload,
                                 _sendReason: sendReason,
-                                timeout: _xhrTimeout
+                                timeout: _xhrTimeout,
+                                disableXhrSync: _disableXhrSync,
+                                disableFetchKeepAlive: _disableFetchKeepAlive
                             };
-                            if (!isUndefined(_disableXhrSync)) {
-                                orgPayloadData.disableXhrSync = !!_disableXhrSync;
-                            }
                             if (useHeaders_1) {
                                 if (!_hasHeader(orgPayloadData.headers, STR_CACHE_CONTROL)) {
                                     orgPayloadData.headers[STR_CACHE_CONTROL] = DEFAULT_CACHE_CONTROL;
@@ -3471,7 +3484,8 @@
                                             urlString: orgPayloadData.urlString,
                                             headers: extend({}, orgPayloadData.headers),
                                             timeout: orgPayloadData.timeout,
-                                            disableXhrSync: orgPayloadData.disableXhrSync
+                                            disableXhrSync: orgPayloadData.disableXhrSync,
+                                            disableFetchKeepAlive: orgPayloadData.disableFetchKeepAlive
                                         };
                                         var senderCalled_1 = false;
                                         doPerf(_core, function () { return "HttpManager:_doPayloadSend.sendHook"; }, function () {
@@ -3741,7 +3755,7 @@
             var _this = _super.call(this) || this;
             _this.identifier = "PostChannel";
             _this.priority = 1011;
-            _this.version = '3.2.5';
+            _this.version = '3.2.7';
             var _config;
             var _isTeardownCalled = false;
             var _flushCallbackQueue = [];
@@ -4474,4 +4488,4 @@
     (function(obj, prop, descriptor) { /* ai_es3_polyfil defineProperty */ var func = Object["defineProperty"]; if (func) { try { return func(obj, prop, descriptor); } catch(e) { /* IE8 defines defineProperty, but will throw */ } } if (descriptor && typeof descriptor.value !== undefined) { obj[prop] = descriptor.value; } return obj; })(exports, '__esModule', { value: true });
 
 })(this.oneDS = this.oneDS || {});
-//# sourceMappingURL=ms.post-3.2.5.gbl.js.map
+//# sourceMappingURL=ms.post-3.2.7.gbl.js.map