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

Add configuration support for OpenSergoClient #22 #30

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

Add configuration support for OpenSergoClient #22 #30

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
26 changes: 20 additions & 6 deletions src/main/java/io/opensergo/OpenSergoClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
package io.opensergo;

import io.grpc.ManagedChannel;
import io.grpc.ManagedChannelBuilder;
import io.grpc.netty.NettyChannelBuilder;
import io.grpc.stub.StreamObserver;
import io.opensergo.log.OpenSergoLogger;
import io.opensergo.proto.transport.v1.OpenSergoUniversalTransportServiceGrpc;
Expand All @@ -35,6 +35,7 @@

/**
* @author Eric Zhao
* @author Jax4Li
*/
public class OpenSergoClient implements AutoCloseable {

Expand Down Expand Up @@ -78,17 +79,23 @@ public OpenSergoClient build() {
}

public OpenSergoClient(String host, int port) {
// TODO: improve default config logic here.
this(host, port, new OpenSergoClientConfig());
}

public OpenSergoClient(String host, int port, OpenSergoClientConfig clientConfig) {
checkClientConfig(clientConfig);
// TODO: support TLS
this.clientConfig = clientConfig;
this.channel = ManagedChannelBuilder.forAddress(host, port)
.usePlaintext()
.build();
NettyChannelBuilder channelBuilder = NettyChannelBuilder.forAddress(host, port)
.maxInboundMessageSize(clientConfig.getMaxInboundMessageSize())
.maxRetryAttempts(clientConfig.getMaxRetryAttempts())
.maxHedgedAttempts(clientConfig.getMaxHedgedAttempts())
.retryBufferSize(clientConfig.getRetryBufferSize())
.perRpcBufferLimit(clientConfig.getPerRpcBufferLimit())
.idleTimeout(clientConfig.getIdleTimeoutMillis(), TimeUnit.MILLISECONDS)
.keepAliveTime(clientConfig.getKeepAliveTimeMillis(), TimeUnit.MILLISECONDS)
.keepAliveTimeout(clientConfig.getKeepAliveTimeoutMillis(), TimeUnit.MILLISECONDS);
this.channel = clientConfig.isServerSideTls() || clientConfig.isClientSideTls()?
channelBuilder.sslContext(clientConfig.newSslContext()).build() : channelBuilder.usePlaintext().build();
this.transportGrpcStub = OpenSergoUniversalTransportServiceGrpc.newStub(channel);
this.configCache = new SubscribedConfigCache();
this.subscribeRegistry = new SubscribeRegistry();
Expand All @@ -97,6 +104,13 @@ public OpenSergoClient(String host, int port, OpenSergoClientConfig clientConfig

private void checkClientConfig(OpenSergoClientConfig clientConfig) {
AssertUtils.assertNotNull(clientConfig, "clientConfig cannot be null");
if (clientConfig.isServerSideTls()){
AssertUtils.assertNotNull(clientConfig.getServerTrustCertFile(), "serverTrustCertFile cannot be null");
}
if (clientConfig.isClientSideTls()){
AssertUtils.assertNotNull(clientConfig.getClientCertChainFile(), "clientCertChainFile cannot be null");
AssertUtils.assertNotNull(clientConfig.getClientPrivateKeyFile(), "clientPrivateKeyFile cannot be null");
}
}

public void start() throws Exception {
Expand Down
212 changes: 211 additions & 1 deletion src/main/java/io/opensergo/OpenSergoClientConfig.java
View file
Open in desktop
Copy link
Collaborator

@jnan806 jnan806 Mar 29, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

@Jax4Li @sczyh30
I have a question that, need we to separate the network-communication-config and OpenSergo-self-config in OpenSergoClientConfig with MemberClasses.

是否需要在 OpenSergoClientConfig 中定义内部类来区分 网络通讯框架的 config 和 OpenSergo 自身的 config。

Copy link
Contributor Author

Choose a reason for hiding this comment

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

可能是有必要的，会不会存在这样的情况OpenSergoClientConfig除了包含网络通讯框架的 config 还会有其他的？你们觉得呢

Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,220 @@
*/
package io.opensergo;

import io.grpc.internal.GrpcUtil;
import io.grpc.internal.ManagedChannelImplBuilder;
import io.grpc.netty.GrpcSslContexts;
import io.grpc.netty.NettyChannelBuilder;
import io.netty.handler.ssl.SslContext;
import io.netty.handler.ssl.SslContextBuilder;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.net.ssl.SSLException;
import java.io.File;
import java.util.concurrent.TimeUnit;

/**
* @author Jiangnan Jia
* @author Eric Zhao
* @author Jax4Li
*/
public class OpenSergoClientConfig {
// TODO: add config attribute
private final int maxInboundMessageSize;
private final int maxRetryAttempts;
private final int maxHedgedAttempts;
private final long retryBufferSize;
private final long perRpcBufferLimit;
private final long idleTimeoutMillis;
private final long keepAliveTimeMillis;
private final long keepAliveTimeoutMillis;

private final boolean serverSideTls;
private final File serverTrustCertFile;
private final boolean clientSideTls;
private final File clientCertChainFile;
private final File clientPrivateKeyFile;
private final String clientPrivateKeyPwd;

private OpenSergoClientConfig(Builder builder) {
this.maxInboundMessageSize = builder.maxInboundMessageSize;
this.maxRetryAttempts = builder.maxRetryAttempts;
this.maxHedgedAttempts = builder.maxHedgedAttempts;
this.retryBufferSize = builder.retryBufferSize;
this.perRpcBufferLimit = builder.perRpcBufferLimit;
this.idleTimeoutMillis = builder.idleTimeoutMillis;
this.keepAliveTimeMillis = builder.keepAliveTimeMillis;
this.keepAliveTimeoutMillis = builder.keepAliveTimeoutMillis;
this.serverTrustCertFile = builder.serverTrustCertFile;
this.clientCertChainFile = builder.clientCertChainFile;
this.clientPrivateKeyFile = builder.clientPrivateKeyFile;
this.clientPrivateKeyPwd = builder.clientPrivateKeyPwd;
this.serverSideTls = builder.serverSideTls;
this.clientSideTls = builder.clientSideTls;
}

public OpenSergoClientConfig() {
this(new Builder());
}

public SslContext newSslContext(){
SslContextBuilder sslContextBuilder = GrpcSslContexts.forClient();
if (this.isServerSideTls()){
sslContextBuilder.trustManager(this.getServerTrustCertFile());
}
if (this.isClientSideTls()){
sslContextBuilder.keyManager(this.getClientCertChainFile(),
this.getClientPrivateKeyFile(), this.getClientPrivateKeyPwd());
}
try {
return sslContextBuilder.build();
} catch (SSLException e) {
throw new IllegalArgumentException(e.getMessage());
}
}

public int getMaxInboundMessageSize() {
return maxInboundMessageSize;
}

public int getMaxRetryAttempts() {
return maxRetryAttempts;
}

public int getMaxHedgedAttempts() {
return maxHedgedAttempts;
}

public long getRetryBufferSize() {
return retryBufferSize;
}

public long getPerRpcBufferLimit() {
return perRpcBufferLimit;
}

public long getIdleTimeoutMillis() {
return idleTimeoutMillis;
}

public long getKeepAliveTimeMillis() {
return keepAliveTimeMillis;
}

public long getKeepAliveTimeoutMillis() {
return keepAliveTimeoutMillis;
}

public File getServerTrustCertFile() {
return serverTrustCertFile;
}

public File getClientCertChainFile() {
return clientCertChainFile;
}

public File getClientPrivateKeyFile() {
return clientPrivateKeyFile;
}

public String getClientPrivateKeyPwd() {
return clientPrivateKeyPwd;
}

public boolean isServerSideTls() {
return serverSideTls;
}

public boolean isClientSideTls() {
return clientSideTls;
}

public static class Builder {
private boolean serverSideTls;
private boolean clientSideTls;
/** The file should include a collection of X.509 certificates in PEM/CRT format that can be used for verification of the remote server's certificate. */
private File serverTrustCertFile;
/** An X.509 certificate chain file in PEM/CRT format is from client. */
private File clientCertChainFile;
/** A PKCS#8 private key file in PEM format is from client.*/
private File clientPrivateKeyFile;
/** The password of the keyFile, or null if it's not password-protected*/
private String clientPrivateKeyPwd;

/** @see io.grpc.internal.AbstractManagedChannelImplBuilder#maxInboundMessageSize */
private int maxInboundMessageSize = GrpcUtil.DEFAULT_MAX_MESSAGE_SIZE;
/** @see io.grpc.internal.ManagedChannelImplBuilder#maxRetryAttempts */
private int maxRetryAttempts = 5;
/** @see ManagedChannelImplBuilder#maxHedgedAttempts */
private int maxHedgedAttempts = 5;
/** @see ManagedChannelImplBuilder#retryBufferSize */
private long retryBufferSize = 1L << 24;
/** @see ManagedChannelImplBuilder#perRpcBufferLimit */
private long perRpcBufferLimit = 1L << 20;
/** @see ManagedChannelImplBuilder#IDLE_MODE_DEFAULT_TIMEOUT_MILLIS */
private long idleTimeoutMillis = TimeUnit.MINUTES.toMillis(30);
/** @see GrpcUtil#DEFAULT_KEEPALIVE_TIMEOUT_NANOS */
private long keepAliveTimeoutMillis = TimeUnit.SECONDS.toMillis(20);
/** @see NettyChannelBuilder#keepAliveTimeNanos */
private long keepAliveTimeMillis = TimeUnit.NANOSECONDS.toMillis(GrpcUtil.KEEPALIVE_TIME_NANOS_DISABLED);

public OpenSergoClientConfig.Builder serverSideTls(@Nonnull File serverTrustCertFile) {
this.serverSideTls = true;
this.serverTrustCertFile = serverTrustCertFile;
return this;
}

public OpenSergoClientConfig.Builder clientSideTls(@Nonnull File clientCertChainFile, @Nonnull File clientPrivateKeyFile,
@Nullable String clientPrivateKeyPwd) {
this.clientSideTls = true;
this.clientCertChainFile = clientCertChainFile;
this.clientPrivateKeyFile = clientPrivateKeyFile;
this.clientPrivateKeyPwd = clientPrivateKeyPwd;
return this;
}

public OpenSergoClientConfig.Builder maxInboundMessageSize(int maxInboundMessageSize) {
this.maxInboundMessageSize = maxInboundMessageSize;
return this;
}

public OpenSergoClientConfig.Builder maxRetryAttempts(int maxRetryAttempts) {
this.maxRetryAttempts = maxRetryAttempts;
return this;
}

public OpenSergoClientConfig.Builder maxHedgedAttempts(int maxHedgedAttempts) {
this.maxHedgedAttempts = maxHedgedAttempts;
return this;
}

public OpenSergoClientConfig.Builder retryBufferSize(long retryBufferSize) {
this.retryBufferSize = retryBufferSize;
return this;
}

public OpenSergoClientConfig.Builder perRpcBufferLimit(long perRpcBufferLimit) {
this.perRpcBufferLimit = perRpcBufferLimit;
return this;
}

public OpenSergoClientConfig.Builder idleTimeoutMillis(long idleTimeoutMillis) {
this.idleTimeoutMillis = idleTimeoutMillis;
return this;
}

public OpenSergoClientConfig.Builder keepAliveTimeMillis(long keepAliveTimeMillis) {
this.keepAliveTimeMillis = keepAliveTimeMillis;
return this;
}

public OpenSergoClientConfig.Builder keepAliveTimeoutMillis(long keepAliveTimeoutMillis) {
this.keepAliveTimeoutMillis = keepAliveTimeoutMillis;
return this;
}

public OpenSergoClientConfig build() {
return new OpenSergoClientConfig(this);
}
}
}