Improve the Thread model wrt the starting email

- Factorize the SQL query (only one query instead of two)
- Make it possible to only request the subject

4 files changed, 122 insertions, 13 deletions

diff --git a/kittystore/storm/model.py b/kittystore/storm/model.py
index 458f2fd..554edfa 100644
--- a/kittystore/storm/model.py
+++ b/kittystore/storm/model.py
@@ -126,13 +126,19 @@ class Thread(object):
         self.date_active = date_active
 
     @property
+    def _starting_email_req(self):
+        """ Returns the request to get the starting email.
+        If there are no results with in_reply_to IS NULL, then it's
+        probably a partial import and we don't have the real first email.
+        In this case, use the date.
+        """
+        return self.emails.order_by(Email.in_reply_to != None, Email.date)
+
+    @property
     def starting_email(self):
         """Return (and cache) the email starting this thread"""
         if self._starting_email is None:
-            self._starting_email = self.emails.find(Email.in_reply_to == None).one()
-            if self._starting_email is None:
-                # probably a partial import, we don't have the real first email
-                self._starting_email = self.emails.order_by(Email.date).first()
+            self._starting_email = self._starting_email_req.first()
         return self._starting_email
 
     @property
@@ -140,6 +146,16 @@ class Thread(object):
         return self.emails.order_by(Desc(Email.date)).first()
 
     @property
+    def subject(self):
+        """Return the subject of this thread"""
+        if self._starting_email is not None:
+            return self.starting_email.subject
+        else:
+            # Don't get the whole message if it's not cached yet (useful for
+            # HyperKitty's thread view).
+            return self._starting_email_req.values(Email.subject).next()
+
+    @property
     def participants(self):
         """Set of email senders in this thread"""
         p = []
diff --git a/kittystore/test/__init__.py b/kittystore/test/__init__.py
index 9a10e1f..2a2b228 100644
--- a/kittystore/test/__init__.py
+++ b/kittystore/test/__init__.py
@@ -6,3 +6,13 @@ import os
 def get_test_file(*fileparts):
     return os.path.join(os.path.dirname(__file__), "testdata", *fileparts)
 get_test_file.__test__ = False
+
+
+class FakeList(object):
+    # pylint: disable=R0903
+    # (Too few public methods)
+    def __init__(self, name):
+        self.fqdn_listname = name
+        self.display_name = None
+
+
diff --git a/kittystore/test/test_storm_model.py b/kittystore/test/test_storm_model.py
new file mode 100644
index 0000000..38ba6c2
--- /dev/null
+++ b/kittystore/test/test_storm_model.py
@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=R0904,C0103
+# - Too many public methods
+# - Invalid name XXX (should match YYY)
+
+import unittest
+
+from mailman.email.message import Message
+
+from kittystore.storm import get_storm_store
+from kittystore.storm.model import Email, Thread
+
+from kittystore.test import get_test_file, FakeList
+
+
+class TestStormModel(unittest.TestCase):
+
+    def setUp(self):
+        self.store = get_storm_store("sqlite:")
+        #self.store = get_storm_store("postgres://kittystore:kittystore@localhost/kittystore_test", True)
+        #self.store = get_storm_store("mysql://kittystore:kittystore@localhost/kittystore_test", True)
+
+    def tearDown(self):
+        self.store.close()
+
+    def test_starting_message_1(self):
+        # A basic thread: msg2 replies to msg1
+        ml = FakeList("example-list")
+        msg1 = Message()
+        msg1["From"] = "sender1@example.com"
+        msg1["Message-ID"] = "<msg1>"
+        msg1.set_payload("message 1")
+        self.store.add_to_list(ml, msg1)
+        msg2 = Message()
+        msg2["From"] = "sender2@example.com"
+        msg2["Message-ID"] = "<msg2>"
+        msg2.set_payload("message 2")
+        msg2["In-Reply-To"] = msg1["Message-ID"]
+        self.store.add_to_list(ml, msg2)
+        thread = self.store.db.find(Thread).one()
+        self.assertEqual(thread.starting_email.message_id, "msg1")
+
+    def test_starting_message_2(self):
+        # A partially-imported thread: msg1 replies to something we don't have
+        ml = FakeList("example-list")
+        msg1 = Message()
+        msg1["From"] = "sender1@example.com"
+        msg1["Message-ID"] = "<msg1>"
+        msg1["In-Reply-To"] = "<msg0>"
+        msg1.set_payload("message 1")
+        self.store.add_to_list(ml, msg1)
+        msg2 = Message()
+        msg2["From"] = "sender2@example.com"
+        msg2["Message-ID"] = "<msg2>"
+        msg2["In-Reply-To"] = msg1["Message-ID"]
+        msg2.set_payload("message 2")
+        self.store.add_to_list(ml, msg2)
+        thread = self.store.db.find(Thread).one()
+        self.assertEqual(thread.starting_email.message_id, "msg1")
+
+    def test_starting_message_3(self):
+        # A thread where the reply has an anterior date to the first email
+        # (the In-Reply-To header must win over the date sort)
+        ml = FakeList("example-list")
+        msg1 = Message()
+        msg1["From"] = "sender1@example.com"
+        msg1["Message-ID"] = "<msg1>"
+        msg1["Date"] = "Fri, 02 Nov 2012 16:07:54 +0000"
+        msg1.set_payload("message 1")
+        self.store.add_to_list(ml, msg1)
+        msg2 = Message()
+        msg2["From"] = "sender2@example.com"
+        msg2["Message-ID"] = "<msg2>"
+        msg2["Date"] = "Fri, 01 Nov 2012 16:07:54 +0000"
+        msg2.set_payload("message 2")
+        msg2["In-Reply-To"] = msg1["Message-ID"]
+        self.store.add_to_list(ml, msg2)
+        thread = self.store.db.find(Thread).one()
+        self.assertEqual(thread.starting_email.message_id, "msg1")
+
+    def test_subject(self):
+        ml = FakeList("example-list")
+        msg = Message()
+        msg["From"] = "sender@example.com"
+        msg["Message-ID"] = "<dummymsg>"
+        msg["Date"] = "Fri, 02 Nov 2012 16:07:54 +0000"
+        msg["Subject"] = "Dummy subject"
+        msg.set_payload("Dummy message")
+        self.store.add_to_list(ml, msg)
+        thread = self.store.db.find(Thread).one()
+        self.assertEqual(thread.subject, "Dummy subject")
diff --git a/kittystore/test/test_storm_store.py b/kittystore/test/test_storm_store.py
index f89feb1..fb7d847 100644
--- a/kittystore/test/test_storm_store.py
+++ b/kittystore/test/test_storm_store.py
@@ -13,15 +13,7 @@ from mailman.email.message import Message
 from kittystore.storm import get_storm_store
 from kittystore.storm.model import Email, Attachment
 
-from kittystore.test import get_test_file
-
-
-class FakeList(object):
-    # pylint: disable=R0903
-    # (Too few public methods)
-    def __init__(self, name):
-        self.fqdn_listname = name
-        self.display_name = None
+from kittystore.test import get_test_file, FakeList
 
 
 class TestStormStore(unittest.TestCase):