CLIS-88 Implement Retry for WFP Blocks Ignoring Error Causes

Author: isasmendiagus

Diff for: .eslintrc.json

@@ -21,7 +21,7 @@
       "error",
       { "allowWholeFile": true }
     ],
-    "eslint-comments/no-unused-disable": false,
+    "eslint-comments/no-unused-disable": 0,
     "import/order": [
       "error",
       { "newlines-between": "always", "alphabetize": { "order": "asc" } }

Diff for: package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "scanoss",
-  "version": "0.10.3",
+  "version": "0.10.4",
   "description": "The SCANOSS JS package provides a simple, easy to consume module for interacting with SCANOSS APIs/Engine.",
   "main": "build/main/index.js",
   "typings": "build/main/index.d.ts",

Diff for: package.json

@@ -15,17 +15,30 @@ export class DispatchableItem {
 
   private sbomMode: SbomMode;
 
-  private _uuid: string;
   constructor() {
     this.errorCounter = 0;
     this.form = new FormData();
   }
 
-  public getForm(): FormData {
-    this.form.append('file', Buffer.from(this.fingerprintPackage.getContent()), 'data.wfp');
-    if(this.engineFlags) this.form.append('flags', this.engineFlags);
+  private _uuid: string;
+
+  public get uuid(): string {
+    return this._uuid;
+  }
+
+  public set uuid(uuid: string) {
+    this._uuid = uuid;
+  }
 
-    if(this.sbomMode && this.sbom) {
+  public getForm(): FormData {
+    this.form.append(
+      'file',
+      Buffer.from(this.fingerprintPackage.getContent()),
+      'data.wfp'
+    );
+    if (this.engineFlags) this.form.append('flags', this.engineFlags);
+
+    if (this.sbomMode && this.sbom) {
       this.form.append('assets', this.sbom);
       this.form.append('type', this.sbomMode);
     }
@@ -57,12 +70,4 @@ export class DispatchableItem {
     this.sbom = sbom;
     this.sbomMode = sbomMode;
   }
-
-  public get uuid(): string {
-    return this._uuid;
-  }
-
-  public set uuid(uuid: string) {
-    this._uuid = uuid;
-  }
 }

Diff for: src/sdk/scanner/Dispatcher/DispatchableItem.ts

@@ -124,7 +124,7 @@ export class Dispatcher extends EventEmitter {
   emitNoDispatchedItem(disptItem) {
     this.emit(
       ScannerEvents.DISPATCHER_LOG,
-      `[ SCANNER ]: WFP content sended to many times. Some files won't be scanned`
+      `[ SCANNER ]: WFP content sended to many times`
     );
     this.emit(ScannerEvents.DISPATCHER_ITEM_NO_DISPATCHED, disptItem);
   }
@@ -136,25 +136,28 @@ export class Dispatcher extends EventEmitter {
         error.name = 'TIMEOUT';
       }
 
-      if (this.recoverableErrors.has(error.name)) {
-        disptItem.increaseErrorCounter();
-        if (
-          disptItem.getErrorCounter() >=
-          this.scannerCfg.MAX_RETRIES_FOR_RECOVERABLES_ERRORS
-        ) {
-          this.emitNoDispatchedItem(disptItem);
-          if (this.scannerCfg.ABORT_ON_MAX_RETRIES)
-            this.emitUnrecoberableError(error, disptItem, response);
-          return;
+      disptItem.increaseErrorCounter();
+      if (
+        disptItem.getErrorCounter() >=
+        this.scannerCfg.MAX_RETRIES_FOR_RECOVERABLES_ERRORS
+      ) {
+        this.emitNoDispatchedItem(disptItem);
+
+        if (this.scannerCfg.ABORT_ON_MAX_RETRIES) {
+          error[
+            'max_retries'
+          ] = `Fingerprint block retried ${this.scannerCfg.MAX_RETRIES_FOR_RECOVERABLES_ERRORS} times, aborting`;
+          this.emitUnrecoberableError(error, disptItem, response);
         }
-        this.emit(
-          ScannerEvents.DISPATCHER_LOG,
-          `[ SCANNER ]: Recoverable error happened sending WFP content to server. Reason: ${error}`
-        );
-        this.dispatchItem(disptItem);
+
         return;
       }
-      this.emitUnrecoberableError(error, disptItem, response);
+      this.emit(
+        ScannerEvents.DISPATCHER_LOG,
+        `[ SCANNER ]: An error occurred while sending WFP content to the server. Reason: ${error}`
+      );
+      this.dispatchItem(disptItem);
+      return;
     }
   }
 

Diff for: src/sdk/scanner/Dispatcher/Dispatcher.ts

@@ -14,7 +14,7 @@ export class ScannerCfg extends BaseConfig {
   public IGNORE_CERT_ERRORS = false;
 
   // Level of concurrency
-  public CONCURRENCY_LIMIT = 10;
+  public CONCURRENCY_LIMIT = 5;
 
   // Timeout for each transaction
   public TIMEOUT = 180000;
@@ -29,7 +29,7 @@ export class ScannerCfg extends BaseConfig {
   // the winnowing algorithm will report a ScannerEvents.WINNOWING_STATUS event.
   public WINNOWING_REPORT_STATUS_AFTER_X = 10;
 
-  public MAX_RETRIES_FOR_RECOVERABLES_ERRORS = 5;
+  public MAX_RETRIES_FOR_RECOVERABLES_ERRORS = 6;
 
   public ABORT_ON_MAX_RETRIES = true;