Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Implement handling of HEAD requests #7999

Merged
merged 8 commits into from
Aug 3, 2020
Merged

Implement handling of HEAD requests #7999

merged 8 commits into from
Aug 3, 2020

Conversation

clokep
Copy link
Contributor

@clokep clokep commented Jul 30, 2020

In order to handle HEAD requests properly in our _AsyncResource we need to handle it for DirectServe*Resource and then also for JsonResource separately.

  • Adds a default _async_render_HEAD method which just calls _async_render_GET (this is essentially Twisted's implementation, but made async).
  • For each servlet: when register on_GET, also register on_HEAD if there isn't an override for on_HEAD.
  • Updates the CORS headers to say they supported HEAD.

I debated if it made more sense to just convert the HEAD method to GET in JsonResource._get_handler_for_request, open to suggestions about this! (It could be a smaller memory footprint, but probably a bit less flexible?)

Fixes #6008, fixes #6746, fixes #7994

@clokep clokep mentioned this pull request Jul 30, 2020
Closed
@clokep clokep requested a review from a team July 30, 2020 16:57
@clokep @auscompgeek
Fix typo.
343801e 
Co-authored-by: David Vo <auscompgeek@users.noreply.github.com>
richvdh
richvdh reviewed Jul 31, 2020
View reviewed changes
synapse/http/server.py Outdated Show resolved Hide resolved
clokep
clokep commented Jul 31, 2020
View reviewed changes
tests/test_server.py
@@ -255,7 +278,7 @@ def setUp(self):
self.reactor = ThreadedMemoryReactorClock()

def test_good_response(self):
def callback(request):
async def callback(request):
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Somewhat unrelated, but the TestResource._async_render_GET awaits this function so it should be async.

@clokep
Copy link
Contributor Author

clokep commented Jul 31, 2020

I debated if it made more sense to just convert the HEAD method to GET in JsonResource._get_handler_for_request, open to suggestions about this! (It could be a smaller memory footprint, but probably a bit less flexible?)

I made this change so it is consistent with the changes made in response to #7999 (comment)

@clokep clokep requested a review from richvdh July 31, 2020 12:13
richvdh
richvdh approved these changes Aug 3, 2020
View reviewed changes
Copy link
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

changelog.d/7999.bugfix Outdated Show resolved Hide resolved
synapse/http/server.py
@@ -242,10 +242,12 @@ async def _async_render(self, request: Request):
no appropriate method exists. Can be overriden in sub classes for
different routing.
"""
# Treat HEAD requests as GET requests.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well, ideally we'd only do this if the class didn't have an _async_render_HEAD, but given we don't have any such classes, it doesn't really matter

Copy link
Contributor Author

@clokep clokep Aug 3, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I debated on checking for _async_render_HEAD, but it seemed silly to add processing for something we know is always going to be false! If we need this in the future we can add this check.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems fair!

@clokep @richvdh
Clarify changelog.
09588c2 
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
@clokep clokep merged commit 6812509 into develop Aug 3, 2020
@clokep clokep deleted the clokep/head branch August 3, 2020 12:45
reivilibre added a commit that referenced this pull request Aug 13, 2020
@reivilibre
Merge tag 'v1.19.0rc1' into develop
bfd79c2 
Synapse 1.19.0rc1 (2020-08-13)
==============================

Removal warning
---------------

As outlined in the [previous release](https://github.com/matrix-org/synapse/releases/tag/v1.18.0), we are no longer publishing Docker images with the `-py3` tag suffix. On top of that, we have also removed the `latest-py3` tag. Please see [the announcement in the upgrade notes for 1.18.0](https://github.com/matrix-org/synapse/blob/develop/UPGRADE.rst#upgrading-to-v1180).

Features
--------

- Add option to allow server admins to join rooms which fail complexity checks. Contributed by @lugino-emeritus. ([\#7902](#7902))
- Add an option to purge room or not with delete room admin endpoint (`POST /_synapse/admin/v1/rooms/<room_id>/delete`). Contributed by @dklimpel. ([\#7964](#7964))
- Add rate limiting to users joining rooms. ([\#8008](#8008))
- Add a `/health` endpoint to every configured HTTP listener that can be used as a health check endpoint by load balancers. ([\#8048](#8048))
- Allow login to be blocked based on the values of SAML attributes. ([\#8052](#8052))
- Allow guest access to the `GET /_matrix/client/r0/rooms/{room_id}/members` endpoint, according to MSC2689. Contributed by Awesome Technologies Innovationslabor GmbH. ([\#7314](#7314))

Bugfixes
--------

- Fix a bug introduced in Synapse v1.7.2 which caused inaccurate membership counts in the room directory. ([\#7977](#7977))
- Fix a long standing bug: 'Duplicate key value violates unique constraint "event_relations_id"' when message retention is configured. ([\#7978](#7978))
- Fix "no create event in auth events" when trying to reject invitation after inviter leaves. Bug introduced in Synapse v1.10.0. ([\#7980](#7980))
- Fix various comments and minor discrepencies in server notices code. ([\#7996](#7996))
- Fix a long standing bug where HTTP HEAD requests resulted in a 400 error. ([\#7999](#7999))
- Fix a long-standing bug which caused two copies of some log lines to be written when synctl was used along with a MemoryHandler logger. ([\#8011](#8011), [\#8012](#8012))

Updates to the Docker image
---------------------------

- We no longer publish Docker images with the `-py3` tag suffix, as [announced in the upgrade notes](https://github.com/matrix-org/synapse/blob/develop/UPGRADE.rst#upgrading-to-v1180). ([\#8056](#8056))

Improved Documentation
----------------------

- Document how to set up a client .well-known file and fix several pieces of outdated documentation. ([\#7899](#7899))
- Improve workers docs. ([\#7990](#7990), [\#8000](#8000))
- Fix typo in `docs/workers.md`. ([\#7992](#7992))
- Add documentation for how to undo a room shutdown. ([\#7998](#7998), [\#8010](#8010))

Internal Changes
----------------

- Reduce the amount of whitespace in JSON stored and sent in responses. Contributed by David Vo. ([\#7372](#7372))
- Switch to the JSON implementation from the standard library and bump the minimum version of the canonicaljson library to 1.2.0. ([\#7936](#7936), [\#7979](#7979))
- Convert various parts of the codebase to async/await. ([\#7947](#7947), [\#7948](#7948), [\#7949](#7949), [\#7951](#7951), [\#7963](#7963), [\#7973](#7973), [\#7975](#7975), [\#7976](#7976), [\#7981](#7981), [\#7987](#7987), [\#7989](#7989), [\#8003](#8003), [\#8014](#8014), [\#8016](#8016), [\#8027](#8027), [\#8031](#8031), [\#8032](#8032), [\#8035](#8035), [\#8042](#8042), [\#8044](#8044), [\#8045](#8045), [\#8061](#8061), [\#8062](#8062), [\#8063](#8063), [\#8066](#8066), [\#8069](#8069), [\#8070](#8070))
- Move some database-related log lines from the default logger to the database/transaction loggers. ([\#7952](#7952))
- Add a script to detect source code files using non-unix line terminators. ([\#7965](#7965), [\#7970](#7970))
- Log the SAML session ID during creation. ([\#7971](#7971))
- Implement new experimental push rules for some users. ([\#7997](#7997))
- Remove redundant and unreliable signature check for v1 Identity Service lookup responses. ([\#8001](#8001))
- Improve the performance of the register endpoint. ([\#8009](#8009))
- Reduce less useful output in the newsfragment CI step. Add a link to the changelog section of the contributing guide on error. ([\#8024](#8024))
- Rename storage layer objects to be more sensible. ([\#8033](#8033))
- Change the default log config to reduce disk I/O and storage for new servers. ([\#8040](#8040))
- Add an assertion on `prev_events` in `create_new_client_event`. ([\#8041](#8041))
- Add a comment to `ServerContextFactory` about the use of `SSLv23_METHOD`. ([\#8043](#8043))
- Log `OPTIONS` requests at `DEBUG` rather than `INFO` level to reduce amount logged at `INFO`. ([\#8049](#8049))
- Reduce amount of outbound request logging at `INFO` level. ([\#8050](#8050))
- It is no longer necessary to explicitly define `filters` in the logging configuration. (Continuing to do so is redundant but harmless.) ([\#8051](#8051))
- Add and improve type hints. ([\#8058](#8058), [\#8064](#8064), [\#8060](#8060), [\#8067](#8067))
babolivier pushed a commit that referenced this pull request Sep 1, 2021
@anoadragon453
Merge commit '681250980' into anoa/dinsic_release_1_21_x
3442b28 
* commit '681250980':
  Implement handling of HTTP HEAD requests. (#7999)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@auscompgeek auscompgeek auscompgeek left review comments

@richvdh richvdh richvdh approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
3 participants
@clokep @auscompgeek @richvdh