@microsoft/1ds-post-js 3.1.10 → 3.1.11

package/dist-esm/src/BatchNotificationActions.js

@@ -1,5 +1,5 @@
 /*
- * 1DS JS SDK POST plugin, 3.1.10
+ * 1DS JS SDK POST plugin, 3.1.11
  * Copyright (c) Microsoft and contributors. All rights reserved.
  * (Microsoft Internal Only)
  */

package/dist-esm/src/ClockSkewManager.js

@@ -1,5 +1,5 @@
 /*
- * 1DS JS SDK POST plugin, 3.1.10
+ * 1DS JS SDK POST plugin, 3.1.11
  * Copyright (c) Microsoft and contributors. All rights reserved.
  * (Microsoft Internal Only)
  */

package/dist-esm/src/Constants.d.ts

@@ -21,4 +21,5 @@ export declare const strApiKey = "apikey";
 export declare const strMsaDeviceTicket = "AuthMsaDeviceTicket";
 export declare const strAuthXToken = "AuthXToken";
 export declare const strSdkVersion = "sdk-version";
+export declare const strNoResponseBody = "NoResponseBody";
 export declare const strMsfpc = "msfpc";

package/dist-esm/src/Constants.js

@@ -1,5 +1,5 @@
 /*
- * 1DS JS SDK POST plugin, 3.1.10
+ * 1DS JS SDK POST plugin, 3.1.11
  * Copyright (c) Microsoft and contributors. All rights reserved.
  * (Microsoft Internal Only)
  */
@@ -26,5 +26,6 @@ export var strApiKey = "apikey";
 export var strMsaDeviceTicket = "AuthMsaDeviceTicket";
 export var strAuthXToken = "AuthXToken";
 export var strSdkVersion = "sdk-version";
+export var strNoResponseBody = "NoResponseBody";
 export var strMsfpc = "msfpc";
 //# sourceMappingURL=Constants.js.map

package/dist-esm/src/Constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"Constants.js.map","sources":["Constants.js"],"sourcesContent":["export var Method = \"POST\";\r\nexport var DisabledPropertyName = \"Microsoft_ApplicationInsights_BypassAjaxInstrumentation\";\r\nexport var strDropped = \"drop\";\r\nexport var strSending = \"send\";\r\nexport var strRequeue = \"requeue\";\r\nexport var strResponseFail = \"rspFail\";\r\nexport var strOther = \"oth\";\r\nexport var defaultCacheControl = \"no-cache, no-store\";\r\nexport var defaultContentType = \"application/x-json-stream\";\r\nexport var strCacheControl = \"cache-control\";\r\nexport var strContentTypeHeader = \"content-type\";\r\nexport var strKillTokensHeader = \"kill-tokens\";\r\nexport var strKillDurationHeader = \"kill-duration\";\r\nexport var strKillDurationSecondsHeader = \"kill-duration-seconds\";\r\nexport var strTimeDeltaHeader = \"time-delta-millis\";\r\nexport var strClientVersion = \"client-version\";\r\nexport var strClientId = \"client-id\";\r\nexport var strTimeDeltaToApply = \"time-delta-to-apply-millis\";\r\nexport var strUploadTime = \"upload-time\";\r\nexport var strApiKey = \"apikey\";\r\nexport var strMsaDeviceTicket = \"AuthMsaDeviceTicket\";\r\nexport var strAuthXToken = \"AuthXToken\";\r\nexport var strSdkVersion = \"sdk-version\";\r\nexport var strMsfpc = \"msfpc\";\r\n//# sourceMappingURL=Constants.js.map"],"names":[],"mappings":";;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA"}
+{"version":3,"file":"Constants.js.map","sources":["Constants.js"],"sourcesContent":["export var Method = \"POST\";\r\nexport var DisabledPropertyName = \"Microsoft_ApplicationInsights_BypassAjaxInstrumentation\";\r\nexport var strDropped = \"drop\";\r\nexport var strSending = \"send\";\r\nexport var strRequeue = \"requeue\";\r\nexport var strResponseFail = \"rspFail\";\r\nexport var strOther = \"oth\";\r\nexport var defaultCacheControl = \"no-cache, no-store\";\r\nexport var defaultContentType = \"application/x-json-stream\";\r\nexport var strCacheControl = \"cache-control\";\r\nexport var strContentTypeHeader = \"content-type\";\r\nexport var strKillTokensHeader = \"kill-tokens\";\r\nexport var strKillDurationHeader = \"kill-duration\";\r\nexport var strKillDurationSecondsHeader = \"kill-duration-seconds\";\r\nexport var strTimeDeltaHeader = \"time-delta-millis\";\r\nexport var strClientVersion = \"client-version\";\r\nexport var strClientId = \"client-id\";\r\nexport var strTimeDeltaToApply = \"time-delta-to-apply-millis\";\r\nexport var strUploadTime = \"upload-time\";\r\nexport var strApiKey = \"apikey\";\r\nexport var strMsaDeviceTicket = \"AuthMsaDeviceTicket\";\r\nexport var strAuthXToken = \"AuthXToken\";\r\nexport var strSdkVersion = \"sdk-version\";\r\nexport var strNoResponseBody = \"NoResponseBody\";\r\nexport var strMsfpc = \"msfpc\";\r\n//# sourceMappingURL=Constants.js.map"],"names":[],"mappings":";;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA"}

package/dist-esm/src/DataModels.d.ts

@@ -12,6 +12,8 @@ export interface IPayloadData {
     headers?: {
         [name: string]: string;
     };
+    timeout?: number;
+    disableXhrSync?: boolean;
 }
 /**
  * Defines the function signature for the Payload Preprocessor.
@@ -60,6 +62,10 @@ export interface IChannelConfiguration {
     disableAutoBatchFlushLimit?: boolean;
     /**
      * [Optional] The HTTP override that should be used to send requests, as an IXHROverride object.
+     * By default during the unload of a page or if the event specifies that it wants to use sendBeacon() or sync fetch (with keep-alive),
+     * this override will NOT be called. You can now change this behavior by enabling the 'alwaysUseXhrOverride' configuration value.
+     * The payload data (first argument) now also includes any configured 'timeout' (defaults to undefined) and whether you should avoid
+     * creating any synchronous XHR requests 'disableXhrSync' (defaults to false/undefined)
      */
     httpXHROverride?: IXHROverride;
     /**
@@ -138,6 +144,49 @@ export interface IChannelConfiguration {
      * previous OPTIONS response, at which point some of the current dynamic values sent on the query string will be moved to a header.
      */
     avoidOptions?: boolean;
+    /**
+     * [Optional] Specify a timeout (in ms) to apply to requests when sending requests using XHR, XDR or fetch requests. Defaults to undefined
+     * and therefore the runtime defaults (normally zero for browser environments)
+     */
+    xhrTimeout?: number;
+    /**
+     * [Optional] When using Xhr 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)) and you have clients
+     * that end up blocking the UI during page unloading. This will cause ALL XHR requests to be sent asynchronously which
+     * during page unload may result in the lose of telemetry.
+     */
+    disableXhrSync?: boolean;
+    /**
+     * [Optional] By default during unload (or when you specify to use sendBeacon() or sync fetch (with keep-alive) for an event) the SDK
+     * ignores any provided httpXhrOverride and attempts to use sendBeacon() or fetch(with keep-alive) when they are available.
+     * When this configuration option is true any provided httpXhrOverride will always be used, so any provided httpXhrOverride will
+     * also need to "handle" the synchronous unload scenario.
+     */
+    alwaysUseXhrOverride?: boolean;
+    /**
+     * [Optional] Identifies the number of times any single event will be retried if it receives a failed (retirable) response, this
+     * causes the event to be internally "requeued" and resent in the next batch. As each normal batched send request is retried at
+     * least once before starting to increase the internal backoff send interval, normally batched events will generally be attempted
+     * the next nearest even number of times. This means that the total number of actual send attempts will almost always be even
+     * (setting to 5 will cause 6 requests), unless using manual synchronous flushing (calling flush(false)) which is not subject to
+     * request level retry attempts.
+     * Defaults to 6 times.
+     */
+    maxEventRetryAttempts?: number;
+    /**
+     * [Optional] Identifies the number of times any single event will be retried if it receives a failed (retriable) response as part
+     * of processing / flushing events once a page unload state has been detected, this causes the event to be internally "requeued"
+     * and resent in the next batch, which during page unload. Unlike the normal batching process, send requests are never retried,
+     * so the value listed here is always the maximum number of attempts for any single event.
+     * Defaults to 2 times.
+     * Notes:
+     * The SDK by default will use the sendBeacon() API if it exists which is treated as a fire and forget successful response, so for
+     * environments that support or supply this API the events won't be retried (because they will be deeded to be successfully sent).
+     * When an environment (IE) doesn't support sendBeacon(), this will cause multiple synchronous (by default) XMLHttpRequests to be sent,
+     * which will block the UI until a response is received. You can disable ALL synchronous XHR requests by setting the 'disableXhrSync'
+     * configuration setting and/or changing this value to 0 or 1.
+     */
+    maxUnloadEventRetryAttempts?: number;
 }
 /**
  * SendPOSTFunction type defines how an HTTP POST request is sent to an ingestion server

package/dist-esm/src/DataModels.js

@@ -1,5 +1,5 @@
 /*
- * 1DS JS SDK POST plugin, 3.1.10
+ * 1DS JS SDK POST plugin, 3.1.11
  * Copyright (c) Microsoft and contributors. All rights reserved.
  * (Microsoft Internal Only)
  */

package/dist-esm/src/EventBatch.js

@@ -1,5 +1,5 @@
 /*
- * 1DS JS SDK POST plugin, 3.1.10
+ * 1DS JS SDK POST plugin, 3.1.11
  * Copyright (c) Microsoft and contributors. All rights reserved.
  * (Microsoft Internal Only)
  */

package/dist-esm/src/HttpManager.d.ts

@@ -19,7 +19,7 @@ export declare class HttpManager {
      * @constructor
      * @param requestQueue   - The queue that contains the requests to be sent.
      */
-    constructor(maxEventsPerBatch: number, maxConnections: number, maxRetries: number, actions: BatchNotificationActions);
+    constructor(maxEventsPerBatch: number, maxConnections: number, maxRequestRetriesBeforeBackoff: number, actions: BatchNotificationActions);
     /**
      * @constructor
      * @param requestQueue   - The queue that contains the requests to be sent.

package/dist-esm/src/HttpManager.js

@@ -1,5 +1,5 @@
 /*
- * 1DS JS SDK POST plugin, 3.1.10
+ * 1DS JS SDK POST plugin, 3.1.11
  * Copyright (c) Microsoft and contributors. All rights reserved.
  * (Microsoft Internal Only)
  */
@@ -15,7 +15,9 @@ import RetryPolicy from "./RetryPolicy";
 import EVTKillSwitch from "./KillSwitch";
 import EVTClockSkewManager from "./ClockSkewManager";
 import dynamicProto from "@microsoft/dynamicproto-js";
-import { defaultCacheControl, defaultContentType, DisabledPropertyName, Method, strApiKey, strCacheControl, strClientId, strClientVersion, strContentTypeHeader, strDropped, strKillDurationHeader, strKillDurationSecondsHeader, strKillTokensHeader, strMsaDeviceTicket, strMsfpc, strOther, strRequeue, strResponseFail, strSending, strTimeDeltaHeader, strTimeDeltaToApply, strUploadTime } from "./Constants";
+import { defaultCacheControl, defaultContentType, DisabledPropertyName, Method, strApiKey, strCacheControl, strClientId, strClientVersion, strContentTypeHeader, strDropped, strKillDurationHeader, strKillDurationSecondsHeader, strKillTokensHeader, strMsaDeviceTicket, strMsfpc, strNoResponseBody, strOther, strRequeue, strResponseFail, strSending, strTimeDeltaHeader, strTimeDeltaToApply, strUploadTime } from "./Constants";
+var strSendAttempt = "sendAttempt";
+var _noResponseQs = "&" + strNoResponseBody + "=true";
 /**
  * Identifies the default notification reason to the action names
  */
@@ -79,7 +81,7 @@ var HttpManager = /** @class */ (function () {
      * @constructor
      * @param requestQueue   - The queue that contains the requests to be sent.
      */
-    function HttpManager(maxEventsPerBatch, maxConnections, maxRetries, actions) {
+    function HttpManager(maxEventsPerBatch, maxConnections, maxRequestRetriesBeforeBackoff, actions) {
         this._responseHandlers = [];
         var _urlString = "?cors=true&" + strContentTypeHeader.toLowerCase() + "=" + defaultContentType;
         var _killSwitch = new EVTKillSwitch();
@@ -99,6 +101,8 @@ var HttpManager = /** @class */ (function () {
         var _cookieMgr;
         var _isUnloading = false;
         var _useHeaders = false;
+        var _xhrTimeout;
+        var _disableXhrSync;
         dynamicProto(HttpManager, this, function (_self) {
             var _sendCredentials = true;
             _self.initialize = function (endpointUrl, core, postChannel, httpInterface, channelConfig) {
@@ -119,9 +123,13 @@ var HttpManager = /** @class */ (function () {
                 if (!isUndefined(channelConfig.enableCompoundKey)) {
                     enableCompoundKey = !!channelConfig.enableCompoundKey;
                 }
+                _xhrTimeout = channelConfig.xhrTimeout;
+                _disableXhrSync = channelConfig.disableXhrSync;
                 _useBeacons = !isReactNative(); // Only use beacons if not running in React Native
                 _serializer = new Serializer(_core, valueSanitizer, stringifyObjects, enableCompoundKey);
                 var syncHttpInterface = httpInterface;
+                var beaconHttpInterface = channelConfig.alwaysUseXhrOverride ? httpInterface : null;
+                var fetchSyncHttpInterface = channelConfig.alwaysUseXhrOverride ? httpInterface : null;
                 if (!httpInterface) {
                     _customHttpInterface = false;
                     var location_1 = getLocation();
@@ -157,8 +165,8 @@ var HttpManager = /** @class */ (function () {
                 _sendInterfaces = (_a = {},
                     _a[0 /* Batched */] = httpInterface,
                     _a[1 /* Synchronous */] = syncHttpInterface || _getSenderInterface([1 /* Xhr */, 2 /* Fetch */, 3 /* Beacon */], true),
-                    _a[2 /* SendBeacon */] = _getSenderInterface([3 /* Beacon */, 2 /* Fetch */, 1 /* Xhr */], true) || syncHttpInterface,
-                    _a[3 /* SyncFetch */] = _getSenderInterface([2 /* Fetch */, 3 /* Beacon */, 1 /* Xhr */], true) || syncHttpInterface,
+                    _a[2 /* SendBeacon */] = beaconHttpInterface || _getSenderInterface([3 /* Beacon */, 2 /* Fetch */], true) || syncHttpInterface || _getSenderInterface([1 /* Xhr */], true),
+                    _a[3 /* SyncFetch */] = fetchSyncHttpInterface || _getSenderInterface([2 /* Fetch */, 3 /* Beacon */], true) || syncHttpInterface || _getSenderInterface([1 /* Xhr */], true),
                     _a);
             };
             // Special internal method to allow the DebugPlugin to hook embedded objects
@@ -200,6 +208,9 @@ var HttpManager = /** @class */ (function () {
                 // It doesn't support custom headers, so no action is taken with current requestHeaders
                 var xdr = new XDomainRequest();
                 xdr.open(Method, payload.urlString);
+                if (payload.timeout) {
+                    xdr.timeout = payload.timeout;
+                }
                 // can't get the status code in xdr.
                 xdr.onload = function () {
                     // we will assume onload means the request succeeded.
@@ -229,6 +240,7 @@ var HttpManager = /** @class */ (function () {
             }
             function _fetchSendPost(payload, oncomplete, sync) {
                 var _a;
+                var theUrl = payload.urlString;
                 var ignoreResponse = false;
                 var responseHandled = false;
                 var requestInit = (_a = {
@@ -243,6 +255,7 @@ var HttpManager = /** @class */ (function () {
                         // As a sync request (during unload), it is unlikely that we will get a chance to process the response so
                         // just like beacon send assume that the events have been accepted and processed
                         ignoreResponse = true;
+                        theUrl += _noResponseQs;
                     }
                 }
                 if (_sendCredentials) {
@@ -253,7 +266,7 @@ var HttpManager = /** @class */ (function () {
                 if (payload.headers && objKeys(payload.headers).length > 0) {
                     requestInit.headers = payload.headers;
                 }
-                fetch(payload.urlString, requestInit).then(function (response) {
+                fetch(theUrl, requestInit).then(function (response) {
                     var headerMap = {};
                     var responseText = "";
                     if (response.headers) {
@@ -284,8 +297,19 @@ var HttpManager = /** @class */ (function () {
                     responseHandled = true;
                     _doOnComplete(oncomplete, 200, {});
                 }
+                if (!responseHandled && payload.timeout > 0) {
+                    // Simulate timeout
+                    _postManager._setTimeoutOverride(function () {
+                        if (!responseHandled) {
+                            // Assume a 500 response (which will cause a retry)
+                            responseHandled = true;
+                            _doOnComplete(oncomplete, 500, {});
+                        }
+                    }, payload.timeout);
+                }
             }
             function _xhrSendPost(payload, oncomplete, sync) {
+                var theUrl = payload.urlString;
                 function _appendHeader(theHeaders, xhr, name) {
                     if (!theHeaders[name] && xhr && xhr.getResponseHeader) {
                         var value = xhr.getResponseHeader(name);
@@ -313,23 +337,26 @@ var HttpManager = /** @class */ (function () {
                 function xhrComplete(xhr, responseTxt) {
                     _doOnComplete(oncomplete, xhr.status, _getAllResponseHeaders(xhr), responseTxt);
                 }
-                var xhRequest = openXhr(Method, payload.urlString, _sendCredentials, true, sync);
+                if (sync && payload.disableXhrSync) {
+                    sync = false;
+                }
+                var xhrRequest = openXhr(Method, theUrl, _sendCredentials, true, sync, payload.timeout);
                 // Set custom headers (e.g. gzip) here (after open())
                 objForEachKey(payload.headers, function (name, value) {
-                    xhRequest.setRequestHeader(name, value);
+                    xhrRequest.setRequestHeader(name, value);
                 });
-                xhRequest.onload = function () {
-                    var response = _getResponseText(xhRequest);
-                    xhrComplete(xhRequest, response);
+                xhrRequest.onload = function () {
+                    var response = _getResponseText(xhrRequest);
+                    xhrComplete(xhrRequest, response);
                     _handleCollectorResponse(response);
                 };
-                xhRequest.onerror = function () {
-                    xhrComplete(xhRequest);
+                xhrRequest.onerror = function () {
+                    xhrComplete(xhrRequest);
                 };
-                xhRequest.ontimeout = function () {
-                    xhrComplete(xhRequest);
+                xhrRequest.ontimeout = function () {
+                    xhrComplete(xhrRequest);
                 };
-                xhRequest.send(payload.data);
+                xhrRequest.send(payload.data);
             }
             function _doOnComplete(oncomplete, status, headers, response) {
                 try {
@@ -344,9 +371,10 @@ var HttpManager = /** @class */ (function () {
                 var internalPayloadData = payload;
                 var status = 200;
                 var thePayload = internalPayloadData._thePayload;
+                var theUrl = payload.urlString + _noResponseQs;
                 try {
                     var nav_1 = getNavigator();
-                    if (!nav_1.sendBeacon(payload.urlString, payload.data)) {
+                    if (!nav_1.sendBeacon(theUrl, payload.data)) {
                         if (thePayload) {
                             // Failed to send entire payload so try and split data and try to send as much events as possible
                             var droppedBatches_1 = [];
@@ -354,7 +382,7 @@ var HttpManager = /** @class */ (function () {
                                 if (droppedBatches_1 && theBatch && theBatch.count() > 0) {
                                     var theEvents = theBatch.events();
                                     for (var lp = 0; lp < theEvents.length; lp++) {
-                                        if (!nav_1.sendBeacon(payload.urlString, _serializer.getEventBlob(theEvents[lp]))) {
+                                        if (!nav_1.sendBeacon(theUrl, _serializer.getEventBlob(theEvents[lp]))) {
                                             // Can't send anymore, so split the batch and drop the rest
                                             droppedBatches_1.push(theBatch.split(lp));
                                             break;
@@ -659,7 +687,6 @@ var HttpManager = /** @class */ (function () {
                     var requestDetails_1 = _buildRequestDetails(thePayload, useHeaders_1);
                     useHeaders_1 = useHeaders_1 || requestDetails_1.useHdrs;
                     var sendEventStart_1 = getTime();
-                    var strSendAttempt_1 = "sendAttempt";
                     doPerf(_core, function () { return "HttpManager:_doPayloadSend"; }, function () {
                         // Increment the send attempt count and add timings after packaging (So it's not serialized in the 1st attempt)
                         for (var batchLp = 0; batchLp < thePayload.batches.length; batchLp++) {
@@ -673,7 +700,7 @@ var HttpManager = /** @class */ (function () {
                                     _setTimingValue(timings, "serializationStart", serializationStart);
                                     _setTimingValue(timings, "serializationCompleted", serializationCompleted);
                                 }
-                                telemetryItem[strSendAttempt_1] > 0 ? telemetryItem[strSendAttempt_1]++ : telemetryItem[strSendAttempt_1] = 1;
+                                telemetryItem[strSendAttempt] > 0 ? telemetryItem[strSendAttempt]++ : telemetryItem[strSendAttempt] = 1;
                             }
                         }
                         // Note: always sending this notification in a synchronous manner.
@@ -686,8 +713,12 @@ var HttpManager = /** @class */ (function () {
                             urlString: requestDetails_1.url,
                             headers: requestDetails_1.hdrs,
                             _thePayload: thePayload,
-                            _sendReason: sendReason
+                            _sendReason: sendReason,
+                            timeout: _xhrTimeout
                         };
+                        if (!isUndefined(_disableXhrSync)) {
+                            orgPayloadData.disableXhrSync = !!_disableXhrSync;
+                        }
                         // Only automatically add the following headers if already sending headers and we are not attempting to avoid an options call
                         if (useHeaders_1) {
                             if (!_hasHeader(orgPayloadData.headers, strCacheControl)) {
@@ -735,7 +766,9 @@ var HttpManager = /** @class */ (function () {
                                     var hookData_1 = {
                                         data: orgPayloadData.data,
                                         urlString: orgPayloadData.urlString,
-                                        headers: extend({}, orgPayloadData.headers)
+                                        headers: extend({}, orgPayloadData.headers),
+                                        timeout: orgPayloadData.timeout,
+                                        disableXhrSync: orgPayloadData.disableXhrSync
                                     };
                                     var senderCalled_1 = false;
                                     doPerf(_core, function () { return "HttpManager:_doPayloadSend.sendHook"; }, function () {
@@ -809,7 +842,7 @@ var HttpManager = /** @class */ (function () {
                         }
                         // Disabling triple-equals rule to avoid httpOverrides from failing because they are returning a string value
                         // tslint:disable-next-line:triple-equals
-                        if (status == 200) {
+                        if (status == 200 || status == 204) {
                             // Response was successfully sent
                             reason = 200 /* Complete */;
                             return;
@@ -826,7 +859,8 @@ var HttpManager = /** @class */ (function () {
                         reason = 100 /* RequeueEvents */;
                         var retryCount_1 = thePayload.retryCnt;
                         if (thePayload.sendType === 0 /* Batched */) {
-                            if (retryCount_1 < maxRetries) {
+                            // attempt to resend the entire batch
+                            if (retryCount_1 < maxRequestRetriesBeforeBackoff) {
                                 isRetrying = true;
                                 _doAction(function () {
                                     // try to resend the same batches
@@ -841,6 +875,11 @@ var HttpManager = /** @class */ (function () {
                             }
                             else {
                                 backOffTrans = true;
+                                if (_isUnloading) {
+                                    // we are unloading so don't try and requeue the events otherwise let the events get requeued and resent during the backoff sending
+                                    // This will also cause the events to be purged based on the priority (if necessary)
+                                    reason = 8001 /* NonRetryableStatus */;
+                                }
                             }
                         }
                     }