mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2024-11-26 00:01:55 -06:00
Code Issues Packages Projects Releases Wiki Activity
dendrite/clientapi
History
0x1a8510f2 46902e5766
Take advantage of changes in recent Go versions (#3361) 
Given that #2714 wasn't merged but we are now at a minimum supported Go
version of 1.20 (soon to be 1.21), I wanted to carry over some of the
changes. Namely:
- Fix the log typo
- Simplify build constraints for unix
- Use stdlib atomic package

### Pull Request Checklist

<!-- Please read
https://matrix-org.github.io/dendrite/development/contributing before
submitting your pull request -->

* [x] I have added Go unit tests or [Complement integration
tests](https://github.com/matrix-org/complement) for this PR _or_ I have
justified why this PR doesn't need tests
* [x] Pull request includes a [sign off below using a legally
identifiable
name](https://matrix-org.github.io/dendrite/development/contributing#sign-off)
_or_ I have already signed off privately

Signed-off-by: `0x1a8510f2 <admin@0x1a8510f2.space>`

---------

Co-authored-by: devonh <devon.dmytro@gmail.com>
2024-05-01 00:38:36 +00:00
..
api feat: admin APIs for token authenticated registration (#3101) 2023-06-22 16:37:21 +00:00
auth Appservice Login (2nd attempt) (#3078) 2023-11-24 22:34:13 +01:00
httputil Move MakeJoin logic to GMSL (#3081) 2023-05-17 00:33:27 +00:00
producers refactor: update GMSL (#3058) 2023-04-19 15:50:33 +01:00
routing Take advantage of changes in recent Go versions (#3361) 2024-05-01 00:38:36 +00:00
threepid Use *spec.SenderID for QuerySenderIDForUser (#3164) 2023-08-02 11:12:14 +01:00
userutil refactor: update GMSL (#3058) 2023-04-19 15:50:33 +01:00
admin_test.go Add getting/deleting single event report (#3344) 2024-03-22 21:54:29 +00:00
clientapi.go Move fedclient interface over to gmsl (#3061) 2023-04-24 16:23:25 +00:00
clientapi_test.go Add event reporting (#3340) 2024-03-21 19:27:34 +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.