[Libreoffice-commits] online.git: loolwsd/PROBLEMS

[Tor Lillqvist]

 loolwsd/PROBLEMS |   22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

New commits:
commit 2d74d65578a334b7dd46f0b035eb20264bed989f
Author: Tor Lillqvist <tml at collabora.com>
Date:   Wed Apr 20 10:35:38 2016 +0300

    Rant about the duplicate specification of document URI, GET and 'load'

diff --git a/loolwsd/PROBLEMS b/loolwsd/PROBLEMS
index 687fae9..1e8a1f6 100644
--- a/loolwsd/PROBLEMS
+++ b/loolwsd/PROBLEMS
@@ -1,3 +1,25 @@
+- The URL of the document to view and/or edit is specified both in the
+  HTTP GET and in the 'load' message. This is redundant, and adds
+  completely unnecessary, hard to define, and hard to test, states
+  that the server and clients can be in. For instance:
+
+  - Is it an error to send a different URL in the 'load' message than
+    the one in the GET? (Of course it is. Do we check that? Do we have
+    a unit test to make sure it stays an error?)
+
+  - What messages are accepted by the server before the 'load'? What
+    messages are sent to the client? Do they make sense, if it is only
+    the 'load' that actually fully completes the association of a
+    session with a document? Do we have unit tests for this?
+
+  - What if one client connects, and then before it has sent the
+    'load' message, another client connects specifying the same
+    document in the GET, and also sends a 'load' message. Which client
+    gets the edit lock? Is that arbitrary or specified? Do we have a
+    unit test for it?
+
+  - Etc
+
 - There is way too much of busy waiting for fairly arbitrarily chosen
   timeout periods in the code.