Improve callable function for long running requests. #1635
+306
−117
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In #1634, we introduced new API to return response chunks for callable functions. This means that callable function response my be long-running.
To ensure that long-running requests are handled well, we are adding 2 new features:
heartbeat: Some network proxies may close request connection when no response data is sent for some time interval. By default, callable function will send a heartbeat ping every 30 seconds. Our client SDKs will ignore these pings. Users can disable heartbeat for streaming response by setting
heartbeatSeconds
configuration tonull
.AbortSignal:
response
object of the callable handler will now includesignal
property which the developer can use to check and see if a client connection has been dropped. They can forward this signal property tofetch
-like APIs so that underlying calls would be terminated properly.e.g.