Files
redefined-designs/frontend/src/customer/AuthRouteModal.tsx
T
bermudalamb 8de261538b
Linting / lint (pull_request) Successful in 2m4s
SonarQube Analysis / sonarqube (pull_request) Failing after 4m51s
refactor(frontend): declare props read-only, and drop the deprecated antd prop (#100)
Seventeen components declared props the compiler was free to assume were mutable, and one antd prop had gone stale. Both mechanical, neither with any behaviour attached.

React never writes to props, and `Readonly<>` says so to the compiler rather than only to the reader. This finishes a pattern the codebase had already chosen rather than introducing one: AccountDetails and EmailTemplateEditor were already written as `type Props = Readonly<{…}>`, so the thirteen named prop interfaces are converted to that same shape and the four context providers, which annotate `{ children }` inline, get `Readonly<{ children: React.ReactNode }>`.

Cart.tsx was the last place passing `destroyOnClose`, deprecated in antd 5.20. Twelve other call sites across the admin screens, the filter drawer and four customer modals already use `destroyOnHidden`, so this one was simply stale. Deprecated props keep working until they do not, and the failure then arrives as an antd upgrade breaking something unrelated to the change being made.

Counted rather than assumed, which the issue specifically asks for, because a `Readonly<>` in the wrong position type-checks and fixes nothing: lint goes from 31 warnings to 13, a drop of exactly eighteen, and both rules disappear from the breakdown entirely rather than merely thinning out.

What that leaves is the point of doing it. The remaining thirteen are eleven `set-state-in-effect` and two `no-alphabetical-sort` — so the frontend's warnings are now only the ones that need a decision, which is what makes #99 tractable. It had grown from the eight in that issue's title to eleven, two of them added by #97's clock tick and lapsed-cart refetch.

No behaviour change intended, so the bar was the end-to-end suite. Full run: 121 passed, 8 failed; all eight pass in a 45/45 serial re-run, which is the shared-database and event-loop flakiness this suite has had throughout.

Closes #100
2026-08-24 11:43:10 -05:00

43 lines
1.4 KiB
TypeScript

import Modal from 'antd/es/modal';
import AuthForm, { AuthMode } from './AuthForm';
type Props = Readonly<{
mode: AuthMode;
onClose: () => void;
// Moving between the auth routes, supplied by the router so the rule about
// keeping the whole detour to one history entry lives in one place.
onNavigate: (path: string) => void;
}>;
const TITLES: Record<AuthMode, string> = {
register: 'Create an account',
login: 'Log in'
};
// /login and /register as modals over the page behind them, so a customer who
// clicks Log in while browsing and changes their mind is not stranded. Both
// stay real routes: /reset-password links to /login, and customers may have
// bookmarks.
export default function AuthRouteModal({ mode, onClose, onNavigate }: Props) {
return (
<Modal
title={TITLES[mode]}
open
onCancel={onClose}
footer={null}
style={{ maxWidth: 'calc(100vw - 32px)' }}
destroyOnHidden
>
<AuthForm
mode={mode}
onModeChange={(next) => onNavigate(next === 'login' ? '/login' : '/register')}
onForgotPassword={() => onNavigate('/forgot-password')}
// Closing returns to the page behind, now signed in. Someone who signs
// in while browsing wants to carry on browsing rather than be moved to
// their account page.
onSuccess={onClose}
/>
</Modal>
);
}