EmailAPI Validation cleanup + test coverage #23
Merged
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
- Moved all Error throws to JunoError to be more easily detected with unit tests - Refactored all validations to now use a centralized validation system to reduce chance of error - Added unit tests for string and email validation - Added jest to the project
UZ9
commented
Oct 24, 2024
src/lib/email.ts
Outdated
| throw new Error( | ||
| 'Parameter recipients or content cannot be an empty array' | ||
|
|
||
| if (recipients.length === 0 && cc?.length === 0 && bcc?.length === 0) { |
There was a problem hiding this comment.
Recipients can be length 0 (it was previously assumed it couldn't) as long as there is at least one of either recipient, cc, or bcc. This will likely be something we need to change with the schema as well considering recipients is not an optional field in it
| @@ -63,7 +70,7 @@ export class EmailAPI { | |||
| ); | |||
| return result.body; | |||
| } catch (e) { | |||
| throw new Error(e); | |||
There was a problem hiding this comment.
Throwing new Error here was previously obfuscating what the error actually was
| } | ||
| } | ||
| } | ||
|
|
||
| const validateEmailRecipient = (recipient: EmailRecipient) => { |
There was a problem hiding this comment.
Validation methods moved to central validators.ts file
| @@ -12,21 +13,21 @@ class JunoAPI { | |||
|
|
|||
| get user(): UserAPI { | |||
| if (!this.userAPI) { | |||
| throw new Error('juno.init() must be called before using the Juno SDK'); | |||
| throw new JunoValidationError('juno.init() must be called before using the Juno SDK'); | |||
There was a problem hiding this comment.
Throwing a JunoValidationError instead of a normal Error helps ensure unit tests are catching the correction exception (it could accidentally catch something else and pass otherwise)
UZ9
changed the title
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.
build/mainin the name