Abort imports for scans with no resources

Signed-off-by: Omkar Phansopkar <[email protected]>

Author: OmkarPh

src/constants/errors.ts

@@ -0,0 +1 @@
+export const NO_RESOURCES_ERROR = "No files found in the scan"

src/contexts/dbContext.tsx

@@ -20,6 +20,7 @@ import {
   UTIL_CHANNEL,
 } from "../constants/IpcConnection";
 import { DEFAULT_ROUTE_ON_IMPORT, ROUTES } from "../constants/routes";
+import { NO_RESOURCES_ERROR } from "../constants/errors";
 import { AddEntry, GetHistory, RemoveEntry } from "../services/historyStore";
 import { WorkbenchDB } from "../services/workbenchDB";
 import { isSqliteSchemaOutdated } from "../utils/checks";
@@ -363,15 +364,19 @@ The SQLite file is invalid. Try re-importing the ScanCode JSON file and creating
             );
           });
       })
-      .catch((err) => {
+      .catch((err: Error) => {
         abortImport();
-        console.error(
-          "Some error parsing json data (caught in dbContext)",
-          err
-        );
-        toast.error(
-          "Some error parsing json data !! \nPlease check console for more info"
-        );
+        if (err.message === NO_RESOURCES_ERROR) {
+          toast.error("No resources found in scan\nAborting import");
+        } else {
+          console.error(
+            "Some error parsing json data (caught in dbContext)",
+            err
+          );
+          toast.error(
+            "Some error parsing json data !! \nPlease check console for more info"
+          );
+        }
       });
   }
 

src/services/workbenchDB.ts

@@ -55,6 +55,7 @@ import { TodoAttributes } from "./models/todo";
 import { HeaderAttributes } from "./models/header";
 import { LicenseReferenceAttributes } from "./models/licenseReference";
 import { LicenseRuleReferenceAttributes } from "./models/licenseRuleReference";
+import { NO_RESOURCES_ERROR } from "../constants/errors";
 
 const { version: workbenchVersion } = packageJson;
 
@@ -309,8 +310,6 @@ export class WorkbenchDB {
     const stream = fs.createReadStream(jsonFilePath, { encoding: "utf8" });
     let files_count = 0;
     let dirs_count = 0;
-    let rootPath: string | null = null;
-    let hasRootPath = false;
     const batchSize = 1000;
     let files: Resource[] = [];
     const parsedFilePaths = new Set<string>();
@@ -380,12 +379,6 @@ export class WorkbenchDB {
             .on("data", function (file?: Resource) {
               if (!file) return;
 
-              if (!rootPath) {
-                rootPath = file.path.split("/")[0];
-              }
-              if (rootPath === file.path) {
-                hasRootPath = true;
-              }
               // @TODO: When/if scancode reports directories in its header, this needs
               //       to be replaced.
               if (parsedFilePaths.size === 0) {
@@ -435,21 +428,14 @@ export class WorkbenchDB {
               // Add root directory into data
               // See https://github.com/nexB/scancode-toolkit/issues/543
               promiseChain
-                .then(() => {
-                  if (!hasRootPath) {
-                    rootPath = rootPath || "no-files";
-                    files.push({
-                      path: rootPath,
-                      name: rootPath,
-                      type: "directory",
-                      files_count: files_count,
-                    });
-                    parsedFilePaths.add(rootPath);
-                  }
-                })
                 .then(() =>
                   this._imputeIntermediateDirectories(files, parsedFilePaths)
                 )
+                .then(() => {
+                  if (files.length === 0) {
+                    throw new Error(NO_RESOURCES_ERROR);
+                  }
+                })
                 .then(() => this._batchCreateFiles(files))
                 .then(() => this.db.Header.create(TopLevelData.parsedHeader))
                 .then(() => {
@@ -470,10 +456,12 @@ export class WorkbenchDB {
                 .then(() => {
                   onProgressUpdate(100);
                   console.info("JSON parse completed (final step)");
-                  console.timeEnd("json-parse-time");
                   resolve();
                 })
-                .catch((e: unknown) => reject(e));
+                .catch((e: unknown) => reject(e))
+                .finally(() => {
+                  console.timeEnd("json-parse-time");
+                });
             })
             .on("error", (err: unknown) => {
               console.error(

tests/test-scans/fileTree/empty.json

@@ -44,25 +44,25 @@ export const FileTreeSamples: {
       },
       {
         id: 4,
-        name: "samples",
-        parent: "#",
-        path: "samples",
-        type: "directory",
-      },
-      {
-        id: 5,
         name: "licenses",
         parent: "samples/JGroups",
         path: "samples/JGroups/licenses",
         type: "directory",
       },
       {
-        id: 6,
+        id: 5,
         name: "JGroups",
         parent: "samples",
         path: "samples/JGroups",
         type: "directory",
       },
+      {
+        id: 6,
+        name: "samples",
+        parent: "#",
+        path: "samples",
+        type: "directory",
+      },
       {
         id: 7,
         name: "src",
@@ -96,7 +96,7 @@ export const FileTreeSamples: {
                     type: "file",
                   },
                 ],
-                id: 5,
+                id: 4,
                 isLeaf: false,
                 key: "samples/JGroups/licenses",
                 name: "licenses",
@@ -138,7 +138,7 @@ export const FileTreeSamples: {
                 type: "directory",
               },
             ],
-            id: 6,
+            id: 5,
             isLeaf: false,
             key: "samples/JGroups",
             name: "JGroups",
@@ -170,7 +170,7 @@ export const FileTreeSamples: {
             type: "directory",
           },
         ],
-        id: 4,
+        id: 6,
         isLeaf: false,
         key: "samples",
         name: "samples",
@@ -398,29 +398,4 @@ export const FileTreeSamples: {
       },
     ],
   },
-  {
-    jsonFileName: "empty.json",
-    flatData: [
-      {
-        id: 1,
-        name: "no-files",
-        path: "no-files",
-        parent: "#",
-        type: "directory",
-      },
-    ],
-    fileTree: [
-      {
-        id: 1,
-        key: "no-files",
-        name: "no-files",
-        parent: "#",
-        path: "no-files",
-        type: "directory",
-        isLeaf: false,
-        title: "no-files",
-        children: [],
-      },
-    ],
-  },
 ];

tests/test-scans/fileTree/expectedFileTree.ts

@@ -1,3 +1,7 @@
 {
-  "NOTE": "Test for headerless scans"
+  "files": [
+    {
+      "path": "postgresml-2.8.1"
+    }
+  ]
 }

tests/test-scans/headers/headerless.json

@@ -19,5 +19,10 @@
         "spdx_license_list_version": "3.20"
       }
     }
+  ],
+  "files": [
+    {
+      "path": "postgresml-2.8.1"
+    }
   ]
 }

tests/test-scans/headers/minimal.json

@@ -32,5 +32,10 @@
         "files_count": 39
       }
     }
+  ],
+  "files": [
+    {
+      "path": "postgresml-2.8.1"
+    }
   ]
 }

tests/test-scans/headers/withOptions.json

@@ -1,13 +1,16 @@
 {
   "files": [
     {
-      "path": "manifests"
+      "path": "manifests",
+      "type": "directory"
     },
     {
-      "path": "manifests/copyright"
+      "path": "manifests/copyright",
+      "type": "file"
     },
     {
-      "path": "manifests/FirebaseAnalytics.podspec.json"
+      "path": "manifests/FirebaseAnalytics.podspec.json",
+      "type": "file"
     }
   ]
 }

tests/test-scans/sanity/minimal.json

@@ -1,4 +1,7 @@
 export const SanitySamples: { jsonFileName: string }[] = [
-  { jsonFileName: "empty.json" },
   { jsonFileName: "minimal.json" },
 ];
+
+export const NoResourceSamples: { jsonFileName: string }[] = [
+  { jsonFileName: "empty.json" },
+];