Merge pull request #130 from EmilianoSanchez/fix-retry-condition

Fix: the SDK doesn't retry on some recoverable network errors

Author: conormurray95

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@harnessio/ff-nodejs-server-sdk",
-  "version": "1.8.8",
+  "version": "1.8.9",
   "description": "Feature flags SDK for NodeJS environments",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.mjs",

package.json

@@ -320,20 +320,6 @@ export default class Client {
   }
 
   private axiosRetryCondition(error) {
-    if (axiosRetry.isNetworkOrIdempotentRequestError(error)) {
-      return true;
-    }
-
-    // retry if connection is aborted
-    if (error.code === 'ECONNABORTED') {
-      return true;
-    }
-
-    // DNS issues, service down, etc
-    if (error.code === 'ENOTFOUND' || error.code === 'ECONNREFUSED') {
-      return true;
-    }
-
     // Auth is a POST request so not covered by isNetworkOrIdempotentRequestError and it's not an aborted connection
     const status = error?.response?.status;
     const url = error?.config?.url ?? '';
@@ -343,14 +329,8 @@ export default class Client {
       return false;
     }
 
-    if (
-      url.includes('client/auth') && ((status >= 500 && status <= 599) || (status >= 400 && status <= 499))
-    ) {
-      return true;
-    }
-
-    // Otherwise do not retry
-    return false;
+    // Otherwise retry: if connection is aborted, DNS issues, service down, network errors, etc
+    return true;
   }
 
   private createAxiosInstanceWithRetries(

src/client.ts

@@ -284,6 +284,7 @@ export class StreamProcessor {
     }
 
     clearTimeout(this.retryTimeout);
+    this.retryTimeout = undefined;
 
     this.readyState = StreamProcessor.CLOSED;
     this.log.info('Closing StreamProcessor');

src/streaming.ts

@@ -3,17 +3,62 @@ import { FeatureConfig, Segment } from './openapi';
 
 export type Type = boolean | string | number | Record<string, unknown>;
 export interface Options {
+  /**
+   * The URL used to fetch Feature Flag Evaluations. When using the Relay Proxy, change this to: http://localhost:7000
+   *
+   * @defaultValue https://config.ff.harness.io/api/1.0
+   */
   baseUrl?: string;
+  /**
+   * The URL for posting metrics data to the Feature Flag service. When using the Relay Proxy, change this to: http://localhost:7000
+   *
+   * @defaultValue https://events.ff.harness.io/api/1.0
+   */
   eventsUrl?: string;
+  /**
+   * The interval in milliseconds that we poll for changes when you are not using streaming mode.
+   *
+   * @defaultValue 60000
+   */
   pollInterval?: number;
+  /**
+   * The interval in milliseconds to post analytics data to the Feature Flag service.
+   *
+   * @defaultValue 60000
+   */
   eventsSyncInterval?: number;
+  /**
+   * Set to true to enable streaming mode. Set to false to disable streaming mode.
+   *
+   * @defaultValue true
+   */
   enableStream?: boolean;
+  /**
+   * Set to true to enable analytics. Set to false to disable analytics. Note: When enabled, analytics data is posted every `eventsSyncInterval`.
+   *
+   * @defaultValue true
+   */
   enableAnalytics?: boolean;
   cache?: KeyValueStore;
   store?: AsyncKeyValueStore;
+  /**
+   * Set a custom logger to use for logging.
+   *
+   * @defaultValue console
+   */
   logger?: Logger;
   tlsTrustedCa?: string;
+  /**
+   * Set the timeout for requests to the Feature Flag service.
+   *
+   * @defaultValue 30000
+   */
   axiosTimeout?: number;
+  /**
+   * Set the number of retries for requests to the Feature Flag service.
+   *
+   * @defaultValue Infinity
+   */
   axiosRetries?: number;
 }
 

src/types.ts

@@ -1 +1 @@
-export const VERSION = '1.8.8';
+export const VERSION = '1.8.9';