Ensure errors are wrapped in FirestoreError in DatastoreImpl methods #4788
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
🦋 Changeset detectedLatest commit: 7bbbfe5 The changes in this PR will be included in the next version bump. This PR includes changesets to release 8 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Size Analysis Report |
Binary Size ReportAffected SDKs
Test Logs
|
|
|
||
| use(chaiAsPromised); | ||
|
|
||
| // TODO: Improve the coverage of these tests. |
There was a problem hiding this comment.
Needs a bug number or a user name (e.g. wilhuff)
| Promise.reject(new FirestoreError(Code.ABORTED, 'zzyzx')); | ||
| const credentials = new MockCredentialsProvider(); | ||
| const datastore = newDatastore(credentials, connection, serializer); | ||
| await expect(invokeDatastoreImplInvokeStreamingRPC(datastore)) |
There was a problem hiding this comment.
This doesn't seem to verify that we return a FirestoreError. I think you can do this as such:
await expect(invokeDatastoreImplInvokeStreamingRPC(datastore)).to.be.eventually.rejectedWIth(new FirestoreError(Code.ABORTED, 'zzyzx'))
If that doesn't work, you can use a try/catch here.
This also applies to other tests such as"DatastoreImpl.invokeRPC() wraps unknown exceptions in a FirestoreError". Since GRPC errors also have codes, I suspect that these tests may have passed even without your change.
There was a problem hiding this comment.
Done. Unfortunately, the "nice" way of using rejectedWith as you suggest doesn't work. The check incorrectly fails with this message:
AssertionError: expected promise to be rejected with 'FirebaseError: [code=unknown]: zzyzx' but it was rejected with 'FirebaseError: [code=unknown]: zzyzx'
(note: both the actual and expected strings in the message are equal)
But I found that you can verify multiple properties at once. So I used that to verify that the name is FirebaseError in addition to verifying the code.
schmidt-sebastian
approved these changes
Apr 19, 2021
Merged
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixes: #4780