Merge pull request #1659 from opossum-tool/refactoring-displaypackageinfo

Refactoring DisplayPackageInfo

Author: lennartclaas

src/Frontend/Components/AggregatedAttributionsPanel/AccordionPanel.tsx

@@ -47,8 +47,8 @@ export function AccordionPanel(props: AccordionPanelProps): ReactElement {
   const [expanded, setExpanded] = useState<boolean>(false);
 
   useMemo(() => {
-    setExpanded(props.panelData.attributionIdsWithCount?.length > 0);
-  }, [props.panelData.attributionIdsWithCount]);
+    setExpanded(props.panelData.displayAttributionsWithCount?.length > 0);
+  }, [props.panelData.displayAttributionsWithCount]);
 
   function handleExpansionChange(
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -69,7 +69,7 @@ export function AccordionPanel(props: AccordionPanelProps): ReactElement {
       key={`PackagePanel-${props.panelData.title}`}
       expanded={expanded}
       onChange={handleExpansionChange}
-      disabled={isDisabled(props.panelData.attributionIdsWithCount)}
+      disabled={isDisabled(props.panelData.displayAttributionsWithCount)}
     >
       <MuiAccordionSummary
         sx={{
@@ -86,8 +86,7 @@ export function AccordionPanel(props: AccordionPanelProps): ReactElement {
       >
         <PackagePanel
           title={props.panelData.title}
-          attributionIdsWithCount={props.panelData.attributionIdsWithCount}
-          attributions={props.panelData.attributions}
+          attributionIdsWithCount={props.panelData.displayAttributionsWithCount}
           isAddToPackageEnabled={props.isAddToPackageEnabled}
         />
       </MuiAccordionDetails>

src/Frontend/Components/AggregatedAttributionsPanel/AggregatedAttributionsPanel.tsx

@@ -19,12 +19,14 @@ import {
 import { isIdOfResourceWithChildren } from '../../util/can-resource-have-children';
 import { SyncAccordionPanel } from './SyncAccordionPanel';
 import {
-  getContainedManualPackages,
   getExternalAttributionIdsWithCount,
   PanelAttributionData,
 } from '../../util/get-contained-packages';
 import { AttributionIdWithCount } from '../../types/types';
-import { getDisplayContainedExternalPackagesWithCount } from './accordion-panel-helpers';
+import {
+  getDisplayContainedExternalPackagesWithCount,
+  getDisplayContainedManualPackagesWithCount,
+} from './accordion-panel-helpers';
 
 interface AggregatedAttributionsPanelProps {
   isAddToPackageEnabled: boolean;
@@ -105,17 +107,17 @@ export function AggregatedAttributionsPanel(
             title={PackagePanelTitle.ContainedExternalPackages}
             workerArgs={containedExternalPackagesWorkerArgs}
             syncFallbackArgs={containedExternalPackagesSyncFallbackArgs}
-            getDisplayAttributionIdsWithCount={
+            getDisplayAttributionsWithCount={
               getDisplayContainedExternalPackagesWithCount
             }
-            attributions={externalData.attributions}
             isAddToPackageEnabled={props.isAddToPackageEnabled}
           />
           <WorkerAccordionPanel
             title={PackagePanelTitle.ContainedManualPackages}
             workerArgs={containedManualPackagesWorkerArgs}
-            getDisplayAttributionIdsWithCount={getContainedManualPackages}
-            attributions={manualData.attributions}
+            getDisplayAttributionsWithCount={
+              getDisplayContainedManualPackagesWithCount
+            }
             isAddToPackageEnabled={props.isAddToPackageEnabled}
           />
         </>

src/Frontend/Components/AggregatedAttributionsPanel/SyncAccordionPanel.tsx

@@ -10,7 +10,7 @@ import {
 import { AccordionPanel } from './AccordionPanel';
 import { PackagePanelTitle } from '../../enums/enums';
 import { AttributionIdWithCount, PanelData } from '../../types/types';
-import { getDisplayAttributionsWithCount } from './accordion-panel-helpers';
+import { getDisplayExternalAttributionsWithCount } from './accordion-panel-helpers';
 
 interface SyncAccordionPanelProps {
   title: PackagePanelTitle;
@@ -23,15 +23,14 @@ interface SyncAccordionPanelProps {
 export function SyncAccordionPanel(
   props: SyncAccordionPanelProps
 ): ReactElement {
-  const displayAttributionIdsWithCount = getDisplayAttributionsWithCount(
+  const displayAttributionsWithCount = getDisplayExternalAttributionsWithCount(
     props.getAttributionIdsWithCount(),
     props.attributions,
     props.attributionsToHashes
   );
   const panelData: PanelData = {
     title: props.title,
-    attributionIdsWithCount: displayAttributionIdsWithCount,
-    attributions: props.attributions,
+    displayAttributionsWithCount,
   };
 
   return (

src/Frontend/Components/AggregatedAttributionsPanel/WorkerAccordionPanel.tsx

@@ -3,24 +3,22 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import React, { ReactElement, useContext, useMemo, useState } from 'react';
-import {
-  Attributions,
-  AttributionsToHashes,
-} from '../../../shared/shared-types';
+import { AttributionsToHashes } from '../../../shared/shared-types';
 import { AccordionPanel } from './AccordionPanel';
 import { PackagePanelTitle } from '../../enums/enums';
 import {
-  AttributionIdsWithCountAndResourceId,
-  AttributionIdWithCount,
+  DisplayAttributionsWithCountAndResourceId,
+  DisplayAttributionWithCount,
   PanelData,
 } from '../../types/types';
 import { AccordionWorkersContext } from '../WorkersContextProvider/WorkersContextProvider';
 import { PanelAttributionData } from '../../util/get-contained-packages';
 
-const EMPTY_ATTRIBUTION_IDS_WITH_COUNT_AND_RESOURCE_ID = {
-  resourceId: '',
-  attributionIdsWithCount: [],
-};
+const EMPTY_DISPLAY_ATTRIBUTIONS_WITH_COUNT_AND_RESOURCE_ID: DisplayAttributionsWithCountAndResourceId =
+  {
+    resourceId: '',
+    displayAttributionsWithCount: [],
+  };
 
 type ContainedAttributionsAccordionWorkerArgs =
   | ContainedExternalAttributionsAccordionWorkerArgs
@@ -44,21 +42,20 @@ interface WorkerAccordionPanelProps {
     | PackagePanelTitle.ContainedManualPackages;
   workerArgs: ContainedAttributionsAccordionWorkerArgs;
   syncFallbackArgs?: ContainedAttributionsAccordionWorkerArgs;
-  getDisplayAttributionIdsWithCount(
+  getDisplayAttributionsWithCount(
     workerArgs: ContainedAttributionsAccordionWorkerArgs
-  ): Array<AttributionIdWithCount>;
-  attributions: Attributions;
+  ): Array<DisplayAttributionWithCount>;
   isAddToPackageEnabled: boolean;
 }
 
 export function WorkerAccordionPanel(
   props: WorkerAccordionPanelProps
 ): ReactElement {
   const [
-    attributionIdsWithCountAndResourceId,
-    setAttributionIdsWithCountAndResourceId,
-  ] = useState<AttributionIdsWithCountAndResourceId>(
-    EMPTY_ATTRIBUTION_IDS_WITH_COUNT_AND_RESOURCE_ID
+    displayAttributionsWithCountAndResourceId,
+    setDisplayAttributionsWithCountAndResourceId,
+  ] = useState<DisplayAttributionsWithCountAndResourceId>(
+    EMPTY_DISPLAY_ATTRIBUTIONS_WITH_COUNT_AND_RESOURCE_ID
   );
   const resourceDetailsTabsWorkers = useContext(AccordionWorkersContext);
 
@@ -79,8 +76,8 @@ export function WorkerAccordionPanel(
       props.workerArgs,
       worker,
       props.title,
-      setAttributionIdsWithCountAndResourceId,
-      props.getDisplayAttributionIdsWithCount,
+      setDisplayAttributionsWithCountAndResourceId,
+      props.getDisplayAttributionsWithCount,
       props.syncFallbackArgs
     );
     // eslint-disable-next-line react-hooks/exhaustive-deps
@@ -89,19 +86,17 @@ export function WorkerAccordionPanel(
   let panelData: PanelData;
   if (
     props.workerArgs.selectedResourceId ===
-    attributionIdsWithCountAndResourceId.resourceId
+    displayAttributionsWithCountAndResourceId.resourceId
   ) {
     panelData = {
       title: props.title,
-      attributionIdsWithCount:
-        attributionIdsWithCountAndResourceId.attributionIdsWithCount,
-      attributions: props.attributions,
+      displayAttributionsWithCount:
+        displayAttributionsWithCountAndResourceId.displayAttributionsWithCount,
     };
   } else {
     panelData = {
       title: props.title,
-      attributionIdsWithCount: [],
-      attributions: props.attributions,
+      displayAttributionsWithCount: [],
     };
   }
 
@@ -118,16 +113,16 @@ async function loadAttributionIdsWithCount(
   workerArgs: ContainedAttributionsAccordionWorkerArgs,
   worker: Worker,
   panelTitle: string,
-  setAttributionIdsWithCountAndResourceId: (
-    attributionIdsWithCountAndResourceId: AttributionIdsWithCountAndResourceId
+  setDisplayAttributionsWithCountAndResourceId: (
+    attributionIdsWithCountAndResourceId: DisplayAttributionsWithCountAndResourceId
   ) => void,
-  getDisplayAttributionIdsWithCount: (
+  getDisplayAttributionsWithCount: (
     workerArgs: ContainedAttributionsAccordionWorkerArgs
-  ) => Array<AttributionIdWithCount>,
+  ) => Array<DisplayAttributionWithCount>,
   syncFallbackArgs?: ContainedAttributionsAccordionWorkerArgs
 ): Promise<void> {
-  setAttributionIdsWithCountAndResourceId(
-    EMPTY_ATTRIBUTION_IDS_WITH_COUNT_AND_RESOURCE_ID
+  setDisplayAttributionsWithCountAndResourceId(
+    EMPTY_DISPLAY_ATTRIBUTIONS_WITH_COUNT_AND_RESOURCE_ID
   );
 
   // WebWorkers can fail for different reasons, e.g. because they run out
@@ -142,21 +137,21 @@ async function loadAttributionIdsWithCount(
         logErrorAndComputeInMainProcess(
           panelTitle,
           Error('Web Worker execution error.'),
-          setAttributionIdsWithCountAndResourceId,
-          getDisplayAttributionIdsWithCount,
+          setDisplayAttributionsWithCountAndResourceId,
+          getDisplayAttributionsWithCount,
           workerArgs,
           syncFallbackArgs
         );
       } else {
-        setAttributionIdsWithCountAndResourceId(output);
+        setDisplayAttributionsWithCountAndResourceId(output);
       }
     };
   } catch (error) {
     logErrorAndComputeInMainProcess(
       panelTitle,
       error,
-      setAttributionIdsWithCountAndResourceId,
-      getDisplayAttributionIdsWithCount,
+      setDisplayAttributionsWithCountAndResourceId,
+      getDisplayAttributionsWithCount,
       workerArgs,
       syncFallbackArgs
     );
@@ -166,21 +161,23 @@ async function loadAttributionIdsWithCount(
 function logErrorAndComputeInMainProcess(
   panelTitle: string,
   error: unknown,
-  setAttributionIdsWithCountAndResourceId: (
-    attributionIdsWithCountAndResourceId: AttributionIdsWithCountAndResourceId
+  setDisplayAttributionsWithCountAndResourceId: (
+    attributionIdsWithCountAndResourceId: DisplayAttributionsWithCountAndResourceId
   ) => void,
-  getDisplayAttributionIdsWithCount: (
+  getDisplayAttributionsWithCount: (
     workerArgs: ContainedAttributionsAccordionWorkerArgs
-  ) => Array<AttributionIdWithCount>,
+  ) => Array<DisplayAttributionWithCount>,
   workerArgs: ContainedAttributionsAccordionWorkerArgs,
   syncFallbackArgs?: ContainedAttributionsAccordionWorkerArgs
 ): void {
-  const displayAttributionIdsWithCount = getDisplayAttributionIdsWithCount(
+  console.info(`Error in ResourceDetailsTab ${panelTitle}: `, error);
+
+  const displayAttributionIdsWithCount = getDisplayAttributionsWithCount(
     syncFallbackArgs || workerArgs
   );
 
-  setAttributionIdsWithCountAndResourceId({
+  setDisplayAttributionsWithCountAndResourceId({
     resourceId: workerArgs.selectedResourceId,
-    attributionIdsWithCount: displayAttributionIdsWithCount,
+    displayAttributionsWithCount: displayAttributionIdsWithCount,
   });
 }