falconry/falcon

ASGI: Add affordances and recipe for long-polling

Open

#1,808 opened on Dec 12, 2020

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Python (9,293 stars) (925 forks)batch import
documentationenhancementgood first issueneeds contributor

Description

The 3.0 ASGI implementation already affords long-polling, but it would be useful to provide a recipe to demonstrate the pattern in the context of a Falcon app.

Also, for the sake of efficiency, we may want to provide a req.wait_disconnect() or similar method that can be executed in a background task within a responder. The responder could then use this in order to detect if it should abandon a long-poll early in the case that the client bails out. This is similar to what asgi.App does when streaming SSE's (using watch_disconnect().

Contributor guide

Tech stack
pythonrest api
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Python experienceFalcon basicsASGI conceptsLong polling patterns
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Review the existing ASGI implementation in Falcon, particularly the 'asgi.App' class and its 'watch disconnect' method. Examine the issue comments for further design discussions. Determine the signature and behavior of a proposed 'req.wait disconnect()' method and document a recipe for implementing long polling in a Falcon application.
ASGI: Add affordances and recipe for long-polling · falconry/falcon#1808 | Good First Issue