matrix-org.dendrite/clientapi
KuhnChris 4f943771fa
Appservice Login (2nd attempt) (#3078)
Rebase of #2936 as @vijfhoek wrote he got no time to work on this, and I
kind of needed it for my experiments.
I checked the tests, and it is working with my example code (i.e.
impersonating, registering, creating channel, invite people, write
messages).
I'm not a huge `go` pro, and still learning, but I tried to fix and/or
integrate the changes as best as possible with the current `main` branch
changes.
If there is anything left, let me know and I'll try to figure it out.

Signed-off-by: `Kuhn Christopher <kuhnchris+git@kuhnchris.eu>`

---------

Signed-off-by: Sijmen <me@sijman.nl>
Signed-off-by: Sijmen Schoon <me@sijman.nl>
Co-authored-by: Sijmen Schoon <me@sijman.nl>
Co-authored-by: Sijmen Schoon <me@vijf.life>
Co-authored-by: Till <2353100+S7evinK@users.noreply.github.com>
2023-11-24 22:34:13 +01: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 Appservice Login (2nd attempt) (#3078) 2023-11-24 22:34:13 +01: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
README.md use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
admin_test.go Use `IsBlacklistedOrBackingOff` to determine if we should try to fetch devices (#3254) 2023-11-09 08:43:27 +01:00
clientapi.go Move fedclient interface over to gmsl (#3061) 2023-04-24 16:23:25 +00:00
clientapi_test.go Use `IsBlacklistedOrBackingOff` to determine if we should try to fetch devices (#3254) 2023-11-09 08:43:27 +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.