Merge pull request #334 from tracim/fix/278/log_notification_metadata

tracim/development.ini.base

 website.server_name = 127.0.0.1
 
 email.notification.activated = False
+# email.notification.log_file_path = /tmp/mail-notifications.log
 # email notifications can be sent with the user_id added as an identifier
 # this way email clients like Thunderbird will be able to distinguish
 # notifications generated by a user or another one

tracim/test.ini

 radicale.client.base_url.host = http://localhost:15232
 radicale.client.base_url.prefix = /
 email.notification.activated = false
+email.notification.log_file_path = /tmp/mail-notifications-test.log
 
 [server:main]
 use = egg:gearbox#wsgiref

tracim/tracim/config/app_cfg.py

         self.EMAIL_NOTIFICATION_SMTP_PASSWORD = tg.config.get(
             'email.notification.smtp.password',
         )
+        self.EMAIL_NOTIFICATION_LOG_FILE_PATH = tg.config.get(
+            'email.notification.log_file_path',
+            None,
+        )
 
         self.TRACKER_JS_PATH = tg.config.get(
             'js_tracker_path',

tracim/tracim/lib/email.py

 # -*- 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(
         self.password = password
 
 
-
 class EmailSender(object):
     """
     this class allow to send emails and has no relations with SQLAlchemy and other tg HTTP request environment
             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

 # -*- 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):
     """
             email_address = email_address
         )
 
+    @staticmethod
+    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='|',
+                    file=log_file,
+                )
+
     def notify_content_update(self, event_actor_id: int, event_content_id: int):
         """
         Look for all users to be notified about the new content and send them an individual email
             message.attach(part1)
             message.attach(part2)
 
+            self.log_notification(
+                action='CREATED',
+                recipient=message['To'],
+                subject=message['Subject'],
+            )
             send_email_through(async_email_sender.send_mail, message)
 
     def _build_email_body(self, mako_template_filepath: str, role: UserRoleInWorkspace, content: Content, actor: User) -> str:

tracim/tracim/tests/library/test_notification.py

 # -*- coding: utf-8 -*-
+import os
+import re
 
 from nose.tools import eq_
 from nose.tools import ok_
-from nose.tools import raises
-
-from sqlalchemy.orm.exc import NoResultFound
-
-import transaction
 
 from tracim.config.app_cfg import CFG
 from tracim.lib.notifications import DummyNotifier
 from tracim.lib.notifications import RealNotifier
 from tracim.model.auth import User
 from tracim.model.data import Content
-
 from tracim.tests import TestStandard
 
 
     def test_email_subject_tag_list(self):
         tags = EST.all()
 
-        eq_(4,len(tags))
+        eq_(4, len(tags))
         ok_('{website_title}' in tags)
         ok_('{workspace_label}' in tags)
         ok_('{content_label}' in tags)
 
 
 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 = '\|{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(
+            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(
+            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(
+            action=line_2_act,
+            recipient=line_2_rec,
+            subject=line_2_subj,
+        )
+        with open(log_path, 'rt') as log_file:
+            line_1 = log_file.readline()
+            line_2 = log_file.readline()
+        os.remove(path=log_path)
+        ok_(re.search(pattern=line_1_pattern, string=line_1))
+        ok_(re.search(pattern=line_2_pattern, string=line_2))
+
     def test_email_notifier__build_name_with_user_id(self):
         u = User()
         u.user_id = 3
         notifier = EmailNotifier(smtp_config=None, global_config=config)
         email = notifier._get_sender()
         eq_('Robot <noreply@tracim.io>', email)
-