@microsoft/applicationinsights-channel-js 3.0.0-beta.2301-08 → 3.0.0-beta.2301-10

package/src/Sender.ts

@@ -148,6 +148,8 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
         let _convertUndefined: any;
         let _isRetryDisabled: boolean;
         let _maxBatchInterval: number;
+        let _sessionStorageUsed: boolean;
+        let _namePrefix: string;
 
         dynamicProto(Sender, this, (_self, _base) => {
 
@@ -164,10 +166,7 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
                     _retryAt = null;
 
                     // flush if we have exceeded the max-size already
-                    if (_self._buffer.size() > _maxBatchSizeInBytes) {
-                        _self.triggerSend(true, null, SendRequestReason.MaxBatchSize);
-                    }
-
+                    _checkMaxSize();
                     _setupTimer();
                 }
             };
@@ -227,7 +226,8 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
                 _offlineListener = createOfflineListener(_evtNamespace);
 
                 // This function will be re-called whenever any referenced configuration is changed
-                _self._addHook(onConfigChange(config, () => {
+                _self._addHook(onConfigChange(config, (details) => {
+                    let config = details.cfg;
                     let ctx = createProcessTelemetryContext(null, config, core);
                     let senderConfig = ctx.getExtCfg(identifier, defaultAppInsightsChannelConfig);
 
@@ -239,18 +239,62 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
                         }
                     });
 
+                    // Only update the endpoint if the original config !== the current config
+                    // This is so any redirect endpointUrl is not overwritten
+                    if (_orgEndpointUrl !== senderConfig.endpointUrl) {
+                        if (_orgEndpointUrl) {
+                            // TODO: add doc to remind users to flush before changing endpoint, otherwise all unsent payload will be sent to new endpoint
+                        }
+                        _endpointUrl = _orgEndpointUrl = senderConfig.endpointUrl;
+                    }
+
+                    if (_customHeaders && _customHeaders !== senderConfig.customHeaders) {
+                        // Removing any previously defined custom headers as they have changed
+                        arrForEach(_customHeaders, customHeader => {
+                            delete _headers[customHeader.header];
+                        });
+                    }
+
                     _maxBatchSizeInBytes = senderConfig.maxBatchSizeInBytes;
                     _beaconSupported = (senderConfig.onunloadDisableBeacon === false || senderConfig.isBeaconApiDisabled === false) && isBeaconsSupported();
+                    
+                    let canUseSessionStorage = !!senderConfig.enableSessionStorageBuffer && utlCanUseSessionStorage();
+                    let namePrefix = senderConfig.namePrefix;
+                 
+                    //Note: emitLineDelimitedJson and eventsLimitInMem is directly accessed via config in senderBuffer
+                    //Therefore, if canUseSessionStorage is not changed, we do not need to re initialize a new one
+                    let shouldUpdate = (canUseSessionStorage !== _sessionStorageUsed)
+                                    || (canUseSessionStorage && (_namePrefix !== namePrefix)); // prefixName is only used in session storage
 
                     if (_self._buffer) {
-                        // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-                        // TODO 3.x.x !!! - Handle the enableSessionStorageBuffer changing
-                        // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+                        // case1 (Pre and Now enableSessionStorageBuffer settings are same)
+                        // if namePrefix changes, transfer current buffer to new buffer
+                        // else no action needed
+
+                        //case2 (Pre and Now enableSessionStorageBuffer settings are changed)
+                        // transfer current buffer to new buffer
+                       
+                        if (shouldUpdate) {
+                            try {
+                                
+                                _self._buffer = _self._buffer.createNew(diagLog, senderConfig, canUseSessionStorage);
+                       
+                            } catch (e) {
+                                _throwInternal(_self.diagLog(), eLoggingSeverity.CRITICAL,
+                                    _eInternalMessageId.FailedAddingTelemetryToBuffer,
+                                    "failed to transfer telemetry to different buffer storage, telemetry will be lost: " + getExceptionName(e),
+                                    { exception: dumpObj(e) });
+                            }
+                        }
+                        _checkMaxSize();
                     } else {
-                        _self._buffer = (senderConfig.enableSessionStorageBuffer && utlCanUseSessionStorage())
+                        _self._buffer = canUseSessionStorage
                             ? new SessionStorageSendBuffer(diagLog, senderConfig) : new ArraySendBuffer(diagLog, senderConfig);
                     }
 
+                    _namePrefix = namePrefix;
+                    _sessionStorageUsed = canUseSessionStorage;
+
                     _self._sample = new Sample(senderConfig.samplingPercentage, diagLog);
 
                     _instrumentationKey = senderConfig.instrumentationKey;
@@ -260,26 +304,6 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
                             _eInternalMessageId.InvalidInstrumentationKey, "Invalid Instrumentation key " + _instrumentationKey);
                     }
 
-                    // Only update the endpoint if the original config !== the current config
-                    // This is so any redirect endpointUrl is not overwritten
-                    if (_orgEndpointUrl !== senderConfig.endpointUrl) {
-                        if (_orgEndpointUrl) {
-                            // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-                            // TODO 3.x.x !!! - Handle the endpointUrl changing
-                            // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-                        }
-
-                        _endpointUrl = _orgEndpointUrl = senderConfig.endpointUrl;
-                    }
-
-                    if (_customHeaders && _customHeaders !== senderConfig.customHeaders) {
-                        // Removing any previously defined custom headers as they have changed
-                        arrForEach(_customHeaders, customHeader => {
-                            delete _headers[customHeader.header];
-                        });
-                    }
-
-                  
                     _customHeaders = senderConfig.customHeaders;
                     if (!isInternalApplicationInsightsEndpoint(_endpointUrl) && _customHeaders && _customHeaders.length > 0) {
                         arrForEach(_customHeaders, customHeader => {
@@ -413,12 +437,8 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
         
                     // flush if we would exceed the max-size limit by adding this item
                     const buffer = _self._buffer;
-                    const bufferSize = buffer.size();
-        
-                    if ((bufferSize + payload.length) > _maxBatchSizeInBytes) {
-                        _self.triggerSend(true, null, SendRequestReason.MaxBatchSize);
-                    }
-        
+                    _checkMaxSize(payload);
+
                     // enqueue the payload
                     buffer.enqueue(payload);
         
@@ -581,6 +601,15 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
                 return _self._sample.isSampledIn(envelope);
             }
 
+            function _checkMaxSize(incomingPayload?: string): boolean {
+                let incomingSize = incomingPayload? incomingPayload.length : 0;
+                if ((_self._buffer.size() + incomingSize) > _maxBatchSizeInBytes) {
+                    _self.triggerSend(true, null, SendRequestReason.MaxBatchSize);
+                    return true;
+                }
+                return false;
+            }
+
             function _checkResponsStatus(status: number, payload: string[], responseUrl: string, countOfItemsInPayload: number, errorMessage: string, res: any) {
                 let response: IBackendResponse = null;
 
@@ -601,7 +630,6 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
                             return;
                         }
                     }
-
                     if (!_isRetryDisabled && _isRetriable(status)) {
                         _resendPayload(payload);
                         _throwInternal(_self.diagLog(),
@@ -1014,6 +1042,7 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
                 const buffer = _self._buffer;
                 let _window = getWindow();
                 const xdr = new XDomainRequest();
+                // NOTE: xdr may send previous retry payload to new endpoint since we are not able to check response URL
                 xdr.onload = () => _self._xdrOnLoad(xdr, payload);
                 xdr.onerror = (event: ErrorEvent|any) => _self._onError(payload, _formatErrorMessageXdr(xdr), event);
         
@@ -1116,6 +1145,8 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControlsAI {
                 _instrumentationKey = null;
                 _convertUndefined = UNDEFINED_VALUE;
                 _isRetryDisabled = false;
+                _sessionStorageUsed = null;
+                _namePrefix = UNDEFINED_VALUE;
 
                 objDefineProp(_self, "_senderConfig", {
                     enumerable: true,

package/src/__DynamicConstants.ts

@@ -22,30 +22,31 @@ export const _DYN_DATA_TYPE = "dataType";  // Count: 10
 export const _DYN_ENVELOPE_TYPE = "envelopeType";  // Count: 7
 export const _DYN_TO_STRING = "toString";  // Count: 7
 export const _DYN_ON_LINE = "onLine";  // Count: 4
-export const _DYN_ENQUEUE = "enqueue";  // Count: 5
+export const _DYN__GET = "_get";  // Count: 5
+export const _DYN_ENQUEUE = "enqueue";  // Count: 7
 export const _DYN_COUNT = "count";  // Count: 6
 export const _DYN_EVENTS_LIMIT_IN_MEM = "eventsLimitInMem";  // Count: 2
 export const _DYN_PUSH = "push";  // Count: 6
 export const _DYN_EMIT_LINE_DELIMITED_0 = "emitLineDelimitedJson";  // Count: 3
-export const _DYN_CLEAR = "clear";  // Count: 6
+export const _DYN_CLEAR = "clear";  // Count: 7
 export const _DYN_BATCH_PAYLOADS = "batchPayloads";  // Count: 5
-export const _DYN_MARK_AS_SENT = "markAsSent";  // Count: 6
+export const _DYN_CREATE_NEW = "createNew";  // Count: 3
+export const _DYN_MARK_AS_SENT = "markAsSent";  // Count: 7
 export const _DYN_CLEAR_SENT = "clearSent";  // Count: 5
 export const _DYN__BUFFER__KEY = "BUFFER_KEY";  // Count: 5
-export const _DYN__SENT__BUFFER__KEY = "SENT_BUFFER_KEY";  // Count: 7
+export const _DYN__SENT__BUFFER__KEY = "SENT_BUFFER_KEY";  // Count: 8
 export const _DYN__MAX__BUFFER__SIZE = "MAX_BUFFER_SIZE";  // Count: 5
-export const _DYN_NAME_PREFIX = "namePrefix";  // Count: 4
-export const _DYN_TRIGGER_SEND = "triggerSend";  // Count: 6
-export const _DYN_DIAG_LOG = "diagLog";  // Count: 15
+export const _DYN_TRIGGER_SEND = "triggerSend";  // Count: 5
+export const _DYN_DIAG_LOG = "diagLog";  // Count: 16
 export const _DYN__SENDER = "_sender";  // Count: 5
+export const _DYN_CUSTOM_HEADERS = "customHeaders";  // Count: 3
 export const _DYN_MAX_BATCH_SIZE_IN_BY1 = "maxBatchSizeInBytes";  // Count: 2
 export const _DYN_ONUNLOAD_DISABLE_BEA2 = "onunloadDisableBeacon";  // Count: 2
 export const _DYN_IS_BEACON_API_DISABL3 = "isBeaconApiDisabled";  // Count: 2
-export const _DYN__BUFFER = "_buffer";  // Count: 8
 export const _DYN_ENABLE_SESSION_STORA4 = "enableSessionStorageBuffer";  // Count: 2
+export const _DYN__BUFFER = "_buffer";  // Count: 9
 export const _DYN_SAMPLING_PERCENTAGE = "samplingPercentage";  // Count: 2
 export const _DYN_INSTRUMENTATION_KEY = "instrumentationKey";  // Count: 2
-export const _DYN_CUSTOM_HEADERS = "customHeaders";  // Count: 3
 export const _DYN_DISABLE_XHR = "disableXhr";  // Count: 5
 export const _DYN_ONUNLOAD_DISABLE_FET5 = "onunloadDisableFetch";  // Count: 2
 export const _DYN_CONVERT_UNDEFINED = "convertUndefined";  // Count: 2

package/types/SendBuffer.d.ts

@@ -34,6 +34,13 @@ export interface ISendBuffer {
      * Removes items from the SENT_BUFFER. Should be called on successful response from the backend.
      */
     clearSent: (payload: string[]) => void;
+    /**
+    * Copy current buffer items to a new buffer.
+    * if canUseSessionStorage is undefined, it will set to false.
+    * if newLogger and newConfig are undefined, current logger and empty config will be used.
+    * if canUseSessionStorage is set to true, new SessionStorageSendBuffer will be returned otherwise ArraySendBuffer will be returned.
+    */
+    createNew: (newLogger?: IDiagnosticLogger, newConfig?: ISenderConfig, canUseSessionStorage?: boolean) => ArraySendBuffer | SessionStorageSendBuffer;
 }
 declare abstract class BaseSendBuffer {
     protected _get: () => string[];
@@ -45,6 +52,7 @@ declare abstract class BaseSendBuffer {
     clear(): void;
     getItems(): string[];
     batchPayloads(payload: string[]): string;
+    createNew(newLogger?: IDiagnosticLogger, newConfig?: ISenderConfig, canUseSessionStorage?: boolean): ArraySendBuffer | SessionStorageSendBuffer;
 }
 export declare class ArraySendBuffer extends BaseSendBuffer implements ISendBuffer {
     constructor(logger: IDiagnosticLogger, config: ISenderConfig);
@@ -60,5 +68,6 @@ export declare class SessionStorageSendBuffer extends BaseSendBuffer implements
     clear(): void;
     markAsSent(payload: string[]): void;
     clearSent(payload: string[]): void;
+    createNew(newLogger?: IDiagnosticLogger, newConfig?: ISenderConfig, canUseSessionStorage?: boolean): ArraySendBuffer | SessionStorageSendBuffer;
 }
 export {};

package/types/__DynamicConstants.d.ts

@@ -10,6 +10,7 @@ export declare const _DYN_DATA_TYPE = "dataType";
 export declare const _DYN_ENVELOPE_TYPE = "envelopeType";
 export declare const _DYN_TO_STRING = "toString";
 export declare const _DYN_ON_LINE = "onLine";
+export declare const _DYN__GET = "_get";
 export declare const _DYN_ENQUEUE = "enqueue";
 export declare const _DYN_COUNT = "count";
 export declare const _DYN_EVENTS_LIMIT_IN_MEM = "eventsLimitInMem";
@@ -17,23 +18,23 @@ export declare const _DYN_PUSH = "push";
 export declare const _DYN_EMIT_LINE_DELIMITED_0 = "emitLineDelimitedJson";
 export declare const _DYN_CLEAR = "clear";
 export declare const _DYN_BATCH_PAYLOADS = "batchPayloads";
+export declare const _DYN_CREATE_NEW = "createNew";
 export declare const _DYN_MARK_AS_SENT = "markAsSent";
 export declare const _DYN_CLEAR_SENT = "clearSent";
 export declare const _DYN__BUFFER__KEY = "BUFFER_KEY";
 export declare const _DYN__SENT__BUFFER__KEY = "SENT_BUFFER_KEY";
 export declare const _DYN__MAX__BUFFER__SIZE = "MAX_BUFFER_SIZE";
-export declare const _DYN_NAME_PREFIX = "namePrefix";
 export declare const _DYN_TRIGGER_SEND = "triggerSend";
 export declare const _DYN_DIAG_LOG = "diagLog";
 export declare const _DYN__SENDER = "_sender";
+export declare const _DYN_CUSTOM_HEADERS = "customHeaders";
 export declare const _DYN_MAX_BATCH_SIZE_IN_BY1 = "maxBatchSizeInBytes";
 export declare const _DYN_ONUNLOAD_DISABLE_BEA2 = "onunloadDisableBeacon";
 export declare const _DYN_IS_BEACON_API_DISABL3 = "isBeaconApiDisabled";
-export declare const _DYN__BUFFER = "_buffer";
 export declare const _DYN_ENABLE_SESSION_STORA4 = "enableSessionStorageBuffer";
+export declare const _DYN__BUFFER = "_buffer";
 export declare const _DYN_SAMPLING_PERCENTAGE = "samplingPercentage";
 export declare const _DYN_INSTRUMENTATION_KEY = "instrumentationKey";
-export declare const _DYN_CUSTOM_HEADERS = "customHeaders";
 export declare const _DYN_DISABLE_XHR = "disableXhr";
 export declare const _DYN_ONUNLOAD_DISABLE_FET5 = "onunloadDisableFetch";
 export declare const _DYN_CONVERT_UNDEFINED = "convertUndefined";

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.33.7"
+      "packageVersion": "7.33.8"
     }
   ]
 }