Merge pull request #1649 from ral-facilities/add-description-to-system-types-#1540

Add description to system types #1540

Author: lottieo

cypress/e2e/with_api/systemTypes/systemTypes.cy.ts

@@ -13,15 +13,15 @@ describe('System Types', () => {
     cy.findByText('Operational').should('exist');
     cy.findByText('Scrapped').should('exist');
 
-    // Check that spares defintion button filters the table
+    // Check that spares definition button filters the table
     cy.findByRole('button', { name: 'Show Spares Definition' }).click();
 
     cy.findByText('Operational').should('not.exist');
     cy.findByText('Scrapped').should('not.exist');
     cy.findByText('Storage').should('exist');
     cy.findByText('Spares Definition Filter Applied').should('exist');
 
-    // filters by spares defintion from the settings page
+    // filters by spares definition from the settings page
 
     cy.findByRole('button', { name: 'navigate to settings home' }).click();
     cy.findByText('Spares Definition').click();

cypress/e2e/with_mock_data/systemTypes.cy.ts

@@ -9,6 +9,8 @@ describe('System Types', () => {
   it('should render table correctly', () => {
     cy.findByText('Value').should('be.visible');
     cy.findByText('Storage').should('be.visible');
+    cy.findByText('Description').should('be.visible');
+    cy.findByText('Storage system type').should('be.visible');
   });
 
   it('sets and clears the table filters', () => {

cypress/e2e/with_mock_data/systems.cy.ts

@@ -928,7 +928,7 @@ describe('Systems', () => {
           created_time: '2024-01-01T12:00:00.000+00:00',
           modified_time: '2024-01-02T13:10:10.000+00:00',
           type_id: '2',
-          type: { id: '2', value: 'Operational' },
+          type: { id: '2', value: 'Operational', description: 'Operational system type' },
         })
       );
       expect(JSON.stringify(await postRequests[1].json())).equal(
@@ -944,7 +944,7 @@ describe('Systems', () => {
           created_time: '2024-01-01T12:00:00.000+00:00',
           modified_time: '2024-01-02T13:10:10.000+00:00',
           type_id: '2',
-          type: { id: '2', value: 'Operational' },
+          type: { id: '2', value: 'Operational', description: 'Operational system type' },
         })
       );
     });

src/api/api.types.tsx

@@ -108,6 +108,7 @@ export interface System extends CreatedModifiedMixin, Required<SystemPost> {
 export interface SystemType {
   id: string;
   value: string;
+  description: string;
 }
 
 // ------------------------------------ CATALOGUE CATEGORIES ------------------------------------

src/apiConfigProvider.component.test.tsx

@@ -58,7 +58,11 @@ describe('APIConfigProvider', () => {
             ],
           },
           isLoading: false,
-          sparesDefinition: { system_types: [{ id: '1', value: 'Storage' }] },
+          sparesDefinition: {
+            system_types: [
+              { id: '1', value: 'Storage', description: 'Storage system type' },
+            ],
+          },
         },
       })
     );

src/mocks/SystemTypes.json

@@ -1,11 +1,16 @@
 [
   {
     "id": "1",
-    "value": "Storage"
+    "value": "Storage",
+    "description": "Storage system type"
   },
   {
     "id": "2",
-    "value": "Operational"
+    "value": "Operational",
+    "description": "Operational system type"
   },
-  { "id": "3", "value": "Scrapped" }
+  { "id": "3",
+    "value": "Scrapped",
+    "description": "Scrapped system type"
+  }
 ]

src/settings/systemTypes/__snapshots__/systemsTypes.component.test.tsx.snap

@@ -69,6 +69,15 @@ function SystemTypes() {
         columnFilterModeOptions: COLUMN_FILTER_MODE_OPTIONS.string,
         Cell: ({ row }) => row.original.value,
       },
+      {
+        header: 'Description',
+        Header: TableHeaderOverflowTip,
+        accessorFn: (row) => row.description,
+        id: 'description',
+        filterVariant: COLUMN_FILTER_VARIANTS.string,
+        filterFn: COLUMN_FILTER_FUNCTIONS.string,
+        columnFilterModeOptions: COLUMN_FILTER_MODE_OPTIONS.string,
+      },
       {
         header: 'Used For Spares',
         Header: TableHeaderOverflowTip,