[FLINK-15740] Remove Deadline#timeLeft()

• Type: Improvement
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Fix Version/s: 1.20.0
• Component/s: API / DataStream, Tests
• Labels: auto-deprioritized-major pull-request-available
• Assignee: Unassigned
• Reporter: Chesnay Schepler
• Created: 23/Jan/20 13:52
• Updated: 11/Mar/24 12:44

Description

As shown in FLINK-13662, Deadline#timeLeft() is conceptually broken since there is no reliable way to call said method while ensuring that
a) the value is non-negative (desired since most time-based APIs reject negative values)
b) the value sign (+,-) corresponds to preceding calls to #hasTimeLeft()

 

As a result any usage of the following form is unreliable and obfuscating error messages.

while (deadline.hasTimeLeft()) {
	doSomething(deadline.timeLeft());
} 

 

All existing usage should be migrate to either

while (deadline.hasTimeLeft()) {
	doSomething();
} 

or

while (true) {
	doSomething(deadline.timeLeftIfAny());
}

Issue Links

• links to: GitHub Pull Request #10966
• links to: GitHub Pull Request #10998