Mirrors/dendrite
2
0
Fork 0
mirror of https://github.com/matrix-org/dendrite synced 2024-12-14 07:12:53 +00:00
Code Issues Projects Releases Packages Wiki Activity
dendrite/clientapi
History
kegsay 2b34f88fde
Use ProtoEvent where needed instead of EventBuilder (#3075) 
They are fundamentally different concepts, so should be represented as
such. Proto events are exchanged in /make_xxx calls over federation, and
made as "fledgling" events in /createRoom and general event sending.
*Building* events is a reasonably complex VERSION SPECIFIC process which
needs amongst other things, auth event providers, prev events, signing
keys, etc.

Requires https://github.com/matrix-org/gomatrixserverlib/pull/379
2023-05-04 11:17:42 +01:00
..
api refactor: use latest GMSL which splits fed client from matrix room logic (#3051) 2023-04-06 09:55:01 +01:00
auth refactor: update GMSL (#3058) 2023-04-19 15:50:33 +01:00
httputil Do not use ioutil as it is deprecated (#2625) 2022-08-05 10:26:59 +01:00
jsonerror Add key backup tests (#3071) 2023-04-28 17:49:38 +02:00
producers refactor: update GMSL (#3058) 2023-04-19 15:50:33 +01:00
routing Use ProtoEvent where needed instead of EventBuilder (#3075) 2023-05-04 11:17:42 +01:00
threepid Use ProtoEvent where needed instead of EventBuilder (#3075) 2023-05-04 11:17:42 +01:00
userutil refactor: update GMSL (#3058) 2023-04-19 15:50:33 +01:00
admin_test.go Pass federation API to roomserver in PurgeRoom tests 2023-05-01 21:28:10 -06:00
clientapi.go Move fedclient interface over to gmsl (#3061) 2023-04-24 16:23:25 +00:00
clientapi_test.go Add key backup tests (#3071) 2023-04-28 17:49:38 +02:00
README.md use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00

README.md

This component roughly corresponds to "Client Room Send" and "Client Sync" on the WIRING diagram. This component produces multiple binaries.

Internals

  • HTTP routing is done using gorilla/mux and the routing paths are in the routing package.

Writers

  • Each HTTP "write operation" (/createRoom, /rooms/$room_id/send/$type, etc) is contained entirely to a single file in the writers package.
  • This file contains the request and response struct definitions, as well as a Validate() bool function to validate incoming requests.
  • The entry point for each write operation is a stand-alone function as this makes testing easier. All dependencies should be injected into this function, including server keys/name, etc.