fix: remove request NONE id schemes [DHIS2-18013]

src/components/edit/exchange-update/__tests__/getExchangeValues.test.js

@@ -0,0 +1,64 @@
+import { cleanUpRequests } from '../getExchangeValues.js'
+
+describe('cleanUpRequests', () => {
+    it('removes irrelevant properties', () => {
+        const originalRequests = [
+            {
+                name: 'a name',
+                visualization: 'a visualization',
+                dx: [],
+                pe: [],
+                ou: [],
+                filters: [],
+                inputIdScheme: 'UID',
+                outputDataElementIdScheme: 'UID',
+                outputOrgUnitIdScheme: 'UID',
+                outputIdScheme: 'UID',
+                outputDataItemIdScheme: 'UID',
+                dhis2: [],
+                team: 'platform',
+            },
+        ]
+        const expectedRequests = [
+            {
+                name: 'a name',
+                visualization: 'a visualization',
+                dx: [],
+                pe: [],
+                ou: [],
+                filters: [],
+                inputIdScheme: 'UID',
+                outputDataElementIdScheme: 'UID',
+                outputOrgUnitIdScheme: 'UID',
+                outputIdScheme: 'UID',
+                outputDataItemIdScheme: 'UID',
+            },
+        ]
+        expect(cleanUpRequests({ requests: originalRequests })).toEqual(
+            expectedRequests
+        )
+    })
+
+    it('only returns properties that are not null or undefined on the original', () => {
+        const originalRequests = [{ dx: [], pe: undefined }]
+        const expectedRequests = [{ dx: [] }]
+        expect(cleanUpRequests({ requests: originalRequests })).toEqual(
+            expectedRequests
+        )
+    })
+
+    it('removes ID schemes of value NONE (outputDataElementIdScheme, outputOrgUnitIdScheme, outputDataItemIdScheme)', () => {
+        const originalRequests = [
+            {
+                dx: [],
+                outputDataElementIdScheme: 'NONE',
+                outputOrgUnitIdScheme: 'NONE',
+                outputDataItemIdScheme: 'NONE',
+            },
+        ]
+        const expectedRequests = [{ dx: [] }]
+        expect(cleanUpRequests({ requests: originalRequests })).toEqual(
+            expectedRequests
+        )
+    })
+})

src/components/edit/exchange-update/getExchangeValues.js

@@ -4,15 +4,38 @@ import {
     AUTHENTICATION_TYPES,
 } from '../shared/index.js'
 
-const removeRequestIDSchemeValuesOfNONE = ({ requests }) => {
+// this filters out additional properties that are used by the app UI, but should not be sent to backend
+const validProperties = [
+    'name',
+    'visualization',
+    'dx',
+    'pe',
+    'ou',
+    'filters',
+    'inputIdScheme',
+    'outputDataElementIdScheme',
+    'outputOrgUnitIdScheme',
+    'outputIdScheme',
+    'outputDataItemIdScheme',
+]
+const copyRequestWithValidProperties = (request) =>
+    validProperties.reduce((requestCopy, prop) => {
+        if (request[prop]) {
+            requestCopy[prop] = request[prop]
+        }
+        return requestCopy
+    }, {})
+
+export const cleanUpRequests = ({ requests }) => {
     const idSchemeProps = [
-        'idScheme',
-        'dataElementIdScheme',
-        'orgUnitIdScheme',
-        'categoryOptionComboIdScheme',
+        'outputDataElementIdScheme',
+        'outputDataItemIdScheme',
+        'outputOrgUnitIdScheme',
     ]
     return requests.map((request) => {
-        const requestCopy = { ...request }
+        const requestCopy = copyRequestWithValidProperties(request)
+
+        // delete any ID Scheme prop with value of NONE
         for (const prop of idSchemeProps) {
             if (requestCopy[prop] === SCHEME_TYPES.none) {
                 delete requestCopy[prop]
@@ -78,7 +101,7 @@ const getTargetDetails = ({ values }) => {
 export const getExchangeValuesFromForm = ({ values, requests }) => ({
     name: values.name,
     target: getTargetDetails({ values }),
-    source: { requests: removeRequestIDSchemeValuesOfNONE({ requests }) },
+    source: { requests: cleanUpRequests({ requests }) },
 })
 
 const getIdSchemeValues = ({ exchangeInfo }) => {

src/pages/addItem.test.js

@@ -32,20 +32,24 @@ jest.mock('@dhis2/analytics', () => ({
     DataDimension: ({ onSelect }) => (
         <input
             data-test="fake-data-selector"
-            onInput={(e) => onSelect({ items: [e.target.value] })}
+            onInput={(e) =>
+                onSelect({ items: [{ id: 'anIdDe', name: e.target.value }] })
+            }
         />
     ),
     PeriodDimension: ({ onSelect }) => (
         <input
             data-test="fake-period-selector"
-            onInput={(e) => onSelect({ items: [e.target.value] })}
+            onInput={(e) =>
+                onSelect({ items: [{ id: 'anIdPe', name: e.target.value }] })
+            }
         />
     ),
     OrgUnitDimension: ({ onSelect }) => (
         <input
             data-test="fake-orgunit-selector"
             onInput={(e) =>
-                onSelect({ items: [{ id: 'anId', name: e.target.value }] })
+                onSelect({ items: [{ id: 'anIdOu', name: e.target.value }] })
             }
         />
     ),
@@ -66,6 +70,8 @@ jest.mock('@dhis2/app-runtime', () => ({
     }),
 }))
 
+const createExchangeMock = jest.fn()
+
 const setUp = (
     ui,
     {
@@ -75,8 +81,9 @@ const setUp = (
 ) => {
     const customerProviderData = {
         attributes: { attributes },
-        aggregateDataExchanges: (type) => {
+        aggregateDataExchanges: (type, query) => {
             if (type === 'create') {
+                createExchangeMock(query?.data)
                 return {}
             }
             return undefined
@@ -213,6 +220,32 @@ describe('<AddItem/>', () => {
                 screen.getByTestId('saving-exchange-loader')
             ).toBeInTheDocument()
         )
+
+        const expectedPayload = {
+            name: 'an exchange name',
+            source: {
+                requests: [
+                    {
+                        dx: ['anIdDe'],
+                        filters: [],
+                        inputIdScheme: 'UID',
+                        name: 'a request name',
+                        ou: ['anIdOu'],
+                        outputIdScheme: 'UID',
+                        pe: ['anIdPe'],
+                    },
+                ],
+            },
+            target: {
+                request: {
+                    idScheme: 'UID',
+                },
+                type: 'INTERNAL',
+            },
+        }
+
+        expect(createExchangeMock).toHaveBeenCalled()
+        expect(createExchangeMock).toHaveBeenCalledWith(expectedPayload)
     })
 
     it('does not create an internal exchange if the name is missing', async () => {
@@ -855,4 +888,25 @@ describe('<AddItem/>', () => {
             expect(warningModal).not.toBeInTheDocument()
         })
     })
+
+    it('warns about unsaved changes if user clicks cancel after making changes in the request form', async () => {
+        const { screen } = setUp(<AddItem />, {
+            userContext: testUserContext({ canAddExchange: true }),
+        })
+
+        expect(
+            await screen.findByTestId('add-exchange-title')
+        ).toHaveTextContent('Add exchange')
+
+        screen.getByText('Add request').click()
+        const requestNameInput = await screen.findByLabelText('Request name')
+        fireEvent.input(requestNameInput, { target: { value: 'a request' } })
+
+        const footer = screen.getByTestId('edit-request-footer')
+        within(footer).getByText('Cancel').click()
+
+        const warningModal = await screen.findByTestId('request-discard-modal')
+        expect(warningModal).toBeVisible()
+        expect(warningModal).toHaveTextContent('Discard unsaved changes')
+    })
 })