Unify v1 and v2 REST client APIs #5226

hawkowl · 2019-05-22T06:24:21Z

This PR:

removes the code differences between v1 and v2 RestServlets
removes nearly all the code differences between v1 and v2 paths
does not move them into the same directory (that will be a follow-up)
maintains /api/v1 access

codecov · 2019-05-22T18:51:04Z

Codecov Report

Merging #5226 into develop will decrease coverage by 0.24%.
The diff coverage is 95.68%.

@@             Coverage Diff             @@
##           develop    #5226      +/-   ##
===========================================
- Coverage    62.78%   62.53%   -0.25%     
===========================================
  Files          341      341              
  Lines        35410    35429      +19     
  Branches      5793     5791       -2     
===========================================
- Hits         22231    22155      -76     
- Misses       11616    11737     +121     
+ Partials      1563     1537      -26

codecov · 2019-05-22T18:51:05Z

Codecov Report

Merging #5226 into develop will decrease coverage by <.01%.
The diff coverage is 93.01%.

@@            Coverage Diff             @@
##           develop   #5226      +/-   ##
==========================================
- Coverage       63%     63%   -0.01%     
==========================================
  Files          342     341       -1     
  Lines        35579   35610      +31     
  Branches      5828    5827       -1     
==========================================
+ Hits         22418   22435      +17     
- Misses       11593   11605      +12     
- Partials      1568    1570       +2

erikjohnston

This looks fairly sane, other than having different client_patterns functions wit the same name

erikjohnston · 2019-05-29T15:36:14Z

synapse/rest/client/v1/_base.py

+from synapse.rest.client.v2_alpha._base import client_patterns as _client_patterns
+
+
+def client_patterns(*args, **kwargs):


Can we please call this something different as it does a different thing (by default) than the other client_patterns, e.g. client_patterns_with_v1? Or alternatively move the v2_alpha version up here and specifically add v1=True to the places that need it.

… into hawkowl/burn-v2

@dnaf

Synapse 1.0.0rc1 (2019-06-07) ============================= Features -------- - Synapse now more efficiently collates room statistics. ([\#4338](#4338), [\#5260](#5260), [\#5324](#5324)) - Add experimental support for relations (aka reactions and edits). ([\#5220](#5220)) - Ability to configure default room version. ([\#5223](#5223), [\#5249](#5249)) - Allow configuring a range for the account validity startup job. ([\#5276](#5276)) - CAS login will now hit the r0 API, not the deprecated v1 one. ([\#5286](#5286)) - Validate federation server TLS certificates by default (implements [MSC1711](https://github.com/matrix-org/matrix-doc/blob/master/proposals/1711-x509-for-federation.md)). ([\#5359](#5359)) - Update /_matrix/client/versions to reference support for r0.5.0. ([\#5360](#5360)) - Add a script to generate new signing-key files. ([\#5361](#5361)) - Update upgrade and installation guides ahead of 1.0. ([\#5371](#5371)) - Replace the `perspectives` configuration section with `trusted_key_servers`, and make validating the signatures on responses optional (since TLS will do this job for us). ([\#5374](#5374)) - Add ability to perform password reset via email without trusting the identity server. ([\#5377](#5377)) - Set default room version to v4. ([\#5379](#5379)) Bugfixes -------- - Fixes client-server API not sending "m.heroes" to lazy-load /sync requests when a rooms name or its canonical alias are empty. Thanks to @dnaf for this work! ([\#5089](#5089)) - Prevent federation device list updates breaking when processing multiple updates at once. ([\#5156](#5156)) - Fix worker registration bug caused by ClientReaderSlavedStore being unable to see get_profileinfo. ([\#5200](#5200)) - Fix race when backfilling in rooms with worker mode. ([\#5221](#5221)) - Fix appservice timestamp massaging. ([\#5233](#5233)) - Ensure that server_keys fetched via a notary server are correctly signed. ([\#5251](#5251)) - Show the correct error when logging out and access token is missing. ([\#5256](#5256)) - Fix error code when there is an invalid parameter on /_matrix/client/r0/publicRooms ([\#5257](#5257)) - Fix error when downloading thumbnail with missing width/height parameter. ([\#5258](#5258)) - Fix schema update for account validity. ([\#5268](#5268)) - Fix bug where we leaked extremities when we soft failed events, leading to performance degradation. ([\#5274](#5274), [\#5278](#5278), [\#5291](#5291)) - Fix "db txn 'update_presence' from sentinel context" log messages. ([\#5275](#5275)) - Fix dropped logcontexts during high outbound traffic. ([\#5277](#5277)) - Fix a bug where it is not possible to get events in the federation format with the request `GET /_matrix/client/r0/rooms/{roomId}/messages`. ([\#5293](#5293)) - Fix performance problems with the rooms stats background update. ([\#5294](#5294)) - Fix noisy 'no key for server' logs. ([\#5300](#5300)) - Fix bug where a notary server would sometimes forget old keys. ([\#5307](#5307)) - Prevent users from setting huge displaynames and avatar URLs. ([\#5309](#5309)) - Fix handling of failures when processing incoming events where calling `/event_auth` on remote server fails. ([\#5317](#5317)) - Ensure that we have an up-to-date copy of the signing key when validating incoming federation requests. ([\#5321](#5321)) - Fix various problems which made the signing-key notary server time out for some requests. ([\#5333](#5333)) - Fix bug which would make certain operations (such as room joins) block for 20 minutes while attemoting to fetch verification keys. ([\#5334](#5334)) - Fix a bug where we could rapidly mark a server as unreachable even though it was only down for a few minutes. ([\#5335](#5335), [\#5340](#5340)) - Fix a bug where account validity renewal emails could only be sent when email notifs were enabled. ([\#5341](#5341)) - Fix failure when fetching batches of events during backfill, etc. ([\#5342](#5342)) - Add a new room version where the timestamps on events are checked against the validity periods on signing keys. ([\#5348](#5348), [\#5354](#5354)) - Fix room stats and presence background updates to correctly handle missing events. ([\#5352](#5352)) - Include left members in room summaries' heroes. ([\#5355](#5355)) - Fix `federation_custom_ca_list` configuration option. ([\#5362](#5362)) - Fix missing logcontext warnings on shutdown. ([\#5369](#5369)) Improved Documentation ---------------------- - Fix docs on resetting the user directory. ([\#5282](#5282)) - Fix notes about ACME in the MSC1711 faq. ([\#5357](#5357)) Internal Changes ---------------- - Synapse will now serve the experimental "room complexity" API endpoint. ([\#5216](#5216)) - The base classes for the v1 and v2_alpha REST APIs have been unified. ([\#5226](#5226), [\#5328](#5328)) - Simplifications and comments in do_auth. ([\#5227](#5227)) - Remove urllib3 pin as requests 2.22.0 has been released supporting urllib3 1.25.2. ([\#5230](#5230)) - Preparatory work for key-validity features. ([\#5232](#5232), [\#5234](#5234), [\#5235](#5235), [\#5236](#5236), [\#5237](#5237), [\#5244](#5244), [\#5250](#5250), [\#5296](#5296), [\#5299](#5299), [\#5343](#5343), [\#5347](#5347), [\#5356](#5356)) - Specify the type of reCAPTCHA key to use. ([\#5283](#5283)) - Improve sample config for monthly active user blocking. ([\#5284](#5284)) - Remove spurious debug from MatrixFederationHttpClient.get_json. ([\#5287](#5287)) - Improve logging for logcontext leaks. ([\#5288](#5288)) - Clarify that the admin change password API logs the user out. ([\#5303](#5303)) - New installs will now use the v54 full schema, rather than the full schema v14 and applying incremental updates to v54. ([\#5320](#5320)) - Improve docstrings on MatrixFederationClient. ([\#5332](#5332)) - Clean up FederationClient.get_events for clarity. ([\#5344](#5344)) - Various improvements to debug logging. ([\#5353](#5353)) - Don't run CI build checks until sample config check has passed. ([\#5370](#5370)) - Automatically retry buildkite builds (max twice) when an agent is lost. ([\#5380](#5380))

hawkowl added 8 commits May 21, 2019 17:45

port everything to use r0

1531476

fix

87adbc4

fixes

622122e

fixes

54d20a6

fixes

44f3aae

fixes

169be22

fixes

d91e084

fixes

63fe8d7

hawkowl added 10 commits May 27, 2019 14:19

Merge remote-tracking branch 'origin/develop' into hawkowl/burn-v2

d8afa71

fix 500

33075f6

fix 500

34e0a18

fix 500

fe089c9

make it point to the r0 url

bf1da35

this is supposed to be r0 as well

5eaff91

fix missing var

02c4420

add v1 url adding

0c046bc

update this copyright since this is original

dac219b

fix

6247f77

hawkowl requested a review from a team May 28, 2019 08:11

hawkowl added 2 commits May 30, 2019 00:21

Update and rename 5226.removal to 5226.misc

76ee829

Merge branch 'develop' into hawkowl/burn-v2

dc36d62

erikjohnston suggested changes May 29, 2019

View reviewed changes

hawkowl added 3 commits May 30, 2019 20:36

remove all code duplication

796f888

Merge branch 'hawkowl/burn-v2' of ssh://github.com/matrix-org/synapse…

7eadafe

… into hawkowl/burn-v2

Merge remote-tracking branch 'origin/develop' into hawkowl/burn-v2

f001507

hawkowl requested a review from erikjohnston May 30, 2019 11:05

hawkowl added 2 commits May 31, 2019 20:37

Merge branch 'develop' into hawkowl/burn-v2

21e2627

Update logout.py

12e4487

erikjohnston approved these changes May 31, 2019

View reviewed changes

hawkowl added 3 commits June 3, 2019 20:59

bump timeout duration

883c7f1

Merge branch 'hawkowl/burn-v2' of ssh://github.com/matrix-org/synapse…

a2a4f84

… into hawkowl/burn-v2

Merge remote-tracking branch 'origin/develop' into hawkowl/burn-v2

258dcba

hawkowl merged commit 2889b05 into develop Jun 3, 2019

hawkowl deleted the hawkowl/burn-v2 branch June 3, 2019 11:29

neilisfragile mentioned this pull request Jun 5, 2019

Neilj/changelog clean up #5356

Merged

erikjohnston mentioned this pull request Jan 20, 2020

Fix /events/:event_id deprecated API. #6731

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unify v1 and v2 REST client APIs #5226

Unify v1 and v2 REST client APIs #5226

hawkowl commented May 22, 2019 •

edited

Loading

codecov bot commented May 22, 2019

codecov bot commented May 22, 2019 •

edited

Loading

erikjohnston left a comment

erikjohnston May 29, 2019

		from synapse.rest.client.v2_alpha._base import client_patterns as _client_patterns


		def client_patterns(args, *kwargs):

Unify v1 and v2 REST client APIs #5226

Unify v1 and v2 REST client APIs #5226

Conversation

hawkowl commented May 22, 2019 • edited Loading

codecov bot commented May 22, 2019

Codecov Report

codecov bot commented May 22, 2019 • edited Loading

Codecov Report

erikjohnston left a comment

Choose a reason for hiding this comment

erikjohnston May 29, 2019

Choose a reason for hiding this comment

hawkowl commented May 22, 2019 •

edited

Loading

codecov bot commented May 22, 2019 •

edited

Loading