Merge pull request #627 from nexB/fix/flag_fields

Fixed Boolean cell renderer, refactored renderers, hidden license text for directories
aboutcode-org · Jan 22, 2024 · 49e7126 · 49e7126
2 parents 542efce + 356f504
commit 49e7126
Show file tree

Hide file tree

Showing 13 changed files with 67 additions and 43 deletions.
diff --git a/src/pages/TableView/CustomCellRenderers/BooleanCellRenderer.tsx b/src/pages/TableView/CustomCellRenderers/BooleanCellRenderer.tsx
@@ -0,0 +1,12 @@
+import React from "react";
+
+interface BooleanCellRendererProps {
+  value: boolean;
+}
+const BooleanCellRenderer: React.FunctionComponent<BooleanCellRendererProps> = (
+  props
+) => {
+  return props.value ? "Yes" : "No";
+};
+
+export default BooleanCellRenderer;
diff --git a/src/pages/TableView/CustomCellRenderers/Licenses/DetectionOriginRenderer.tsx b/src/pages/TableView/CustomCellRenderers/Licenses/DetectionOriginRenderer.tsx
@@ -16,7 +16,9 @@ enum ORIGIN {
   PACKAGE_DATA = "package_data",
 }
 
-const DetectionOriginRenderer = (props: DetectionOriginRendererProps) => {
+const DetectionOriginRenderer: React.FunctionComponent<
+  DetectionOriginRendererProps
+> = (props) => {
   const { value, data } = props;
   const { goToFileInTableView, goToPackage } = useWorkbenchDB();
 

diff --git a/src/pages/TableView/CustomCellRenderers/Licenses/FileLicenseCluesRenderer.tsx b/src/pages/TableView/CustomCellRenderers/Licenses/FileLicenseCluesRenderer.tsx
@@ -7,7 +7,9 @@ interface FileLicenseCluesRendererProps {
   value: LicenseClueDetails[];
 }
 
-const FileLicenseCluesRenderer = (props: FileLicenseCluesRendererProps) => {
+const FileLicenseCluesRenderer: React.FunctionComponent<
+  FileLicenseCluesRendererProps
+> = (props) => {
   const { value } = props;
 
   const parsedValue: LicenseClueDetails[] = useMemo(() => {
@@ -24,7 +26,7 @@ const FileLicenseCluesRenderer = (props: FileLicenseCluesRendererProps) => {
 
   if (!parsedValue) return <></>;
 
-  if (!Array.isArray(parsedValue)) return value;
+  if (!Array.isArray(parsedValue)) return <>{value}</>;
 
   return (
     <>

diff --git a/src/pages/TableView/CustomCellRenderers/Licenses/FileLicenseDetectionsRenderer.tsx b/src/pages/TableView/CustomCellRenderers/Licenses/FileLicenseDetectionsRenderer.tsx
@@ -7,9 +7,9 @@ interface FileLicenseDetectionsRendererProps {
   value: LicenseDetectionAttributes[];
 }
 
-const FileLicenseDetectionsRenderer = (
-  props: FileLicenseDetectionsRendererProps
-) => {
+const FileLicenseDetectionsRenderer: React.FunctionComponent<
+  FileLicenseDetectionsRendererProps
+> = (props) => {
   const { value } = props;
 
   const parsedValue: LicenseDetectionAttributes[] = useMemo(() => {
@@ -26,7 +26,7 @@ const FileLicenseDetectionsRenderer = (
 
   if (!parsedValue) return <></>;
 
-  if (!Array.isArray(parsedValue)) return value;
+  if (!Array.isArray(parsedValue)) return <>{value}</>;
 
   return (
     <>

diff --git a/src/pages/TableView/CustomCellRenderers/Licenses/FilePathRenderer.tsx b/src/pages/TableView/CustomCellRenderers/Licenses/FilePathRenderer.tsx
@@ -7,7 +7,9 @@ interface FilePathRendererProps {
   iconComponent?: React.ReactNode;
 }
 
-const FilePathRenderer = (props: FilePathRendererProps) => {
+const FilePathRenderer: React.FunctionComponent<FilePathRendererProps> = (
+  props
+) => {
   const { value, iconComponent } = props;
   const { goToFileInTableView } = useWorkbenchDB();
 

diff --git a/src/pages/TableView/CustomCellRenderers/Licenses/RegionLinesRenderer.tsx b/src/pages/TableView/CustomCellRenderers/Licenses/RegionLinesRenderer.tsx
@@ -7,7 +7,9 @@ interface RegionLinesRendererProps {
   };
 }
 
-const RegionLinesRenderer = (props: RegionLinesRendererProps) => {
+const RegionLinesRenderer: React.FunctionComponent<RegionLinesRendererProps> = (
+  props
+) => {
   const { data } = props;
   return (
     <span>

diff --git a/src/pages/TableView/CustomCellRenderers/ListCellRenderer.tsx b/src/pages/TableView/CustomCellRenderers/ListCellRenderer.tsx
@@ -4,7 +4,9 @@ interface ListCellRendererProps {
   value: string;
 }
 
-const ListCellRenderer = (props: ListCellRendererProps) => {
+const ListCellRenderer: React.FunctionComponent<ListCellRendererProps> = (
+  props
+) => {
   const parsedValue: string[][] | string[] | string = useMemo(() => {
     if (Array.isArray(props.value)) return props.value;
 
@@ -30,11 +32,7 @@ const ListCellRenderer = (props: ListCellRendererProps) => {
         ? parsedValue.map((subValues, i) => (
             <span key={i}>
               {Array.isArray(subValues)
-                ? subValues.map((value, j) => (
-                    <span key={j}>
-                      {value}
-                    </span>
-                  ))
+                ? subValues.map((value, j) => <span key={j}>{value}</span>)
                 : subValues}
               <br />
             </span>

diff --git a/src/pages/TableView/CustomCellRenderers/TickRenderer.tsx b/src/pages/TableView/CustomCellRenderers/TickRenderer.tsx
@@ -7,7 +7,7 @@ interface TickRendererProps {
   data: unknown;
 }
 
-const TickRenderer = (props: TickRendererProps) => {
+const TickRenderer: React.FunctionComponent<TickRendererProps> = (props) => {
   const { value } = props;
 
   const icon = value ? faCheck : faX;

diff --git a/src/pages/TableView/CustomCellRenderers/UrlListCellRenderer.tsx b/src/pages/TableView/CustomCellRenderers/UrlListCellRenderer.tsx
@@ -1,4 +1,4 @@
-import React, { FunctionComponent, useMemo } from "react";
+import React, { useMemo } from "react";
 import { Link } from "react-router-dom";
 import CoreLink from "../../../components/CoreLink/CoreLink";
 
@@ -12,7 +12,7 @@ interface UrlListCellRendererProps {
   customDisplayTextFieldFallback?: string;
   data: any;
 }
-const UrlListCellRenderer: FunctionComponent<UrlListCellRendererProps> = (
+const UrlListCellRenderer: React.FunctionComponent<UrlListCellRendererProps> = (
   props
 ) => {
   const {
@@ -123,7 +123,7 @@ interface ListComponentProps {
   urlSuffix?: string;
   customDisplayText?: string;
 }
-const LinkComponent: FunctionComponent<ListComponentProps> = (props) => {
+const LinkComponent: React.FunctionComponent<ListComponentProps> = (props) => {
   const { value, routerLink, urlPrefix, urlSuffix, customDisplayText } = props;
   const URL = (urlPrefix || "") + value + (urlSuffix || "");
 

diff --git a/src/pages/TableView/CustomCellRenderers/index.tsx b/src/pages/TableView/CustomCellRenderers/index.tsx
@@ -1,19 +1,21 @@
+import BooleanCellRenderer from "./BooleanCellRenderer";
+import DetectionOriginRenderer from "./Licenses/DetectionOriginRenderer";
 import FileLicenseDetectionsRenderer from "./Licenses/FileLicenseDetectionsRenderer";
 import FileLicenseCluesRenderer from "./Licenses/FileLicenseCluesRenderer";
 import FilePathRenderer from "./Licenses/FilePathRenderer";
-import DetectionOriginRenderer from "./Licenses/DetectionOriginRenderer";
-import RegionLinesRenderer from "./Licenses/RegionLinesRenderer";
 import ListCellRenderer from "./ListCellRenderer";
-import UrlListCellRenderer from "./UrlListCellRenderer";
+import RegionLinesRenderer from "./Licenses/RegionLinesRenderer";
 import TickRenderer from "./TickRenderer";
+import UrlListCellRenderer from "./UrlListCellRenderer";
 
 export {
-  TickRenderer,
-  ListCellRenderer,
-  RegionLinesRenderer,
+  BooleanCellRenderer,
   DetectionOriginRenderer,
-  UrlListCellRenderer,
   FilePathRenderer,
   FileLicenseDetectionsRenderer,
   FileLicenseCluesRenderer,
+  ListCellRenderer,
+  RegionLinesRenderer,
+  TickRenderer,
+  UrlListCellRenderer,
 };
diff --git a/src/pages/TableView/columnDefs.ts b/src/pages/TableView/columnDefs.ts
@@ -3,26 +3,28 @@ import { ColDef, IFilterOptionDef } from "ag-grid-community";
 import { ROUTES } from "../../constants/routes";
 import { QUERY_KEYS } from "./../../constants/params";
 import {
+  BooleanCellRenderer,
   FileLicenseDetectionsRenderer,
   FileLicenseCluesRenderer,
   ListCellRenderer,
   UrlListCellRenderer,
 } from "./CustomCellRenderers";
 
 enum CustomComponentKeys {
-  ListCellRenderer = "ListCellRenderer",
-  UrlListCellRenderer = "UrlListCellRenderer",
-  LicenseExpressionRenderer = "LicenseExpressionRenderer",
+  BooleanCellRenderer = "BooleanCellRenderer",
   FileLicenseDetectionsRenderer = "FileLicenseDetectionsRenderer",
   FileLicenseCluesRenderer = "FileLicenseCluesRenderer",
+  ListCellRenderer = "ListCellRenderer",
+  UrlListCellRenderer = "UrlListCellRenderer",
 }
 
-export const frameworkComponents = {
-  [CustomComponentKeys.ListCellRenderer]: ListCellRenderer,
-  [CustomComponentKeys.UrlListCellRenderer]: UrlListCellRenderer,
+export const frameworkComponents: Record<CustomComponentKeys, React.FunctionComponent> = {
+  [CustomComponentKeys.BooleanCellRenderer]: BooleanCellRenderer,
   [CustomComponentKeys.FileLicenseDetectionsRenderer]:
     FileLicenseDetectionsRenderer,
   [CustomComponentKeys.FileLicenseCluesRenderer]: FileLicenseCluesRenderer,
+  [CustomComponentKeys.ListCellRenderer]: ListCellRenderer,
+  [CustomComponentKeys.UrlListCellRenderer]: UrlListCellRenderer,
 };
 
 export type ISimpleFilterModelType =
@@ -48,8 +50,6 @@ export const FILTER_OPTIONS: FilterOptionsMap = {
   LIST_FILTERS: ["contains", "notContains"],
 };
 
-const BooleanValueRenderer = (value: boolean) => (value ? "Yes" : "No");
-
 interface COLUMNS_LIST {
   // Required to update select options by field string
   [key: string]: ColDef;
@@ -154,42 +154,42 @@ export const ALL_COLUMNS: COLUMNS_LIST = {
     field: "is_binary",
     colId: "is_binary",
     headerName: "Binary File",
-    cellRenderer: BooleanValueRenderer,
+    cellRenderer: CustomComponentKeys.BooleanCellRenderer,
     initialWidth: 100,
   },
   is_text: {
     field: "is_text",
     colId: "is_text",
     headerName: "Text File",
-    cellRenderer: BooleanValueRenderer,
+    cellRenderer: CustomComponentKeys.BooleanCellRenderer,
     initialWidth: 100,
   },
   is_archive: {
     field: "is_archive",
     colId: "is_archive",
     headerName: "Archive File",
-    cellRenderer: BooleanValueRenderer,
+    cellRenderer: CustomComponentKeys.BooleanCellRenderer,
     initialWidth: 100,
   },
   is_media: {
     field: "is_media",
     colId: "is_media",
     headerName: "Media File",
-    cellRenderer: BooleanValueRenderer,
+    cellRenderer: CustomComponentKeys.BooleanCellRenderer,
     initialWidth: 100,
   },
   is_source: {
     field: "is_source",
     colId: "is_source",
     headerName: "Source File",
-    cellRenderer: BooleanValueRenderer,
+    cellRenderer: CustomComponentKeys.BooleanCellRenderer,
     initialWidth: 100,
   },
   is_script: {
     field: "is_script",
     colId: "is_script",
     headerName: "Script File",
-    cellRenderer: BooleanValueRenderer,
+    cellRenderer: CustomComponentKeys.BooleanCellRenderer,
     initialWidth: 100,
   },
 

diff --git a/src/services/models/flatFile.ts b/src/services/models/flatFile.ts
@@ -138,7 +138,10 @@ export default function flatFileModel(sequelize: Sequelize) {
 
       detected_license_expression: DataTypes.STRING,
       detected_license_expression_spdx: DataTypes.STRING,
-      percentage_of_license_text: DataTypes.NUMBER,
+      percentage_of_license_text: {
+        type: DataTypes.NUMBER,
+        allowNull: true,
+      },
       license_clues: jsonDataType("license_clues", []),
       license_policy: jsonDataType("license_policy", []),
       license_detections: jsonDataType("license_detections", []),
@@ -325,7 +328,8 @@ export function flattenFile(file: Resource): FlattenedFile {
 
     detected_license_expression: file.detected_license_expression,
     detected_license_expression_spdx: file.detected_license_expression_spdx,
-    percentage_of_license_text: file.percentage_of_license_text,
+    percentage_of_license_text:
+      file?.type === "file" ? file?.percentage_of_license_text : null,
     license_clues: file.license_clues,
     license_policy: getLicensePolicyLabel(file.license_policy),
     license_detections: file.license_detections,

diff --git a/tests/test-scans/licenses/expectedLicenses.ts b/tests/test-scans/licenses/expectedLicenses.ts
@@ -727,7 +727,7 @@ export const LicenseSamples: {
         license_detections: [],
         detected_license_expression: null,
         detected_license_expression_spdx: null,
-        percentage_of_license_text: 0,
+        percentage_of_license_text: null,
       },
       {
         license_clues: [],