jimzah/dendrite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
85ac8a3f5b
dendrite/clientapi
History
Kegsay 85ac8a3f5b
Factor out how monolith routes get added (#1107) 
Previously we had 3 monoliths:
 - dendrite-monolith-server
 - dendrite-demo-libp2p
 - dendritejs

which all had their own of setting up public routes. Factor this
out into a new `setup.Monolith` struct which gets all dependencies
set as fields. This is different to `basecomponent.Base` which
doesn't provide any way to set configured deps (e.g public rooms db)

Part of a larger process to clean up how we initialise Dendrite.
2020-06-09 12:07:33 +01:00
..
auth s/Base64String/Base64Bytes/g (#1093) 2020-06-04 11:50:57 +01:00
consumers
httputil
jsonerror
producers Send-to-device support (#1072) 2020-06-01 17:50:19 +01:00
routing Enable room version 6 (#1087) 2020-06-04 10:53:39 +01:00
threepid s/Base64String/Base64Bytes/g (#1093) 2020-06-04 11:50:57 +01:00
userutil
clientapi.go Factor out how monolith routes get added (#1107) 2020-06-09 12:07:33 +01:00
README.md

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.