Current wiring (#1125)

* Current wiring

* Add ServerKeyAPI lines

1 files changed, 71 insertions, 0 deletions

diff --git a/docs/WIRING-Current.md b/docs/WIRING-Current.md
new file mode 100644
index 00000000..62450f2f
--- /dev/null
+++ b/docs/WIRING-Current.md
@@ -0,0 +1,71 @@
+This document details how various components communicate with each other. There are two kinds of components:
+ - Public-facing: exposes CS/SS API endpoints and need to be routed to via client-api-proxy or equivalent.
+ - Internal-only: exposes internal APIs and produces Kafka events.
+
+## Internal HTTP APIs
+
+Not everything can be done using Kafka logs. For example, requesting the latest events in a room is much better suited to
+a request/response model like HTTP or RPC. Therefore, components can expose "internal APIs" which sit outside of Kafka logs.
+Note in Monolith mode these are actually direct function calls and are not serialised HTTP requests.
+
+```
+   Tier 1            Sync        PublicRooms      FederationAPI      ClientAPI    MediaAPI
+Public Facing        | .-----1------`              | | |    | |        | | | |
+                     2 | .-------3-----------------` | |    | `--------|-|-|-|--11--------------------.
+                     | | | .--------4----------------------------------` | | |                        |
+                     | | | |         .---5-----------` |    |            | | |                        |
+                     | | | |         |  .---6----------------------------` | |                        |
+                     | | | |         |  |              |  .-----7----------` |                        |
+                     | | | |         |  |              8  | |                10                       |
+                     | | | |         |  |              |  | `---9----.       |                        |
+                     V V V V         V  V              V  V          V       V                        V
+   Tier 2           Roomserver     EDUServer         FedSender       AppService    KeyServer   ServerKeyAPI
+Internal only               |                               `------------------------12----------^   ^
+                            `------------------------------------------------------------13----------`
+
+ Client ---> Server
+```
+- 1 (PublicRooms -> Roomserver): Calculating current auth for changing visibility
+- 2 (Sync -> Roomserver): When making backfill requests
+- 3 (FedAPI -> Roomserver): Calculating (prev/auth events) and sending new events, processing backfill/state/state_ids requests
+- 4 (ClientAPI -> Roomserver): Calculating (prev/auth events) and sending new events, processing /state requests
+- 5 (FedAPI -> EDUServer): Sending typing/send-to-device events
+- 6 (ClientAPI -> EDUServer): Sending typing/send-to-device events
+- 7 (ClientAPI -> FedSender): Handling directory lookups
+- 8 (FedAPI -> FedSender): Resetting backoffs when receiving traffic from a server. Querying joined hosts when handling alias lookup requests
+- 9 (FedAPI -> AppService): Working out if the client is an appservice user
+- 10 (ClientAPI -> AppService): Working out if the client is an appservice user
+- 11 (FedAPI -> ServerKeyAPI): Verifying incoming event signatures
+- 12 (FedSender -> ServerKeyAPI): Verifying event signatures of responses (e.g from send_join)
+- 13 (Roomserver -> ServerKeyAPI): Verifying event signatures of backfilled events
+
+## Kafka logs
+
+```
+                       .----1--------------------------------------------.
+                       V                                                 |
+   Tier 1            Sync        PublicRooms      FederationAPI      ClientAPI    MediaAPI
+Public Facing        ^   ^           ^                                 ^  
+                     |   |           |                                 |
+                     2   |           |                                 |
+                     |   `-3------------.                              |
+                     |               |  |                              |
+                     |               |  |                              |
+                     | .------4------`  |                              |
+                     | | .--------5-----|------------------------------`             
+                     | | |              |           
+   Tier 2           Roomserver     EDUServer         FedSender       AppService    KeyServer   ServerKeyAPI
+Internal only              |          |                ^ ^
+                           |          `-----6----------` |
+                           `--------------------7--------`
+
+
+Producer ----> Consumer
+```
+- 1 (ClientAPI -> Sync): For tracking account data
+- 2 (Roomserver -> Sync): For all data to send to clients
+- 3 (EDUServer -> Sync): For typing/send-to-device data to send to clients
+- 4 (Roomserver -> PublicRooms): For tracking the current room name/topic/joined count/etc.
+- 5 (Roomserver -> ClientAPI): For tracking memberships for profile updates.
+- 6 (EDUServer -> FedSender): For sending EDUs over federation
+- 7 (Roomserver -> FedSender): For sending PDUs over federation, for tracking joined hosts.