feat(sdk): Decrypt error is StreamrClientError
#2895
Merged
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.
Removed custom
DecryptErrorclass. UsingStreamrClientErrorwith codeDECRYPT_ERRORinstead.Changed some wording of decrypt errors: encryption keys are no longer referred as group key, which is an internal term for encryption key (see e.g.
exports.ts#36).Cause parameter
Considered adding
causeparameter forStreamrClientError(https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause). Decided not to include it as it we've earlier had compatibility issues with it when using Firefox. Maybe browser support is nowadays better. We can add that later if needed.The
causeparameter would link root causeErrorinstances to StreamrClientError and therefore provide very detailed stack traces. For client errors such stack traces are maybe not needed in practice. I.e. ifdecryptWithAES()throws an error, we'll create aStreamrClientErrorwith message of "AES decryption failed" and type ofDECRYPT_ERROR. In most cases these bits of information are sufficient for analyzing application level issues.Future improvements
StreamrClientErrortoEqualStreamrError()test utility