set deadlines on outbound requests

[bjlaub]

Before this PR

No Expect-Within header is added to outbound requests

After this PR

Adds the deadlines-java library and utilizes it to set Expect-Within headers on outbound requests.

This change adds a DeadlineAdvertisementChannel which calls Deadlines.encodeToRequest to set an Expect-Within header equal to the configured socket read timeout for the client, or a remaining deadline read from a TraceLocal per the implementation in deadlines-java (whichever is smaller).

deadlines-java does not currently doe any enforcement on deadline expiration, and instead only reports metrics when a deadline is exceeded before sending an outbound request.

==COMMIT_MSG==
set deadlines on outbound requests
==COMMIT_MSG==

Possible downsides?

[changelog-app]

Generate changelog in changelog/@unreleased

What do the change types mean?

• feature: A new feature of the service.
• improvement: An incremental improvement in the functionality or operation of the service.
• fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
• break: Has the potential to break consumers of this service's API, inclusive of both Palantir services
  and external consumers of the service's API (e.g. customer-written software or integrations).
• deprecation: Advertises the intention to remove service functionality without any change to the
  operation of the service itself.
• manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration,
  performing database surgery, ...) at the time of upgrade for it to succeed.
• migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?

• ❗The break and manual task changelog types will result in a major release!
• 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
• ✨ All others will result in a minor version release.

Type

• Feature
• Improvement
• Fix
• Break
• Deprecation
• Manual task
• Migration

Description

set deadlines on outbound requests

Check the box to generate changelog(s)

• Generate changelog entry

[bjlaub]

are there other places we need to create one of these?

[carterkozak]

There shouldn't be -- this should do the trick! This position looks great because executes after the queues and retrying channels so that it will be re-applied on each request with an updated Expect-With value

[carterkozak]

There are a couple places which set a read timeout value of zero expecting it to be infinite. We handle this case in the apache httpclient shim here:

dialogue/dialogue-apache-hc5-client/src/main/java/com/palantir/dialogue/hc5/ApacheHttpClientChannels.java

Lines 641 to 648 in f4915fc

	if (socketTimeoutMillis == 0) {
	// https://issues.apache.org/jira/browse/HTTPCLIENT-2099
	log.debug(
	"Working around HTTPCLIENT-2099 by using a 1 day socket "
	+ "timeout instead of zero (unlimited). Client: {}",
	SafeArg.of("client", clientName));
	socketTimeoutMillis = Duration.ofDays(1).toMillis();
	}

I think we'll need to handle that case in the DeadlineAdvertisementChannel

[bjlaub]

👍 fixed!

[autorelease3]

Released 5.1.0