char/dendrite
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
dendrite/clientapi
History
Neil Alexander a308e61331
Federation sender API remodel (#988) 
* Define an input API for the federationsender

* Wiring for rooomserver input API and federation sender input API

* Whoops, commit common too

* Merge input API into query API

* Rename FederationSenderQueryAPI to FederationSenderInternalAPI

* Fix dendritejs

* Rename Input to Perform

* Fix a couple of inputs -> performs

* Remove needless storage interface, add comments
2020-04-29 11:34:31 +01:00
..
auth Add SQL tracing via DENDRITE_TRACE_SQL (#968) 2020-04-16 10:06:55 +01:00
consumers Fix sarama import URLs (#856) 2020-04-22 15:26:56 +01:00
httputil Remove httputil.LogThenError so that the line numbers are reported properly - make error reporting slightly more useful (#879) 2020-03-02 16:20:44 +00:00
jsonerror Add room version to room create request, persist in storage (#915) 2020-03-17 15:12:01 +00:00
producers More invite support (#979) 2020-04-24 16:30:25 +01:00
routing Federation sender API remodel (#988) 2020-04-29 11:34:31 +01:00
threepid Further room version wiring (#936) 2020-03-27 16:28:22 +00:00
userutil use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
clientapi.go Federation sender API remodel (#988) 2020-04-29 11:34:31 +01: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.