CosmosClientBuilder: Add preferred regions and public internal func WithConnectionModeDirect() #1397
Conversation
2. Make the function to build CosmosClient by customize connection configs from internal to public
lingdaLi
requested review from
ealsur,
FabianMeiswinkel,
j82w,
kirankumarkolli and
kirillg
as code owners
|
|
| /// <seealso cref="CosmosClientOptions.ApplicationPreferredRegions"/> | ||
| public CosmosClientBuilder WithApplicationPreferredRegions(IReadOnlyList<string> applicationPreferredRegions) | ||
| { | ||
| this.clientOptions.ApplicationPreferredRegions = applicationPreferredRegions; |
There was a problem hiding this comment.
We need to make a deep copy of the list, since the list itself is mutable.
There was a problem hiding this comment.
Either that or use ImmutableList.
There was a problem hiding this comment.
No need, the list is copied when the ConnectionPolicy is built. https://github.com/Azure/azure-cosmos-dotnet-v3/blob/master/Microsoft.Azure.Cosmos/src/ConnectionPolicy.cs#L73
There was a problem hiding this comment.
Since @bchong95 brought this topic, do you guys think it's necessary to force the input type as ImmutableList? Since it will ensure the thread safe. I might over thinking but it's possible the list will change during add process?
There was a problem hiding this comment.
Internally the list that is passed is iterated when you build the Client instance and not referenced, so modifying the variable after bulding the client has no effect.
There was a problem hiding this comment.
What's the contract on ClientOptions. If its IReadOnly then won't it also have the same issue?
There was a problem hiding this comment.
CosmosClientOptions's contract is public IReadOnlyList<string> ApplicationPreferredRegions { get; set; }. Like I mentioned, once the Client is built, we don't maintain a reference to the variable, so modifying the variable does not alter the Client configuration.
There was a problem hiding this comment.
@ealsur lets please track this feedback for V4.
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
…dPrefferedRegionsConfig
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
Description
When we migrate our app from sdk v2 to sdk v3, we need a way to set the EnableTcpConnectionEndpointRediscovery and ApplicationPreferredRegions on CosmosClientOptions by CosmosClientBuilder.
The reason we need create CosmosClientBuilder is due to we need utilize the internal encryption feature.
Type of change
1395
Put closes #1395 .
lingdaLi