Ignore duplicate log entries

Before an entry is appended, match for duplicate and ignore if there is a match.

Author: m4dcoder

orquesta/conducting.py

@@ -229,15 +229,21 @@ def log_entry(self, entry_type, message,
         if entry_type not in ['info', 'warn', 'error']:
             raise exc.WorkflowLogEntryError('The log entry type "%s" is not valid.' % entry_type)
 
-        # Create a log entry.
+        # Identify the appropriate log and then log the entry.
+        log = self.errors if entry_type == 'error' else self.log
+
+        # Create the log entry.
         entry = {'type': entry_type, 'message': message}
         dx.set_dict_value(entry, 'task_id', task_id, insert_null=False)
         dx.set_dict_value(entry, 'task_transition_id', task_transition_id, insert_null=False)
         dx.set_dict_value(entry, 'result', result, insert_null=False)
         dx.set_dict_value(entry, 'data', data, insert_null=False)
 
-        # Identify the appropriate log and then log the entry.
-        log = self.errors if entry_type == 'error' else self.log
+        # Ignore if this is a duplicate.
+        if len(list(filter(lambda x: x == entry, log))) > 0:
+            return
+
+        # Append the log entry.
         log.append(entry)
 
     def log_error(self, e, task_id=None, task_transition_id=None):

orquesta/tests/unit/conducting/test_workflow_conductor.py

@@ -749,7 +749,7 @@ def test_set_workflow_paused_when_has_active_tasks(self):
         conductor.request_workflow_state(states.PAUSED)
         self.assertEqual(conductor.get_workflow_state(), states.PAUSING)
 
-    def test_append_log_entry(self):
+    def test_append_log_entries(self):
         inputs = {'a': 123, 'b': True}
         conductor = self._prep_conductor(inputs=inputs, state=states.RUNNING)
 
@@ -838,3 +838,58 @@ def test_append_log_entry(self):
         self.assertIsInstance(conductor.flow, conducting.TaskFlow)
         self.assertListEqual(conductor.log, expected_log_entries)
         self.assertListEqual(conductor.errors, expected_errors)
+
+    def test_append_duplicate_log_entries(self):
+        inputs = {'a': 123, 'b': True}
+        conductor = self._prep_conductor(inputs=inputs, state=states.RUNNING)
+
+        extra = {'x': 1234}
+        conductor.log_entry('info', 'The workflow is running as expected.', data=extra)
+        conductor.log_entry('info', 'The workflow is running as expected.', data=extra)
+        conductor.log_entry('warn', 'The task may be running a little bit slow.', task_id='task1')
+        conductor.log_entry('warn', 'The task may be running a little bit slow.', task_id='task1')
+        conductor.log_entry('error', 'This is baloney.', task_id='task1')
+        conductor.log_entry('error', 'This is baloney.', task_id='task1')
+        conductor.log_error(TypeError('Something is not right.'), task_id='task1')
+        conductor.log_error(TypeError('Something is not right.'), task_id='task1')
+        conductor.log_errors([KeyError('task1'), ValueError('foobar')], task_id='task1')
+        conductor.log_errors([KeyError('task1'), ValueError('foobar')], task_id='task1')
+
+        expected_log_entries = [
+            {
+                'type': 'info',
+                'message': 'The workflow is running as expected.',
+                'data': extra
+            },
+            {
+                'type': 'warn',
+                'message': 'The task may be running a little bit slow.',
+                'task_id': 'task1'
+            }
+        ]
+
+        expected_errors = [
+            {
+                'type': 'error',
+                'message': 'This is baloney.',
+                'task_id': 'task1'
+            },
+            {
+                'type': 'error',
+                'message': 'TypeError: Something is not right.',
+                'task_id': 'task1'
+            },
+            {
+                'type': 'error',
+                'message': "KeyError: 'task1'",
+                'task_id': 'task1'
+            },
+            {
+                'type': 'error',
+                'message': 'ValueError: foobar',
+                'task_id': 'task1'
+            }
+        ]
+
+        self.assertListEqual(conductor.log, expected_log_entries)
+        self.assertListEqual(conductor.errors, expected_errors)