CSCFAIRMETA-1076 refactor and clean up (#861)

* - translationsRoot moved to mobx stores - cleaned up some excessive Stores passing between components (FieldList, FieldListAdd, ModalContent, etc.) - '@' alias added to webpack so that paths now can be written "@/stores" - @ refers to ./js * retry for pr * fix for imports of locations tests * regression test fix * locations rename fix updated ipdb to 0.13.9 * existing Locations in provenance missing translations fixed. * cleanup Co-authored-by: Jori Niemi <3295718+tahme@users.noreply.github.com>
CSCfi · Sep 21, 2021 · 0cc7cb3 · 0cc7cb3
1 parent 2c687fe
commit 0cc7cb3
Show file tree

Hide file tree

Showing 42 changed files with 258 additions and 308 deletions.
diff --git a/etsin_finder/frontend/__tests__/combined/qvain/qvain.regression.test.jsx b/etsin_finder/frontend/__tests__/combined/qvain/qvain.regression.test.jsx
@@ -20,7 +20,7 @@ describe('Given modified provenance with added used entity', () => {
     mockStores.Qvain.Provenances.clearInEdit()
   })
 
-  test('Provenance should not have Used enitities', () => {
+  test('Provenance should not have Used entities', () => {
     mockStores.Qvain.Provenances.storage.length.should.eql(1)
     mockStores.Qvain.Provenances.storage[0].uiid.should.eql(uiid)
     mockStores.Qvain.Provenances.storage[0].usedEntities.storage.length.should.eql(0)
@@ -39,14 +39,14 @@ describe('Given modified provenance with added location', () => {
     mockStores.Qvain.Provenances.clearInEdit()
     // then edit the provenance to add a new location
     mockStores.Qvain.Provenances.edit(uiid)
-    mockStores.Qvain.Provenances.inEdit.spatials.create()
+    mockStores.Qvain.Provenances.inEdit.locations.create()
     // cancel provennace
     mockStores.Qvain.Provenances.clearInEdit()
   })
 
   test('Provenance should not have Locations', () => {
     mockStores.Qvain.Provenances.storage.length.should.eql(1)
     mockStores.Qvain.Provenances.storage[0].uiid.should.eql(uiid)
-    mockStores.Qvain.Provenances.storage[0].spatials.storage.length.should.eql(0)
+    mockStores.Qvain.Provenances.storage[0].locations.storage.length.should.eql(0)
   })
 })
diff --git a/etsin_finder/frontend/__tests__/components/general/qvain.input.test.jsx b/etsin_finder/frontend/__tests__/components/general/qvain.input.test.jsx
@@ -18,18 +18,18 @@ let Field = {
     startDate: '1.1.2000',
     endDate: '2.2.2020',
   },
+  translationsRoot: 'translationsRoot',
   changeAttribute: jest.fn(),
 }
 
-let translationsRoot = 'translationsRoot'
 let datum = 'datum'
 let id = 'id'
 
 const expectedLabelContent = 'translationsRoot.modal.datumInput.label'
 
 describe('DurationPicker', () => {
   let wrapper
-  let props = { Field, translationsRoot, datum, id }
+  let props = { Field, datum, id }
   const Stores = {
     Qvain: {
       readonly: false,

diff --git a/etsin_finder/frontend/__tests__/components/general/qvain.modalContent.test.jsx b/etsin_finder/frontend/__tests__/components/general/qvain.modalContent.test.jsx
@@ -1,23 +1,35 @@
 import React from 'react'
 import { shallow } from 'enzyme'
 import 'chai/register-expect'
+import { useStores } from '@/stores/stores'
 
-import ModalContent from '../../../js/components/qvain/general/modal/modalContent'
+import ModalContent from '@/components/qvain/general/modal/modalContent'
 import ModalButtons from '../../../js/components/qvain/general/modal/modalButtons'
 import { ConfirmClose } from '../../../js/components/qvain/general/modal/confirmClose'
 
+jest.mock('@/stores/stores', () => {
+  return {
+    useStores: jest.fn(),
+  }
+})
 describe('ModalContent', () => {
   let wrapper
 
+  const mockStores = {
+    Qvain: {
+      readonly: false,
+    },
+  }
+
   const Form = () => <div id="form" />
 
   const props = {
-    Store: { readonly: false },
-    Field: {},
+    Field: {
+      translationsRoot: 'translationsRoot',
+    },
     Form,
     formProps: { someProp: 'someProp' },
     handleSave: jest.fn(),
-    translationsRoot: 'translationsRoot',
     language: 'language',
     onConfirmCancel: jest.fn(),
     onConfirm: jest.fn(),
@@ -37,6 +49,7 @@ describe('ModalContent', () => {
   })
 
   const render = extraProps => {
+    useStores.mockReturnValue(mockStores)
     const parsedProps = { ...props, ...extraProps }
     wrapper = shallow(<ModalContent {...parsedProps} />)
   }
@@ -88,10 +101,7 @@ describe('ModalContent', () => {
 
       test('should have expectedProps', () => {
         const expectedProps = {
-          Store: props.Store,
           Field,
-          translationsRoot: props.translationsRoot,
-          language: props.language,
           someProp: props.formProps.someProp,
         }
 

diff --git a/etsin_finder/frontend/__tests__/components/general/qvain.modalInput.test.jsx b/etsin_finder/frontend/__tests__/components/general/qvain.modalInput.test.jsx
@@ -11,7 +11,7 @@ import { Label } from '../../../js/components/qvain/general/modal/form'
 describe('ModalInput', () => {
   let wrapper
 
-  const Field = { changeAttribute: jest.fn(), inEdit: {} }
+  const Field = { changeAttribute: jest.fn(), inEdit: {}, translationsRoot: 'translationsRoot' }
 
   const props = {
     Field,

diff --git a/etsin_finder/frontend/__tests__/components/general/qvain.modalReferenceInput.test.jsx b/etsin_finder/frontend/__tests__/components/general/qvain.modalReferenceInput.test.jsx
@@ -12,11 +12,11 @@ const Field = {
   inEdit: {
     datum: {},
   },
+  translationsRoot: 'translationsRoot',
 }
 
 const props = {
   Field,
-  translationsRoot: 'translationsRoot',
   datum: 'datum',
   model: jest.fn(),
   metaxIdentifier: 'metaxIdentifier',
@@ -26,8 +26,8 @@ describe('ModalRefenceInput', function () {
   let wrapper
 
   const getTranslations = props => ({
-    label: `${props.translationsRoot}.modal.${props.datum}Input.label`,
-    placeholder: `${props.translationsRoot}.modal.${props.datum}Input.placeholder`,
+    label: `${Field.translationsRoot}.modal.${props.datum}Input.label`,
+    placeholder: `${Field.translationsRoot}.modal.${props.datum}Input.placeholder`,
   })
 
   const render = extraProps => {

diff --git a/etsin_finder/frontend/__tests__/components/general/qvain.translationTabInputModal.test.jsx b/etsin_finder/frontend/__tests__/components/general/qvain.translationTabInputModal.test.jsx
@@ -25,11 +25,11 @@ describe('TranslationsTabInputModal', () => {
       Stores = buildStores()
       Field = new FieldClass(Stores.Qvain, template, model)
       Field.create()
+      Field.translationsRoot = 'translationsRoot'
 
       props = {
         Field,
         datum: 'datum',
-        translationsRoot: 'translationsRoot',
         language: 'en',
         handleBlur: jest.fn(),
       }

diff --git a/etsin_finder/frontend/__tests__/components/qvain/qvain.provenance.test.jsx b/etsin_finder/frontend/__tests__/components/qvain/qvain.provenance.test.jsx
@@ -60,6 +60,8 @@ describe('Provenance', () => {
         schema: {
           validate: jest.fn(),
         },
+        translationsRoot: 'provenance translationsRoot',
+        associationsTranslationsRoot: 'qvain.history.provenance.modal.actorsInput',
       },
     },
     Locale: {
@@ -105,12 +107,10 @@ describe('Provenance', () => {
         FieldList: {
           Field: mockStores.Qvain.Provenances,
           lang: 'en',
-          translationsRoot: 'qvain.history.provenance',
         },
         FieldListAdd: {
           Store: mockStores.Qvain,
           Field: mockStores.Qvain.Provenances,
-          translationsRoot: 'qvain.history.provenance',
           Form,
         },
       }
@@ -185,11 +185,13 @@ describe('given required props and mockStores', () => {
           outcomeDescription: {
             fi: 'fi-outcome',
           },
-          spatials: {
+          locations: {
             storage: [],
+            translationsRoot: 'locations translationsRoot',
           },
           usedEntities: {
             storage: [],
+            translationsRoot: 'usedEntities translationsRoot',
           },
           associations: {
             actorOptions: [],
@@ -209,9 +211,7 @@ describe('given required props and mockStores', () => {
   }
 
   const props = {
-    Store: mockStores.Qvain,
     Field: mockStores.Qvain.Provenances,
-    translationsRoot: 'translationsRoot',
   }
 
   const harness = new Harness(Form, props)
@@ -316,26 +316,20 @@ describe('given required props and mockStores', () => {
         { label: 'LocationFieldListAdd', findArgs: FieldListAdd },
       ]
 
-      const translationsRoot = 'qvain.history.provenance.modal.locationInput'
+      const translationsRoot = 'locations translationsRoot'
 
       const props = {
         LocationLabel: {
           content: `${translationsRoot}.label`,
           htmlFor: 'location-input',
         },
         LocationFieldList: {
-          Store: mockStores.Qvain.Provenances,
-          Field: mockStores.Qvain.Provenances.inEdit.spatials,
-          fieldIdentifier: 'spatials',
-          lang: 'en',
-          translationsRoot,
+          Field: mockStores.Qvain.Provenances.inEdit.locations,
           disableNoItemsText: true,
         },
         LocationFieldListAdd: {
-          Store: mockStores.Qvain.Provenances,
-          Field: mockStores.Qvain.Provenances.inEdit.spatials,
+          Field: mockStores.Qvain.Provenances.inEdit.locations,
           Form: SpatialsForm,
-          translationsRoot,
           position: 'left',
           hideButton: false,
         },
@@ -345,7 +339,7 @@ describe('given required props and mockStores', () => {
     })
   })
 
-  describe('LocationInput', () => {
+  describe('UsedEntityInput', () => {
     beforeEach(() => {
       harness.restoreWrapper('UsedEntityInput')
       harness.dive()
@@ -358,26 +352,20 @@ describe('given required props and mockStores', () => {
         { label: 'UsedEntityFieldListAdd', findArgs: FieldListAdd },
       ]
 
-      const translationsRoot = 'qvain.history.provenance.modal.usedEntityInput'
+      const translationsRoot = 'usedEntities translationsRoot'
 
       const props = {
         UsedEntityLabel: {
           content: `${translationsRoot}.label`,
           htmlFor: 'used-entity-input',
         },
         UsedEntityFieldList: {
-          Store: mockStores.Qvain.Provenances,
           Field: mockStores.Qvain.Provenances.inEdit.usedEntities,
-          fieldIdentifier: 'usedEntities',
-          lang: 'en',
-          translationsRoot: translationsRoot,
           disableNoItemsText: true,
         },
         LocationFieldListAdd: {
-          Store: mockStores.Qvain.Provenances,
           Field: mockStores.Qvain.Provenances.inEdit.usedEntities,
           Form: UsedEntitiesForm,
-          translationsRoot: translationsRoot,
           formProps: { hideRelationType: true },
           position: 'left',
           hideButton: false,
@@ -403,13 +391,11 @@ describe('given required props and mockStores', () => {
         { label: 'ActorsSelect', findType: 'prop', findArgs: ['component', ReactSelect] },
       ]
 
-      const { inEdit } = mockStores.Qvain.Provenances
-
-      const translationsRoot = 'qvain.history.provenance.modal.actorsInput'
+      const { inEdit, associationsTranslationsRoot } = mockStores.Qvain.Provenances
 
       const expectedProps = {
         ActorsLabel: {
-          content: `${translationsRoot}.label`,
+          content: `${associationsTranslationsRoot}.label`,
           htmlFor: 'actors-input',
         },
         ActorsList: {
@@ -419,7 +405,7 @@ describe('given required props and mockStores', () => {
         },
         ActorsSelect: {
           inputId: 'actors-select',
-          attributes: { placeholder: `${translationsRoot}.placeholder` },
+          attributes: { placeholder: `${associationsTranslationsRoot}.placeholder` },
           options: [
             {
               label: createButtonTranslation,

diff --git a/etsin_finder/frontend/__tests__/components/qvain/qvain.relatedResource.test.jsx b/etsin_finder/frontend/__tests__/components/qvain/qvain.relatedResource.test.jsx
@@ -117,12 +117,8 @@ describe('given mockStores', () => {
         const props = {
           FieldList: {
             Field: mockStores.Qvain.RelatedResources,
-            lang: 'en',
-            translationsRoot: mockStores.Qvain.RelatedResources.translationsRoot,
           },
           FieldListAdd: {
-            translationsRoot: mockStores.Qvain.RelatedResources.translationsRoot,
-            Store: mockStores.Qvain,
             Field: mockStores.Qvain.RelatedResources,
             Form,
             handleSave,

diff --git a/...tests__/components/qvain/spatial.test.jsx → ..._/components/qvain/qvain.spatial.test.jsx b/...tests__/components/qvain/spatial.test.jsx → ..._/components/qvain/qvain.spatial.test.jsx
@@ -49,13 +49,14 @@ describe('given mockStore in useStores', () => {
   const harness = new Harness(SpatialFieldContent)
   const mockStores = {
     Qvain: {
-      Spatials: {},
+      Spatials: {
+        translationsRoot: 'translationsRoot',
+      },
     },
     Locale: {
       lang: 'en',
     },
   }
-  const translationsRoot = 'qvain.temporalAndSpatial.spatial'
 
   describe('SpatialFieldContent', () => {
     beforeEach(() => {
@@ -76,12 +77,9 @@ describe('given mockStore in useStores', () => {
       const props = {
         FieldList: {
           Field: mockStores.Qvain.Spatials,
-          lang: mockStores.Locale.lang,
-          translationsRoot,
           disableNoItemsText: false,
         },
         FieldListAdd: {
-          Store: mockStores.Qvain,
           Field: mockStores.Qvain.Spatials,
           Form: Form,
         },
@@ -96,8 +94,8 @@ describe('given mockStore in useStores', () => {
         harness.props.handleSave()
       })
 
-      test('should call handleSave with Qvain.Spatials & translationsRoot', () => {
-        expect(handleSave).to.have.beenCalledWith(mockStores.Qvain.Spatials, translationsRoot)
+      test('should call handleSave with Qvain.Spatials', () => {
+        expect(handleSave).to.have.beenCalledWith(mockStores.Qvain.Spatials)
       })
     })
   })