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

package/src/PostChannel.ts

@@ -3,17 +3,17 @@
 * @author Abhilash Panwar (abpanwar); Hector Hernandez (hectorh); Nev Wylie (newylie)
 * @copyright Microsoft 2018-2020
 */
+import dynamicProto from "@microsoft/dynamicproto-js";
 import {
     BaseTelemetryPlugin, IChannelControls, IExtendedConfiguration, IExtendedAppInsightsCore,
     EventLatencyValue, NotificationManager, EventsDiscardedReason, IPlugin, ITelemetryItem,
-    IAppInsightsCore, isValueAssigned, setProcessTelemetryTimings, isWindowObjectAvailable,
+    IAppInsightsCore, isValueAssigned, setProcessTelemetryTimings,
     IProcessTelemetryContext, SendRequestReason, arrForEach, eLoggingSeverity, _eExtendedInternalMessageId,
     doPerf, objForEachKey, optimizeObject, isChromium, getWindow, EventSendType, isNumber, mergeEvtNamespace,
     createUniqueNamespace, IProcessTelemetryUnloadContext, ITelemetryUnloadState,
     addPageUnloadEventListener, addPageHideEventListener, addPageShowEventListener,
     removePageUnloadEventListener, removePageHideEventListener, removePageShowEventListener,
-    _throwInternal,
-    _eInternalMessageId
+    _throwInternal, _eInternalMessageId, objDefineAccessors
 } from "@microsoft/1ds-core-js";
 import {
     IChannelConfiguration, RT_PROFILE, NRT_PROFILE, IPostChannel,
@@ -23,8 +23,8 @@ import {
 import { EventBatch } from "./EventBatch";
 import { HttpManager } from "./HttpManager";
 import { retryPolicyGetMillisToBackoffForRetry } from "./RetryPolicy";
-import dynamicProto from "@microsoft/dynamicproto-js";
 import { strMsaDeviceTicket } from "./Constants";
+import { createTimeoutWrapper, ITimeoutOverrideWrapper, TimeoutClearFunc, TimeoutSetFunc } from "./TimeoutOverrideWrapper";
 
 const FlushCheckTimer = 0.250;          // This needs to be in seconds, so this is 250ms
 const MaxNumberEventPerBatch = 500;
@@ -32,7 +32,6 @@ const EventsDroppedAtOneTime = 20;
 const MaxSendAttempts = 6;
 const MaxSyncUnloadSendAttempts = 2;        // Assuming 2 based on beforeunload and unload
 const MaxBackoffCount = 4;
-const globalContext = isWindowObjectAvailable ? window : this;
 const MaxConnections = 2;
 const MaxRequestRetriesBeforeBackoff = 1;
 
@@ -66,7 +65,11 @@ export default class PostChannel extends BaseTelemetryPlugin implements IChannel
     public priority = 1011;
     public version = "#version#";
     public _notificationManager: NotificationManager | undefined;
+
+    /** @deprecated This property is not intended to be used directly please let us know if you have taken a dependency on this property as it may be removed in a future release */
     public _setTimeoutOverride: typeof setTimeout;
+
+    /** @deprecated This property is not intended to be used directly please let us know if you have taken a dependency on this property as it may be removed in a future release */
     public _clearTimeoutOverride: typeof clearTimeout;
 
     constructor() {
@@ -97,10 +100,10 @@ export default class PostChannel extends BaseTelemetryPlugin implements IChannel
         let _delayedBatchReason: SendRequestReason;
         let _optimizeObject: boolean = true;
         let _isPageUnloadTriggered = false;
-        let _disableXhrSync = false;
         let _maxEventSendAttempts: number = MaxSendAttempts;
         let _maxUnloadEventSendAttempts: number = MaxSyncUnloadSendAttempts;
         let _evtNamespace: string | string[];
+        let _timeoutWrapper: ITimeoutOverrideWrapper;
 
         dynamicProto(PostChannel, this, (_self, _base) => {
             _initDefaults();
@@ -121,8 +124,7 @@ export default class PostChannel extends BaseTelemetryPlugin implements IChannel
                         let ctx = _self._getTelCtx();
                         coreConfig.extensionConfig[_self.identifier] = coreConfig.extensionConfig[_self.identifier] || {};
                         _config = ctx.getExtCfg(_self.identifier);
-                        _self._setTimeoutOverride = _config.setTimeoutOverride ? _config.setTimeoutOverride : setTimeout.bind(globalContext);
-                        _self._clearTimeoutOverride = _config.clearTimeoutOverride ? _config.clearTimeoutOverride : clearTimeout.bind(globalContext);
+                        _timeoutWrapper = createTimeoutWrapper(_config.setTimeoutOverride, _config.clearTimeoutOverride);
     
                         // Only try and use the optimizeObject() if this appears to be a chromium based browser and it has not been explicitly disabled
                         _optimizeObject = !_config.disableOptimizeObj && isChromium();
@@ -141,7 +143,6 @@ export default class PostChannel extends BaseTelemetryPlugin implements IChannel
                             _autoFlushEventsLimit = _config.autoFlushEventsLimit;
                         }
     
-                        _disableXhrSync = _config.disableXhrSync;
                         if (isNumber(_config[strMaxEventRetryAttempts])) {
                             _maxEventSendAttempts = _config[strMaxEventRetryAttempts];
                         }
@@ -421,20 +422,19 @@ export default class PostChannel extends BaseTelemetryPlugin implements IChannel
 
             _self.flush = (async = true, callback?: () => void, sendReason?: SendRequestReason) => {
                 if (!_paused) {
-                    // Clear the normal schedule timer as we are going to try and flush ASAP
-                    _clearScheduledTimer();
 
                     sendReason = sendReason || SendRequestReason.ManualFlush;
 
                     if (async) {
-                        // Move all queued events to the HttpManager
-                        _queueBatches(EventLatencyValue.Normal, EventSendType.Batched, sendReason);
-
-                        // All events (should) have been queue -- lets just make sure the queue counts are correct to avoid queue exhaustion (previous bug #9685112)
-                        _resetQueueCounts();
-
                         if (_flushCallbackTimerId == null) {
+                            // Clear the normal schedule timer as we are going to try and flush ASAP
+                            _clearScheduledTimer();
+
+                            // Move all queued events to the HttpManager so that we don't discard new events (Auto flush scenario)
+                            _queueBatches(EventLatencyValue.Normal, EventSendType.Batched, sendReason);
+                            
                             _flushCallbackTimerId = _createTimer(() => {
+                                _flushCallbackTimerId = null;
                                 _flushImpl(callback, sendReason);
                             }, 0);
                         } else {
@@ -443,12 +443,20 @@ export default class PostChannel extends BaseTelemetryPlugin implements IChannel
                             _flushCallbackQueue.push(callback);
                         }
                     } else {
+                        // Clear the normal schedule timer as we are going to try and flush ASAP
+                        let cleared = _clearScheduledTimer();
+
                         // Now cause all queued events to be sent synchronously
                         _sendEventsForLatencyAndAbove(EventLatencyValue.Normal, EventSendType.Synchronous, sendReason);
 
                         if (callback !== null && callback !== undefined) {
                             callback();
                         }
+
+                        if (cleared) {
+                            // restart the normal event timer if it was cleared
+                            _scheduleTimer();
+                        }
                     }
                 }
             };
@@ -572,10 +580,10 @@ export default class PostChannel extends BaseTelemetryPlugin implements IChannel
                 _delayedBatchReason = null;
                 _optimizeObject = true;
                 _isPageUnloadTriggered = false;
-                _disableXhrSync = false;
                 _maxEventSendAttempts = MaxSendAttempts;
                 _maxUnloadEventSendAttempts = MaxSyncUnloadSendAttempts;
                 _evtNamespace = null;
+                _timeoutWrapper = createTimeoutWrapper();
                 _httpManager = new HttpManager(MaxNumberEventPerBatch, MaxConnections, MaxRequestRetriesBeforeBackoff, {
                     requeue: _requeueEvents,
                     send: _sendingEvent,
@@ -583,7 +591,7 @@ export default class PostChannel extends BaseTelemetryPlugin implements IChannel
                     drop: _eventsDropped,
                     rspFail: _eventsResponseFail,
                     oth: _otherEvent
-                });
+                }, _timeoutWrapper);
 
                 _initializeProfiles();
                 _clearQueues();
@@ -601,14 +609,17 @@ export default class PostChannel extends BaseTelemetryPlugin implements IChannel
                     timerMultiplier = retryPolicyGetMillisToBackoffForRetry(_currentBackoffCount - 1);
                 }
 
-                return _self._setTimeoutOverride(theTimerFunc, timeOut * timerMultiplier);
+                return _timeoutWrapper.set(theTimerFunc, timeOut * timerMultiplier);
             }
             function _clearScheduledTimer() {
                 if (_scheduledTimerId !== null) {
-                    _self._clearTimeoutOverride(_scheduledTimerId);
+                    _timeoutWrapper.clear(_scheduledTimerId);
                     _scheduledTimerId = null;
                     _timerCount = 0;
+                    return true;
                 }
+
+                return false;
             }
 
             // Try to send all queued events using beacons if available
@@ -617,7 +628,7 @@ export default class PostChannel extends BaseTelemetryPlugin implements IChannel
 
                 // Cancel all flush callbacks
                 if (_flushCallbackTimerId) {
-                    _self._clearTimeoutOverride(_flushCallbackTimerId);
+                    _timeoutWrapper.clear(_flushCallbackTimerId);
                     _flushCallbackTimerId = null;
                 }
 
@@ -829,6 +840,9 @@ export default class PostChannel extends BaseTelemetryPlugin implements IChannel
                 // Add any additional queued events and cause all queued events to be sent asynchronously
                 _sendEventsForLatencyAndAbove(EventLatencyValue.Normal, EventSendType.Batched, sendReason);
 
+                // All events (should) have been queue -- lets just make sure the queue counts are correct to avoid queue exhaustion (previous bug #9685112)
+                _resetQueueCounts();
+
                 _waitForIdleManager(() => {
                     // Only called AFTER the httpManager does not have any outstanding requests
                     if (callback) {
@@ -836,14 +850,16 @@ export default class PostChannel extends BaseTelemetryPlugin implements IChannel
                     }
 
                     if (_flushCallbackQueue.length > 0) {
-                        _flushCallbackTimerId = _createTimer(() => _flushImpl(_flushCallbackQueue.shift(), sendReason), 0);
+                        _flushCallbackTimerId = _createTimer(() => {
+                            _flushCallbackTimerId = null;
+                            _flushImpl(_flushCallbackQueue.shift(), sendReason);
+                        }, 0);
                     } else {
                         // No more flush requests
                         _flushCallbackTimerId = null;
-                        if (_hasEvents()) {
-                            // We still have events, so restart the normal timer schedule
-                            _scheduleTimer();
-                        }
+
+                        // Restart the normal timer schedule
+                        _scheduleTimer();
                     }
                 });
             }
@@ -853,6 +869,7 @@ export default class PostChannel extends BaseTelemetryPlugin implements IChannel
                     callback();
                 } else {
                     _flushCallbackTimerId = _createTimer(() => {
+                        _flushCallbackTimerId = null;
                         _waitForIdleManager(callback);
                     }, FlushCheckTimer);
                 }
@@ -1008,6 +1025,21 @@ export default class PostChannel extends BaseTelemetryPlugin implements IChannel
                     _autoFlushBatchLimit = 0;
                 }
             }
+
+            // Provided for backward compatibility they are not "expected" to be in current use but they are public
+            objDefineAccessors(_self, "_setTimeoutOverride",
+                () => _timeoutWrapper.set, 
+                (value: TimeoutSetFunc<any>) => {
+                    // Recreate the timeout wrapper
+                    _timeoutWrapper = createTimeoutWrapper(value, _timeoutWrapper.clear);
+                });
+
+            objDefineAccessors(_self, "_clearTimeoutOverride",
+                () => _timeoutWrapper.clear, 
+                (value: TimeoutClearFunc<any>) => {
+                    // Recreate the timeout wrapper
+                    _timeoutWrapper = createTimeoutWrapper(_timeoutWrapper.set, value);
+                });
         });
     }
 

package/src/TimeoutOverrideWrapper.ts

@@ -0,0 +1,29 @@
+/**
+ * TimeoutOverrideWrapper.ts
+ * @author  Nev Wylie (newylie)
+ * @copyright Microsoft 2022
+ * Simple internal timeout wrapper
+ */
+
+export type TimeoutSetFunc<T = any> = (callback: (...args: any[]) => void, ms: number, ...args: any[]) => T;
+export type TimeoutClearFunc<T = any> = (timeoutId?: T) => void;
+
+export interface ITimeoutOverrideWrapper<T = any> {
+    set: TimeoutSetFunc<T>;
+    clear: TimeoutClearFunc<T>;
+}
+
+export function defaultSetTimeout<T = any>(callback: (...args: any[]) => void, ms: number, ...args: any[]): T {
+    return setTimeout(callback, ms, args) as any;
+}
+
+export function defaultClearTimeout<T = any>(timeoutId?: T): void {
+    clearTimeout(timeoutId as any);
+}
+
+export function createTimeoutWrapper<T = any>(argSetTimeout?: TimeoutSetFunc<T>, argClearTimeout?: TimeoutClearFunc<T>) {
+    return {
+        set: argSetTimeout || defaultSetTimeout,
+        clear: argClearTimeout || defaultClearTimeout
+    } 
+}