Completes notification logging

tracim/tracim/lib/email.py

@@ -1,17 +1,16 @@
 # -*- coding: utf-8 -*-
 import smtplib
+import typing
 from email.message import Message
 from email.mime.multipart import MIMEMultipart
 from email.mime.text import MIMEText
 
-import typing
 from mako.template import Template
 from tg.i18n import ugettext as _
 
 from tracim.lib.base import logger
-from tracim.model import User
-
 from tracim.lib.utils import get_rq_queue
+from tracim.model import User
 
 
 def send_email_through(
@@ -53,7 +52,6 @@ class SmtpConfiguration(object):
         self.password = password
 
 
-
 class EmailSender(object):
     """
     this class allow to send emails and has no relations with SQLAlchemy and other tg HTTP request environment
@@ -86,14 +84,19 @@ class EmailSender(object):
             self._smtp_connection.quit()
             logger.info(self, 'Connection closed.')
 
-
     def send_mail(self, message: MIMEMultipart):
         if not self._is_active:
             logger.info(self, 'Not sending email to {} (service desactivated)'.format(message['To']))
         else:
-            self.connect() # Acutally, this connects to SMTP only if required
+            self.connect()  # Acutally, this connects to SMTP only if required
             logger.info(self, 'Sending email to {}'.format(message['To']))
             self._smtp_connection.send_message(message)
+            from tracim.lib.notifications import EmailNotifier
+            EmailNotifier.log_notification(
+                action='   SENT',
+                recipient=message['To'],
+                subject=message['Subject'],
+            )
 
 
 class EmailManager(object):

tracim/tracim/lib/notifications.py

@@ -1,30 +1,31 @@
 # -*- coding: utf-8 -*-
 import datetime
+import typing
 
 from email.header import Header
 from email.mime.multipart import MIMEMultipart
 from email.mime.text import MIMEText
 
-import lxml
 from lxml.html.diff import htmldiff
 
 from mako.template import Template
 
 from tracim.lib.base import logger
+from tracim.lib.email import EmailSender
 from tracim.lib.email import SmtpConfiguration
 from tracim.lib.email import send_email_through
-from tracim.lib.email import EmailSender
 from tracim.lib.user import UserApi
-from tracim.lib.workspace import WorkspaceApi
 from tracim.lib.utils import lazy_ugettext as l_
-from tracim.model.serializers import Context
+from tracim.lib.workspace import WorkspaceApi
+from tracim.model.auth import User
+from tracim.model.data import ActionDescription
+from tracim.model.data import Content
+from tracim.model.data import ContentType
+from tracim.model.data import UserRoleInWorkspace
 from tracim.model.serializers import CTX
+from tracim.model.serializers import Context
 from tracim.model.serializers import DictLikeClass
 
-from tracim.model.data import Content, UserRoleInWorkspace, ContentType, \
-    ActionDescription
-from tracim.model.auth import User
-
 
 class INotifier(object):
     """
@@ -212,17 +213,22 @@ class EmailNotifier(object):
         )
 
     @staticmethod
-    def _log_notification(
-            recipient: str,
-            subject: str
+    def log_notification(
+            action: str,
+            recipient: typing.Optional[str],
+            subject: typing.Optional[str],
     ) -> None:
         """Log notification metadata."""
         from tracim.config.app_cfg import CFG
         log_path = CFG.get_instance().EMAIL_NOTIFICATION_LOG_FILE_PATH
         if log_path:
+            # TODO - A.P - 2017-09-06 - file logging inefficiency
+            # Updating a document with 100 users to notify will leads to open
+            # and close the file 100 times.
             with open(log_path, 'a') as log_file:
                 print(
                     datetime.datetime.now(),
+                    action,
                     recipient,
                     subject,
                     sep='|',
@@ -296,8 +302,9 @@ class EmailNotifier(object):
             message.attach(part1)
             message.attach(part2)
 
-            self._log_notification(
-                recipient=message['for'],
+            self.log_notification(
+                action='CREATED',
+                recipient=message['To'],
                 subject=message['Subject'],
             )
             send_email_through(async_email_sender.send_mail, message)

tracim/tracim/tests/library/test_notification.py

@@ -49,19 +49,32 @@ class TestDummyNotifier(TestStandard):
 class TestEmailNotifier(TestStandard):
 
     def test_unit__log_notification(self):
+        """Check file and format of notification log."""
         log_path = CFG.get_instance().EMAIL_NOTIFICATION_LOG_FILE_PATH
-        pattern = '\|{rec}\|{subj}$\\n'
+        pattern = '\|{act}\|{rec}\|{subj}$\\n'
+        line_1_act = 'CREATED'
         line_1_rec = 'user 1 <us.er@o.ne>'
         line_1_subj = 'notification 1'
-        line_1_pattern = pattern.format(rec=line_1_rec, subj=line_1_subj)
+        line_1_pattern = pattern.format(
+            act=line_1_act,
+            rec=line_1_rec,
+            subj=line_1_subj,
+        )
+        line_2_act = '   SENT'
         line_2_rec = 'user 2 <us.er@t.wo>'
         line_2_subj = 'notification 2'
-        line_2_pattern = pattern.format(rec=line_2_rec, subj=line_2_subj)
-        EmailNotifier._log_notification(
+        line_2_pattern = pattern.format(
+            act=line_2_act,
+            rec=line_2_rec,
+            subj=line_2_subj,
+        )
+        EmailNotifier.log_notification(
+            action=line_1_act,
             recipient=line_1_rec,
             subject=line_1_subj,
         )
-        EmailNotifier._log_notification(
+        EmailNotifier.log_notification(
+            action=line_2_act,
             recipient=line_2_rec,
             subject=line_2_subj,
         )