[Django]-Propagate http abort/close from nginx to uwsgi / Django

by

13đź‘Ť

My use case is that I have an application where people page through some ajax results very quickly, and so if the quickly page through I abort the pending ajax request for the page that they skipped, this keeps the client clean and efficient.

Aborting an AJAX request on the client side is done through XMLHttpRequest.abort(). If the request has not yet been sent out when abort() is called, then the request won’t go out. But if the request has been sent, the server won’t know that the request has been aborted. The connection won’t be closed, there won’t be any message sent to the server, nothing. If you want the server to know that a request is no longer needed, you basically need to come up with a way to identify requests so that when you make the initial request you get an identifier for it. Then, through another AJAX request you could tell the server that an earlier request should be cancelled. (If you search questions about abort() like this one and search for “server” you’ll find explanations saying the same.)

Note that uwsgi_ignore_client_abort is something that deals with connection closures at the TCP level. That’s a different thing from aborting an AJAX request. There is generally no action you can take in JavaScript that will entail closing a TCP connection. The browser optimizes the creation and destruction of connections to suit its needs. Just now, I did this:

  1. I used lsof to check whether any process had a connection to example.com. There were none. (lsof is a *nix utility that allows listing open files. Network connections are “files” in *nix.)

  2. I opened a page to example.com in Chrome. lsof showed the connection and the process that opened it.

  3. Then I closed the page.

  4. I polled with lsof to see if the connection I identified earlier was still opened. It stayed open for about one minute after I closed the page even though there was no real need to keep the connection open.

And there’s no amount of fiddling with uswgi settings that will make it be aware of aborts performed through XMLHttpRequest.abort()

The use-case scenario you gave was one where users were paging fast through some results. I can see two possibilities for the description given in the question:

  1. The user waits for a refresh before paging further. For instance, Alice is looking through an list of user names sorted alphabetically for user “Zeno” and each time a new page is shown, she sees the name is not there and pages down. In this case, there’s nothing to abort because the user’s action is dependent on the request having been handled first. (The user has to see the new page before making a decision.)

  2. The user just pages down without waiting for a refresh. Alice again is looking for “Zeno” but she figures it’s going to be on the last page so click, click, click she goes. In this case, you can debounce the requests made to the server. Then the next page button is pressed, increment the number of the page that should be shown to the user but don’t send the request right away. Instead, you wait for a small delay after the user ceases clicking the button to then send the request with final page number and so you make one request instead of a dozen. Here is an example of a debounce performed for a DataTables search.

👤Louis

6đź‘Ť

Now obviously there may be certain pages, where I don’t want the request to be prematurely aborted for any reason.

This is precisely the problem behind taking this one way or the other.

  • Obviously, you may not want to continue spending system resources processing a connection that has since been aborted, e.g., an expensive search operation.

  • But then maybe the connection was important enough that it still has to be processed even if the client has disconnected.

    • E.g., the very same expensive search operation, but one that’s actually not client-specific, and will be cached by nginx for all subsequent clients, too.

    • Or maybe an operation that modifies the state of your application — you clearly wouldn’t want to have your application to have an inconsistent state!

As mentioned, the problem is with uWSGI, not with NGINX. However, you cannot have uWSGI automatically decide what was your intention, without you revealing such intention yourself to uWSGI.

And how exactly will you reveal your intention in your code? A whole bunch of programming languages don’t really support multithreaded and/or asynchronous programming models, which makes it entirely non-trivial to cancel operations.

As such, there is no magic solution here. Even the concurrency-friendly programming languages like Golang are having issues around the WithCancel context — you may have to pass it around in every function call that could possibly block, making the code very ugly.

Are you already doing the above context passing in Django? If not, then the solution is ugly but very simple — any time you can clearly abort the request, check whether the client is still connected with uwsgi.is_connected(uwsgi.connection_fd()):

👤cnst

Leave a comment