@microsoft/1ds-post-js 3.1.9 → 3.2.0

package/dist-esm/src/BatchNotificationActions.js

@@ -1,5 +1,5 @@
 /*
- * 1DS JS SDK POST plugin, 3.1.9
+ * 1DS JS SDK POST plugin, 3.2.0
  * 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.9
+ * 1DS JS SDK POST plugin, 3.2.0
  * Copyright (c) Microsoft and contributors. All rights reserved.
  * (Microsoft Internal Only)
  */

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

@@ -0,0 +1,25 @@
+export declare const Method = "POST";
+export declare const DisabledPropertyName: string;
+export declare const strDropped = "drop";
+export declare const strSending = "send";
+export declare const strRequeue = "requeue";
+export declare const strResponseFail = "rspFail";
+export declare const strOther = "oth";
+export declare const defaultCacheControl = "no-cache, no-store";
+export declare const defaultContentType = "application/x-json-stream";
+export declare const strCacheControl = "cache-control";
+export declare const strContentTypeHeader = "content-type";
+export declare const strKillTokensHeader = "kill-tokens";
+export declare const strKillDurationHeader = "kill-duration";
+export declare const strKillDurationSecondsHeader = "kill-duration-seconds";
+export declare const strTimeDeltaHeader = "time-delta-millis";
+export declare const strClientVersion = "client-version";
+export declare const strClientId = "client-id";
+export declare const strTimeDeltaToApply = "time-delta-to-apply-millis";
+export declare const strUploadTime = "upload-time";
+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

@@ -0,0 +1,31 @@
+/*
+ * 1DS JS SDK POST plugin, 3.2.0
+ * Copyright (c) Microsoft and contributors. All rights reserved.
+ * (Microsoft Internal Only)
+ */
+export var Method = "POST";
+export var DisabledPropertyName = "Microsoft_ApplicationInsights_BypassAjaxInstrumentation";
+export var strDropped = "drop";
+export var strSending = "send";
+export var strRequeue = "requeue";
+export var strResponseFail = "rspFail";
+export var strOther = "oth";
+export var defaultCacheControl = "no-cache, no-store";
+export var defaultContentType = "application/x-json-stream";
+export var strCacheControl = "cache-control";
+export var strContentTypeHeader = "content-type";
+export var strKillTokensHeader = "kill-tokens";
+export var strKillDurationHeader = "kill-duration";
+export var strKillDurationSecondsHeader = "kill-duration-seconds";
+export var strTimeDeltaHeader = "time-delta-millis";
+export var strClientVersion = "client-version";
+export var strClientId = "client-id";
+export var strTimeDeltaToApply = "time-delta-to-apply-millis";
+export var strUploadTime = "upload-time";
+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

@@ -0,0 +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 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;
     /**
@@ -132,6 +138,55 @@ export interface IChannelConfiguration {
      * This is used during initialization to identify the requested send transport, it will be ignored if a httpXHROverride is provided.
      */
     transports?: number | number[];
+    /**
+     * [Optional] Avoid adding request headers to the outgoing request that would cause a pre-flight (OPTIONS) request to be sent for each request.
+     * This currently defaults to true but will be changed once the collector handles additional settings to allow the browser to better cache any
+     * 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.9
+ * 1DS JS SDK POST plugin, 3.2.0
  * Copyright (c) Microsoft and contributors. All rights reserved.
  * (Microsoft Internal Only)
  */

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

@@ -20,6 +20,10 @@ export declare class EventBatch {
      * Returns the iKey associated with this batch of events
      */
     iKey: () => string;
+    /**
+     * Returns the first msfpc value from the batch
+     */
+    Msfpc: () => string;
     /**
      * Returns the number of events contained in the batch
      */
@@ -29,10 +33,9 @@ export declare class EventBatch {
      * Add all of the events to the current batch, if the max number of events would be exceeded then no
      * events are added.
      * @param theEvents - The events that needs to be batched.
-     * @param append - True (default) add the event to the end of the queue otherwise prepend (used for re-queuing)
      * @returns The number of events added.
      */
-    addEvents: (theEvents: IPostTransmissionTelemetryItem[], append: boolean) => number;
+    addEvent: (theEvents: IPostTransmissionTelemetryItem) => boolean;
     /**
      * Split this batch into 2 with any events > fromEvent returned in the new batch and all other
      * events are kept in the current batch.

package/dist-esm/src/EventBatch.js

@@ -1,9 +1,24 @@
 /*
- * 1DS JS SDK POST plugin, 3.1.9
+ * 1DS JS SDK POST plugin, 3.2.0
  * Copyright (c) Microsoft and contributors. All rights reserved.
  * (Microsoft Internal Only)
  */
-import { isNullOrUndefined } from "@microsoft/1ds-core-js";
+import { isNullOrUndefined, isValueAssigned } from "@microsoft/1ds-core-js";
+import { strMsfpc } from "./Constants";
+function _getEventMsfpc(theEvent) {
+    var intWeb = ((theEvent.ext || {})["intweb"]);
+    if (intWeb && isValueAssigned(intWeb[strMsfpc])) {
+        return intWeb[strMsfpc];
+    }
+    return null;
+}
+function _getMsfpc(theEvents) {
+    var msfpc = null;
+    for (var lp = 0; msfpc === null && lp < theEvents.length; lp++) {
+        msfpc = _getEventMsfpc(theEvents[lp]);
+    }
+    return msfpc;
+}
 /**
 * This class defines a "batch" events related to a specific iKey, it is used by the PostChannel and HttpManager
 * to collect and transfer ownership of events without duplicating them in-memory. This reduces the previous
@@ -19,39 +34,44 @@ var EventBatch = /** @class */ (function () {
     function EventBatch(iKey, addEvents) {
         var events = addEvents ? [].concat(addEvents) : [];
         var _self = this;
+        var _msfpc = _getMsfpc(events);
         _self.iKey = function () {
             return iKey;
         };
+        _self.Msfpc = function () {
+            // return the cached value unless it's undefined -- used to avoid cpu
+            return _msfpc || "";
+        };
         _self.count = function () {
             return events.length;
         };
         _self.events = function () {
             return events;
         };
-        _self.addEvents = function (theEvents, append) {
-            if (append === void 0) { append = true; }
-            if (theEvents && theEvents.length > 0) {
-                if (append) {
-                    events = events.concat(theEvents);
-                }
-                else {
-                    events = theEvents.concat(events);
+        _self.addEvent = function (theEvent) {
+            if (theEvent) {
+                events.push(theEvent);
+                if (!_msfpc) {
+                    // Not found so try and find one
+                    _msfpc = _getEventMsfpc(theEvent);
                 }
-                return theEvents.length;
+                return true;
             }
-            return 0;
+            return false;
         };
         _self.split = function (fromEvent, numEvents) {
             // Create a new batch with the same iKey
-            var newBatch = new EventBatch(iKey);
+            var theEvents;
             if (fromEvent < events.length) {
                 var cnt = events.length - fromEvent;
                 if (!isNullOrUndefined(numEvents)) {
                     cnt = numEvents < cnt ? numEvents : cnt;
                 }
-                newBatch.addEvents(events.splice(fromEvent, cnt), true);
+                theEvents = events.splice(fromEvent, cnt);
+                // reset the fetched msfpc value
+                _msfpc = _getMsfpc(events);
             }
-            return newBatch;
+            return new EventBatch(iKey, theEvents);
         };
     }
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"EventBatch.js.map","sources":["EventBatch.js"],"sourcesContent":["import { isNullOrUndefined } from \"@microsoft/1ds-core-js\";\r\n/**\r\n* This class defines a \"batch\" events related to a specific iKey, it is used by the PostChannel and HttpManager\r\n* to collect and transfer ownership of events without duplicating them in-memory. This reduces the previous\r\n* array duplication and shared ownership issues that occurred due to race conditions caused by the async nature\r\n* of sending requests.\r\n*/\r\nvar EventBatch = /** @class */ (function () {\r\n    /**\r\n     * Private constructor so that caller is forced to use the static create method.\r\n     * @param iKey - The iKey to associate with the events (not validated)\r\n     * @param addEvents - The optional collection of events to assign to this batch - defaults to an empty array.\r\n     */\r\n    function EventBatch(iKey, addEvents) {\r\n        var events = addEvents ? [].concat(addEvents) : [];\r\n        var _self = this;\r\n        _self.iKey = function () {\r\n            return iKey;\r\n        };\r\n        _self.count = function () {\r\n            return events.length;\r\n        };\r\n        _self.events = function () {\r\n            return events;\r\n        };\r\n        _self.addEvents = function (theEvents, append) {\r\n            if (append === void 0) { append = true; }\r\n            if (theEvents && theEvents.length > 0) {\r\n                if (append) {\r\n                    events = events.concat(theEvents);\r\n                }\r\n                else {\r\n                    events = theEvents.concat(events);\r\n                }\r\n                return theEvents.length;\r\n            }\r\n            return 0;\r\n        };\r\n        _self.split = function (fromEvent, numEvents) {\r\n            // Create a new batch with the same iKey\r\n            var newBatch = new EventBatch(iKey);\r\n            if (fromEvent < events.length) {\r\n                var cnt = events.length - fromEvent;\r\n                if (!isNullOrUndefined(numEvents)) {\r\n                    cnt = numEvents < cnt ? numEvents : cnt;\r\n                }\r\n                newBatch.addEvents(events.splice(fromEvent, cnt), true);\r\n            }\r\n            return newBatch;\r\n        };\r\n    }\r\n    /**\r\n     * Creates a new Event Batch object\r\n     * @param iKey The iKey associated with this batch of events\r\n     */\r\n    EventBatch.create = function (iKey, theEvents) {\r\n        return new EventBatch(iKey, theEvents);\r\n    };\r\n    return EventBatch;\r\n}());\r\nexport { EventBatch };\r\n//# sourceMappingURL=EventBatch.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;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;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA"}
+{"version":3,"file":"EventBatch.js.map","sources":["EventBatch.js"],"sourcesContent":["import { isNullOrUndefined, isValueAssigned } from \"@microsoft/1ds-core-js\";\r\nimport { strMsfpc } from \"./Constants\";\r\nfunction _getEventMsfpc(theEvent) {\r\n    var intWeb = ((theEvent.ext || {})[\"intweb\"]);\r\n    if (intWeb && isValueAssigned(intWeb[strMsfpc])) {\r\n        return intWeb[strMsfpc];\r\n    }\r\n    return null;\r\n}\r\nfunction _getMsfpc(theEvents) {\r\n    var msfpc = null;\r\n    for (var lp = 0; msfpc === null && lp < theEvents.length; lp++) {\r\n        msfpc = _getEventMsfpc(theEvents[lp]);\r\n    }\r\n    return msfpc;\r\n}\r\n/**\r\n* This class defines a \"batch\" events related to a specific iKey, it is used by the PostChannel and HttpManager\r\n* to collect and transfer ownership of events without duplicating them in-memory. This reduces the previous\r\n* array duplication and shared ownership issues that occurred due to race conditions caused by the async nature\r\n* of sending requests.\r\n*/\r\nvar EventBatch = /** @class */ (function () {\r\n    /**\r\n     * Private constructor so that caller is forced to use the static create method.\r\n     * @param iKey - The iKey to associate with the events (not validated)\r\n     * @param addEvents - The optional collection of events to assign to this batch - defaults to an empty array.\r\n     */\r\n    function EventBatch(iKey, addEvents) {\r\n        var events = addEvents ? [].concat(addEvents) : [];\r\n        var _self = this;\r\n        var _msfpc = _getMsfpc(events);\r\n        _self.iKey = function () {\r\n            return iKey;\r\n        };\r\n        _self.Msfpc = function () {\r\n            // return the cached value unless it's undefined -- used to avoid cpu\r\n            return _msfpc || \"\";\r\n        };\r\n        _self.count = function () {\r\n            return events.length;\r\n        };\r\n        _self.events = function () {\r\n            return events;\r\n        };\r\n        _self.addEvent = function (theEvent) {\r\n            if (theEvent) {\r\n                events.push(theEvent);\r\n                if (!_msfpc) {\r\n                    // Not found so try and find one\r\n                    _msfpc = _getEventMsfpc(theEvent);\r\n                }\r\n                return true;\r\n            }\r\n            return false;\r\n        };\r\n        _self.split = function (fromEvent, numEvents) {\r\n            // Create a new batch with the same iKey\r\n            var theEvents;\r\n            if (fromEvent < events.length) {\r\n                var cnt = events.length - fromEvent;\r\n                if (!isNullOrUndefined(numEvents)) {\r\n                    cnt = numEvents < cnt ? numEvents : cnt;\r\n                }\r\n                theEvents = events.splice(fromEvent, cnt);\r\n                // reset the fetched msfpc value\r\n                _msfpc = _getMsfpc(events);\r\n            }\r\n            return new EventBatch(iKey, theEvents);\r\n        };\r\n    }\r\n    /**\r\n     * Creates a new Event Batch object\r\n     * @param iKey The iKey associated with this batch of events\r\n     */\r\n    EventBatch.create = function (iKey, theEvents) {\r\n        return new EventBatch(iKey, theEvents);\r\n    };\r\n    return EventBatch;\r\n}());\r\nexport { EventBatch };\r\n//# sourceMappingURL=EventBatch.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;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;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;AACA;AACA;AACA;AACA;AACA;AACA"}

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

@@ -11,7 +11,7 @@ import { IChannelConfiguration } from "./Index";
 /**
  * Class managing the sending of requests.
  */
-export default class HttpManager {
+export declare class HttpManager {
     sendHook: PayloadPreprocessorFunction | undefined;
     sendListener: PayloadListenerFunction | undefined;
     _responseHandlers: Array<(responseText: string) => void>;
@@ -19,7 +19,7 @@ export default 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.