Skip to content

Fix useragent for grpc #138

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

Merged
merged 2 commits into from
Jun 26, 2024
Merged

Fix useragent for grpc #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89e9a91
fix useragent for grpc
rohanshah18 Jun 26, 2024
f521ff2
remove getUserAgentGrpc()
rohanshah18 Jun 26, 2024
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
15 changes: 3 additions & 12 deletions src/main/java/io/pinecone/configs/PineconeConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,20 +202,11 @@ public void validate() {
* @return The user agent string.
*/
public String getUserAgent() {
return buildUserAgent("pineconeClientVersion");
return buildUserAgent();
}

/**
* Builds the user agent string for the Pinecone client's gRPC requests.
*
* @return The user agent string for gRPC requests.
*/
public String getUserAgentGrpc() {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

removed this method since netty-java-grpc/ is already appended to the user-agent string

return buildUserAgent("pineconeClientVersion[grpc]");
}

private String buildUserAgent(String clientId) {
String userAgent = String.format("lang=java; %s=%s", clientId, "v1.2.1");
private String buildUserAgent() {
String userAgent = String.format("lang=java; %s=%s", "pineconeClientVersion", "v1.2.1");
if (this.getSourceTag() != null && !this.getSourceTag().isEmpty()) {
userAgent += "; source_tag=" + this.getSourceTag();
}
Expand Down
10 changes: 5 additions & 5 deletions src/main/java/io/pinecone/configs/PineconeConnection.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ public PineconeConnection(PineconeConfig config) {
if (config.getHost() == null || config.getHost().isEmpty()) {
throw new PineconeValidationException("Index-name or host is required for data plane operations");
}
channel = buildChannel(config.getHost());
channel = buildChannel();
}
initialize();
}
Expand Down Expand Up @@ -134,14 +134,15 @@ private void onConnectivityStateChanged() {
channel.getState(false), channel);
}

private ManagedChannel buildChannel(String host) {
String endpoint = formatEndpoint(host);
private ManagedChannel buildChannel() {
String endpoint = formatEndpoint(config.getHost());
NettyChannelBuilder builder = NettyChannelBuilder.forTarget(endpoint);

try {
builder = builder.overrideAuthority(endpoint)
.negotiationType(NegotiationType.TLS)
.sslContext(GrpcSslContexts.forClient().build());
.sslContext(GrpcSslContexts.forClient().build())
.userAgent(config.getUserAgent());

if(config.getProxyConfig() != null) {
ProxyDetector proxyDetector = getProxyDetector();
Expand Down Expand Up @@ -169,7 +170,6 @@ private ProxyDetector getProxyDetector() {
private static Metadata assembleMetadata(PineconeConfig config) {
Metadata metadata = new Metadata();
metadata.put(Metadata.Key.of("api-key", Metadata.ASCII_STRING_MARSHALLER), config.getApiKey());
metadata.put(Metadata.Key.of("User-Agent", Metadata.ASCII_STRING_MARSHALLER), config.getUserAgentGrpc());
return metadata;
}

Expand Down
12 changes: 0 additions & 12 deletions src/test/java/io/pinecone/PineconeConfigTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,25 +33,13 @@ public void testGetUserAgent() {
assertEquals(config.getUserAgent(), "lang=java; pineconeClientVersion=" + pineconeClientVersion);
}

@Test
public void testGetUserAgentGrpc() {
PineconeConfig config = new PineconeConfig("testApiKey");
assertEquals(config.getUserAgentGrpc(), "lang=java; pineconeClientVersion[grpc]=" + pineconeClientVersion);
}
@Test
public void testGetUserAgentWithSourceTag() {
PineconeConfig config = new PineconeConfig("testApiKey");
config.setSourceTag("testSourceTag");
assertEquals(config.getUserAgent(), "lang=java; pineconeClientVersion=" + pineconeClientVersion + "; source_tag=testsourcetag");
}

@Test
public void testGetUserAgentGrpcWithSourceTag() {
PineconeConfig config = new PineconeConfig("testApiKey");
config.setSourceTag("testSourceTag");
assertEquals(config.getUserAgentGrpc(), "lang=java; pineconeClientVersion[grpc]=" + pineconeClientVersion + "; source_tag=testsourcetag");
}

@Test
public void testSourceTagIsNormalized() {
PineconeConfig config = new PineconeConfig("testApiKey");
Expand Down