2017-07-21 06:55:25 +02:00
|
|
|
import atexit
|
|
|
|
|
2017-11-16 00:53:11 +01:00
|
|
|
import tornado.web
|
2016-11-27 04:56:26 +01:00
|
|
|
from django.conf import settings
|
|
|
|
|
2017-11-16 00:53:11 +01:00
|
|
|
from zerver.lib.queue import get_queue_client
|
2020-06-11 00:54:34 +02:00
|
|
|
from zerver.tornado import autoreload
|
2016-11-27 04:56:26 +01:00
|
|
|
from zerver.tornado.handlers import AsyncDjangoHandler
|
|
|
|
|
2020-06-11 00:54:34 +02:00
|
|
|
|
2018-05-10 01:32:40 +02:00
|
|
|
def setup_tornado_rabbitmq() -> None: # nocoverage
|
2017-07-21 06:55:25 +02:00
|
|
|
# When tornado is shut down, disconnect cleanly from rabbitmq
|
|
|
|
if settings.USING_RABBITMQ:
|
|
|
|
queue_client = get_queue_client()
|
|
|
|
atexit.register(lambda: queue_client.close())
|
2018-05-21 00:38:54 +02:00
|
|
|
autoreload.add_reload_hook(lambda: queue_client.close())
|
2017-07-21 06:55:25 +02:00
|
|
|
|
2018-11-03 00:09:16 +01:00
|
|
|
def create_tornado_application(port: int) -> tornado.web.Application:
|
2018-07-13 12:58:16 +02:00
|
|
|
urls = (
|
|
|
|
r"/notify_tornado",
|
|
|
|
r"/json/events",
|
|
|
|
r"/api/v1/events",
|
|
|
|
r"/api/v1/events/internal",
|
|
|
|
)
|
2016-11-27 04:56:26 +01:00
|
|
|
|
|
|
|
# Application is an instance of Django's standard wsgi handler.
|
dependencies: Remove WebSockets system for sending messages.
Zulip has had a small use of WebSockets (specifically, for the code
path of sending messages, via the webapp only) since ~2013. We
originally added this use of WebSockets in the hope that the latency
benefits of doing so would allow us to avoid implementing a markdown
local echo; they were not. Further, HTTP/2 may have eliminated the
latency difference we hoped to exploit by using WebSockets in any
case.
While we’d originally imagined using WebSockets for other endpoints,
there was never a good justification for moving more components to the
WebSockets system.
This WebSockets code path had a lot of downsides/complexity,
including:
* The messy hack involving constructing an emulated request object to
hook into doing Django requests.
* The `message_senders` queue processor system, which increases RAM
needs and must be provisioned independently from the rest of the
server).
* A duplicate check_send_receive_time Nagios test specific to
WebSockets.
* The requirement for users to have their firewalls/NATs allow
WebSocket connections, and a setting to disable them for networks
where WebSockets don’t work.
* Dependencies on the SockJS family of libraries, which has at times
been poorly maintained, and periodically throws random JavaScript
exceptions in our production environments without a deep enough
traceback to effectively investigate.
* A total of about 1600 lines of our code related to the feature.
* Increased load on the Tornado system, especially around a Zulip
server restart, and especially for large installations like
zulipchat.com, resulting in extra delay before messages can be sent
again.
As detailed in
https://github.com/zulip/zulip/pull/12862#issuecomment-536152397, it
appears that removing WebSockets moderately increases the time it
takes for the `send_message` API query to return from the server, but
does not significantly change the time between when a message is sent
and when it is received by clients. We don’t understand the reason
for that change (suggesting the possibility of a measurement error),
and even if it is a real change, we consider that potential small
latency regression to be acceptable.
If we later want WebSockets, we’ll likely want to just use Django
Channels.
Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2019-07-23 01:43:40 +02:00
|
|
|
return tornado.web.Application([(url, AsyncDjangoHandler) for url in urls],
|
2016-11-27 04:56:26 +01:00
|
|
|
debug=settings.DEBUG,
|
2018-05-21 00:38:54 +02:00
|
|
|
autoreload=False,
|
2016-11-27 04:56:26 +01:00
|
|
|
# Disable Tornado's own request logging, since we have our own
|
|
|
|
log_function=lambda x: None)
|