Update spring data cosmos to track2 cosmos SDK v4 dependency #13229
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,123 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| package com.azure.spring.data.cosmos; | ||
|
|
||
| import com.azure.cosmos.CosmosAsyncClient; | ||
| import com.azure.cosmos.CosmosClient; | ||
| import com.azure.cosmos.CosmosClientBuilder; | ||
| import com.azure.spring.data.cosmos.common.MacAddress; | ||
| import com.azure.spring.data.cosmos.common.PropertyLoader; | ||
| import com.azure.spring.data.cosmos.common.TelemetrySender; | ||
| import com.azure.spring.data.cosmos.config.CosmosDBConfig; | ||
| import org.apache.commons.lang3.reflect.FieldUtils; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import org.springframework.lang.NonNull; | ||
| import org.springframework.util.Assert; | ||
|
|
||
| import javax.annotation.PostConstruct; | ||
| import java.lang.reflect.Field; | ||
|
|
||
| /** | ||
| * Factory class for CosmosDb to create client | ||
| */ | ||
| public class CosmosDBFactory { | ||
|
Contributor
There was a problem hiding this comment. is this a public class? I wonder if it should be CosmosDBFactory or CosmosFactory. the same comment applies to all other public surface area, should we go with CosmosDB or Cosmos on the public surface. our brand name is Cosmos
Member
Author
There was a problem hiding this comment. Yes, changing all CosmosDB to Cosmos in next commit on this PR. |
||
|
|
||
| private static final Logger logger = LoggerFactory.getLogger(CosmosDBFactory.class); | ||
|
|
||
| private final CosmosDBConfig config; | ||
|
|
||
| private static final boolean IS_TELEMETRY_ALLOWED = | ||
| PropertyLoader.isApplicationTelemetryAllowed(); | ||
|
|
||
| private static final String USER_AGENT_SUFFIX = | ||
| Constants.USER_AGENT_SUFFIX + PropertyLoader.getProjectVersion(); | ||
|
|
||
| private String getUserAgentSuffix() { | ||
| String suffix = ";" + USER_AGENT_SUFFIX; | ||
|
|
||
| if (IS_TELEMETRY_ALLOWED || config.isAllowTelemetry()) { | ||
| suffix += ";" + MacAddress.getHashMac(); | ||
| } | ||
|
|
||
| return suffix; | ||
| } | ||
|
|
||
| /** | ||
| * Validate config and initialization | ||
| * | ||
| * @param cosmosDBConfig cosmosDBConfig | ||
| */ | ||
| public CosmosDBFactory(@NonNull CosmosDBConfig cosmosDBConfig) { | ||
| validateConfig(cosmosDBConfig); | ||
|
|
||
| this.config = cosmosDBConfig; | ||
| } | ||
|
|
||
| /** | ||
| * To create a CosmosAsyncClient | ||
| * | ||
| * @return CosmosClient | ||
| */ | ||
| public CosmosAsyncClient getCosmosAsyncClient() { | ||
| final CosmosClientBuilder cosmosClientBuilderFromConfig = | ||
| getCosmosClientBuilderFromConfig(config); | ||
| return cosmosClientBuilderFromConfig.buildAsyncClient(); | ||
| } | ||
|
|
||
| /** | ||
| * To create a CosmosClient | ||
| * | ||
| * @return CosmosSyncClient | ||
| */ | ||
| public CosmosClient getCosmosSyncClient() { | ||
| final CosmosClientBuilder cosmosClientBuilderFromConfig = | ||
| getCosmosClientBuilderFromConfig(config); | ||
| return cosmosClientBuilderFromConfig.buildClient(); | ||
| } | ||
|
|
||
| private CosmosClientBuilder getCosmosClientBuilderFromConfig(CosmosDBConfig cosmosDBConfig) { | ||
| final CosmosClientBuilder cosmosClientBuilder = cosmosDBConfig.getCosmosClientBuilder(); | ||
| cosmosClientBuilder.contentResponseOnWriteEnabled(true); | ||
| final String userAgentSuffixValue = getUserAgentSuffixValue(cosmosClientBuilder); | ||
| final String userAgentSuffix = getUserAgentSuffix() + userAgentSuffixValue; | ||
|
|
||
| return cosmosDBConfig.getCosmosClientBuilder().userAgentSuffix(userAgentSuffix); | ||
| } | ||
|
|
||
| private String getUserAgentSuffixValue(CosmosClientBuilder cosmosClientBuilder) { | ||
| final Field userAgentSuffix = FieldUtils.getDeclaredField(CosmosClientBuilder.class, | ||
| "userAgentSuffix", true); | ||
| try { | ||
| return (String)userAgentSuffix.get(cosmosClientBuilder); | ||
| } catch (IllegalAccessException e) { | ||
| logger.error("Error occurred while getting userAgentSuffix from CosmosClientBuilder", | ||
| e); | ||
| } | ||
| return ""; | ||
| } | ||
|
|
||
| private void validateConfig(@NonNull CosmosDBConfig config) { | ||
| Assert.hasText(config.getDatabase(), "cosmosDb database should have text!"); | ||
| } | ||
|
|
||
| @PostConstruct | ||
| private void sendTelemetry() { | ||
| // If any one of them is enabled, send telemetry data | ||
| if (IS_TELEMETRY_ALLOWED || config.isAllowTelemetry()) { | ||
| final TelemetrySender sender = new TelemetrySender(); | ||
|
|
||
| sender.send(this.getClass().getSimpleName()); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * To get config object of cosmosDb | ||
| * | ||
| * @return CosmosDBConfig | ||
| */ | ||
| public CosmosDBConfig getConfig() { | ||
| return config; | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You shouldn't need com.google.code.findbugs:jsr305 in the bannedDependency includes. This particular entry was removed from this file as part of the same PR that fixed in the inheritance.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure @JimSuplizio - will get rid of it from bannedDependencies includes.