-
Notifications
You must be signed in to change notification settings - Fork 885
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
240 additions
and
6 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'@firebase/firestore': patch | ||
--- | ||
|
||
Ensure that errors get wrapped in FirestoreError |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,221 @@ | ||
/** | ||
* @license | ||
* Copyright 2021 Google LLC | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import { expect, use } from 'chai'; | ||
import * as chaiAsPromised from 'chai-as-promised'; | ||
|
||
import { EmptyCredentialsProvider, Token } from '../../../src/api/credentials'; | ||
import { DatabaseId } from '../../../src/core/database_info'; | ||
import { Connection, Stream } from '../../../src/remote/connection'; | ||
import { | ||
Datastore, | ||
newDatastore, | ||
invokeCommitRpc, | ||
invokeBatchGetDocumentsRpc | ||
} from '../../../src/remote/datastore'; | ||
import { JsonProtoSerializer } from '../../../src/remote/serializer'; | ||
import { Code, FirestoreError } from '../../../src/util/error'; | ||
|
||
use(chaiAsPromised); | ||
|
||
// TODO(b/185584343): Improve the coverage of these tests. | ||
// At the time of writing, the tests only cover the error handling in | ||
// `invokeRPC()` and `invokeStreamingRPC()`. | ||
describe('Datastore', () => { | ||
class MockConnection implements Connection { | ||
invokeRPC<Req, Resp>( | ||
rpcName: string, | ||
path: string, | ||
request: Req, | ||
token: Token | null | ||
): Promise<Resp> { | ||
throw new Error('MockConnection.invokeRPC() must be replaced'); | ||
} | ||
|
||
invokeStreamingRPC<Req, Resp>( | ||
rpcName: string, | ||
path: string, | ||
request: Req, | ||
token: Token | null | ||
): Promise<Resp[]> { | ||
throw new Error('MockConnection.invokeStreamingRPC() must be replaced'); | ||
} | ||
|
||
openStream<Req, Resp>( | ||
rpcName: string, | ||
token: Token | null | ||
): Stream<Req, Resp> { | ||
throw new Error('MockConnection.openStream() must be replaced'); | ||
} | ||
} | ||
|
||
class MockCredentialsProvider extends EmptyCredentialsProvider { | ||
invalidateTokenInvoked = false; | ||
invalidateToken(): void { | ||
this.invalidateTokenInvoked = true; | ||
} | ||
} | ||
|
||
const serializer = new JsonProtoSerializer( | ||
new DatabaseId('test-project'), | ||
/* useProto3Json= */ false | ||
); | ||
|
||
async function invokeDatastoreImplInvokeRpc( | ||
datastore: Datastore | ||
): Promise<void> { | ||
// Since we cannot access the `DatastoreImpl` class directly, invoke its | ||
// `invokeRPC()` method indirectly via `invokeCommitRpc()`. | ||
await invokeCommitRpc(datastore, /* mutations= */ []); | ||
} | ||
|
||
async function invokeDatastoreImplInvokeStreamingRPC( | ||
datastore: Datastore | ||
): Promise<void> { | ||
// Since we cannot access the `DatastoreImpl` class directly, invoke its | ||
// `invokeStreamingRPC()` method indirectly via | ||
// `invokeBatchGetDocumentsRpc()`. | ||
await invokeBatchGetDocumentsRpc(datastore, /* keys= */ []); | ||
} | ||
|
||
it('newDatastore() returns an an instance of Datastore', () => { | ||
const datastore = newDatastore( | ||
new EmptyCredentialsProvider(), | ||
new MockConnection(), | ||
serializer | ||
); | ||
expect(datastore).to.be.an.instanceof(Datastore); | ||
}); | ||
|
||
it('DatastoreImpl.invokeRPC() fails if terminated', async () => { | ||
const datastore = newDatastore( | ||
new EmptyCredentialsProvider(), | ||
new MockConnection(), | ||
serializer | ||
); | ||
datastore.terminate(); | ||
await expect(invokeDatastoreImplInvokeRpc(datastore)) | ||
.to.eventually.be.rejectedWith(/terminated/) | ||
.and.include({ | ||
'name': 'FirebaseError', | ||
'code': Code.FAILED_PRECONDITION | ||
}); | ||
}); | ||
|
||
it('DatastoreImpl.invokeRPC() rethrows a FirestoreError', async () => { | ||
const connection = new MockConnection(); | ||
connection.invokeRPC = () => | ||
Promise.reject(new FirestoreError(Code.ABORTED, 'zzyzx')); | ||
const credentials = new MockCredentialsProvider(); | ||
const datastore = newDatastore(credentials, connection, serializer); | ||
await expect(invokeDatastoreImplInvokeRpc(datastore)) | ||
.to.eventually.be.rejectedWith('zzyzx') | ||
.and.include({ | ||
'name': 'FirebaseError', | ||
'code': Code.ABORTED | ||
}); | ||
expect(credentials.invalidateTokenInvoked).to.be.false; | ||
}); | ||
|
||
it('DatastoreImpl.invokeRPC() wraps unknown exceptions in a FirestoreError', async () => { | ||
const connection = new MockConnection(); | ||
connection.invokeRPC = () => Promise.reject('zzyzx'); | ||
const credentials = new MockCredentialsProvider(); | ||
const datastore = newDatastore(credentials, connection, serializer); | ||
await expect(invokeDatastoreImplInvokeRpc(datastore)) | ||
.to.eventually.be.rejectedWith('zzyzx') | ||
.and.include({ | ||
'name': 'FirebaseError', | ||
'code': Code.UNKNOWN | ||
}); | ||
expect(credentials.invalidateTokenInvoked).to.be.false; | ||
}); | ||
|
||
it('DatastoreImpl.invokeRPC() invalidates the token if unauthenticated', async () => { | ||
const connection = new MockConnection(); | ||
connection.invokeRPC = () => | ||
Promise.reject(new FirestoreError(Code.UNAUTHENTICATED, 'zzyzx')); | ||
const credentials = new MockCredentialsProvider(); | ||
const datastore = newDatastore(credentials, connection, serializer); | ||
await expect(invokeDatastoreImplInvokeRpc(datastore)) | ||
.to.eventually.be.rejectedWith('zzyzx') | ||
.and.include({ | ||
'name': 'FirebaseError', | ||
'code': Code.UNAUTHENTICATED | ||
}); | ||
expect(credentials.invalidateTokenInvoked).to.be.true; | ||
}); | ||
|
||
it('DatastoreImpl.invokeStreamingRPC() fails if terminated', async () => { | ||
const datastore = newDatastore( | ||
new EmptyCredentialsProvider(), | ||
new MockConnection(), | ||
serializer | ||
); | ||
datastore.terminate(); | ||
await expect(invokeDatastoreImplInvokeStreamingRPC(datastore)) | ||
.to.eventually.be.rejectedWith(/terminated/) | ||
.and.include({ | ||
'name': 'FirebaseError', | ||
'code': Code.FAILED_PRECONDITION | ||
}); | ||
}); | ||
|
||
it('DatastoreImpl.invokeStreamingRPC() rethrows a FirestoreError', async () => { | ||
const connection = new MockConnection(); | ||
connection.invokeStreamingRPC = () => | ||
Promise.reject(new FirestoreError(Code.ABORTED, 'zzyzx')); | ||
const credentials = new MockCredentialsProvider(); | ||
const datastore = newDatastore(credentials, connection, serializer); | ||
await expect(invokeDatastoreImplInvokeStreamingRPC(datastore)) | ||
.to.eventually.be.rejectedWith('zzyzx') | ||
.and.include({ | ||
'name': 'FirebaseError', | ||
'code': Code.ABORTED | ||
}); | ||
expect(credentials.invalidateTokenInvoked).to.be.false; | ||
}); | ||
|
||
it('DatastoreImpl.invokeStreamingRPC() wraps unknown exceptions in a FirestoreError', async () => { | ||
const connection = new MockConnection(); | ||
connection.invokeStreamingRPC = () => Promise.reject('zzyzx'); | ||
const credentials = new MockCredentialsProvider(); | ||
const datastore = newDatastore(credentials, connection, serializer); | ||
await expect(invokeDatastoreImplInvokeStreamingRPC(datastore)) | ||
.to.eventually.be.rejectedWith('zzyzx') | ||
.and.include({ | ||
'name': 'FirebaseError', | ||
'code': Code.UNKNOWN | ||
}); | ||
expect(credentials.invalidateTokenInvoked).to.be.false; | ||
}); | ||
|
||
it('DatastoreImpl.invokeStreamingRPC() invalidates the token if unauthenticated', async () => { | ||
const connection = new MockConnection(); | ||
connection.invokeStreamingRPC = () => | ||
Promise.reject(new FirestoreError(Code.UNAUTHENTICATED, 'zzyzx')); | ||
const credentials = new MockCredentialsProvider(); | ||
const datastore = newDatastore(credentials, connection, serializer); | ||
await expect(invokeDatastoreImplInvokeStreamingRPC(datastore)) | ||
.to.eventually.be.rejectedWith('zzyzx') | ||
.and.include({ | ||
'name': 'FirebaseError', | ||
'code': Code.UNAUTHENTICATED | ||
}); | ||
expect(credentials.invalidateTokenInvoked).to.be.true; | ||
}); | ||
}); |