Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace key in dynamic endpoint #209

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Replace key in dynamic endpoint #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/main/java/io/aiven/kafka/connect/http/recordsender/SingleRecordSender.java
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sender needs to know if the URL is configured to inject a key or not. Otherwise, it will wastefully transform a key in to a string, and eventually not use it.
Consider adding a flag that is passed from the configuration to have this condition.

Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ protected SingleRecordSender(final HttpSender httpSender) {
public void send(final Collection<SinkRecord> records) {
for (final SinkRecord record : records) {
final String body = recordValueConverter.convert(record);
httpSender.send(body);
httpSender.send(body, record.key().toString());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider having a recordKeyConverter -- it should only convert known types (e.g. String, Numbers) into String to avoid messing with complex/unexpected conversions.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, what happens when the key is null? Should it use an empty string? fail? use a fallback value?

}
}

@Override
public void send(final SinkRecord record) {
final String body = recordValueConverter.convert(record);
httpSender.send(body);
httpSender.send(body, record.key().toString());
}
}
20 changes: 20 additions & 0 deletions src/main/java/io/aiven/kafka/connect/http/sender/AbstractHttpSender.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,26 @@ protected AbstractHttpSender(
this.httpClient = Objects.requireNonNull(httpClient);
}

public final HttpResponse<String> send(final String body, final String key) {
if (this.config.httpUri().toString().contains("{key}")) {
final var configOriginalMap = this.config.originalsStrings();
final String genericUrl = configOriginalMap.get("http.url");
final String newUrl = genericUrl.replace("{key}", key);
configOriginalMap.replace("http.url", newUrl);
log.debug("Key replaced in URL. New URL: {}", newUrl);

final var newConfig = new HttpSinkConfig(configOriginalMap);
log.debug("Sending request with body: {}", body);
Comment on lines +52 to +59
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of modifying the configs on every execution, I'd prefer a more structured approach to flag this.
Consider:

  • adding a new config, e.g. http.url.inject.key.enable=true/false defaults: false.
  • maybe have a fallback value to use it when key is null or cannot be converted, e.g. http.url.inject.key.fallback=string defaults: null -- if value cannot be converted or null, then fail at runtime.
  • delegate to the config on how to replace the key with the url by adding a new config.httpUri(keySupplier.get())


final var requestBuilder =
httpRequestBuilder.build(newConfig).POST(HttpRequest.BodyPublishers.ofString(body));
return sendWithRetries(requestBuilder, HttpResponseHandler.ON_HTTP_ERROR_RESPONSE_HANDLER,
config.maxRetries());
} else {
return send(body);
}
}

public final HttpResponse<String> send(final String body) {
final var requestBuilder =
httpRequestBuilder.build(config).POST(HttpRequest.BodyPublishers.ofString(body));
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/io/aiven/kafka/connect/http/sender/HttpSender.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,6 @@

public interface HttpSender {
HttpResponse<String> send(final String body);

HttpResponse<String> send(final String body, String key);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider passing the key as a function instead of a value:

Suggested change
HttpResponse<String> send(final String body, String key);
HttpResponse<String> send(final String body, Supplier<String> keySupplier);

}