dendrite/clientapi
Kegsay b7187a9a35
Remove clientapi producers which aren't actually producers (#1111)
* Remove clientapi producers which aren't actually producers

They are actually just convenience wrappers around the internal APIs
for roomserver/eduserver. Move their logic to their respective `api`
packages and call them directly.

* Remove TODO

* unbreak ygg
2020-06-10 12:17:54 +01:00
..
auth s/Base64String/Base64Bytes/g (#1093) 2020-06-04 11:50:57 +01:00
consumers Fix #897 and shuffle directory around (#1054) 2020-05-21 14:40:13 +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 Roomserver perform join (#1001) 2020-05-04 13:53:47 +01:00
producers Remove clientapi producers which aren't actually producers (#1111) 2020-06-10 12:17:54 +01:00
routing Remove clientapi producers which aren't actually producers (#1111) 2020-06-10 12:17:54 +01:00
threepid Remove clientapi producers which aren't actually producers (#1111) 2020-06-10 12:17:54 +01:00
userutil use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
clientapi.go Remove clientapi producers which aren't actually producers (#1111) 2020-06-10 12:17:54 +01:00
README.md use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00

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.