Improve handling of declined portings #14
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
3nvi
reviewed
May 27, 2024
Comment on lines
11
to
12
| porting?: Porting, | ||
| errorCode?: PortingEmbedError |
There was a problem hiding this comment.
nit: not sure if it's right to make the error optional. I think that we should always throw an error to avoid having a breaking change for the customer.
P.S. I'd consider bagging all the custom staff into an object so we can add more things in the future without issuing a breaking change.
Something like
onError: (error: Error, meta: Metadata)where:
type Metadata = PortingEmbedErrorMetadata | OtherErrorMetadata | ...
type PortingEmbedErrorMetadata = {
code: 'portingDeclined' // all should have a `code` field
porting: Porting
}There was a problem hiding this comment.
thank you!! I agree, makes sense 💯 🙏
3nvi
reviewed
May 28, 2024
3nvi
approved these changes
May 28, 2024
| if (e instanceof ApiError) { | ||
| onError(e, { | ||
| code: e.code, | ||
| porting: subscription?.porting || undefined, |
There was a problem hiding this comment.
optional: same thing :)
Suggested change
| porting: subscription?.porting || undefined, | |
| porting: subscription?.porting, |
There was a problem hiding this comment.
ah that's because porting can be undefined or null here
| } else { | ||
| onError(new Error('Something went wrong.'), { | ||
| code: 'unexpectedError', | ||
| porting: subscription?.porting || undefined, |
There was a problem hiding this comment.
Suggested change
| porting: subscription?.porting || undefined, | |
| porting: subscription?.porting, |
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.
When a porting is declined, instead of showing a dead end error state in the embed with no available actions the user can take, we are triggering
onError.onErrorto accept metadata withcodeand optionalportingparamsonErrora required prop to initializePortingEmbedonErrorfrom the porting form when a porting is declinedGenericPortingDeclinedcomponentonSupportRequested