fix: ensure fields do not have undefined initial values

[HendrikThePendric]

Implements DHIS2-19266

---

Key features

1. When creating the initial state, ensure the values and initialValues do not contain properties that are undefined

---

Description

The error we were seeing when opening the modal was caused by the fact that a dashboard did not have a code. So the initialValues object provided to createInitialState was not undefined itself, but one of its properties did have a value of undefined. The validation logic was assuming each property would default to the value defined in the defaultInitialValues object, but this was the case.

In this fix I chose to implement a generic fix that scans all initialValues properties and if an undefined value is encountered, it falls back to the default. IMO this preferable over making the validation logic more flexible, or implementing a fix specific to the code field.

---

[dhis2-bot]

🚀 Deployed on https://pr-3246.dashboard.netlify.dhis2.org

[jenniferarnesen]

So, I'm a follower of the idea of only testing the intended public interface of a module (hook in this case) rather than testing implementation details (e.g. isValidUuid, createInitialState). This keeps code cleaner and prevents unintended uses of those "internal" functions. It also makes it easier to identify when a constant or function is not in use and to refactor the implementation. As far as testing goes, in the case of the current tests, it is really easy to do these tests just by testing the hook:

      it('creates the expected initial state when some properties are undefined', () => {
            const initialValues = {
                title: undefined,
                code: undefined,
                description: undefined,
                supersetEmbedId: undefined,
                showChartControls: undefined,
                expandFilters: undefined,
            }
            const { result } = renderHook(() =>
                useSupersetDashboardFieldsState(initialValues)
            )

            expect(result.current.values).toEqual(defaultInitialValues)
            expect(result.current.isSupersetEmbedIdValid).toBe(false)
            expect(result.current.isCodeValid).toBe(true)
            expect(result.current.shouldShowSupersetEmbedIdError).toBe(false)
            expect(result.current.hasFieldChanges).toBe(false)
      })

[HendrikThePendric]

So, I'm a follower of the idea of only testing the intended public interface of a module (hook in this case) rather than testing implementation details (e.g. isValidUuid, createInitialState). This keeps code cleaner and prevents unintended uses of those "internal" functions. It also makes it easier to identify when a constant or function is not in use and to refactor the implementation.

This is interesting. Up until now I have mostly given preference to testing the smallest unit in isolation when writing unit tests. And while I do think that in general this is a sensible notion, and that this will actually result in the cleanest code, I do see your other points and will start writing unit tests against the intended public interface in the future. My current approach does involve exporting these internals and I have seen the problems you mention happen in practice.

I'll proceed to update the entire spec file.

[jenniferarnesen]

Can you add the "Untitled dashboard" placeholder to the title, since that's what it gets set to if the user doesn't type anything. This is also in line with regular dashboard creation.

[HendrikThePendric]

Can you add the "Untitled dashboard" placeholder to the title, since that's what it gets set to if the user doesn't type anything. This is also in line with regular dashboard creation.

OK, done 0109115

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[dhis2-bot]

🎉 This PR is included in version 101.1.4 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀