mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2025-12-17 11:53:09 -06:00
Code Issues Packages Projects Releases Wiki Activity
dendrite/clientapi
History
Neil Alexander 7615857be0 Squashed commit of the following: 
commit c1bca95adb
Author: Kegsay <kegan@matrix.org>
Date:   Thu Apr 16 10:06:55 2020 +0100

    Add SQL tracing via DENDRITE_TRACE_SQL (#968)

    * Add SQL tracing via DENDRITE_TRACE_SQL

    Add this to `internal/sqlutil` in preparation for #897

    * Not entirely

commit c2ea961909
Author: Kegsay <kegan@matrix.org>
Date:   Wed Apr 15 17:48:40 2020 +0100

    Add HTTP trace logging (#965)

    * Dump all requests/response server-side

    * Wrap in DENDRITE_TRACE

    * DENDRITE_TRACE_HTTP is better

    * Bugfix for response body and linting

    * False is true and true is false

    * Linting

    * How did this get missed

    * More linting
2020-04-16 10:19:57 +01:00
..
auth Squashed commit of the following: 2020-04-16 10:19:57 +01:00
consumers Implement gomatrixserverlib.HeaderedEvent in roomserver Kafka output (#914) 2020-03-17 11:01:25 +00: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 Invites v2 endpoint (#952) 2020-04-03 14:29:06 +01:00
routing Move /room/{roomID}/state endpoints into client API (#606) (#962) 2020-04-14 18:36:08 +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 Rename the typing server to EDU server (#948) 2020-03-30 15:02:20 +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.