Use IDs for accounts and mailboxes instead of the names

Author: fkantelberg

.coveragerc

@@ -1,2 +1,4 @@
 [run]
-omit = *tests*
+source = */mail_devel/*
+concurrency = multiprocessing
+parallel = True

noxfile.py

@@ -10,19 +10,20 @@ def clean(session):
 @nox.session()
 def py3(session):
     session.install(
+        "-e",
+        ".",
         "pytest",
         "pytest-asyncio",
         "pytest-cov",
         "pytest-xdist",
         "pytest-timeout",
         "coverage",
     )
-    session.install(".")
     session.run(
         "pytest",
         "-n=5",
-        "--cov-append",
         "--cov=src/mail_devel",
+        "--cov-append",
         "--asyncio-mode=auto",
         "--timeout=5",
     )

src/mail_devel/__init__.py

@@ -1,3 +1,3 @@
 from .service import Service
 
-VERSION = "0.8.2"
+VERSION = "0.9.0"

src/mail_devel/http.py

@@ -96,20 +96,30 @@ async def start(self) -> None:
                 web.post(r"/api", self._api_post),
                 web.post(r"/api/upload", self._api_upload),
                 web.get(r"/api", self._api_index),
-                web.get(r"/api/{user}", self._api_user),
-                web.get(r"/api/{user}/{mailbox}", self._api_mailbox),
-                web.get(r"/api/{user}/{mailbox}/{uid:\d+}", self._api_message),
-                web.get(r"/api/{user}/{mailbox}/{uid:\d+}/reply", self._api_reply),
+                web.get(r"/api/{account:\d+}", self._api_account),
+                web.get(r"/api/{account:\d+}/{mailbox:\d+}", self._api_mailbox),
                 web.get(
-                    r"/api/{user}/{mailbox}/{uid:\d+}/attachment/{attachment}",
+                    r"/api/{account:\d+}/{mailbox:\d+}/{uid:\d+}",
+                    self._api_message,
+                ),
+                web.get(
+                    r"/api/{account:\d+}/{mailbox:\d+}/{uid:\d+}/reply",
+                    self._api_reply,
+                ),
+                web.get(
+                    r"/api/{account:\d+}/{mailbox:\d+}/{uid:\d+}/attachment/{attachment}",
                     self._api_attachment,
                 ),
-                web.get(r"/api/{user}/{mailbox}/{uid:\d+}/flags", self._api_flag),
+                web.get(
+                    r"/api/{account:\d+}/{mailbox:\d+}/{uid:\d+}/flags", self._api_flag
+                ),
                 web.put(
-                    r"/api/{user}/{mailbox}/{uid:\d+}/flags/{flag}", self._api_flag
+                    r"/api/{account:\d+}/{mailbox:\d+}/{uid:\d+}/flags/{flag}",
+                    self._api_flag,
                 ),
                 web.delete(
-                    r"/api/{user}/{mailbox}/{uid:\d+}/flags/{flag}", self._api_flag
+                    r"/api/{account:\d+}/{mailbox:\d+}/{uid:\d+}/flags/{flag}",
+                    self._api_flag,
                 ),
             ]
         )
@@ -191,18 +201,22 @@ async def _api_config(self, request: Request) -> Response:  # pylint: disable=W0
         )
 
     async def _api_index(self, request: Request) -> Response:  # pylint: disable=W0613
-        mailboxes = await self.mailboxes.list()
-        return web.json_response(mailboxes)
+        accounts = await self.mailboxes.list()
+        return web.json_response(
+            {self.mailboxes.id_of_user(user): user for user in accounts}
+        )
 
-    async def _api_user(self, request: Request) -> Response:  # pylint: disable=W0613
+    async def _api_account(self, request: Request) -> Response:  # pylint: disable=W0613
         try:
-            user = request.match_info["user"]
-            mailbox = self.mailboxes[user]
+            account_id = int(request.match_info["account"])
+            account = await self.mailboxes.get_by_id(account_id)
         except KeyError as e:  # pragma: no cover
             raise web.HTTPNotFound() from e
 
-        mailboxes = await mailbox.list_mailboxes()
-        return web.json_response([e.name for e in mailboxes.list()])
+        mailboxes = await account.list_mailboxes()
+        return web.json_response(
+            {account.id_of_mailbox(e.name): e.name for e in mailboxes.list()}
+        )
 
     async def _api_upload(self, request: Request) -> Response:  # pylint: disable=W0613
         data = await request.json()
@@ -256,9 +270,10 @@ async def _api_post(self, request: Request) -> Response:
 
     async def _api_mailbox(self, request: Request) -> Response:
         try:
-            user = request.match_info["user"]
-            name = request.match_info["mailbox"]
-            mailbox = await self.mailboxes[user].get_mailbox(name)
+            account_id = int(request.match_info["account"])
+            account = self.mailboxes.user_mapping[account_id]
+            mailbox_id = int(request.match_info["mailbox"])
+            mailbox = await self.mailboxes[account].get_mailbox_by_id(mailbox_id)
         except KeyError as e:  # pragma: no cover
             raise web.HTTPNotFound() from e
 
@@ -270,10 +285,11 @@ async def _api_mailbox(self, request: Request) -> Response:
 
     async def _api_message(self, request: Request) -> Response:
         try:
-            user = request.match_info["user"]
-            name = request.match_info["mailbox"]
+            account_id = int(request.match_info["account"])
+            account = self.mailboxes.user_mapping[account_id]
+            mailbox_id = int(request.match_info["mailbox"])
             uid = int(request.match_info["uid"])
-            mailbox = await self.mailboxes[user].get_mailbox(name)
+            mailbox = await self.mailboxes[account].get_mailbox_by_id(mailbox_id)
         except (IndexError, KeyError) as e:  # pragma: no cover
             raise web.HTTPNotFound() from e
 
@@ -285,10 +301,11 @@ async def _api_message(self, request: Request) -> Response:
 
     async def _api_reply(self, request: Request) -> Response:
         try:
-            user = request.match_info["user"]
-            name = request.match_info["mailbox"]
+            account_id = int(request.match_info["account"])
+            mailbox_id = int(request.match_info["mailbox"])
             uid = int(request.match_info["uid"])
-            mailbox = await self.mailboxes[user].get_mailbox(name)
+            account = await self.mailboxes.get_by_id(account_id)
+            mailbox = await account.get_mailbox_by_id(mailbox_id)
         except (IndexError, KeyError) as e:  # pragma: no cover
             raise web.HTTPNotFound() from e
 
@@ -314,11 +331,12 @@ async def _api_reply(self, request: Request) -> Response:
 
     async def _api_attachment(self, request: Request) -> Response:
         try:
-            user = request.match_info["user"]
-            name = request.match_info["mailbox"]
+            account_id = int(request.match_info["account"])
+            mailbox_id = int(request.match_info["mailbox"])
             uid = int(request.match_info["uid"])
             attachment = request.match_info["attachment"]
-            mailbox = await self.mailboxes[user].get_mailbox(name)
+            account = await self.mailboxes.get_by_id(account_id)
+            mailbox = await account.get_mailbox_by_id(mailbox_id)
         except (IndexError, KeyError) as e:  # pragma: no cover
             raise web.HTTPNotFound() from e
 
@@ -350,9 +368,10 @@ async def _api_attachment(self, request: Request) -> Response:
 
     async def _api_flag(self, request: Request) -> Response:
         try:
-            user = request.match_info["user"]
-            name = request.match_info["mailbox"]
-            mailbox = await self.mailboxes[user].get_mailbox(name)
+            account_id = int(request.match_info["account"])
+            mailbox_id = int(request.match_info["mailbox"])
+            account = await self.mailboxes.get_by_id(account_id)
+            mailbox = await account.get_mailbox_by_id(mailbox_id)
             uid = int(request.match_info["uid"])
 
             if request.method in ("DELETE", "PUT"):

src/mail_devel/mailbox.py

@@ -14,6 +14,23 @@
 class TestMailboxSet(MailboxSet):
     """This MailboxSet creates the mailboxes automatically"""
 
+    def __init__(self):
+        super().__init__()
+        self.mailbox_mapping: dict[int, str] = {}
+
+    def id_of_mailbox(self, name: str) -> int:
+        for mailbox_id, mailbox_name in self.mailbox_mapping.items():
+            if mailbox_name == name:
+                return mailbox_id
+
+        new_id = len(self.mailbox_mapping) + 1
+        self.mailbox_mapping[new_id] = name
+        return new_id
+
+    async def get_mailbox_by_id(self, mailbox_id: int) -> MailboxData:
+        mailbox_name = self.mailbox_mapping[mailbox_id]
+        return await self.get_mailbox(mailbox_name)
+
     async def get_mailbox(self, name: str) -> MailboxData:
         if name not in self._set:
             await self.add_mailbox(name)
@@ -26,16 +43,26 @@ class TestMailboxDict:
     def __init__(
         self, config: IMAPConfig, filter_set: FilterSet, multi_user: bool = False
     ):
-        self.config = config
-        self.filter_set = filter_set
-        self.multi_user = multi_user
+        self.config: IMAPConfig = config
+        self.filter_set: FilterSet = filter_set
+        self.multi_user: bool = multi_user
+        self.user_mapping: dict[int, str] = {}
 
     def __contains__(self, user: str) -> bool:
         return not self.multi_user or user in self.config.set_cache
 
     def __getitem__(self, user: str) -> TestMailboxSet:
         return self.config.set_cache[user][0]
 
+    def id_of_user(self, name: str) -> int:
+        for uid, user_name in self.user_mapping.items():
+            if user_name == name:
+                return uid
+
+        new_id = len(self.user_mapping) + 1
+        self.user_mapping[new_id] = name
+        return new_id
+
     async def inbox_stats(self) -> dict[str, int]:
         stats = {}
         for user, (mset, _fset) in self.config.set_cache.items():
@@ -50,6 +77,13 @@ async def list(self):
 
         return list(self.config.set_cache)
 
+    async def get_by_id(self, user_id: int) -> TestMailboxSet:
+        if not self.multi_user:
+            return await self.get(self.config.demo_user)
+
+        user_name = self.user_mapping[user_id]
+        return await self.get(user_name)
+
     async def get(self, user: str) -> TestMailboxSet:
         """Get the mailbox for the user or the main mailbox if single user mode"""
         if not self.multi_user:

src/mail_devel/resources/index.html

@@ -45,7 +45,7 @@
         <thead>
           <tr>
             <th class="summary">Summary</th>
-            <th class="date">Date</th>
+            <th class="date"><span class="ordering"></span> Date</th>
             <th class="read">Read</th>
           </tr>
         </thead>

src/mail_devel/resources/main.css

@@ -144,6 +144,13 @@ button, .btn {
   width: 1px;
   white-space: nowrap;
 }
+#mailbox .ordering {
+  display: inline-block;
+  vertical-align: text-top;
+  width: 12pt;
+}
+#mailbox .ordering.asc:before {content: "\25B4"}
+#mailbox .ordering.desc:before {content: "\25BC"}
 
 #mailbox table th {
   border: 1px solid gray;