Merge branch 'develop' into add-addtional-fields-to-catalogue-items-#107

* develop: requested changes fixed unit tests reverted changes that didn't work removed unneeded useState changed to camelcase function name requested interface changes #117 country field moved in dialog #117 requested changes fix tests #117 changed address view #117 requested changes #117 simplified edit #73 changed types to be | null #68 change errors to use less states #123 fixed unit tests #117 made address field changes and updated tests accordingly #117
ral-facilities · Nov 17, 2023 · 006d0a9 · 006d0a9
2 parents af6874a + be26ff7
commit 006d0a9
Show file tree

Hide file tree

Showing 11 changed files with 438 additions and 465 deletions.
diff --git a/cypress/e2e/manufacturer/manufacturer.cy.ts b/cypress/e2e/manufacturer/manufacturer.cy.ts
@@ -24,15 +24,9 @@ describe('Manufacturer', () => {
     cy.findByText('http://example.com').should('be.visible');
     cy.findByText('http://test.com').should('be.visible');
     cy.findByText('http://test.co.uk').should('be.visible');
-    cy.findByText('1 Example Street Oxford Oxfordshire OX1 2AB').should(
-      'be.visible'
-    );
-    cy.findByText('2 Example Street Oxford Oxfordshire OX1 2AB').should(
-      'be.visible'
-    );
-    cy.findByText('3 Example Street Oxford Oxfordshire OX1 2AB').should(
-      'be.visible'
-    );
+    cy.findByText('07334893348').should('be.visible');
+    cy.findByText('07294958549').should('be.visible');
+    cy.findByText('07934303412').should('be.visible');
   });
 
   it('manufacturer url is correct and opens new webpage', () => {
@@ -52,8 +46,8 @@ describe('Manufacturer', () => {
     cy.findByRole('button', { name: 'Add Manufacturer' }).click();
     cy.findByLabelText('Name *').type('Manufacturer D');
     cy.findByLabelText('URL').type('http://test.co.uk');
-    cy.findByLabelText('Building number *').type('1');
-    cy.findByLabelText('Street name *').type('Example Street');
+    cy.findByLabelText('Country *').type('United Kingdom');
+    cy.findByLabelText('Address Line *').type('4 Example Street');
     cy.findByLabelText('Town').type('Oxford');
     cy.findByLabelText('County').type('Oxfordshire');
     cy.findByLabelText('Post/Zip code *').type('OX1 2AB');
@@ -70,16 +64,16 @@ describe('Manufacturer', () => {
       expect(patchRequests.length).equal(1);
       const request = patchRequests[0];
       expect(JSON.stringify(request.body)).equal(
-        '{"name":"Manufacturer D","url":"http://test.co.uk","address":{"building_number":"1","street_name":"Example Street","town":"Oxford","county":"Oxfordshire","postcode":"OX1 2AB"},"telephone":"07349612203"}'
+        '{"name":"Manufacturer D","url":"http://test.co.uk","address":{"address_line":"4 Example Street","town":"Oxford","county":"Oxfordshire","postcode":"OX1 2AB","country":"United Kingdom"},"telephone":"07349612203"}'
       );
     });
   });
 
   it('adds a manufacturer with only mandatory fields', () => {
     cy.findByRole('button', { name: 'Add Manufacturer' }).click();
     cy.findByLabelText('Name *').type('Manufacturer D');
-    cy.findByLabelText('Building number *').type('1');
-    cy.findByLabelText('Street name *').type('Example Street');
+    cy.findByLabelText('Country *').type('United Kingdom');
+    cy.findByLabelText('Address Line *').type('4 Example Street');
     cy.findByLabelText('Post/Zip code *').type('OX1 2AB');
 
     cy.startSnoopingBrowserMockedRequest();
@@ -93,7 +87,7 @@ describe('Manufacturer', () => {
       expect(patchRequests.length).equal(1);
       const request = patchRequests[0];
       expect(JSON.stringify(request.body)).equal(
-        '{"name":"Manufacturer D","address":{"building_number":"1","street_name":"Example Street","town":"","county":"","postcode":"OX1 2AB"},"telephone":""}'
+        '{"name":"Manufacturer D","address":{"address_line":"4 Example Street","town":null,"county":null,"postcode":"OX1 2AB","country":"United Kingdom"},"telephone":null}'
       );
     });
 
@@ -108,12 +102,12 @@ describe('Manufacturer', () => {
       cy.findByRole('dialog')
         .should('be.visible')
         .within(() => {
-          cy.contains('Please enter a building number.');
+          cy.contains('Please enter a country.');
         });
       cy.findByRole('dialog')
         .should('be.visible')
         .within(() => {
-          cy.contains('Please enter a street name.');
+          cy.contains('Please enter an address.');
         });
       cy.findByRole('dialog')
         .should('be.visible')
@@ -122,11 +116,10 @@ describe('Manufacturer', () => {
         });
     });
     it('displays error message when duplicate name entered', () => {
-      cy.findByTestId('Add Manufacturer').click();
+      cy.findByRole('button', { name: 'Add Manufacturer' }).click();
       cy.findByLabelText('Name *').type('Manufacturer A');
-      cy.findByLabelText('Building number *').type('1');
-      cy.findByLabelText('Street name *').type('Example Street');
-      cy.findByLabelText('Post/Zip code *').type('OX1 2AB');
+      cy.findByLabelText('Country *').type('United Kingdom');
+      cy.findByLabelText('Address Line *').type('4 Example Street');
 
       cy.findByRole('button', { name: 'Save' }).click();
       cy.findByRole('dialog')
@@ -184,23 +177,23 @@ describe('Manufacturer', () => {
     cy.findByRole('button', {
       name: 'Edit Manufacturer A manufacturer',
     }).click();
-    cy.findByLabelText('Name').clear();
-    cy.findByLabelText('Name').type('test');
+    cy.findByLabelText('Name *').clear();
+    cy.findByLabelText('Name *').type('test');
 
-    cy.findByLabelText('Building number').clear();
-    cy.findByLabelText('Building number').type('100');
+    cy.findByLabelText('Country *').clear();
+    cy.findByLabelText('Country *').type('test');
 
-    cy.findByLabelText('Street name').clear();
-    cy.findByLabelText('Street name').type('test');
+    cy.findByLabelText('Address Line *').clear();
+    cy.findByLabelText('Address Line *').type('test');
 
     cy.findByLabelText('Town').clear();
     cy.findByLabelText('Town').type('test');
 
     cy.findByLabelText('County').clear();
     cy.findByLabelText('County').type('test');
 
-    cy.findByLabelText('Post/Zip code').clear();
-    cy.findByLabelText('Post/Zip code').type('test');
+    cy.findByLabelText('Post/Zip code *').clear();
+    cy.findByLabelText('Post/Zip code *').type('test');
 
     cy.findByLabelText('Telephone number').clear();
     cy.findByLabelText('Telephone number').type('0000000000');
@@ -216,7 +209,7 @@ describe('Manufacturer', () => {
       expect(patchRequests.length).equal(1);
       const request = patchRequests[0];
       expect(JSON.stringify(request.body)).equal(
-        '{"name":"test","address":{"building_number":"100","street_name":"test","town":"test","county":"test","postcode":"test"},"telephone":"0000000000"}'
+        '{"name":"test","address":{"address_line":"test","town":"test","county":"test","postcode":"test","country":"test"},"telephone":"0000000000"}'
       );
     });
   });
@@ -226,8 +219,8 @@ describe('Manufacturer', () => {
       name: 'Edit Manufacturer A manufacturer',
     }).click();
 
-    cy.findByLabelText('Name').clear();
-    cy.findByLabelText('Name').type('test_dup');
+    cy.findByLabelText('Name *').clear();
+    cy.findByLabelText('Name *').type('test_dup');
 
     cy.findByRole('button', { name: 'Save' }).click();
 
@@ -278,10 +271,10 @@ describe('Manufacturer', () => {
       name: 'Edit Manufacturer A manufacturer',
     }).click();
 
-    cy.findByLabelText('Name').clear();
-    cy.findByLabelText('Building number').clear();
-    cy.findByLabelText('Street name').clear();
-    cy.findByLabelText('Post/Zip code').clear();
+    cy.findByLabelText('Name *').clear();
+    cy.findByLabelText('Country *').clear();
+    cy.findByLabelText('Address Line *').clear();
+    cy.findByLabelText('Post/Zip code *').clear();
 
     cy.findByRole('button', { name: 'Save' }).click();
     cy.findByRole('dialog')
@@ -292,12 +285,12 @@ describe('Manufacturer', () => {
     cy.findByRole('dialog')
       .should('be.visible')
       .within(() => {
-        cy.contains('Please enter a building number.');
+        cy.contains('Please enter a country.');
       });
     cy.findByRole('dialog')
       .should('be.visible')
       .within(() => {
-        cy.contains('Please enter a street name.');
+        cy.contains('Please enter an address.');
       });
     cy.findByRole('dialog')
       .should('be.visible')

diff --git a/src/api/manufacturer.test.tsx b/src/api/manufacturer.test.tsx
@@ -1,5 +1,5 @@
 import { renderHook, waitFor } from '@testing-library/react';
-import { AddManufacturer, Manufacturer } from '../app.types';
+import { Manufacturer } from '../app.types';
 import { hooksWrapperWithProviders } from '../setupTests';
 import {
   useAddManufacturer,
@@ -13,17 +13,17 @@ describe('manufacturer api functions', () => {
   });
 
   describe('useAddManufacturer', () => {
-    let mockDataAdd: AddManufacturer;
+    let mockDataAdd: Manufacturer;
     beforeEach(() => {
       mockDataAdd = {
         name: 'Manufacturer D',
         url: 'http://test.co.uk',
         address: {
-          building_number: '1',
-          street_name: 'Example',
+          address_line: '4 Example Street',
           town: 'Oxford',
           county: 'Oxfordshire',
           postcode: 'OX1 2AB',
+          country: 'United Kingdom',
         },
         telephone: '07349612203',
       };
@@ -43,11 +43,11 @@ describe('manufacturer api functions', () => {
         code: 'manufacturer-d',
         url: 'http://test.co.uk',
         address: {
-          building_number: '1',
-          street_name: 'Example Street',
+          address_line: '4 Example Street',
           town: 'Oxford',
           county: 'Oxfordshire',
           postcode: 'OX1 2AB',
+          country: 'United Kingdom',
         },
         telephone: '07349612203',
         id: '4',
@@ -63,17 +63,17 @@ describe('manufacturer api functions', () => {
     let mockDataView: Manufacturer;
     beforeEach(() => {
       mockDataView = {
+        id: '1',
         name: 'Manufacturer A',
         url: 'http://example.com',
         address: {
-          building_number: '1',
-          street_name: 'Example',
+          address_line: '1 Example Street',
           town: 'Oxford',
           county: 'Oxfordshire',
           postcode: 'OX1 2AB',
+          country: 'United Kingdom',
         },
         telephone: '07334893348',
-        id: '1',
       };
     });
     it('posts a request to delete a manufacturer and return a successful response', async () => {
@@ -110,11 +110,11 @@ describe('manufacturer api functions', () => {
           code: 'manufacturer-a',
           url: 'http://example.com',
           address: {
-            building_number: '1',
-            street_name: 'Example Street',
+            address_line: '1 Example Street',
             town: 'Oxford',
             county: 'Oxfordshire',
             postcode: 'OX1 2AB',
+            country: 'United Kingdom',
           },
           telephone: '07334893348',
         },
@@ -124,11 +124,11 @@ describe('manufacturer api functions', () => {
           code: 'manufacturer-b',
           url: 'http://test.com',
           address: {
-            building_number: '2',
-            street_name: 'Example Street',
+            address_line: '2 Example Street',
             town: 'Oxford',
             county: 'Oxfordshire',
             postcode: 'OX1 2AB',
+            country: 'United Kingdom',
           },
           telephone: '07294958549',
         },
@@ -138,11 +138,11 @@ describe('manufacturer api functions', () => {
           code: 'manufacturer-c',
           url: 'http://test.co.uk',
           address: {
-            building_number: '3',
-            street_name: 'Example Street',
+            address_line: '3 Example Street',
             town: 'Oxford',
             county: 'Oxfordshire',
             postcode: 'OX1 2AB',
+            country: 'United Kingdom',
           },
           telephone: '07934303412',
         },

diff --git a/src/api/manufacturer.tsx b/src/api/manufacturer.tsx
@@ -8,12 +8,7 @@ import {
 } from '@tanstack/react-query';
 import { settings } from '../settings';
 
-import {
-  AddManufacturer,
-  AddManufacturerResponse,
-  EditManufacturer,
-  Manufacturer,
-} from '../app.types';
+import { AddManufacturer, Manufacturer, EditManufacturer } from '../app.types';
 
 const getAllManufacturers = async (): Promise<Manufacturer[]> => {
   let apiUrl: string;
@@ -47,20 +42,20 @@ export const useManufacturers = (): UseQueryResult<
 
 const addManufacturer = async (
   manufacturer: AddManufacturer
-): Promise<AddManufacturerResponse> => {
+): Promise<Manufacturer> => {
   let apiUrl: string;
   apiUrl = '';
   const settingsResult = await settings;
   if (settingsResult) {
     apiUrl = settingsResult['apiUrl'];
   }
   return axios
-    .post<AddManufacturerResponse>(`${apiUrl}/v1/manufacturers`, manufacturer)
+    .post<Manufacturer>(`${apiUrl}/v1/manufacturers`, manufacturer)
     .then((response) => response.data);
 };
 
 export const useAddManufacturer = (): UseMutationResult<
-  AddManufacturerResponse,
+  Manufacturer,
   AxiosError,
   AddManufacturer
 > => {

diff --git a/src/app.types.tsx b/src/app.types.tsx
@@ -38,36 +38,31 @@ export interface CatalogueCategory {
   is_leaf: boolean;
   catalogue_item_properties?: CatalogueCategoryFormData[];
 }
+
 export interface AddManufacturer {
   name: string;
-  url?: string;
-  address: Address | undefined;
-  telephone?: string;
-}
-
-export interface AddManufacturerResponse {
-  id: string;
-  name: string;
-  url: string;
-  address: Address;
-  telephone: string;
-  code: string;
+  url?: string | null;
+  address: AddAddress;
+  telephone?: string | null;
 }
 
 export interface EditManufacturer {
   name?: string;
-  url?: string;
+  url?: string | null;
   address?: EditAddress;
-  telephone?: string;
-  id?: string;
+  telephone?: string | null;
+  id?: string | null;
 }
 
-export interface Manufacturer {
-  id?: string;
+export interface ManufacturerDetails {
   name: string;
-  url?: string;
-  address: Address;
-  telephone: string;
+  url?: string | null;
+  address: AddAddress;
+  telephone: string | null;
+}
+
+export interface Manufacturer extends ManufacturerDetails {
+  id: string;
 }
 
 export interface CatalogueCategoryFormData {
@@ -143,20 +138,19 @@ export interface ErrorParsing {
   detail: string;
 }
 
-interface Address {
-  building_number: string;
-  street_name: string;
-  town?: string;
-  county?: string;
+interface AddAddress {
+  address_line: string;
+  town?: string | null;
+  county?: string | null;
   postcode: string;
+  country: string;
 }
-
 interface EditAddress {
-  building_number?: string;
-  street_name?: string;
-  town?: string;
-  county?: string;
+  address_line?: string;
+  town?: string | null;
+  county?: string | null;
   postcode?: string;
+  country?: string;
 }
 export interface CatalogueCategoryTransferState {
   name: string;