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.

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

services: move classes with protobuf dependency into io.grpc.protobuf.services #8056

Merged
merged 21 commits into from Apr 17, 2021
Merged
Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
3375c1d
Move classes having protobuf dependency in io.grpc.services into io.g…
voidzcy Apr 7, 2021
2f5eb30
Migrate xds interop server's usage for HealthStatusManager.
voidzcy Apr 7, 2021
0436117
Creata a forwarding class for HealthCheckingLoadBalancerUtil to allow…
voidzcy Apr 7, 2021
d677c84
Merge branch 'master' of github.com:grpc/grpc-java into impl/clean_up…
voidzcy Apr 13, 2021
d8412ab
Keep channelz and binlog implementations in-place, while mark them as…
voidzcy Apr 13, 2021
c402bf9
Forward ProtoReflectionService.
voidzcy Apr 13, 2021
9989179
Fix bazel build.
voidzcy Apr 13, 2021
15fb5fc
Clean up package-info.java in services/protobuf.services.
voidzcy Apr 13, 2021
851628c
Keep tests for channelz and binlog implementations, as they are kept …
voidzcy Apr 13, 2021
b6a5c18
Restore unnecessary changes.
voidzcy Apr 15, 2021
c505f40
Change to forwarding by inheritance instead of by delegating.
voidzcy Apr 16, 2021
a9ce138
Forward with delegation, delete necessary abstract class forwarding.
voidzcy Apr 16, 2021
b592d20
Clean up bazel.
voidzcy Apr 16, 2021
1951bc2
Fix style.
voidzcy Apr 16, 2021
ba9fb8d
Do not extend public interface that is already accessible.
voidzcy Apr 16, 2021
6477050
Statically import constant.
voidzcy Apr 16, 2021
3f4dd94
Reestore excessive empty line change.
voidzcy Apr 16, 2021
1f5dcba
Fix interface reference.
voidzcy Apr 16, 2021
4dae3bb
Empty line.
voidzcy Apr 16, 2021
de38d17
Delete all unnecessary classes.
voidzcy Apr 16, 2021
0c282c1
Clean up bazel.
voidzcy Apr 16, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -30,9 +30,9 @@
import io.grpc.StatusRuntimeException;
import io.grpc.health.v1.HealthCheckResponse.ServingStatus;
import io.grpc.netty.NettyServerBuilder;
import io.grpc.protobuf.services.HealthStatusManager;
import io.grpc.protobuf.services.ProtoReflectionService;
import io.grpc.services.AdminInterface;
import io.grpc.services.HealthStatusManager;
import io.grpc.stub.StreamObserver;
import io.grpc.testing.integration.Messages.SimpleRequest;
import io.grpc.testing.integration.Messages.SimpleResponse;
Expand Down
12 changes: 10 additions & 2 deletions services/BUILD.bazel
Expand Up @@ -5,11 +5,16 @@ package(default_visibility = ["//visibility:public"])
java_library(
name = "binarylog",
srcs = [
"src/main/java/io/grpc/services/BinaryLogProvider.java",
"src/main/java/io/grpc/protobuf/services/BinaryLogProvider.java",
"src/main/java/io/grpc/protobuf/services/BinaryLogProviderImpl.java",
"src/main/java/io/grpc/services/BinaryLogProviderImpl.java",
"src/main/java/io/grpc/protobuf/services/BinaryLogSink.java",
"src/main/java/io/grpc/services/BinaryLogSink.java",
"src/main/java/io/grpc/protobuf/services/BinlogHelper.java",
"src/main/java/io/grpc/services/BinlogHelper.java",
"src/main/java/io/grpc/protobuf/services/InetAddressUtil.java",
"src/main/java/io/grpc/services/InetAddressUtil.java",
"src/main/java/io/grpc/protobuf/services/TempFileSink.java",
"src/main/java/io/grpc/services/TempFileSink.java",
],
deps = [
Expand All @@ -26,7 +31,9 @@ java_library(
java_library(
name = "channelz",
srcs = [
"src/main/java/io/grpc/protobuf/services/ChannelzProtoUtil.java",
"src/main/java/io/grpc/services/ChannelzProtoUtil.java",
"src/main/java/io/grpc/protobuf/services/ChannelzService.java",
"src/main/java/io/grpc/services/ChannelzService.java",
],
deps = [
Expand Down Expand Up @@ -66,7 +73,8 @@ java_library(
java_library(
name = "health",
srcs = [
"src/main/java/io/grpc/services/HealthServiceImpl.java",
"src/main/java/io/grpc/protobuf/services/HealthServiceImpl.java",
"src/main/java/io/grpc/protobuf/services/HealthStatusManager.java",
"src/main/java/io/grpc/services/HealthStatusManager.java",
],
deps = [
Expand Down
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package io.grpc.services;
package io.grpc.protobuf.services;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
Expand Down
@@ -0,0 +1,92 @@
/*
* Copyright 2018 The gRPC Authors
*
* 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 io.grpc.protobuf.services;

import com.google.common.base.Preconditions;
import io.grpc.CallOptions;
import io.grpc.ClientInterceptor;
import io.grpc.ServerInterceptor;
import java.io.IOException;
import java.util.concurrent.atomic.AtomicLong;
import javax.annotation.Nullable;

/**
* The default implementation of a {@link BinaryLogProvider}.
*/
class BinaryLogProviderImpl extends BinaryLogProvider {
// avoid using 0 because proto3 long fields default to 0 when unset
private static final AtomicLong counter = new AtomicLong(1);

private final BinlogHelper.Factory factory;
private final BinaryLogSink sink;

public BinaryLogProviderImpl() throws IOException {
this(new TempFileSink(), System.getenv("GRPC_BINARY_LOG_CONFIG"));
}

/**
* Deprecated and will be removed in a future version of gRPC.
*/
@Deprecated
public BinaryLogProviderImpl(BinaryLogSink sink) throws IOException {
this(sink, System.getenv("GRPC_BINARY_LOG_CONFIG"));
}

/**
* Creates an instance.
* @param sink ownership is transferred to this class.
* @param configStr config string to parse to determine logged methods and msg size limits.
* @throws IOException if initialization failed.
*/
public BinaryLogProviderImpl(BinaryLogSink sink, String configStr) throws IOException {
this.sink = Preconditions.checkNotNull(sink);
try {
factory = new BinlogHelper.FactoryImpl(sink, configStr);
} catch (RuntimeException e) {
sink.close();
// parsing the conf string may throw if it is blank or contains errors
throw new IOException(
"Can not initialize. The env variable GRPC_BINARY_LOG_CONFIG must be valid.", e);
}
}

@Nullable
@Override
public ServerInterceptor getServerInterceptor(String fullMethodName) {
BinlogHelper helperForMethod = factory.getLog(fullMethodName);
if (helperForMethod == null) {
return null;
}
return helperForMethod.getServerInterceptor(counter.getAndIncrement());
}

@Nullable
@Override
public ClientInterceptor getClientInterceptor(
String fullMethodName, CallOptions callOptions) {
BinlogHelper helperForMethod = factory.getLog(fullMethodName);
if (helperForMethod == null) {
return null;
}
return helperForMethod.getClientInterceptor(counter.getAndIncrement());
}

@Override
public void close() throws IOException {
sink.close();
}
}
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package io.grpc.services;
package io.grpc.protobuf.services;

import com.google.protobuf.MessageLite;
import io.grpc.ExperimentalApi;
Expand Down
53 changes: 53 additions & 0 deletions services/src/main/java/io/grpc/protobuf/services/BinaryLogs.java
@@ -0,0 +1,53 @@
/*
* Copyright 2018, gRPC Authors 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 io.grpc.protobuf.services;

import io.grpc.BinaryLog;
import io.grpc.ExperimentalApi;
import java.io.IOException;

@ExperimentalApi("https://github.com/grpc/grpc-java/issues/4017")
public final class BinaryLogs {
/**
* Creates a binary log that writes to a temp file. <b>Warning:</b> this implementation is
* not performance optimized, and RPCs will experience back pressure if disk IO does not keep
* up.
*/
public static BinaryLog createBinaryLog() throws IOException {
return new BinaryLogProviderImpl();
}

/**
* Deprecated and will be removed in a future version of gRPC.
*/
@Deprecated
public static BinaryLog createBinaryLog(BinaryLogSink sink) throws IOException {
return new BinaryLogProviderImpl(sink);
}

/**
* Creates a binary log with a custom {@link BinaryLogSink} for receiving the logged data,
* and a config string as defined by
* <a href="https://github.com/grpc/proposal/blob/master/A16-binary-logging.md">
* A16-binary-logging</a>.
*/
public static BinaryLog createBinaryLog(BinaryLogSink sink, String configStr) throws IOException {
return new BinaryLogProviderImpl(sink, configStr);
}

private BinaryLogs() {}
}