BA-2357: Support first and last name during signup #236
Conversation
sundayguru
requested review from
anicioalexandre,
deboracosilveira and
priscilladeroode
as code owners
|
WalkthroughThe changes update the sign-up functionality by modifying the validation schemas and registration data structure. The original validation schema has been replaced, and a new schema has been introduced that includes separate fields for first and last names. The sign-up hook now accepts a new optional parameter to toggle between the two schemas. Additionally, the type definitions for sign-up options and the registration request have been updated to support these new fields. The package version has also been incremented to reflect these updates. Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant S as useSignUp Hook
participant V1 as Schema_With_Name
participant V2 as Schema_Default
U->>S: Call useSignUp(useNameField: boolean)
alt useNameField is true
S->>V1: Select DEFAULT_VALIDATION_SCHEMA_WITH_NAME
else useNameField is false
S->>V2: Select DEFAULT_VALIDATION_SCHEMA
end
S->>U: Return form configuration with chosen schema
Suggested labels
Suggested reviewers
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 ESLint
packages/authentication/modules/access/useSignUp/types.tsOops! Something went wrong! :( ESLint: 8.57.1 Error: Cannot read config file: /packages/authentication/.eslintrc.js
packages/authentication/modules/access/useSignUp/__tests__/useSignUp.test.tsxOops! Something went wrong! :( ESLint: 8.57.1 Error: Cannot read config file: /packages/authentication/.eslintrc.js
packages/authentication/modules/access/useSignUp/index.tsOops! Something went wrong! :( ESLint: 8.57.1 Error: Cannot read config file: /packages/authentication/.eslintrc.js
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (9)
💤 Files with no reviewable changes (1)
🚧 Files skipped from review as they are similar to previous changes (8)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (4)
packages/authentication/modules/access/useSignUp/types.ts (1)
15-15: Clarify the parameter naming.The boolean parameter
useNameFieldis not intuitive - from the naming, one might expect thattruemeans "use first and last name fields" when it actually means the opposite (use a single name field instead of separate first/last name fields).Consider renaming this to something more descriptive like
useSingleNameFieldto make the intention clearer:- useNameField?: boolean + useSingleNameField?: booleanpackages/authentication/modules/access/useSignUp/index.ts (2)
23-23: Consider renaming the parameter for clarity.Similar to the type definition, the parameter name
useNameFieldis counterintuitive sincetruemeans use a single name field rather than separate first/last name fields.Rename for clarity:
- useNameField = false, + useSingleNameField = false,
28-30: Verify conditional schema selection.The schema selection logic works but relies on potentially confusing parameter naming. This will select
DEFAULT_VALIDATION_SCHEMA_WITH_NAME(single name field) whenuseNameFieldis true, andDEFAULT_VALIDATION_SCHEMA(first/last name fields) whenuseNameFieldis false.For better readability:
- resolver: zodResolver( - useNameField ? DEFAULT_VALIDATION_SCHEMA_WITH_NAME : DEFAULT_VALIDATION_SCHEMA, - ), + resolver: zodResolver( + useNameField + ? DEFAULT_VALIDATION_SCHEMA_WITH_NAME // Single name field + : DEFAULT_VALIDATION_SCHEMA, // First and last name fields + ),packages/authentication/modules/access/useSignUp/constants.ts (1)
1-30: Ensure data consistency across the application.With this implementation, it's possible to have both a single
nameand separatefirstName/lastNamevalues in the same form data, which could lead to inconsistent user data.Consider implementing a transformation function that ensures only the relevant fields are sent to the API:
// In useSignUp/index.ts const handleSubmit: SubmitHandler<TRegisterRequest> = async (values) => { try { const transformedValues = { ...values }; // Clean up data based on which schema is used if (useNameField) { // Using single name field - remove firstName and lastName delete transformedValues.firstName; delete transformedValues.lastName; } else { // Using first/last name fields - remove name delete transformedValues.name; } await mutation.mutateAsync(transformedValues); } catch (error) { // handled by onError } }This ensures that only the relevant fields are sent to the API, preventing data inconsistency.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
packages/authentication/modules/access/useSignUp/constants.ts(1 hunks)packages/authentication/modules/access/useSignUp/index.ts(1 hunks)packages/authentication/modules/access/useSignUp/types.ts(1 hunks)packages/authentication/types/auth.ts(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (javascript)
🔇 Additional comments (2)
packages/authentication/modules/access/useSignUp/index.ts (1)
11-15: LGTM - Clean imports.The imports have been properly updated to include the new schema constant.
packages/authentication/modules/access/useSignUp/constants.ts (1)
15-22: Verify schema definition.The new validation schema for first and last name fields looks good, with proper validation rules applied to each field.
However, to make the naming more consistent with its functionality:
- export const DEFAULT_VALIDATION_SCHEMA = z.object({ + export const FIRST_LAST_NAME_VALIDATION_SCHEMA = z.object({ firstName: z.string().min(1, ZOD_MESSAGE.required), lastName: z.string().min(1, ZOD_MESSAGE.required), password: z.string().min(1, ZOD_MESSAGE.required).regex(PASSWORD_REGEX, { message: ZOD_MESSAGE.password, }), email: z.string().min(1, ZOD_MESSAGE.required).email(ZOD_MESSAGE.email), })
anicioalexandre
added
the
needs changes
sundayguru
force-pushed
the
BA-2357-support-first-and-last-name
branch
from
ec7b33b to
a3f2946
Compare
sundayguru
force-pushed
the
BA-2357-support-first-and-last-name
branch
from
47181e9 to
d75f596
Compare
|
__package_name__package update -v __package_version__Summary by CodeRabbit
New Features
Bug Fixes
Chores