-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Brian Laub
committed
Jan 30, 2025
1 parent
538707f
commit 2a2d58f
Showing
6 changed files
with
173 additions
and
6 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
dialogue-core/src/main/java/com/palantir/dialogue/core/DeadlineAdvertisementChannel.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 @@ | ||
| /* | ||
| * (c) Copyright 2025 Palantir Technologies Inc. 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 com.palantir.dialogue.core; | ||
|
|
||
| import com.google.common.util.concurrent.ListenableFuture; | ||
| import com.palantir.deadlines.Deadlines; | ||
| import com.palantir.dialogue.Channel; | ||
| import com.palantir.dialogue.Endpoint; | ||
| import com.palantir.dialogue.Request; | ||
| import com.palantir.dialogue.Response; | ||
| import java.time.Duration; | ||
|
|
||
| final class DeadlineAdvertisementChannel implements Channel { | ||
|
|
||
| private final Channel delegate; | ||
| private final Duration readTimeout; | ||
|
|
||
| DeadlineAdvertisementChannel(Channel delegate, Duration readTimeout) { | ||
| this.delegate = delegate; | ||
| this.readTimeout = readTimeout; | ||
| } | ||
|
|
||
| @Override | ||
| public ListenableFuture<Response> execute(Endpoint endpoint, Request request) { | ||
| Request.Builder requestBuilder = Request.builder().from(request); | ||
| Deadlines.encodeToRequest(readTimeout, requestBuilder, RequestBuilderEncodingAdapter.INSTANCE); | ||
| return delegate.execute(endpoint, requestBuilder.build()); | ||
| } | ||
|
|
||
| private enum RequestBuilderEncodingAdapter implements Deadlines.RequestEncodingAdapter<Request.Builder> { | ||
| INSTANCE; | ||
|
|
||
| @Override | ||
| public void setHeader(Request.Builder builder, String headerName, String headerValue) { | ||
| builder.putHeaderParams(headerName, headerValue); | ||
| } | ||
| } | ||
| } |
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
109 changes: 109 additions & 0 deletions
109
dialogue-core/src/test/java/com/palantir/dialogue/core/DeadlineAdvertisementChannelTest.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,109 @@ | ||
| /* | ||
| * (c) Copyright 2025 Palantir Technologies Inc. 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 com.palantir.dialogue.core; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| import com.google.common.util.concurrent.Futures; | ||
| import com.palantir.deadlines.Deadlines; | ||
| import com.palantir.deadlines.Deadlines.RequestDecodingAdapter; | ||
| import com.palantir.deadlines.api.DeadlinesHttpHeaders; | ||
| import com.palantir.dialogue.Channel; | ||
| import com.palantir.dialogue.Request; | ||
| import com.palantir.dialogue.TestEndpoint; | ||
| import com.palantir.tracing.CloseableTracer; | ||
| import java.time.Duration; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Optional; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| class DeadlineAdvertisementChannelTest { | ||
|
|
||
| @Test | ||
| void adds_header_from_configured_read_timeout() { | ||
| try (CloseableTracer tracer = CloseableTracer.startSpan("test")) { | ||
| Duration readTimeout = Duration.ofSeconds(1); | ||
| List<Request> requests = new ArrayList<>(); | ||
| Channel delegate = (_endpoint, request) -> { | ||
| requests.add(request); | ||
| return Futures.immediateCancelledFuture(); | ||
| }; | ||
| Channel channel = new DeadlineAdvertisementChannel(delegate, readTimeout); | ||
| assertThat(channel.execute(TestEndpoint.GET, Request.builder().build())) | ||
| .isCancelled(); | ||
|
|
||
| assertThat(requests).singleElement().satisfies(request -> { | ||
| assertThat(request.headerParams().keySet()) | ||
| .singleElement() | ||
| .isEqualTo(DeadlinesHttpHeaders.EXPECT_WITHIN); | ||
| assertThat(request.headerParams().get(DeadlinesHttpHeaders.EXPECT_WITHIN)) | ||
| .singleElement() | ||
| .satisfies(value -> { | ||
| double nSeconds = Double.parseDouble(value); | ||
| Duration parsed = Duration.ofNanos((long) (nSeconds * 1e9d)); | ||
| assertThat(parsed).isEqualTo(readTimeout); | ||
| }); | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| void adds_header_from_remaining_deadline() { | ||
| try (CloseableTracer tracer = CloseableTracer.startSpan("test")) { | ||
| Duration readTimeout = Duration.ofSeconds(10); | ||
| List<Request> requests = new ArrayList<>(); | ||
| Channel delegate = (_endpoint, request) -> { | ||
| requests.add(request); | ||
| return Futures.immediateCancelledFuture(); | ||
| }; | ||
|
|
||
| // set deadline state for this trace to somethign less than configured read timeout | ||
| Request inboundRequest = Request.builder() | ||
| .putHeaderParams(DeadlinesHttpHeaders.EXPECT_WITHIN, "1") | ||
| .build(); | ||
| Deadlines.parseFromRequest(Optional.empty(), inboundRequest, Decoder.INSTANCE); | ||
|
|
||
| Channel channel = new DeadlineAdvertisementChannel(delegate, readTimeout); | ||
| assertThat(channel.execute(TestEndpoint.GET, Request.builder().build())) | ||
| .isCancelled(); | ||
|
|
||
| assertThat(requests).singleElement().satisfies(request -> { | ||
| assertThat(request.headerParams().keySet()) | ||
| .singleElement() | ||
| .isEqualTo(DeadlinesHttpHeaders.EXPECT_WITHIN); | ||
| assertThat(request.headerParams().get(DeadlinesHttpHeaders.EXPECT_WITHIN)) | ||
| .singleElement() | ||
| .satisfies(value -> { | ||
| double nSeconds = Double.parseDouble(value); | ||
| Duration parsed = Duration.ofNanos((long) (nSeconds * 1e9d)); | ||
| Duration maxAllowed = Duration.ofSeconds(1); | ||
| assertThat(parsed).isLessThanOrEqualTo(maxAllowed); | ||
| }); | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| private enum Decoder implements RequestDecodingAdapter<Request> { | ||
| INSTANCE; | ||
|
|
||
| @Override | ||
| public Optional<String> getFirstHeader(Request request, String headerName) { | ||
| return request.headerParams().get(headerName).stream().findFirst(); | ||
| } | ||
| } | ||
| } |
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