fix(email_verification): should refresh email verification is called once per second #125
Conversation
This file contains 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
porcellus
requested changes
Dec 13, 2024
| @@ -28,6 +28,13 @@ export class EmailVerificationClaimClass extends BooleanClaim { | |||
| refresh: this.refresh, | |||
| shouldRefresh: (payload, userContext) => { | |||
| const DateProvider = DateProviderReference.getReferenceOrThrow().dateProvider; | |||
| const currentTime = DateProvider.now(); | |||
|
|
|||
| if (this.shouldRefreshLastCalled && this.shouldRefreshLastCalled > currentTime - 1000) { | |||
There was a problem hiding this comment.
Please make this an explicit check for checking if shouldRefreshLastCalled is not undefined.
Comment on lines
20
to
33
| /* | ||
| * Delay function is used in case of email verification claim as we have added a debouncing | ||
| * mechanism that shouldRefresh will return false if multiple calls are done in 1000ms. | ||
| * Hence adding delay after each email verification or shouldRefresh calls will result in | ||
| * correct tests. | ||
| * Test for checking when the shouldRefresh returning false when called multiple times in 1000ms | ||
| * is added. | ||
| */ | ||
| const delay = async () => { | ||
| return new Promise((resolve) => { | ||
| setTimeout(resolve, 1000); | ||
| }); | ||
| }; | ||
|
|
There was a problem hiding this comment.
I'd prefer if you did this through manipulating the DateProvider
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary of change
Earlier email verification call was happening multiple times when the backend was not running. Now the email verification calls are restricted to once per second in the
shouldRefreshfunction.Related issues
supertokens/supertokens-auth-react#845
Test Plan
After the change 3 tests started failing in
emailverificationclaim.test.jsas the shouldRefresh was called multiple times in one secondAfter adding delay before each shouldRefresh calls, the tests started passing and one more test added to verify the shouldRefresh response when it is called twice in one second.
Documentation changes
(If relevant, please create a PR in our docs repo, or create a checklist here highlighting the necessary changes)
Checklist for important updates
frontendDriverInterfaceSupported.jsonfile has been updated (if needed)lib/ts/version.tswebJsInterfaceSupported.jsonfile has been updated (if needed)package.jsonpackage-lock.jsonlib/ts/version.tsnpm run build-prettygit tag) in the formatvX.Y.Z, and then find the latest branch (git branch --all) whoseX.Yis greater than the latest released tag.Remaining TODOs for this PR