Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
gcp-observability: implement exclusion of cloud backend RPCs for all …
…3 signals (#9427) (#9436) * gcp-observability: implement exclusion of cloud backend RPCs for all 3 signals by using a ConditionalClientInterceptor that conditionally delegates
- Loading branch information
1 parent
7bdca0c
commit db3dd01
Showing
7 changed files
with
250 additions
and
18 deletions.
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
52 changes: 52 additions & 0 deletions
52
...ty/src/main/java/io/grpc/gcp/observability/interceptors/ConditionalClientInterceptor.java
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,52 @@ | ||
| /* | ||
| * Copyright 2022 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.gcp.observability.interceptors; | ||
|
|
||
| import static com.google.common.base.Preconditions.checkNotNull; | ||
|
|
||
| import io.grpc.CallOptions; | ||
| import io.grpc.Channel; | ||
| import io.grpc.ClientCall; | ||
| import io.grpc.ClientInterceptor; | ||
| import io.grpc.Internal; | ||
| import io.grpc.MethodDescriptor; | ||
| import java.util.function.BiPredicate; | ||
|
|
||
| /** | ||
| * A client interceptor that conditionally calls a delegated interceptor. | ||
| */ | ||
| @Internal | ||
| public final class ConditionalClientInterceptor implements ClientInterceptor { | ||
|
|
||
| private final ClientInterceptor delegate; | ||
| private final BiPredicate<MethodDescriptor<?, ?>, CallOptions> predicate; | ||
|
|
||
| public ConditionalClientInterceptor(ClientInterceptor delegate, | ||
| BiPredicate<MethodDescriptor<?, ?>, CallOptions> predicate) { | ||
| this.delegate = checkNotNull(delegate, "delegate"); | ||
| this.predicate = checkNotNull(predicate, "predicate"); | ||
| } | ||
|
|
||
| @Override | ||
| public <ReqT, RespT> ClientCall<ReqT, RespT> interceptCall(MethodDescriptor<ReqT, RespT> method, | ||
| CallOptions callOptions, Channel next) { | ||
| if (!predicate.test(method, callOptions)) { | ||
| return next.newCall(method, callOptions); | ||
| } | ||
| return delegate.interceptCall(method, callOptions, next); | ||
| } | ||
| } |
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
89 changes: 89 additions & 0 deletions
89
...rc/test/java/io/grpc/gcp/observability/interceptors/ConditionalClientInterceptorTest.java
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,89 @@ | ||
| /* | ||
| * Copyright 2022 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.gcp.observability.interceptors; | ||
|
|
||
| import static com.google.common.truth.Truth.assertThat; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.Mockito.doReturn; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.never; | ||
| import static org.mockito.Mockito.verify; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import io.grpc.CallOptions; | ||
| import io.grpc.Channel; | ||
| import io.grpc.ClientCall; | ||
| import io.grpc.ClientInterceptor; | ||
| import io.grpc.MethodDescriptor; | ||
| import io.grpc.MethodDescriptor.MethodType; | ||
| import java.util.function.BiPredicate; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
| import org.mockito.Mock; | ||
| import org.mockito.MockitoAnnotations; | ||
|
|
||
| /** | ||
| * Tests for {@link ConditionalClientInterceptor}. | ||
| */ | ||
| @RunWith(JUnit4.class) | ||
| public class ConditionalClientInterceptorTest { | ||
|
|
||
| private ConditionalClientInterceptor conditionalClientInterceptor; | ||
| @Mock private ClientInterceptor delegate; | ||
| @Mock private BiPredicate<MethodDescriptor<?, ?>, CallOptions> predicate; | ||
| @Mock private Channel channel; | ||
| @Mock private ClientCall<?, ?> returnedCall; | ||
| private MethodDescriptor<?, ?> method; | ||
|
|
||
| @Before | ||
| @SuppressWarnings("unchecked") | ||
| public void setUp() throws Exception { | ||
| MockitoAnnotations.initMocks(this); | ||
| conditionalClientInterceptor = new ConditionalClientInterceptor( | ||
| delegate, predicate); | ||
| method = MethodDescriptor.newBuilder().setType(MethodType.UNARY) | ||
| .setFullMethodName("service/method") | ||
| .setRequestMarshaller(mock(MethodDescriptor.Marshaller.class)) | ||
| .setResponseMarshaller(mock(MethodDescriptor.Marshaller.class)) | ||
| .build(); | ||
| } | ||
|
|
||
| @Test | ||
| @SuppressWarnings("unchecked") | ||
| public void predicateFalse() { | ||
| when(predicate.test(any(MethodDescriptor.class), any(CallOptions.class))).thenReturn(false); | ||
| doReturn(returnedCall).when(channel).newCall(method, CallOptions.DEFAULT); | ||
| ClientCall<?, ?> clientCall = conditionalClientInterceptor.interceptCall(method, | ||
| CallOptions.DEFAULT, channel); | ||
| assertThat(clientCall).isSameInstanceAs(returnedCall); | ||
| verify(delegate, never()).interceptCall(any(MethodDescriptor.class), any(CallOptions.class), | ||
| any(Channel.class)); | ||
| } | ||
|
|
||
| @Test | ||
| @SuppressWarnings("unchecked") | ||
| public void predicateTrue() { | ||
| when(predicate.test(any(MethodDescriptor.class), any(CallOptions.class))).thenReturn(true); | ||
| doReturn(returnedCall).when(delegate).interceptCall(method, CallOptions.DEFAULT, channel); | ||
| ClientCall<?, ?> clientCall = conditionalClientInterceptor.interceptCall(method, | ||
| CallOptions.DEFAULT, channel); | ||
| assertThat(clientCall).isSameInstanceAs(returnedCall); | ||
| verify(channel, never()).newCall(any(MethodDescriptor.class), any(CallOptions.class)); | ||
| } | ||
| } |
Oops, something went wrong.