Uh oh!
There was an error while loading. Please reload this page.
feat(clerk-js,clerk-react,types): Signal errors#6495
Uh oh!
There was an error while loading. Please reload this page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| '@clerk/clerk-js': minor | ||
| '@clerk/clerk-react': minor | ||
| '@clerk/types': minor | ||
| --- | ||
| [Experimental] Signal Errors |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,96 @@ | ||
| import { isClerkAPIResponseError } from '@clerk/shared/error'; | ||
| import type { Errors } from '@clerk/types'; | ||
| import { computed, signal } from 'alien-signals'; | ||
| import type { SignIn } from './resources/SignIn'; | ||
| export const signInSignal = signal<{ resource: SignIn | null }>({ resource: null }); | ||
| export const signInErrorSignal = signal<{ error: unknown }>({ error: null }); | ||
| export const signInComputedSignal = computed(() => { | ||
| const signIn = signInSignal().resource; | ||
| const error = signInErrorSignal().error; | ||
| const errors = errorsToParsedErrors(error); | ||
| if (!signIn) { | ||
| return { errors, signIn: null }; | ||
| } | ||
| return { errors, signIn: signIn.__internal_future }; | ||
| }); | ||
| /** | ||
| * Converts an error to a parsed errors object that reports the specific fields that the error pertains to. Will put | ||
| * generic non-API errors into the global array. | ||
| */ | ||
| function errorsToParsedErrors(error: unknown): Errors { | ||
| const parsedErrors: Errors = { | ||
| fields: { | ||
| firstName: null, | ||
| lastName: null, | ||
| emailAddress: null, | ||
| identifier: null, | ||
| phoneNumber: null, | ||
| password: null, | ||
| username: null, | ||
| code: null, | ||
| captcha: null, | ||
| legalAccepted: null, | ||
| }, | ||
| raw: [], | ||
| global: [], | ||
| }; | ||
| if (!isClerkAPIResponseError(error)) { | ||
| parsedErrors.raw.push(error); | ||
| parsedErrors.global.push(error); | ||
| return parsedErrors; | ||
| } | ||
| parsedErrors.raw.push(...error.errors); | ||
| error.errors.forEach(error => { | ||
| if ('meta' in error && error.meta && 'paramName' in error.meta) { | ||
| switch (error.meta.paramName) { | ||
| case 'first_name': | ||
| parsedErrors.fields.firstName = error; | ||
| break; | ||
| case 'last_name': | ||
| parsedErrors.fields.lastName = error; | ||
| break; | ||
| case 'email_address': | ||
| parsedErrors.fields.emailAddress = error; | ||
| break; | ||
| case 'identifier': | ||
| parsedErrors.fields.identifier = error; | ||
| break; | ||
| case 'phone_number': | ||
| parsedErrors.fields.phoneNumber = error; | ||
| break; | ||
| case 'password': | ||
| parsedErrors.fields.password = error; | ||
| break; | ||
| case 'username': | ||
| parsedErrors.fields.username = error; | ||
| break; | ||
| case 'code': | ||
| parsedErrors.fields.code = error; | ||
| break; | ||
| case 'captcha': | ||
| parsedErrors.fields.captcha = error; | ||
| break; | ||
| case 'legal_accepted': | ||
| parsedErrors.fields.legalAccepted = error; | ||
| break; | ||
| default: | ||
| parsedErrors.global.push(error); | ||
| break; | ||
| } | ||
| } else { | ||
| parsedErrors.global.push(error); | ||
| } | ||
| }); | ||
| return parsedErrors; | ||
| } | ||
Comment on lines
+27
to
+96
Contributor There was a problem hiding this comment. 🛠️ Refactor suggestion Add unit tests for the new error parsing functionality The
🤖 Prompt for AI Agents | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,39 @@ | ||
| import type { SignInFutureResource } from './signIn'; | ||
| interface FieldError { | ||
| code: string; | ||
| longMessage?: string; | ||
| message: string; | ||
| } | ||
| interface FieldErrors { | ||
| firstName: FieldError | null; | ||
| lastName: FieldError | null; | ||
| emailAddress: FieldError | null; | ||
| identifier: FieldError | null; | ||
| phoneNumber: FieldError | null; | ||
| password: FieldError | null; | ||
| username: FieldError | null; | ||
| code: FieldError | null; | ||
| captcha: FieldError | null; | ||
| legalAccepted: FieldError | null; | ||
| } | ||
| export interface Errors { | ||
| fields: FieldErrors; | ||
| raw: unknown[]; | ||
| global: unknown[]; // does not include any errors that could be parsed as a field error | ||
| } | ||
| export interface State { | ||
| /** | ||
| * A Signal that updates when the underlying `SignIn` resource changes, including errors. | ||
| */ | ||
| signInSignal: { | ||
| (): { | ||
| errors: Errors; | ||
| signIn: SignInFutureResource | null; | ||
| }; | ||
| }; | ||
| /** | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Field errors may be overwritten when multiple errors exist for the same field
The current implementation assigns errors directly to field properties (e.g.,
parsedErrors.fields.firstName = error). If the API returns multiple errors for the same field, only the last one will be retained, potentially losing important validation information.Consider either:
Example of potential data loss:
🤖 Prompt for AI Agents