kobotoolbox / kpi / 36734187808

83%

master: 76%

push

github

feat(frontend): profile details route blocker DEV-1850 (#7615)

### 📣 Summary

Required blank profile details cause a whole UI to be blocked until they
are filled in immediately after log in.

### 💭 Notes

An administrator can mark any of the `USER_METADATA_FIELDS` required.
Until now those were only ever collected at registration, and afterwards
only on instances that also had a Terms of Service announcement
configured.

They now get a "Complete your profile details" screen in the same visual
frame as the sign-in and registration screens.

Final of the four stacked PRs.

Changes here:
- A route blocker in the shape of the two existing ones:
`isProfileDetailsRouteBlockerActive()` in `routerUtils` plus a
component, chosen in `app.jsx` after `InvalidatedPassword` and
`TOSAgreement`. Terms first, details second
- The field collection is *moved* out of `tosForm.component.tsx`, not
duplicated
- No feature flag. Nothing here depends on the auth redesign
(`authRedesignEnabled` only gates the `/auth/*` routes), and since
`TOSForm` no longer collects the fields, flagging this off would leave
nothing collecting them at all
- `getBlankRequiredProfileFieldNames` mirrors
`CurrentUserSerializer.validate_extra_details` on purpose, including
Python truthiness for unticked checkboxes
- Unit tests in `profileDetails.tests.ts`, plus stories covering the MMO
member, the `organization_type: 'none'` skip, and the server rejecting a
save
- `stores/session.ts` gains an unrelated fix: `verifyLoginFailure` never
set `isAuthStateKnown`, so a failed `/me/` left `AllRoutes` spinning
forever
- `ProfileDetailsForm.tsx:120` has a cast and a TODO: Open API types are
incorrect DEV-2903

### 👀 Preview steps

1. ℹ️ in Django admin, mark a few `USER_METADATA_FIELDS` required -
include `gender` and `newsletter_subscription`
2. ℹ️ clear those fields on your account, then reload the app
3. 🟢 notice the "Complete your profile details" scree - every configured
profile field with your current ... (continued)

10449 of 13809 branches covered (75.67%)

33338 of 40126 relevant lines covered (83.08%)

5.51 hits per line