Merge pull request #1262 from BlueBrain/3939/improve-file-size-indication

Dinika · web-flow · commit 059666dbed2d · 2023-06-13T11:55:57.000+02:00
3939 // improve file size indication
diff --git a/src/shared/molecules/MyDataTable/MyDataTable.tsx b/src/shared/molecules/MyDataTable/MyDataTable.tsx
@@ -68,8 +68,8 @@ export type TDataSource = {
   distribution?: {
     contentSize: number;
     encodingFormat: string | string[];
-    label: string | string[];
-    hasDistribution?: boolean;
+    label: string;
+    hasDistribution: boolean;
   };
 };
 type TProps = {
diff --git a/src/shared/organisms/DataPanel/DataPanel.tsx b/src/shared/organisms/DataPanel/DataPanel.tsx
@@ -63,7 +63,11 @@ import {
 } from '../../molecules/MyDataTable/MyDataTable';
 
 import './styles.less';
-import { fileNameForDistributionItem } from '../../../shared/utils/datapanel';
+import {
+  distributionMatchesTypes,
+  fileNameForDistributionItem,
+  getSizeOfResourcesToDownload,
+} from '../../../shared/utils/datapanel';
 
 type Props = {
   authenticated?: boolean;
@@ -133,25 +137,6 @@ function getPathForChildResource(child: any, parent: ResourceObscured) {
   return `${parentPathWithoutExtension}/${childNameWithExtension}`;
 }
 
-const distributionMatchesTypes = (
-  distItem: any,
-  fileExtenstions: string[]
-): boolean => {
-  if (fileExtenstions.length === 0) {
-    return true;
-  }
-
-  const distributionName = fileNameForDistributionItem(distItem, '');
-  const distributionExtension =
-    distributionName
-      .split('.')
-      .pop()
-      ?.trim()
-      .toLowerCase() ?? '';
-
-  return fileExtenstions.includes(distributionExtension);
-};
-
 function makePayload(resourcesPayload: DownloadResourcePayload[]) {
   const archiveId = uuidv4();
   const payload: ArchivePayload = {
@@ -161,7 +146,7 @@ function makePayload(resourcesPayload: DownloadResourcePayload[]) {
   return { payload, archiveId };
 }
 
-type ResourceObscured = {
+export type ResourceObscured = {
   size: number;
   contentType: string | undefined;
   distribution:
@@ -493,14 +478,8 @@ const DataPanel: React.FC<Props> = ({}) => {
             Boolean(resource.distribution?.contentSize)
               ? 'File'
               : 'Resource';
-          // TODO: Add this as part of localstorage object
-          const contentType = resource.distribution
-            ? isArray(resource.distribution?.label)
-              ? resource.distribution?.label[0].split('.').pop()
-              : resource.distribution?.label?.split('.').pop() ?? ''
-            : type === 'Resource'
-            ? 'json'
-            : '';
+          const contentType =
+            resource.distribution?.label?.split('.').pop() ?? '';
           return {
             size,
             contentType: contentType?.toLowerCase(),
@@ -570,15 +549,8 @@ const DataPanel: React.FC<Props> = ({}) => {
     i => !isEmpty(i) && !isNil(i)
   );
 
-  const totalSize = sum(
-    ...compact(
-      flatMap(resultsObject)
-        .filter(item => {
-          return distributionMatchesTypes(item?.distribution, types);
-        })
-        .map(item => item?.size)
-    )
-  );
+  const totalSize = getSizeOfResourcesToDownload(resultsObject, types);
+
   const parsedData: ParsedNexusUrl | undefined = resourcesObscured.length
     ? parseURL(resourcesObscured.find(item => !!item!._self)?._self as string)
     : undefined;
diff --git a/src/shared/utils/__mocks__/data_panel_download_resource.ts b/src/shared/utils/__mocks__/data_panel_download_resource.ts
@@ -44,6 +44,46 @@ export const resourceWithoutDistrition = {
     'https://staging.nise.bbp.epfl.ch/nexus/v1/realms/serviceaccounts/users/service-account-nexus-sa',
 };
 
+export const fileResourceWithNoDistribution = {
+  '@context': [
+    'https://bluebrain.github.io/nexus/contexts/files.json',
+    'https://bluebrain.github.io/nexus/contexts/metadata.json',
+  ],
+  '@id':
+    'https://bbp.epfl.ch/neurosciencegraph/data/938fb28f-6e5c-434f-8d12-572e5c005f73',
+  '@type': 'File',
+  _bytes: 318076,
+  _constrainedBy: 'https://bluebrain.github.io/nexus/schemas/files.json',
+  _createdAt: '2022-03-31T16:54:52.580Z',
+  _createdBy:
+    'https://dev.nise.bbp.epfl.ch/nexus/v1/realms/serviceaccounts/users/service-account-nexus-sa',
+  _deprecated: false,
+  _digest: {
+    _algorithm: 'SHA-256',
+    _value: '84da895fdc949ae7b7bd55192a8fef3b1cd5721c06b0993339e0cc42997bd3a4',
+  },
+  _filename: 'C120501B1-MT-C1_IDRest.zip',
+  _incoming:
+    'https://dev.nise.bbp.epfl.ch/nexus/v1/files/copies/sscx/https:%2F%2Fbbp.epfl.ch%2Fneurosciencegraph%2Fdata%2F938fb28f-6e5c-434f-8d12-572e5c005f73/incoming',
+  _mediaType: 'application/zip',
+  _origin: 'Client',
+  _outgoing:
+    'https://dev.nise.bbp.epfl.ch/nexus/v1/files/copies/sscx/https:%2F%2Fbbp.epfl.ch%2Fneurosciencegraph%2Fdata%2F938fb28f-6e5c-434f-8d12-572e5c005f73/outgoing',
+  _project: 'https://dev.nise.bbp.epfl.ch/nexus/v1/projects/copies/sscx',
+  _rev: 1,
+  _self:
+    'https://dev.nise.bbp.epfl.ch/nexus/v1/files/copies/sscx/https:%2F%2Fbbp.epfl.ch%2Fneurosciencegraph%2Fdata%2F938fb28f-6e5c-434f-8d12-572e5c005f73',
+  _storage: {
+    '@id': 'https://bluebrain.github.io/nexus/vocabulary/diskStorageDefault',
+    '@type': 'DiskStorage',
+    _rev: 1,
+  },
+  _updatedAt: '2022-03-31T16:54:52.580Z',
+  _updatedBy:
+    'https://dev.nise.bbp.epfl.ch/nexus/v1/realms/serviceaccounts/users/service-account-nexus-sa',
+  _uuid: '5673b3ae-bdd6-43b4-a3ca-aa6c771edbfa',
+};
+
 export const resourceWithDistributionArray = {
   '@context': [
     'https://bluebrain.github.io/nexus/contexts/metadata.json',
diff --git a/src/shared/utils/__tests__/datapanel.spec.ts b/src/shared/utils/__tests__/datapanel.spec.ts
@@ -1,4 +1,5 @@
 import {
+  fileResourceWithNoDistribution,
   resourceWithDistributionArray,
   resourceWithDistributionObject,
   resourceWithoutDistrition,
@@ -11,9 +12,16 @@ describe('ToLocalStorageResources', () => {
       resourceWithoutDistrition,
       'studios'
     );
+    const expectedParentDistributionValue = {
+      hasDistribution: false,
+      contentSize: 0,
+      encodingFormat: 'json',
+      label: 'metadata.json',
+    };
 
     expect(actualLSResources.length).toEqual(1);
-    expect(actualLSResources[0].distribution).not.toBeDefined();
+
+    expect(actualLSResources[0].localStorageType).toEqual('resource');
     expect(actualLSResources[0]._self).toEqual(resourceWithoutDistrition._self);
     expect(actualLSResources[0].key).toEqual(resourceWithoutDistrition._self);
     expect(actualLSResources[0].project).toEqual(
@@ -23,6 +31,27 @@ describe('ToLocalStorageResources', () => {
       resourceWithoutDistrition['@type'],
     ]);
     expect(actualLSResources[0].source).toEqual('studios');
+    expect(actualLSResources[0].distribution).toEqual(
+      expectedParentDistributionValue
+    );
+  });
+
+  it('serializes resource of type file with no distribution correctly', () => {
+    const actualLSResources = toLocalStorageResources(
+      fileResourceWithNoDistribution,
+      'my-data'
+    );
+    expect(actualLSResources.length).toEqual(1);
+    const expectedParentDistributionValue = {
+      hasDistribution: false,
+      contentSize: fileResourceWithNoDistribution._bytes,
+      encodingFormat: fileResourceWithNoDistribution._mediaType,
+      label: fileResourceWithNoDistribution._filename,
+    };
+    expect(actualLSResources[0].distribution).toEqual(
+      expectedParentDistributionValue
+    );
+    expect(actualLSResources[0].source).toEqual('my-data');
   });
 
   it('serializes resources with distribution array correctly to local storage object', () => {
@@ -34,8 +63,8 @@ describe('ToLocalStorageResources', () => {
     const expectedParentDistributionValue = {
       hasDistribution: true,
       contentSize: 0,
-      encodingFormat: '',
-      label: '',
+      encodingFormat: 'json',
+      label: 'metadata.json',
     };
 
     expect(actualParentDistributionValue).toEqual(
@@ -59,6 +88,7 @@ describe('ToLocalStorageResources', () => {
         encodingFormat: originalDistItems[index].encodingFormat,
         label: originalDistItems[index].name,
       };
+      expect(actualDistItem.localStorageType).toEqual('distribution');
       expect(actualDistItem.distribution).toEqual(expectedDistributionValue);
       expect(actualDistItem._self).toEqual(resource._self);
       expect(actualDistItem.key).toEqual(`${resource._self}-${index}`);
@@ -69,19 +99,32 @@ describe('ToLocalStorageResources', () => {
     const resource = resourceWithDistributionObject;
     const actualSerializedItems = toLocalStorageResources(resource, 'studios');
 
-    expect(actualSerializedItems.length).toEqual(1);
-    const expectedDistributionValue = {
+    expect(actualSerializedItems.length).toEqual(2);
+
+    const expectedDistributionValueForParent = {
+      hasDistribution: true,
+      contentSize: 0,
+      encodingFormat: 'json',
+      label: 'metadata.json',
+    };
+    expect(actualSerializedItems[0].distribution).toEqual(
+      expectedDistributionValueForParent
+    );
+    expect(actualSerializedItems[0].localStorageType).toEqual('resource');
+
+    const expectedDistributionValueForChild = {
       hasDistribution: true,
       contentSize: 15135,
       encodingFormat: 'text/turtle',
       label: 'molecular-systems.ttl',
     };
-    expect(actualSerializedItems[0].distribution).toEqual(
-      expectedDistributionValue
+    expect(actualSerializedItems[1].distribution).toEqual(
+      expectedDistributionValueForChild
     );
-    expect(actualSerializedItems[0]._self).toEqual(resource._self);
-    expect(actualSerializedItems[0].key).toEqual(resource._self);
-    expect(actualSerializedItems[0].project).toEqual(resource._project);
+    expect(actualSerializedItems[1]._self).toEqual(resource._self);
+    expect(actualSerializedItems[1].key).toEqual(resource._self);
+    expect(actualSerializedItems[1].project).toEqual(resource._project);
+    expect(actualSerializedItems[1].localStorageType).toEqual('distribution');
   });
 
   it('serializes resources with distribution object when content size is number', () => {
@@ -94,10 +137,10 @@ describe('ToLocalStorageResources', () => {
     };
     const actualSerializedItems = toLocalStorageResources(resource, 'studios');
 
-    expect(actualSerializedItems[0].distribution?.contentSize).toEqual(123);
+    expect(actualSerializedItems[1].distribution?.contentSize).toEqual(123);
   });
 
-  it('serializes resources with distribution object when content size is array', () => {
+  it('sums up content size for distribution item when it is an array', () => {
     const resource = {
       ...resourceWithDistributionObject,
       distribution: {
@@ -107,7 +150,7 @@ describe('ToLocalStorageResources', () => {
     };
     const actualSerializedItems = toLocalStorageResources(resource, 'studios');
 
-    expect(actualSerializedItems[0].distribution?.contentSize).toEqual(30);
+    expect(actualSerializedItems[1].distribution?.contentSize).toEqual(30);
   });
 
   it('serializes resources when distribution is empty array', () => {
@@ -118,8 +161,8 @@ describe('ToLocalStorageResources', () => {
     const expectedDistributionValue = {
       hasDistribution: true,
       contentSize: 0,
-      encodingFormat: '',
-      label: '',
+      encodingFormat: 'json',
+      label: 'metadata.json',
     };
 
     expect(actualSerializedItems[0].distribution).toEqual(
@@ -131,7 +174,7 @@ describe('ToLocalStorageResources', () => {
     const resource = { ...resourceWithoutDistrition, distribution: {} };
     const actualSerializedItems = toLocalStorageResources(resource, 'studios');
 
-    expect(actualSerializedItems.length).toEqual(1);
+    expect(actualSerializedItems.length).toEqual(2);
     expect(actualSerializedItems[0].distribution).toBeDefined();
   });
 });
diff --git a/src/shared/utils/datapanel.ts b/src/shared/utils/datapanel.ts
