akka/akka-http

Add onRequestTimeout Directive

Open

#2,015 opened on May 15, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Scala (598 forks)batch import
1 - triagedhelp wantedt:routing

Repository metrics

Stars
 (1,311 stars)
PR merge metrics
 (Avg merge 1d 10h) (2 merged PRs in 30d)

Description

It would be nice if we had a directive that allowed us to side-effect when a server request timeout occurs. Currently we can do something on withRequestTimeoutResponse, but that requires us to supply a response rather than let the timeout handling happen elsewhere. An example of when this is desirable would be when an external request results in client requests or other streams being run that need to be consumed to supply a response to the request. In this case it's desirable to consume/killswitch those streams when the request times out.

Contributor guide

Research direction
Examine the existing `withRequestTimeoutResponse` directive and its implementation. Understand how request timeouts are handled in Akka HTTP. Then implement a new `onRequestTimeout` directive that allows side effects without requiring a response body. Use similar mechanisms to trigger a callback when timeout occurs.
Tech stack
scala
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ScalaAkka HTTP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60