document up the current architecture a bit based on the workshop the other week

2 files changed, 71 insertions, 0 deletions

diff --git a/docs/implementation-notes/architecture.rst b/docs/implementation-notes/architecture.rst
new file mode 100644
index 0000000000..b447858202
--- /dev/null
+++ b/docs/implementation-notes/architecture.rst
@@ -0,0 +1,65 @@
+Synapse Architecture
+====================
+
+As of the end of Oct 2014, Synapse's overall architecture looks like::
+
+                                   Notifier
+                                     ^  |
+                                     |  |
+                           .------------|------.
+                           | handlers/  |      |
+                           |            v      |
+                           | Event*Handler<---------> rest/* <=> Client
+                           | Rooms*Handler     |
+  HSes <=> federation/* <==> FederationHandler |
+               |           | PresenceHandler   |
+               |           | TypingHandler     |
+               |           '-------------------'
+               |                 |     |
+               |              state/*  |
+               |                 |     |
+               |                 v     v
+               `--------------> storage/*
+                                   |
+                                   v
+                                .----.
+                                | DB |
+                                '----'
+
+* Handlers: business logic of synapse itself.  Follows a set contract of BaseHandler:
+
+ * BaseHandler gives us onNewRoomEvent which: (TODO: flesh this out and make it less cryptic):
+ 
+   * handle_state(event)
+   * auth(event)
+   * persist_event(event)
+   * notify notifier or federation(event)
+   
+ * PresenceHandler: use distributor to get EDUs out of Federation.  Very
+   lightweight logic built on the distributor
+ * TypingHandler: use distributor to get EDUs out of Federation.  Very
+   lightweight logic built on the distributor
+ * EventsHandler: handles the events stream...
+ * FederationHandler: - gets PDU from Federation Layer; turns into an event;
+   follows basehandler functionality.
+ * RoomsHandler: does all the room logic, including members - lots of classes in
+   RoomsHandler.
+ * ProfileHandler: talks to the storage to store/retrieve profile info.
+
+* EventFactory: generates events of particular event types.
+* Notifier: Backs the events handler
+* REST: Interfaces handlers and events to the outside world via HTTP/JSON.
+  Converts events back and forth from JSON.
+* Federation: holds the HTTP client & server to talk to other servers.  Does
+  replication to make sure there's nothing missing in the graph.  Handles
+  reliability.  Handles txns.
+* Distributor: generic event bus. used for presence & typing only currently. 
+  Notifier could be implemented using Distributor - so far we are only using for
+  things which actually /require/ dynamic pluggability however as it can
+  obfuscate the actual flow of control.
+* Auth: helper singleton to say whether a given event is allowed to do a given
+  thing  (TODO: put this on the diagram)
+* State: helper singleton: does state conflict resolution. You give it an event
+  and it tells you if it actually updates the state or not, and annotates the
+  event up properly and handles merge conflict resolution.
+* Storage: abstracts the storage engine.
diff --git a/docs/implementation-notes/python_architecture.rst b/docs/implementation-notes/python_architecture.rst
index 8beaa615d0..2a5a2613c4 100644
--- a/docs/implementation-notes/python_architecture.rst
+++ b/docs/implementation-notes/python_architecture.rst
@@ -1,3 +1,9 @@
+.. WARNING::
+  These architecture notes are spectacularly old, and date back to when Synapse 
+  was just federation code in isolation.  This should be merged into the main
+  spec.
+  
+
 = Server to Server =
 
 == Server to Server Stack ==