[SNOW-954150] Use map of clients with different configurations instead of one client for multiple connectors configurations #744
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
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,134 @@ | ||
| /* | ||
| * Copyright (c) 2023 Snowflake Inc. All rights reserved. | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| package com.snowflake.kafka.connector.internal.streaming; | ||
|
|
||
| import static com.snowflake.kafka.connector.SnowflakeSinkConnectorConfig.SNOWPIPE_STREAMING_FILE_VERSION; | ||
| import static net.snowflake.ingest.utils.ParameterProvider.BLOB_FORMAT_VERSION; | ||
|
|
||
| import com.snowflake.kafka.connector.Utils; | ||
| import com.snowflake.kafka.connector.internal.KCLogger; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
| import java.util.Properties; | ||
| import java.util.stream.Collectors; | ||
| import java.util.stream.Stream; | ||
| import net.snowflake.ingest.utils.Constants; | ||
|
|
||
| /** | ||
| * Object to convert and store properties for {@link | ||
| * net.snowflake.ingest.streaming.SnowflakeStreamingIngestClient}. This object is used to compare | ||
| * equality between clients in {@link StreamingClientProvider}. | ||
| */ | ||
| public class StreamingClientProperties { | ||
| public static final String STREAMING_CLIENT_PREFIX_NAME = "KC_CLIENT_"; | ||
| public static final String DEFAULT_CLIENT_NAME = "DEFAULT_CLIENT"; | ||
|
|
||
| private static final KCLogger LOGGER = new KCLogger(StreamingClientProperties.class.getName()); | ||
|
|
||
| // contains converted config properties that are loggable (not PII data) | ||
| public static final List<String> LOGGABLE_STREAMING_CONFIG_PROPERTIES = | ||
| Stream.of( | ||
| Constants.ACCOUNT_URL, | ||
| Constants.ROLE, | ||
| Constants.USER, | ||
| StreamingUtils.STREAMING_CONSTANT_AUTHORIZATION_TYPE) | ||
| .collect(Collectors.toList()); | ||
|
|
||
| public final Properties clientProperties; | ||
| public final String clientName; | ||
| public final Map<String, Object> parameterOverrides; | ||
|
|
||
| /** | ||
| * Creates non-null properties, client name and parameter overrides for the {@link | ||
| * net.snowflake.ingest.streaming.SnowflakeStreamingIngestClient} from the given connectorConfig | ||
| * Properties are created by {@link StreamingUtils#convertConfigForStreamingClient(Map)} and are a | ||
| * subset of the given connector configuration | ||
| * | ||
| * @param connectorConfig Given connector configuration. Null configs are treated as an empty map | ||
| */ | ||
| public StreamingClientProperties(Map<String, String> connectorConfig) { | ||
| // treat null config as empty config | ||
| if (connectorConfig == null) { | ||
| LOGGER.warn( | ||
| "Creating empty streaming client properties because given connector config was empty"); | ||
| connectorConfig = new HashMap<>(); | ||
| } | ||
|
|
||
| this.clientProperties = StreamingUtils.convertConfigForStreamingClient(connectorConfig); | ||
|
|
||
| this.clientName = | ||
| STREAMING_CLIENT_PREFIX_NAME | ||
| + connectorConfig.getOrDefault(Utils.NAME, DEFAULT_CLIENT_NAME); | ||
|
|
||
| // Override only if bdec version is explicitly set in config, default to the version set | ||
| // inside Ingest SDK | ||
| this.parameterOverrides = new HashMap<>(); | ||
| Optional<String> snowpipeStreamingBdecVersion = | ||
| Optional.ofNullable(connectorConfig.get(SNOWPIPE_STREAMING_FILE_VERSION)); | ||
| snowpipeStreamingBdecVersion.ifPresent( | ||
| overriddenValue -> { | ||
| LOGGER.info("Config is overridden for {} ", SNOWPIPE_STREAMING_FILE_VERSION); | ||
| parameterOverrides.put(BLOB_FORMAT_VERSION, overriddenValue); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Gets the loggable properties, see {@link | ||
| * StreamingClientProperties#LOGGABLE_STREAMING_CONFIG_PROPERTIES} | ||
| * | ||
| * @return A formatted string with the loggable properties | ||
| */ | ||
| public String getLoggableClientProperties() { | ||
| return this.clientProperties == null | this.clientProperties.isEmpty() | ||
|
There was a problem hiding this comment. can There was a problem hiding this comment. it shouldn't ever be null or empty, but I added the check just in case |
||
| ? "" | ||
| : this.clientProperties.entrySet().stream() | ||
| .filter( | ||
| propKvp -> | ||
| LOGGABLE_STREAMING_CONFIG_PROPERTIES.stream() | ||
| .anyMatch(propKvp.getKey().toString()::equalsIgnoreCase)) | ||
| .collect(Collectors.toList()) | ||
| .toString(); | ||
| } | ||
|
|
||
| /** | ||
| * Determines equality between StreamingClientProperties by only looking at the parsed | ||
| * clientProperties. This is used in {@link StreamingClientProvider} to determine equality in | ||
| * registered clients | ||
| * | ||
| * @param other other object to determine equality | ||
| * @return if the given object's clientProperties exists and is equal | ||
| */ | ||
| @Override | ||
| public boolean equals(Object other) { | ||
| return other.getClass().equals(StreamingClientProperties.class) | ||
| & ((StreamingClientProperties) other).clientProperties.equals(this.clientProperties); | ||
| } | ||
|
|
||
| /** | ||
| * Creates the hashcode for this object from the clientProperties. This is used in {@link | ||
| * StreamingClientProvider} to determine equality in registered clients | ||
| * | ||
| * @return the clientProperties' hashcode | ||
| */ | ||
| @Override | ||
| public int hashCode() { | ||
| return this.clientProperties.hashCode(); | ||
| } | ||
| } | ||
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.
Added this back (was removed in previous PR iterations) in case removing it causes concurrency issues with client naming