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 (925 forks)batch import
documentationenhancementgood first issueneeds contributor

Repository metrics

Stars
 (9,293 stars)
PR merge metrics
 (Avg merge 2d 7h) (9 merged PRs in 30d)

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

Research direction
Examine current ASGI long polling implementation in Falcon's codebase and design a `wait disconnect` method similar to `watch disconnect` used in SSE streaming.
Tech stack
python
Domain
backend
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.
1-3 hours
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
PythonASGI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50