fix(cognito): user pool - link style email verification fails to deploy #6938
Conversation
A couple of things happen with this change -
- `emailVerificationMessage`, `emailVerificationSubject` and
`smsVerificationMessage` properties are not set when link-style
verification is used. This is root cause for the error message reported
by the user.
- The defaults `emailBody` and `emailSubject` are modified when
link-style verification is used. They will now correctly contian the
template placeholder '{##Verify Email##}'.
fixes #6811
nija-at
added
pr/do-not-merge
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
| throw new Error('SMS message cannot be configured when emailStyle is configured to CODE'); | ||
| } | ||
| const emailMessage = props.userVerification?.emailBody ?? 'Hello {username}, Verify your account by clicking on {##Verify Email##}'; | ||
| if (emailMessage.indexOf('{##Verify Email##}') < 0) { |
There was a problem hiding this comment.
Don't like this placeholder very much. Do we have control over it, or is this what Cognito decided upon?
In any case shouldn't these all be in constants somewhere?
There was a problem hiding this comment.
Cognito's placeholders - https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html
And the {##Verify Email##} is an undocumented one.
In any case shouldn't these all be in constants somewhere?
Yep, will change
Configuring the correct properties for sign up and testing it is hard. This PR - #6938 - shows how it can be easily mis-configured. Testing the correct configuration is hard and requires a certain amount of set up and the correct set of calls to the 'SignUp' API. The integ tests here encode all of this in a way that can be easily replicated when any part of sign up is being modified or needs to be tested.
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
* chore(cognito): integ tests for sign up Configuring the correct properties for sign up and testing it is hard. This PR - #6938 - shows how it can be easily mis-configured. Testing the correct configuration is hard and requires a certain amount of set up and the correct set of calls to the 'SignUp' API. The integ tests here encode all of this in a way that can be easily replicated when any part of sign up is being modified or needs to be tested. * fixup breaking tests Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Commit Message
fix(cognito): user pool - link style email verification fails to deploy (#6938)
A couple of changes -
emailVerificationMessageandemailVerificationSubjectproperties are not set when link-style verification is used.
This is root cause for the error message reported by the user.
The defaults
emailBodyandemailSubjectare modified whenlink-style verification is used. They will now correctly contain the
template placeholder
{##Verify Email##}.Validations are now added that email and SMS verification
messages have the mandatory placeholders.
fixes #6811
End Commit Message
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license