Fixed SPDX expression resolution in detection matches

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

Author: OmkarPh

src/components/LicenseEntity/licenseEntity.css

@@ -69,6 +69,6 @@
 
 .rule-info-button {
   font-size: 1.05em !important;
-  color: #007bff !important;
+  color: var(--bs-btn-bg) !important;
   vertical-align: bottom !important;
 }

src/pages/Licenses/Licenses.tsx

@@ -298,7 +298,8 @@ const LicenseDetections = () => {
                     rootClose
                     overlay={
                       <Tooltip>
-                        Tick the checkboxes below to mark licenses as reviewed
+                        Tick the checkboxes below to mark license detections as
+                        reviewed
                       </Tooltip>
                     }
                   >

src/services/importedJsonTypes.ts

@@ -1,36 +1,4 @@
-export interface LicenseReference {
-  key: string;
-  language: string;
-  short_name: string;
-  name: string;
-  category: string;
-  owner: string;
-  homepage_url: string;
-  notes: string;
-  is_builtin: boolean;
-  is_exception: boolean;
-  is_unknown: boolean;
-  is_generic: boolean;
-  spdx_license_key: string;
-  other_spdx_license_keys: string[];
-  osi_license_key: string | null;
-  text_urls: string[];
-  osi_url?: string;
-  faq_url?: string;
-  other_urls: string[];
-  key_aliases: string[];
-  minimum_coverage: number;
-  standard_notice: string | null;
-  ignorable_copyrights: string[];
-  ignorable_holders: string[];
-  ignorable_authors: string[];
-  ignorable_urls: string[];
-  ignorable_emails: string[];
-  text: string;
-  scancode_url: string | null;
-  licensedb_url: string | null;
-  spdx_url: string | null;
-}
+import { LicenseDetectionAttributes } from "./models/licenseDetections";
 
 export interface LicenseExpressionKey {
   key: string;
@@ -107,6 +75,22 @@ export interface ResourceLicenseDetection {
   identifier: string;
 }
 
+export interface LicensePolicy {
+  license_key: string;
+  label: string;
+  color_code: string;
+  icon: string;
+
+  // Parser-added fields
+  fileId?: number;
+}
+
+export interface RawTopLevelTodo {
+  detection_id: string;
+  review_comments: Record<string, string>;
+  detection: LicenseDetectionAttributes;
+}
+
 export interface Resource {
   id?: number;
   path: string;
@@ -192,6 +176,8 @@ export interface Resource {
   for_license_detections?: string[];
   license_detections?: ResourceLicenseDetection[];
   license_clues?: LicenseClue[];
+  emails?: unknown[];
+  urls?: unknown[];
   copyrights?: {
     copyright: string;
     start_line: number;
@@ -208,14 +194,7 @@ export interface Resource {
     end_line: number;
   }[];
   percentage_of_license_text?: number;
-  license_policy?: {
-    license_key: string;
-    label: string;
-    color_code: string;
-    icon: string;
-    // Parser-added fields
-    fileId?: number;
-  }[];
+  license_policy?: LicensePolicy[];
   scan_errors?: string[];
 
   // Parser-added fields

src/services/models/database.ts

@@ -39,17 +39,9 @@ import licenseRuleReferenceModel, {
   LicenseRuleReferenceAttributes,
 } from "./licenseRuleReference";
 import todoModel, { TodoAttributes } from "./todo";
-
-// let Header;
-// let File;
-// let License;
-// let Copyright;
-// let Package;
-// let Email;
-// let Url;
-// let Scan;
-
-// type SupportedModels = <Model<HeaderAttributes, HeaderAttributes>>;
+import licenseReferenceModel, {
+  LicenseReferenceAttributes,
+} from "./licenseReference";
 
 export interface DatabaseStructure {
   // Top level entities
@@ -61,6 +53,9 @@ export interface DatabaseStructure {
   LicenseDetections: ModelStatic<
     Model<LicenseDetectionAttributes, LicenseDetectionAttributes>
   >;
+  LicenseReferences: ModelStatic<
+    Model<LicenseReferenceAttributes, LicenseReferenceAttributes>
+  >;
   LicenseRuleReferences: ModelStatic<
     Model<LicenseRuleReferenceAttributes, LicenseRuleReferenceAttributes>
   >;
@@ -94,6 +89,7 @@ export function newDatabase(sequelize: Sequelize): DatabaseStructure {
     Packages: packagesModel(sequelize),
     Dependencies: dependenciesModel(sequelize),
     LicenseDetections: licenseDetectionModel(sequelize),
+    LicenseReferences: licenseReferenceModel(sequelize),
     LicenseRuleReferences: licenseRuleReferenceModel(sequelize),
     LicenseClues: licenseClueModel(sequelize),
     Todo: todoModel(sequelize),

src/services/models/flatFile.ts

@@ -17,6 +17,7 @@
 import path from "path";
 import { Sequelize, DataTypes, Model } from "sequelize";
 import { jsonDataType, parentPath } from "./databaseUtils";
+import { LicensePolicy, Resource } from "../importedJsonTypes";
 
 export interface InfoFlatFileAttributes {
   type: string;
@@ -265,7 +266,7 @@ interface FlattenedFile {
   name: string;
   extension: string;
   date: string;
-  size: string;
+  size: number;
   sha1: string;
   md5: string;
   file_count: number;
@@ -310,7 +311,7 @@ interface FlattenedFile {
   package_data_dependencies: unknown[];
   package_data_related_packages: unknown[];
 }
-export function flattenFile(file: any): FlattenedFile {
+export function flattenFile(file: Resource): FlattenedFile {
   return {
     id: file.id,
     fileId: file.id,
@@ -406,7 +407,7 @@ export function flattenFile(file: any): FlattenedFile {
   };
 }
 
-function getLicensePolicyLabel(policy: any[]) {
+function getLicensePolicyLabel(policy: LicensePolicy[]) {
   if (!policy) {
     return [];
   }
@@ -429,7 +430,7 @@ function getCopyrightValues(
   if (!array || !Array.isArray(array)) {
     array = [];
   }
-  const values = array.map((val: any) => val[field]);
+  const values = array.map((val: Record<string, unknown>) => val[field]);
   // must wrap this in a list for datatables display; not sure why
   return [values];
 }

src/services/models/licenseReference.ts

@@ -0,0 +1,89 @@
+/*
+ #
+ # Copyright (c) nexB Inc. and others. All rights reserved.
+ # https://nexb.com and https://github.com/nexB/scancode-workbench/
+ # The ScanCode Workbench software is licensed under the Apache License version 2.0.
+ # ScanCode is a trademark of nexB Inc.
+ #
+ # You may not use this software except in compliance with the License.
+ # You may obtain a copy of the License at: http://apache.org/licenses/LICENSE-2.0
+ # Unless required by applicable law or agreed to in writing, software distributed
+ # under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ # CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ # specific language governing permissions and limitations under the License.
+ #
+ */
+
+import { Sequelize, DataTypes, Model } from "sequelize";
+import { jsonDataType } from "./databaseUtils";
+
+export interface LicenseReferenceAttributes {
+  id: number;
+  key: string;
+  language: string;
+  short_name: string;
+  name: string;
+  category: string;
+  owner: string;
+  homepage_url: string;
+  is_builtin: boolean;
+  is_exception: boolean;
+  is_unknown: boolean;
+  is_generic: boolean;
+  spdx_license_key: string;
+  other_spdx_license_keys: string[];
+  osi_license_key: string;
+  osi_url: string;
+  // notes: string;
+  // ignorable_copyrights: string[];
+  // ignorable_holders: string[];
+  // ignorable_authors: string[];
+  // ignorable_urls: string[];
+  // ignorable_emails: string[];
+  text: string;
+  scancode_url: string;
+  licensedb_url: string;
+  spdx_url: string;
+}
+
+export default function licenseReferenceModel(sequelize: Sequelize) {
+  return sequelize.define<Model<LicenseReferenceAttributes>>(
+    "license_reference",
+    {
+      id: {
+        allowNull: false,
+        autoIncrement: true,
+        primaryKey: true,
+        type: DataTypes.INTEGER,
+      },
+      key: DataTypes.STRING,
+      language: DataTypes.STRING,
+      short_name: DataTypes.STRING,
+      name: DataTypes.STRING,
+      category: DataTypes.STRING,
+      owner: DataTypes.STRING,
+      homepage_url: DataTypes.STRING,
+      is_builtin: DataTypes.BOOLEAN,
+      is_exception: DataTypes.BOOLEAN,
+      is_unknown: DataTypes.BOOLEAN,
+      is_generic: DataTypes.BOOLEAN,
+      spdx_license_key: DataTypes.STRING,
+      other_spdx_license_keys: jsonDataType("other_spdx_license_keys", []),
+      osi_license_key: DataTypes.STRING,
+      osi_url: DataTypes.STRING,
+      // notes: DataTypes.STRING,
+      // ignorable_copyrights: jsonDataType("ignorable_copyrights", []),
+      // ignorable_holders: jsonDataType("ignorable_holders", []),
+      // ignorable_authors: jsonDataType("ignorable_authors", []),
+      // ignorable_urls: jsonDataType("ignorable_urls", []),
+      // ignorable_emails: jsonDataType("ignorable_emails", []),
+      text: DataTypes.STRING,
+      scancode_url: DataTypes.STRING,
+      licensedb_url: DataTypes.STRING,
+      spdx_url: DataTypes.STRING,
+    },
+    {
+      timestamps: false,
+    }
+  );
+}