@microsoft/1ds-post-js 4.3.7-nightly3.2504-18 → 4.3.7-nightly3.2505-02

package/README.md

@@ -66,6 +66,7 @@ appInsightsCore.initialize(coreConfig, []);
 | maxEventRetryAttempts<br /><sub><i>(Since 3.1.11+)</i></sub> | [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. | number<br/>Default: 6
 | maxUnloadEventRetryAttempts<br /><sub><i>(Since 3.1.11+)</i></sub> | [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.<br/>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. | number<br/>Default: 2
 | addNoResponse <br /><sub><i>(Since 3.2.8+)</i></sub> | [Optional] flag to indicate whether the sendBeacon and fetch (with keep-alive flag) should add the "NoResponseBody" query string value to indicate that the server should return a 204 for successful requests. | boolean<br/>Default: true
+| disableZip <br /><sub><i>(Since 4.3.7+)</i></sub> | [Optional] flag to use CompressionStream API to compress the payload. Compression will only occur if the event is asynchronous. For events like unloads, compression will not be applied. * Note: if user set payloadPreprocessor, this zip compression will not be applied. | boolean<br/>Default: true
 
 ### [IXHROverride](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-post-js/interfaces/IXHROverride.html)
 

package/bundle/es5/{ms.post-4.3.7-nightly3.2504-18.gbl.js → ms.post-4.3.7-nightly3.2505-02.gbl.js}

@@ -1,12 +1,12 @@
 /*!
- * 1DS JS SDK POST plugin, 4.3.7-nightly3.2504-18
+ * 1DS JS SDK POST plugin, 4.3.7-nightly3.2505-02
  * Copyright (c) Microsoft and contributors. All rights reserved.
  * (Microsoft Internal Only)
  */
 (function (global, factory) {
     var undef = "undefined";
-    var nsKey, key, nm, theExports = {}, modName = "es5_ms_post_4_3_7_nightly3_2504_18", msMod="__ms$mod__";
-    var mods={}, modDetail=mods[modName]={}, ver="4.3.7-nightly3.2504-18";
+    var nsKey, key, nm, theExports = {}, modName = "es5_ms_post_4_3_7_nightly3_2505_02", msMod="__ms$mod__";
+    var mods={}, modDetail=mods[modName]={}, ver="4.3.7-nightly3.2505-02";
     // Versioned namespace "oneDS4"
     var exportNs=global, nsKey="oneDS4", exportNs=exportNs[nsKey]=(exportNs[nsKey]||{});
     // Global namespace "oneDS"
@@ -1193,8 +1193,8 @@ var _DYN_IS_CHILD_EVT = "isChildEvt";
 var _DYN_DATA = "data";
 var _DYN_GET_CTX = "getCtx";
 var _DYN_SET_CTX = "setCtx";
-var _DYN_URL_STRING = "urlString";
 var _DYN_HEADERS$1 = "headers";
+var _DYN_URL_STRING = "urlString";
 var _DYN_TIMEOUT = "timeout";
 
 var aggregationErrorType;
@@ -1607,6 +1607,20 @@ function optimizeObject(theObject) {
     }
     return theObject;
 }
+function isFeatureEnabled(feature, cfg) {
+    var ft = cfg && cfg.featureOptIn && cfg.featureOptIn[feature];
+    if (feature && ft) {
+        var mode = ft.mode;
+        if (mode === 3 ) {
+            return true;
+        }
+        else if (mode === 2 ) {
+            return false;
+        }
+        return UNDEFINED_VALUE;
+    }
+    return UNDEFINED_VALUE;
+}
 function getResponseText(xhr) {
     try {
         return xhr.responseText;
@@ -1911,7 +1925,7 @@ function newId(maxLength) {
     return result;
 }
 
-var version = '3.3.7-nightly3.2504-18';
+var version = '3.3.7-nightly3.2505-02';
 var instanceName = "." + newId(6);
 var _dataUid = 0;
 function _canAcceptData(target) {
@@ -3524,6 +3538,58 @@ var SenderPostManager = /** @class */ (function () {
             _self[_DYN__DO_TEARDOWN ] = function (unloadCtx, unloadState) {
                 _initDefaults();
             };
+            _self.preparePayload = function (callback, zipPayload, payload, isSync) {
+                if (!zipPayload || isSync || !payload[_DYN_DATA ]) {
+                    callback(payload);
+                    return;
+                }
+                try {
+                    var csStream = getInst("CompressionStream");
+                    if (!isFunction(csStream)) {
+                        callback(payload);
+                        return;
+                    }
+                    var body = new ReadableStream({
+                        start: function (controller) {
+                            controller.enqueue(isString(payload[_DYN_DATA ]) ? new TextEncoder().encode(payload[_DYN_DATA ]) : payload[_DYN_DATA ]);
+                            controller.close();
+                        }
+                    });
+                    var compressedStream = body.pipeThrough(new csStream("gzip"));
+                    var reader_1 = compressedStream.getReader();
+                    var chunks_1 = [];
+                    var totalLength_1 = 0;
+                    var callbackCalled_1 = false;
+                    doAwaitResponse(reader_1.read(), function processChunk(response) {
+                        if (!callbackCalled_1 && !response.rejected) {
+                            var result = response[_DYN_VALUE$1 ];
+                            if (!result.done) {
+                                chunks_1[_DYN_PUSH$1 ](result[_DYN_VALUE$1 ]);
+                                totalLength_1 += result.value[_DYN_LENGTH$2 ];
+                                return doAwaitResponse(reader_1.read(), processChunk);
+                            }
+                            var combined = new Uint8Array(totalLength_1);
+                            var offset = 0;
+                            for (var _i = 0, chunks_2 = chunks_1; _i < chunks_2.length; _i++) {
+                                var chunk = chunks_2[_i];
+                                combined.set(chunk, offset);
+                                offset += chunk[_DYN_LENGTH$2 ];
+                            }
+                            payload[_DYN_DATA ] = combined;
+                            payload[_DYN_HEADERS$1 ]["Content-Encoding"] = "gzip";
+                        }
+                        if (!callbackCalled_1) {
+                            callbackCalled_1 = true;
+                            callback(payload);
+                        }
+                    });
+                    return reader_1;
+                }
+                catch (error) {
+                    callback(payload);
+                    return;
+                }
+            };
             function _onSuccess(res, onComplete) {
                 _doOnComplete(onComplete, 200, {}, res);
             }
@@ -4185,7 +4251,7 @@ var _DYN_LENGTH$1 = "length";
 var _DYN_PROCESS_TELEMETRY_ST0 = "processTelemetryStart";
 
 var _a$1;
-var Version = '4.3.7-nightly3.2504-18';
+var Version = '4.3.7-nightly3.2505-02';
 var FullVersionString = "1DS-Web-JS-" + Version;
 var ObjHasOwnProperty = ObjProto$1.hasOwnProperty;
 var _fieldTypeEventPropMap = (_a$1 = {},
@@ -4623,7 +4689,7 @@ var metadata = "metadata";
 var f = "f";
 var rCheckDot = /\./;
 var Serializer = /** @class */ (function () {
-    function Serializer(perfManager, valueSanitizer, stringifyObjects, enableCompoundKey, getEncodedTypeOverride, excludeCsMetaData) {
+    function Serializer(perfManager, valueSanitizer, stringifyObjects, enableCompoundKey, getEncodedTypeOverride, excludeCsMetaData, cfg) {
         var strData = "data";
         var strBaseData = "baseData";
         var strExt = "ext";
@@ -4633,6 +4699,11 @@ var Serializer = /** @class */ (function () {
         var _isReservedCache = {};
         var _excludeCsMetaData = !!excludeCsMetaData;
         var _getEncodedType = getEncodedTypeOverride || getCommonSchemaMetaData;
+        var _sizeCfg = _getSizeLimtCfg(cfg);
+        var _requestSizeLimitBytes = _validateSizeLimit(_sizeCfg.requestLimit, RequestSizeLimitBytes, 0);
+        var _beaconRequestSizeLimitBytes = _validateSizeLimit(_sizeCfg.requestLimit, BeaconRequestSizeLimitBytes, 1);
+        var _maxRecordSize = _validateSizeLimit(_sizeCfg.recordLimit, MaxRecordSize, 0);
+        var _maxBeaconRecordSize = Math.min(_validateSizeLimit(_sizeCfg.recordLimit, MaxBeaconRecordSize, 1), _beaconRequestSizeLimitBytes);
         dynamicProto(Serializer, this, function (_self) {
             _self.createPayload = function (retryCnt, isTeardown, isSync, isReducedPayload, sendReason, sendType) {
                 return {
@@ -4662,8 +4733,8 @@ var Serializer = /** @class */ (function () {
                         var sizeExceeded = [];
                         var failedEvts = [];
                         var isBeaconPayload = payload.isBeacon;
-                        var requestMaxSize = isBeaconPayload ? BeaconRequestSizeLimitBytes : RequestSizeLimitBytes;
-                        var recordMaxSize = isBeaconPayload ? MaxBeaconRecordSize : MaxRecordSize;
+                        var requestMaxSize = isBeaconPayload ? _beaconRequestSizeLimitBytes : _requestSizeLimitBytes;
+                        var recordMaxSize = isBeaconPayload ? _maxBeaconRecordSize : _maxRecordSize;
                         var lp = 0;
                         var joinCount = 0;
                         while (lp < theEvents.length) {
@@ -4826,6 +4897,22 @@ var Serializer = /** @class */ (function () {
     Serializer.__ieDyn=1;
     return Serializer;
 }());
+function _validateSizeLimit(cfgVal, defaultVal, idx) {
+    if (isArray(cfgVal)) {
+        var val = cfgVal[idx];
+        if (val > 0 && val <= defaultVal) {
+            return val;
+        }
+    }
+    return defaultVal;
+}
+function _getSizeLimtCfg(cfg) {
+    var defaultCfg = {};
+    if (cfg && cfg.requestLimit) {
+        return cfg.requestLimit;
+    }
+    return defaultCfg;
+}
 function _addJSONPropertyMetaData(getEncodedType, json, propKeys, name, propertyValue) {
     if (propertyValue && json) {
         var encodedTypeValue = getEncodedType(propertyValue.value, propertyValue.kind, propertyValue.propertyType);
@@ -4970,6 +5057,7 @@ var HttpManager = /** @class */ (function () {
         var _isUnloading;
         var _useHeaders;
         var _xhrTimeout;
+        var _zipPayload;
         var _disableXhrSync;
         var _disableFetchKeepAlive;
         var _canHaveReducedPayload;
@@ -5017,6 +5105,11 @@ var HttpManager = /** @class */ (function () {
                             enableCompoundKey = !!channelConfig[_DYN_ENABLE_COMPOUND_KEY ];
                         }
                         _xhrTimeout = channelConfig.xhrTimeout;
+                        var csStream = getInst("CompressionStream");
+                        _zipPayload = isFeatureEnabled("zipPayload", coreConfig);
+                        if (!isFunction(csStream) || _sendHook) {
+                            _zipPayload = false;
+                        }
                         _disableXhrSync = !!channelConfig[_DYN_DISABLE_XHR_SYNC ];
                         _disableFetchKeepAlive = !!channelConfig[_DYN_DISABLE_FETCH_KEEP_A6 ];
                         _addNoResponse = channelConfig[_DYN_ADD_NO_RESPONSE ] !== false;
@@ -5025,7 +5118,7 @@ var HttpManager = /** @class */ (function () {
                             _disableFetchKeepAlive = true;
                         }
                         _useBeacons = !isReactNative();
-                        _serializer = new Serializer(_core, valueSanitizer, stringifyObjects, enableCompoundKey, getCommonSchemaMetaData, _excludeCsMetaData);
+                        _serializer = new Serializer(_core, valueSanitizer, stringifyObjects, enableCompoundKey, getCommonSchemaMetaData, _excludeCsMetaData, channelConfig);
                         if (!isNullOrUndefined(channelConfig[_DYN_USE_SEND_BEACON ])) {
                             _useBeacons = !!channelConfig[_DYN_USE_SEND_BEACON ];
                         }
@@ -5568,16 +5661,18 @@ var HttpManager = /** @class */ (function () {
                                     _retryRequestIfNeeded(status, headers, thePayload, sendReason);
                                 };
                                 var isSync = thePayload[_DYN_IS_TEARDOWN ] || thePayload.isSync;
-                                try {
-                                    sendInterface_1.sendPOST(payload, onComplete, isSync);
-                                    if (_sendListener) {
-                                        _sendListener(orgPayloadData, payload, isSync, thePayload[_DYN_IS_BEACON ]);
+                                _sendPostMgr.preparePayload(function (processedPayload) {
+                                    try {
+                                        sendInterface_1.sendPOST(processedPayload, onComplete, isSync);
+                                        if (_sendListener) {
+                                            _sendListener(orgPayloadData, processedPayload, isSync, thePayload[_DYN_IS_BEACON ]);
+                                        }
                                     }
-                                }
-                                catch (ex) {
-                                    _warnToConsole(_logger, "Unexpected exception sending payload. Ex:" + dumpObj(ex));
-                                    _doOnComplete(onComplete, 0, {});
-                                }
+                                    catch (ex) {
+                                        _doOnComplete(onComplete, 0, {});
+                                        _warnToConsole(_logger, "Unexpected exception sending payload. Ex:" + dumpObj(ex));
+                                    }
+                                }, _zipPayload, payload, isSync);
                             };
                         }
                         doPerf(_core, function () { return "HttpManager:_doPayloadSend.sender"; }, function () {
@@ -5851,7 +5946,8 @@ var defaultPostChannelConfig = objDeepFreeze({
     maxEventRetryAttempts: { isVal: isNumber, v: MaxSendAttempts },
     maxUnloadEventRetryAttempts: { isVal: isNumber, v: MaxSyncUnloadSendAttempts },
     addNoResponse: undefValue,
-    excludeCsMetaData: undefValue
+    excludeCsMetaData: undefValue,
+    requestLimit: {}
 });
 function isOverrideFn(httpXHROverride) {
     return httpXHROverride && httpXHROverride.sendPOST;
@@ -5862,7 +5958,7 @@ var PostChannel = /** @class */ (function (_super) {
         var _this = _super.call(this) || this;
         _this.identifier = "PostChannel";
         _this.priority = 1011;
-        _this.version = '4.3.7-nightly3.2504-18';
+        _this.version = '4.3.7-nightly3.2505-02';
         var _postConfig;
         var _isTeardownCalled = false;
         var _flushCallbackQueue = [];
@@ -6647,4 +6743,4 @@ exports.PostChannel = PostChannel;
 exports.RT_PROFILE = RT_PROFILE;
 
 }));
-//# sourceMappingURL=ms.post-4.3.7-nightly3.2504-18.gbl.js.map
+//# sourceMappingURL=ms.post-4.3.7-nightly3.2505-02.gbl.js.map