[Release-3.0][BUG] remove 403 as a “retriable” error code #2296 (#2303)

README.md

@@ -377,6 +377,7 @@ Most configuration fields are named such that they can be defaulted to falsey. A
 | storagePrefix | string[] | undefined | [Optional] An optional value that will be added as name prefix for storage name. |
 | featureOptIn <br/><sub>since 3.0.3</sub> | IFeatureOptIn | undefined | [Optional]  Set Feature opt in details. |
 | throttleMgrCfg <br/><sub>since 3.0.3</sub> | `{[key: number]: IThrottleMgrConfig}` | undefined | [Optional]  Set throttle mgr configuration by key. |
+| retryCodes | number[] | undefined | Identifies the status codes that will cause event batches to be resent, when `null` or `undefined` the SDK will use it's defaults `[401, 408, 429, 500, 502, 503, 504]`. `403` was removed in version 3.1.1. |
 
 ### ICookieMgrConfig
 

channels/applicationinsights-channel-js/src/Interfaces.ts

@@ -122,6 +122,12 @@ export interface ISenderConfig {
      * @since 3.0.6
      */
     disableSendBeaconSplit?: boolean;
+
+    /**
+     * (Optional) The specific error codes that will cause a retry of sending data to the backend.
+     * @since 3.1.1
+     */
+    retryCodes?: number[];
 }
 
 export interface IBackendResponse {

channels/applicationinsights-channel-js/src/Sender.ts

@@ -8,10 +8,10 @@ import {
     BaseTelemetryPlugin, IAppInsightsCore, IChannelControls, IConfigDefaults, IConfiguration, IDiagnosticLogger, INotificationManager,
     IPayloadData, IPlugin, IProcessTelemetryContext, IProcessTelemetryUnloadContext, ITelemetryItem, ITelemetryPluginChain,
     ITelemetryUnloadState, IXHROverride, OnCompleteCallback, SendPOSTFunction, SendRequestReason, TransportType, _eInternalMessageId,
-    _throwInternal, _warnToConsole, arrForEach, cfgDfBoolean, cfgDfValidate, createProcessTelemetryContext, createUniqueNamespace, dateNow,
-    dumpObj, eLoggingSeverity, getExceptionName, getIEVersion, getJSON, getNavigator, getWindow, isArray, isBeaconsSupported,
-    isFetchSupported, isNullOrUndefined, isXhrSupported, mergeEvtNamespace, objExtend, objKeys, onConfigChange, runTargetUnload,
-    useXDomainRequest
+    _throwInternal, _warnToConsole, arrForEach, arrIndexOf, cfgDfBoolean, cfgDfValidate, createProcessTelemetryContext,
+    createUniqueNamespace, dateNow, dumpObj, eLoggingSeverity, getExceptionName, getIEVersion, getJSON, getNavigator, getWindow, isArray,
+    isBeaconsSupported, isFetchSupported, isNullOrUndefined, isXhrSupported, mergeEvtNamespace, objExtend, objKeys, onConfigChange,
+    runTargetUnload, useXDomainRequest
 } from "@microsoft/applicationinsights-core-js";
 import { IPromise, createPromise, doAwaitResponse } from "@nevware21/ts-async";
 import { ITimerHandler, isTruthy, objDeepFreeze, objDefine, scheduleTimeout } from "@nevware21/ts-utils";
@@ -75,7 +75,8 @@ const defaultAppInsightsChannelConfig: IConfigDefaults<ISenderConfig> = objDeepF
     eventsLimitInMem: 10000,
     bufferOverride: false,
     httpXHROverride: { isVal: isOverrideFn, v:UNDEFINED_VALUE },
-    alwaysUseXhrOverride: cfgDfBoolean()
+    alwaysUseXhrOverride: cfgDfBoolean(),
+    retryCodes: UNDEFINED_VALUE
 });
 
 function _chkSampling(value: number) {
@@ -176,6 +177,7 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControls {
         let _xhrSend: SenderFunction;
         let _fallbackSend: SenderFunction;
         let _disableBeaconSplit: boolean;
+        let _retryCodes: number[];
 
         dynamicProto(Sender, this, (_self, _base) => {
 
@@ -286,6 +288,7 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControls {
                     _beaconSupported = (senderConfig.onunloadDisableBeacon === false || senderConfig.isBeaconApiDisabled === false) && isBeaconsSupported();
                     _alwaysUseCustomSend = senderConfig.alwaysUseXhrOverride;
                     _disableXhr = !!senderConfig.disableXhr;
+                    _retryCodes = senderConfig.retryCodes;
 
                     let bufferOverride = senderConfig.bufferOverride;
                     let canUseSessionStorage = !!senderConfig.enableSessionStorageBuffer &&
@@ -1066,7 +1069,7 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControls {
                                 let response = result.value;
 
                                 /**
-                                 * The Promise returned from fetch() won’t reject on HTTP error status even if the response is an HTTP 404 or 500.
+                                 * The Promise returned from fetch() won't reject on HTTP error status even if the response is an HTTP 404 or 500.
                                  * Instead, it will resolve normally (with ok status set to false), and it will only reject on network failure
                                  * or if anything prevented the request from completing.
                                  */
@@ -1205,8 +1208,14 @@ export class Sender extends BaseTelemetryPlugin implements IChannelControls {
              * @param statusCode
              */
             function _isRetriable(statusCode: number): boolean {
+                // retryCodes = [] means should not retry
+                if (!isNullOrUndefined(_retryCodes)) {
+                    return _retryCodes.length && arrIndexOf(_retryCodes, statusCode) > -1;
+                }
+
                 return statusCode === 401 // Unauthorized
-                    || statusCode === 403 // Forbidden
+                    // Removing as private links can return a 403 which causes excessive retries and session storage usage
+                    // || statusCode === 403 // Forbidden
                     || statusCode === 408 // Timeout
                     || statusCode === 429 // Too many requests.
                     || statusCode === 500 // Internal server error.