Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This is an extensible way of providing more control over FirestoreDb creation, in a manner consistent with other Cloud client libraries.
- Loading branch information
Showing
4 changed files
with
197 additions
and
17 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
63 changes: 63 additions & 0 deletions
63
apis/Google.Cloud.Firestore/Google.Cloud.Firestore.Tests/FirestoreDbBuilderTest.cs
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,63 @@ | ||
| // Copyright 2019, 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 | ||
| // | ||
| // https://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. | ||
|
|
||
| using Google.Api.Gax.Testing; | ||
| using Google.Cloud.Firestore.V1; | ||
| using Grpc.Core; | ||
| using System; | ||
| using Xunit; | ||
|
|
||
| namespace Google.Cloud.Firestore.Tests | ||
| { | ||
| public class FirestoreDbBuilderTest | ||
| { | ||
| [Fact] | ||
| public void MaximalConfiguration() | ||
| { | ||
| string warning = null; | ||
| var builder = new FirestoreDbBuilder | ||
| { | ||
| ProjectId = "proj", | ||
| DatabaseId = "db", | ||
| CallInvoker = new FakeCallInvoker(), | ||
| WarningLogger = text => warning = text, | ||
| Settings = new FirestoreSettings { Clock = new FakeClock() } | ||
| }; | ||
| var db = builder.Build(); | ||
| Assert.Equal("proj", db.ProjectId); | ||
| Assert.Equal("db", db.DatabaseId); | ||
| db.LogWarning("Test warning"); | ||
| Assert.Equal("Test warning", warning); | ||
| Assert.IsType<FakeClock>(db.Client.Settings.Clock); | ||
| } | ||
|
|
||
| private class FakeCallInvoker : CallInvoker | ||
| { | ||
| public override AsyncClientStreamingCall<TRequest, TResponse> AsyncClientStreamingCall<TRequest, TResponse>(Method<TRequest, TResponse> method, string host, CallOptions options) => | ||
| throw new NotImplementedException(); | ||
|
|
||
| public override AsyncDuplexStreamingCall<TRequest, TResponse> AsyncDuplexStreamingCall<TRequest, TResponse>(Method<TRequest, TResponse> method, string host, CallOptions options) => | ||
| throw new NotImplementedException(); | ||
|
|
||
| public override AsyncServerStreamingCall<TResponse> AsyncServerStreamingCall<TRequest, TResponse>(Method<TRequest, TResponse> method, string host, CallOptions options, TRequest request) => | ||
| throw new NotImplementedException(); | ||
|
|
||
| public override AsyncUnaryCall<TResponse> AsyncUnaryCall<TRequest, TResponse>(Method<TRequest, TResponse> method, string host, CallOptions options, TRequest request) => | ||
| throw new NotImplementedException(); | ||
|
|
||
| public override TResponse BlockingUnaryCall<TRequest, TResponse>(Method<TRequest, TResponse> method, string host, CallOptions options, TRequest request) => | ||
| throw new NotImplementedException(); | ||
| } | ||
| } | ||
| } |
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
89 changes: 89 additions & 0 deletions
89
apis/Google.Cloud.Firestore/Google.Cloud.Firestore/FirestoreDbBuilder.cs
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,89 @@ | ||
| // Copyright 2019, 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 | ||
| // | ||
| // https://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. | ||
|
|
||
| using Google.Api.Gax; | ||
| using Google.Api.Gax.Grpc; | ||
| using Google.Cloud.Firestore.V1; | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
|
|
||
| namespace Google.Cloud.Firestore | ||
| { | ||
| /// <summary> | ||
| /// Builder class for <see cref="FirestoreDb"/>, providing simple configuration of credentials, | ||
| /// endpoint, project ID etc. | ||
| /// </summary> | ||
| public sealed class FirestoreDbBuilder : ClientBuilderBase<FirestoreDb> | ||
| { | ||
| /// <summary> | ||
| /// The settings to use for RPCs, or null for the default settings. | ||
| /// </summary> | ||
| public FirestoreSettings Settings { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// The ID of the Google Cloud Platform project that contains the database. May be null, in which case | ||
| /// the project will be automatically detected if possible. | ||
| /// </summary> | ||
| public string ProjectId { get; set; } | ||
|
|
||
| // Note: currently internal as only the default database is supported. | ||
| /// <summary> | ||
| /// The ID of the database within the project. May be null, in which case the default database will be used. | ||
| /// </summary> | ||
| internal string DatabaseId { get; set; } | ||
|
|
||
| /// <summary> | ||
| /// Action to receive warning messages. May be null, in which case warnings will be ignored. | ||
| /// </summary> | ||
| public Action<string> WarningLogger { get; set; } | ||
|
|
||
| /// <inheritdoc /> | ||
| public override FirestoreDb Build() | ||
| { | ||
| var projectId = ProjectId ?? Platform.Instance().ProjectId; | ||
| var clientBuilder = FirestoreClientBuilder.FromOtherBuilder(this); | ||
| clientBuilder.Settings = Settings; | ||
| var client = clientBuilder.Build(); | ||
| return BuildFromClient(projectId, client); | ||
| } | ||
|
|
||
| /// <inheritdoc /> | ||
| public override async Task<FirestoreDb> BuildAsync(CancellationToken cancellationToken = default) | ||
| { | ||
| var projectId = ProjectId ?? (await Platform.InstanceAsync().ConfigureAwait(false)).ProjectId; | ||
| var clientBuilder = FirestoreClientBuilder.FromOtherBuilder(this); | ||
| clientBuilder.Settings = Settings; | ||
| var client = await clientBuilder.BuildAsync(cancellationToken).ConfigureAwait(false); | ||
| return BuildFromClient(projectId, client); | ||
| } | ||
|
|
||
| // We never end up using these methods, at least with the current implementation | ||
| /// <inheritdoc /> | ||
| protected override ServiceEndpoint GetDefaultEndpoint() => | ||
| throw new InvalidOperationException($"This method should never execute in {nameof(FirestoreDbBuilder)}"); | ||
|
|
||
| /// <inheritdoc /> | ||
| protected override IReadOnlyList<string> GetDefaultScopes() => | ||
| throw new InvalidOperationException($"This method should never execute in {nameof(FirestoreDbBuilder)}"); | ||
|
|
||
| /// <inheritdoc /> | ||
| protected override ChannelPool GetChannelPool() => | ||
| throw new InvalidOperationException($"This method should never execute in {nameof(FirestoreDbBuilder)}"); | ||
|
|
||
| private FirestoreDb BuildFromClient(string projectId, FirestoreClient client) => | ||
| FirestoreDb.Create(projectId, DatabaseId, client, WarningLogger); | ||
| } | ||
| } |