Merge pull request #3204 from antgonza/send-job-emails

send job emails to users

Author: charles-cowart

qiita_db/processing_job.py

@@ -781,13 +781,15 @@ def _set_status(self, value):
             new_status = qdb.util.convert_to_id(
                 value, "processing_job_status")
 
-            if (new_status in ('running', 'success', 'error') and
-                    not self.command.analysis_only and
-                    self.user.level == 'admin'):
-                subject = ('Job status change: %s (%s)' % (
-                    self.command.name, self.id))
-                message = ('New status: %s' % (new_status))
-                qdb.util.send_email(self.user.email, subject, message)
+            if self.user.info['receive_processing_job_emails']:
+                # skip if software is internal
+                ignore_software = ('Qiita')
+                if self.command.software.name not in ignore_software:
+                    subject = ('Job status change: %s (%s)' % (
+                        self.command.name, self.id))
+                    message = ('New status: %s' % (new_status))
+                    qdb.util.send_email(self.user.email, subject, message)
+
             sql = """UPDATE qiita.processing_job
                      SET processing_job_status_id = %s
                      WHERE processing_job_id = %s"""

qiita_db/support_files/patches/86.sql

@@ -27,3 +27,7 @@ $$ LANGUAGE plpgsql;
 -- Jun 13, 2022
 -- adding an archive_data column to the artifact
 ALTER TABLE qiita.artifact ADD archive_data JSONB DEFAULT NULL;
+
+-- Jun 15, 2022
+-- adding
+ALTER TABLE qiita.qiita_user ADD receive_processing_job_emails BOOL DEFAULT FALSE;

qiita_db/support_files/qiita-db.dbs

@@ -1247,6 +1247,9 @@
 			<column name="pass_reset_timestamp" type="timestamp" length="0" decimal="6" jt="93" >
 				<comment><![CDATA[Time the reset code was generated]]></comment>
 			</column>
+			<column name="receive_processing_job_emails" type="boolean" jt="-7" mandatory="y" >
+				<defo><![CDATA[false]]></defo>
+			</column>
 			<index name="pk_user" unique="PRIMARY_KEY" >
 				<column name="email" />
 			</index>

qiita_db/support_files/qiita-db.html

@@ -71,7 +71,8 @@ def setUp(self):
             'phone': '111-222-3344',
             'pass_reset_code': None,
             'pass_reset_timestamp': None,
-            'user_verify_code': None
+            'user_verify_code': None,
+            'receive_processing_job_emails': True
         }
 
     def tearDown(self):
@@ -123,6 +124,7 @@ def test_create_user(self):
             'user_verify_code': '',
             'address': None,
             'user_level_id': 5,
+            'receive_processing_job_emails': False,
             'email': 'testcreateuser@test.bar'}
         self._check_correct_info(obs, exp)
 
@@ -159,6 +161,7 @@ def test_create_user_info(self):
             'pass_reset_code': None,
             'user_verify_code': '',
             'user_level_id': 5,
+            'receive_processing_job_emails': True,
             'email': 'testcreateuserinfo@test.bar'}
         self._check_correct_info(obs, exp)
 
@@ -225,6 +228,7 @@ def test_get_info(self):
             'pass_reset_code': None,
             'pass_reset_timestamp': None,
             'user_verify_code': None,
+            'receive_processing_job_emails': False,
             'phone': '222-444-6789'
         }
         self.assertEqual(self.user.info, expinfo)

qiita_db/test/test_user.py

@@ -83,7 +83,7 @@ def test_get_table_cols(self):
         obs = qdb.util.get_table_cols("qiita_user")
         exp = {"email", "user_level_id", "password", "name", "affiliation",
                "address", "phone", "user_verify_code", "pass_reset_code",
-               "pass_reset_timestamp"}
+               "pass_reset_timestamp", "receive_processing_job_emails"}
         self.assertEqual(set(obs), exp)
 
     def test_exists_table(self):

qiita_db/test/test_util.py

@@ -7,7 +7,7 @@
 # -----------------------------------------------------------------------------
 
 from tornado.web import authenticated, HTTPError
-from wtforms import Form, StringField, validators
+from wtforms import Form, StringField, BooleanField, validators
 
 from qiita_pet.handlers.base_handlers import BaseHandler
 from qiita_pet.handlers.api_proxy import user_jobs_get_req
@@ -25,6 +25,8 @@ class UserProfile(Form):
     affiliation = StringField("Affiliation")
     address = StringField("Address")
     phone = StringField("Phone")
+    receive_processing_job_emails = BooleanField(
+        "Receive Processing Job Emails?")
 
 
 class UserProfileHandler(BaseHandler):
@@ -45,14 +47,18 @@ def post(self):
         if action == "profile":
             # tuple of colmns available for profile
             # FORM INPUT NAMES MUST MATCH DB COLUMN NAMES
+            not_str_fields = ('receive_processing_job_emails')
             form_data = UserProfile()
             form_data.process(data=self.request.arguments)
-            profile = {name: data[0].decode('ascii') for name, data in
-                       form_data.data.items()}
+            profile = {name: data[0].decode('ascii')
+                       if name not in not_str_fields else
+                       data
+                       for name, data in form_data.data.items()}
 
             # Turn default value as list into default strings
             for field in form_data:
-                field.data = field.data[0].decode('ascii')
+                if field.name not in not_str_fields:
+                    field.data = field.data[0].decode('ascii')
             try:
                 user.info = profile
                 msg = "Profile updated successfully"