scanoss 0.4.10-beta → 0.4.12-beta

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scanoss",
-  "version": "0.4.10-beta",
+  "version": "0.4.12-beta",
   "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",

package/src/cli/bin/cli-bin.ts

@@ -2,7 +2,7 @@
 
 import { program } from 'commander';
 import { depHandler } from '../commands/dep';
-import { fingerprintHandler } from '../commands/fingerprint';
+import { wfpHandler } from '../commands/wfp';
 import { scanHandler } from '../commands/scan';
 
 
@@ -17,7 +17,7 @@ function CLIErrorHandler(e: Error) {
 
 async function main() {
   program
-    .version("0.4.10-beta")
+    .version("0.4.12-beta")
     .description('The SCANOSS JS package provides a simple, easy to consume module for interacting with SCANOSS APIs/Engine.')
 
   program
@@ -53,12 +53,12 @@ async function main() {
     .action((source, options) => {depHandler(source, options).catch((e) => {CLIErrorHandler(e)})})
 
     program
-    .command('fingerprint <source>')
+    .command('wfp <source>')
     .description('Generates fingerprints for a folder/file')
     .option('-H, --hpsm', 'Scan using winnowing high precision matching')
     .option('-o, --output <filename>', 'Output result file name (optional - default stdout)')
     .option('-p, --block-size <size>', 'Maximum size in Kb for each fingerprint block (optional - default 64Kb)')
-    .action((source, options) => {fingerprintHandler(source, options).catch((e) => {CLIErrorHandler(e)})})
+    .action((source, options) => {wfpHandler(source, options).catch((e) => {CLIErrorHandler(e)})})
 
     await program.parseAsync(process.argv);
 }

package/src/cli/commands/{fingerprint.ts → wfp.ts}

@@ -11,7 +11,7 @@ import { Tree } from '../../sdk/tree/Tree';
 import { DependencyFilter } from '../../sdk/tree/Filters/DependencyFilter';
 
 
-export async function fingerprintHandler(rootPath: string, options: any): Promise<void> {
+export async function wfpHandler(rootPath: string, options: any): Promise<void> {
 
   rootPath = rootPath.replace(/\/$/, '');  // Remove trailing slash if exists
   rootPath = rootPath.replace(/^\./, process.env.PWD);  // Convert relative path to absolute path.

package/src/sdk/scanner/Scanner.ts

@@ -217,7 +217,7 @@ export class Scanner extends EventEmitter {
       if (this.scannerInput[0].wfpPath) {
         this.wfpProvider = new WfpSplitter();
         this.setWinnowerListeners();
-        this.wfpProvider.start({wfpPath: this.scannerInput[0].wfpPath});
+        this.wfpProvider.start(this.scannerInput[0]);
       } else {
         const folderRoot = this.scannerInput[0].folderRoot;
         const winnowingMode = this.scannerInput[0].winnowingMode;
@@ -291,7 +291,7 @@ export class Scanner extends EventEmitter {
     if (scannerInput[0]?.wfpPath) {
       this.wfpProvider = new WfpSplitter();
       this.setWinnowerListeners();
-      this.wfpProvider.start({wfpPath: scannerInput[0].wfpPath});
+      this.wfpProvider.start(scannerInput[0]);
     } else {
       const folderRoot = this.scannerInput[0].folderRoot;
       const winnowingMode = this.scannerInput[0].winnowingMode;

package/src/sdk/scanner/WfpProvider/WfpSplitter/WfpSplitter.ts

@@ -36,7 +36,7 @@ export class WfpSplitter extends WfpProvider {
     this.fingerprints = [];
     this.continue = true;
     this.fingerprintIndex = 0;
-    this.ignoreFiles = new Set(params.fileList);
+    this.ignoreFiles = new Set(params?.fileList);
 
     const wfpPath = params.wfpPath;
 
@@ -98,39 +98,43 @@ export class WfpSplitter extends WfpProvider {
     //Use a loop to make sure we read all currently available data
     while (this.continue && null !== (this.chunkDataRead = this.wfpStream.read(1 * 1024 * 1024))) {  // Read chunks of 1MB 1*1024*1024
 
-      // Removes fingerprints that are loose because the file=...... was removed in previous iteration
-      if (ignoreFirstChunkOfFingerprint) { //TODO: Test this scenario
-        //If there is no file= delete everything then
-        if (this.chunkDataRead.indexOf("file=") >= 0) {
-          this.chunkDataRead = this.chunkDataRead.substring(this.chunkDataRead.indexOf('file='));
-          ignoreFirstChunkOfFingerprint = false;
-        } else this.chunkDataRead = "";
-      }
-
       /**** This part removes all the wfp that includes the paths inside this.ignoreFiles ****/
-      const rWfpPath = new RegExp(/^file=\w+,\d+,(?<path>.+)$/gm)
-      //Search for paths in the wfp and compares with the ignorefiles set
-      //When there is a match the matched fingerprint is deleted on the fly
-      let result;
-      while((result = rWfpPath.exec(this.chunkDataRead)) !== null) {
-        if (this.ignoreFiles.has(result?.groups?.path)) {
-          const indexDeleteFrom = result.index
-
-          //TODO: Verify this condition
-          //If there is no next file= in the string, remove until end.
-          let indexDeleteTo = this.chunkDataRead.indexOf('file=', indexDeleteFrom+1)
-          if (indexDeleteTo < 0) {
-            indexDeleteTo = this.chunkDataRead.length;
-
-            //After the deletion of a wfp there are no other file=, so then set ignoreFirstChunkOfFingerprint to true.
-            //In the next iteration, the next chunk of data will be fingerprints without a file=. So, this first part will be discarded.
-            ignoreFirstChunkOfFingerprint = true;
-          }
+      if (this.ignoreFiles.size > 0) {
+
+        // Removes fingerprints that are loose because the file=...... was removed in previous iteration
+        if (ignoreFirstChunkOfFingerprint) { //TODO: Test this scenario
+          //If there is no file= delete everything then
+          if (this.chunkDataRead.indexOf("file=") >= 0) {
+            this.chunkDataRead = this.chunkDataRead.substring(this.chunkDataRead.indexOf('file='));
+            ignoreFirstChunkOfFingerprint = false;
+          } else this.chunkDataRead = "";
+        }
+
 
-          const first = this.chunkDataRead.substring(0,indexDeleteFrom);
-          const second = this.chunkDataRead.substring(indexDeleteTo, this.chunkDataRead.length);
-          this.chunkDataRead = first + second;
-          rWfpPath.lastIndex = 0; //Make sure we reset the state of the regex.
+        const rWfpPath = new RegExp(/^file=\w+,\d+,(?<path>.+)$/gm)
+        //Search for paths in the wfp and compares with the ignorefiles set
+        //When there is a match the matched fingerprint is deleted on the fly
+        let result;
+        while ((result = rWfpPath.exec(this.chunkDataRead)) !== null) {
+          if (this.ignoreFiles.has(result?.groups?.path)) {
+            const indexDeleteFrom = result.index
+
+            //TODO: Verify this condition
+            //If there is no next file= in the string, remove until end.
+            let indexDeleteTo = this.chunkDataRead.indexOf('file=', indexDeleteFrom + 1)
+            if (indexDeleteTo < 0) {
+              indexDeleteTo = this.chunkDataRead.length;
+
+              //After the deletion of a wfp there are no other file=, so then set ignoreFirstChunkOfFingerprint to true.
+              //In the next iteration, the next chunk of data will be fingerprints without a file=. So, this first part will be discarded.
+              ignoreFirstChunkOfFingerprint = true;
+            }
+
+            const first = this.chunkDataRead.substring(0, indexDeleteFrom);
+            const second = this.chunkDataRead.substring(indexDeleteTo, this.chunkDataRead.length);
+            this.chunkDataRead = first + second;
+            rWfpPath.lastIndex = 0; //Make sure we reset the state of the regex.
+          }
         }
       }
       /**** This part removes all the wfp that includes the paths inside this.ignoreFiles ****/

package/tests/scanoss.sh

@@ -1,15 +1,10 @@
 #!/usr/bin/env bash
 
-# filename: commandLine.sh
-# author: @theBuzzyCoder
-
-
-
 #
 # Print help info
 #
 help() {
-  echo "Usage: $0 [-h]
+  echo "Usage: $0 [-h] -w winnowing.wfp -r result.json
                [-r file to result.json]
                [-w file to winnowing]"
   exit 2
@@ -21,8 +16,8 @@ cmd_compare_wfp_result() {
   if [ ! -e "$result_json_path" ] || [ ! -e "$winnowing_path" ]; then
     echo "Error: Please, specify a valid path"
     exit 1
-  fi 
-  
+  fi
+
   diff <(sed -n -E 's/file=\w+,[[:digit:]]+,//p' "$winnowing_path" | sort) <(jq -r '.scanner | keys | .[]' "$result_json_path" | sort)
 
   exit 1

package/tests/sdk/Scanner/WfpProvider/WfpSplitter/WfpSplitter.spec.ts

@@ -28,8 +28,6 @@ describe('Suit test for WfpSplitter Class', () => {
       }
     }
 
-    console.log(wfp)
-
   });
 
 });