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

package/src/HttpManager.ts

@@ -6,9 +6,9 @@
 import {
     isReactNative, isValueAssigned, isString, getTime, arrForEach, getLocation, strTrim, isFetchSupported, isXhrSupported,
     isBeaconsSupported, FullVersionString, useXDomainRequest, IExtendedAppInsightsCore, IExtendedConfiguration,
-    LoggingSeverity, _ExtendedInternalMessageId, SendRequestReason, strUndefined, getNavigator, doPerf, IPerfEvent,
+    eLoggingSeverity, _eExtendedInternalMessageId, SendRequestReason, strUndefined, getNavigator, doPerf, IPerfEvent,
     dateNow, isUndefined, isNullOrUndefined, objForEachKey, ICookieMgr, isNumber, isArray, TransportType, dumpObj, objKeys, extend,
-    EventSendType, hasOwnProperty, openXhr
+    EventSendType, hasOwnProperty, openXhr, _throwInternal, _eInternalMessageId
 } from "@microsoft/1ds-core-js";
 import {
     IXHROverride, IPostTransmissionTelemetryItem, ICollectorResult,
@@ -18,7 +18,7 @@ import {
 import { BatchNotificationAction, BatchNotificationActions } from "./BatchNotificationActions";
 import { EventBatch } from "./EventBatch";
 import { Serializer, ISerializedPayload } from "./Serializer";
-import RetryPolicy from "./RetryPolicy";
+import { retryPolicyGetMillisToBackoffForRetry, retryPolicyShouldRetryForStatus } from "./RetryPolicy";
 import EVTKillSwitch from "./KillSwitch";
 import EVTClockSkewManager from "./ClockSkewManager";
 import dynamicProto from "@microsoft/dynamicproto-js";
@@ -30,6 +30,7 @@ import {
     strKillTokensHeader, strMsaDeviceTicket, strMsfpc, strNoResponseBody, strOther, strRequeue, strResponseFail, strSending, strTimeDeltaHeader,
     strTimeDeltaToApply, strUploadTime
 } from "./Constants";
+import { ITimeoutOverrideWrapper } from "./TimeoutOverrideWrapper";
 
 const strSendAttempt = "sendAttempt";
 
@@ -61,23 +62,20 @@ const _eventActionMap: any = {
 const _collectorQsHeaders = { };
 const _collectorHeaderToQs = { };
 
-function _addCollectorHeaderQsMapping(qsName: string, headerName: string) {
+function _addCollectorHeaderQsMapping(qsName: string, headerName: string, allowQs?: boolean) {
     _collectorQsHeaders[qsName] = headerName;
-    _collectorHeaderToQs[headerName] = qsName;
+    if (allowQs !== false) {
+        _collectorHeaderToQs[headerName] = qsName;
+    }
 }
 
-_addCollectorHeaderQsMapping(strMsaDeviceTicket, strMsaDeviceTicket);
-
-// ----------------------------------------------------------------------------------------------------------------
-// Task 12886642: Need to wait until an updated version of the collector is released to return these as allowed in the OPTIONS call
-// ----------------------------------------------------------------------------------------------------------------
-//_addCollectorHeaderQsMapping(strClientVersion, strClientVersion);
-//_addCollectorHeaderQsMapping(strClientId, "Client-Id");
-//_addCollectorHeaderQsMapping(strApiKey, strApiKey);
-//_addCollectorHeaderQsMapping(strTimeDeltaToApply, strTimeDeltaToApply);
-//_addCollectorHeaderQsMapping(strUploadTime, strUploadTime);
-//_addCollectorHeaderQsMapping(strAuthXToken, strAuthXToken);
-// ----------------------------------------------------------------------------------------------------------------
+_addCollectorHeaderQsMapping(strMsaDeviceTicket, strMsaDeviceTicket, false);
+_addCollectorHeaderQsMapping(strClientVersion, strClientVersion);
+_addCollectorHeaderQsMapping(strClientId, "Client-Id");
+_addCollectorHeaderQsMapping(strApiKey, strApiKey);
+_addCollectorHeaderQsMapping(strTimeDeltaToApply, strTimeDeltaToApply);
+_addCollectorHeaderQsMapping(strUploadTime, strUploadTime);
+_addCollectorHeaderQsMapping(strAuthXToken, strAuthXToken);
 
 type OnCompleteCallback = (status: number, headers: { [headerName: string]: string }, response?: string) => void;
 
@@ -144,7 +142,7 @@ export class HttpManager {
      * @constructor
      * @param requestQueue   - The queue that contains the requests to be sent.
      */
-    constructor(maxEventsPerBatch: number, maxConnections: number, maxRequestRetriesBeforeBackoff: number, actions: BatchNotificationActions) {
+    constructor(maxEventsPerBatch: number, maxConnections: number, maxRequestRetriesBeforeBackoff: number, actions: BatchNotificationActions, timeoutOverride: ITimeoutOverrideWrapper) {
         let _urlString: string = "?cors=true&" + strContentTypeHeader.toLowerCase() + "=" + defaultContentType;
         let _killSwitch: EVTKillSwitch = new EVTKillSwitch();
         let _paused = false;
@@ -182,8 +180,7 @@ export class HttpManager {
 
                 _urlString = endpointUrl + _urlString;
 
-                // Task 12886642: Defaulting to 'false' until the Collector handles sending upload-time header in the OPTIONS call
-                _useHeaders = !isUndefined(channelConfig.avoidOptions) ? !channelConfig.avoidOptions : false;
+                _useHeaders = !isUndefined(channelConfig.avoidOptions) ? !channelConfig.avoidOptions : true;
                 _core = core;
                 _cookieMgr = core.getCookieMgr();
                 _enableEventTimings = !(_core.config as IExtendedConfiguration).disableEventTimings;
@@ -317,7 +314,7 @@ export class HttpManager {
                 if (sync) {
                     xdr.send(payload.data);
                 } else {
-                    _postManager._setTimeoutOverride(() => {
+                    timeoutOverride.set(() => {
                         xdr.send(payload.data);
                     }, 0);
                 }
@@ -389,7 +386,7 @@ export class HttpManager {
 
                 if (!responseHandled && payload.timeout > 0) {
                     // Simulate timeout
-                    _postManager._setTimeoutOverride(() => {
+                    timeoutOverride.set(() => {
                         if (!responseHandled) {
                             // Assume a 500 response (which will cause a retry)
                             responseHandled = true;
@@ -461,8 +458,9 @@ export class HttpManager {
                 try {
                     oncomplete(status, headers, response);
                 } catch (e) {
-                    _postManager.diagLog().throwInternal(LoggingSeverity.WARNING,
-                        _ExtendedInternalMessageId.SendPostOnCompleteFailure, dumpObj(e));
+                    _throwInternal(_postManager.diagLog(),
+                        eLoggingSeverity.WARNING,
+                        _eExtendedInternalMessageId.SendPostOnCompleteFailure, dumpObj(e));
                 }
             }
 
@@ -502,7 +500,7 @@ export class HttpManager {
                     }
 
                 } catch (ex) {
-                    _postManager.diagLog().warnToConsole("Failed to send telemetry using sendBeacon API. Ex:" + ex);
+                    _postManager.diagLog().warnToConsole("Failed to send telemetry using sendBeacon API. Ex:" + dumpObj(ex));
                     status = 0;
                 } finally {
                     _doOnComplete(oncomplete, status, {}, "");
@@ -740,8 +738,9 @@ export class HttpManager {
                         _sendBatchesNotification(droppedBatches, EventBatchNotificationReason.KillSwitch, sendType);
                     }, () => ({ batches: _createDebugBatches(orgBatches), retryCount, isTeardown, isSynchronous, sendReason, useSendBeacon: _isBeaconPayload(sendType), sendType }), !isSynchronous);
                 } catch (ex) {
-                    _postManager.diagLog().throwInternal(LoggingSeverity.WARNING,
-                        _ExtendedInternalMessageId.CannotSerializeObject, "Unexpected Exception sending batch: " + dumpObj(ex));
+                    _throwInternal(_postManager.diagLog(),
+                        eLoggingSeverity.WARNING,
+                        _eInternalMessageId.CannotSerializeObject, "Unexpected Exception sending batch: " + dumpObj(ex));
                 }
             }
 
@@ -752,26 +751,22 @@ export class HttpManager {
                     useHdrs: false          // Assume no headers
                 };
 
-                // ----------------------------------------------------------------------------------------------------------------
-                // Task 12886642: Need to wait until an updated version of the collector is released to return these as allowed in the OPTIONS call
-                // ----------------------------------------------------------------------------------------------------------------
-                // if (!useHeaders) {
-                //     // Attempt to map headers to a query string if possible
-                //     objForEachKey(_headers, (name, value) => {
-                //         if (_collectorHeaderToQs[name]) {
-                //             _addRequestDetails(requestDetails, _collectorHeaderToQs[name], value, false);
-                //         } else {
-                //             // No mapping, so just include in the headers anyway (may not get sent if using sendBeacon())
-                //             requestDetails.hdrs[name] = value;
-                //             requestDetails.useHdrs = true;
-                //         }
-                //     });
-                // } else {
+                if (!useHeaders) {
+                    // Attempt to map headers to a query string if possible
+                    objForEachKey(_headers, (name, value) => {
+                        if (_collectorHeaderToQs[name]) {
+                            _addRequestDetails(requestDetails, _collectorHeaderToQs[name], value, false);
+                        } else {
+                            // No mapping, so just include in the headers anyway (may not get sent if using sendBeacon())
+                            requestDetails.hdrs[name] = value;
+                            requestDetails.useHdrs = true;
+                        }
+                    });
+                } else {
                     // Copy the pre-defined headers into the payload headers
                     requestDetails.hdrs = extend(requestDetails.hdrs, _headers);
                     requestDetails.useHdrs = (objKeys(requestDetails.hdrs).length > 0);
-                // }
-                // ----------------------------------------------------------------------------------------------------------------
+                }
 
                 _addRequestDetails(requestDetails, strClientId, "NO_AUTH", useHeaders);
                 _addRequestDetails(requestDetails, strClientVersion, FullVersionString, useHeaders);
@@ -1033,7 +1028,7 @@ export class HttpManager {
                             return;
                         }
 
-                        if (!RetryPolicy.shouldRetryForStatus(status) || thePayload.numEvents <= 0) {
+                        if (!retryPolicyShouldRetryForStatus(status) || thePayload.numEvents <= 0) {
                             // Only retry for specific response codes and if there is still events after kill switch processing
                             shouldRetry = false;
                         }
@@ -1060,7 +1055,7 @@ export class HttpManager {
                                     }
 
                                     _sendBatches(thePayload.batches, retryCount + 1, thePayload.isTeardown, _isUnloading ? EventSendType.SendBeacon : thePayload.sendType, SendRequestReason.Retry);
-                                }, _isUnloading, RetryPolicy.getMillisToBackoffForRetry(retryCount));
+                                }, _isUnloading, retryPolicyGetMillisToBackoffForRetry(retryCount));
                             } else {
                                 backOffTrans = true;
                                 if (_isUnloading) {
@@ -1141,7 +1136,7 @@ export class HttpManager {
                 if (isSync) {
                     cb();
                 } else {
-                    _postManager._setTimeoutOverride(cb, interval);
+                    timeoutOverride.set(cb, interval);
                 }
             }
 
@@ -1189,8 +1184,9 @@ export class HttpManager {
                         try {
                             responseHandlers[i](responseText);
                         } catch (e) {
-                            _postManager.diagLog().throwInternal(LoggingSeverity.CRITICAL,
-                                _ExtendedInternalMessageId.PostResponseHandler,
+                            _throwInternal(_postManager.diagLog(),
+                                eLoggingSeverity.CRITICAL,
+                                _eExtendedInternalMessageId.PostResponseHandler,
                                 "Response handler failed: " + e);
                         }
                     }
@@ -1217,8 +1213,9 @@ export class HttpManager {
                                 try {
                                     theAction.call(actions, theBatches, batchReason, isSyncRequest, sendType);
                                 } catch (e) {
-                                    _postManager.diagLog().throwInternal(LoggingSeverity.CRITICAL,
-                                        _ExtendedInternalMessageId.NotificationException,
+                                    _throwInternal(_postManager.diagLog(),
+                                        eLoggingSeverity.CRITICAL,
+                                        _eInternalMessageId.NotificationException,
                                         "send request notification failed: " + e);
                                 }
                             }, sendSync || isSyncRequest, 0);