Merge pull request #860 from Particular/use-existing-classifiers

Use existing classifiers

Author: mikeminutillo

src/ServiceControl.UnitTests/Migrations/1.27/SplitFailedMessageDocumentsMigrationTests.cs

@@ -12,6 +12,7 @@
     using ServiceControl.Contracts.Operations;
     using ServiceControl.Infrastructure;
     using ServiceControl.MessageFailures;
+    using ServiceControl.Recoverability;
     using FailedMessage = ServiceControl.MessageFailures.FailedMessage;
 
     [TestFixture]
@@ -287,8 +288,10 @@ public void Split_failuremessages_should_have_failure_groups()
 
                 session.SaveChanges();
             }
+            AddClassifier(new ExceptionTypeAndStackTraceFailureClassifier());
+            AddClassifier(new MessageTypeFailureClassifier());
 
-            var attempts = scenarios.SelectMany(s => s.ProcessingAttempts.Select(pa => new { s.OriginalFailedMessageStatus, pa.ExpectedUniqueMessageId })).ToList();
+            var attempts = scenarios.SelectMany(s => s.ProcessingAttempts.Select(pa => new { s.OriginalFailedMessageStatus, pa.ExpectedUniqueMessageId, EndpointName = pa.Attempt.Headers.ProcessingEndpointName() })).ToList();
 
             // Act
             var migration = CreateMigration();
@@ -311,11 +314,13 @@ public void Split_failuremessages_should_have_failure_groups()
 
                 Assert.IsNotNull(attempt, "Could not find attempt for a failed message");
 
-                var splitGroup = SplitFailedMessageDocumentsMigration.CreateSplitFailureGroup(failedMessage.ProcessingAttempts.Last(), ProcessingAttemptInfo.MessageType, attempt.OriginalFailedMessageStatus);
+                Assert.AreEqual(2, failedMessage.FailureGroups.Count, "A FailedMessage does not have all expected Failure Groups");
 
-                Assert.AreEqual(1, failedMessage.FailureGroups.Count, "A FailedMessage does not have all expected Failure Groups");
-                Assert.IsTrue(failedMessage.FailureGroups.Exists(g => g.Id == splitGroup.Id), "A FailedMessage does not have the expected Split Failure Group");
-                Assert.IsFalse(failedMessage.FailureGroups.Exists(g => g.Id == "GroupId"), "A FailedMessage should not have the Fake Failure Group");
+                var expectedPrefix = string.Format(SplitFailedMessageDocumentsMigration.GroupPrefixFormat, attempt.EndpointName);
+
+                var nonMatchingGroups = failedMessage.FailureGroups.Where(x => x.Title.StartsWith(expectedPrefix) == false).ToArray();
+
+                Assert.IsFalse(nonMatchingGroups.Any(), $"All groups should start with the prefix: {expectedPrefix}");
             }
         }
 
@@ -403,7 +408,13 @@ public ProcessingAttemptInfo(PreSplitScenario scenario, string failedQ, bool isR
                     ReplyToAddress = scenario.ReplyToAddress,
                     FailureDetails = new FailureDetails
                     {
-                        AddressOfFailingEndpoint = failedQ
+                        AddressOfFailingEndpoint = failedQ,
+                        Exception = new ExceptionDetails
+                        {
+                            ExceptionType = "SomeExceptionType",
+                            Message = "An Exception Message",
+                            Source = "TestScenario"
+                        }
                     },
                     Headers = new Dictionary<string, string>
                     {
@@ -437,13 +448,20 @@ public ProcessingAttemptInfo(PreSplitScenario scenario, string failedQ, string e
             }
         }
 
-        private SplitFailedMessageDocumentsMigration CreateMigration() => new SplitFailedMessageDocumentsMigration();
+        private SplitFailedMessageDocumentsMigration CreateMigration() => new SplitFailedMessageDocumentsMigration(failureClassifiers.ToArray());
 
         private EmbeddableDocumentStore documentStore;
+        private IList<IFailureClassifier> failureClassifiers;
+
+        void AddClassifier(IFailureClassifier classifier)
+        {
+            failureClassifiers.Add(classifier);
+        }
 
         [SetUp]
         public void Setup()
         {
+            failureClassifiers = new List<IFailureClassifier>();
             documentStore = InMemoryStoreBuilder.GetInMemoryStore();
         }
 

src/ServiceControl/DbMigrations/1.27/SplitFailedMessageDocumentsMigration.cs

@@ -11,6 +11,13 @@
 
     public class SplitFailedMessageDocumentsMigration : IMigration
     {
+        private readonly IFailureClassifier[] classifiers;
+
+        public SplitFailedMessageDocumentsMigration(IFailureClassifier[] classifiers)
+        {
+            this.classifiers = classifiers;
+        }
+
         public string Apply(IDocumentStore store)
         {
             store.Conventions.DefaultQueryingConsistency = ConsistencyOptions.AlwaysWaitForNonStaleResultsAsOfLastWrite;
@@ -97,10 +104,7 @@ private MigrationStats MigrateFromTemporaryCollection(FailedMessage originalFail
 
                 var messageType = GetMessageType(lastAttempt) ?? "Unknown Message Type";
 
-                failedMessage.FailureGroups = new List<FailedMessage.FailureGroup>
-                    {
-                        CreateSplitFailureGroup(lastAttempt, messageType, originalStatus)
-                    };
+                failedMessage.FailureGroups = CreateFailureGroups(messageType, lastAttempt).ToList();
 
                 if (failedMessage.UniqueMessageId == originalFailedMessage.UniqueMessageId) return;
 
@@ -117,6 +121,30 @@ private MigrationStats MigrateFromTemporaryCollection(FailedMessage originalFail
             return stats;
         }
 
+        private IEnumerable<FailedMessage.FailureGroup> CreateFailureGroups(string messageType, FailedMessage.ProcessingAttempt attempt)
+        {
+            var failureDetails = new ClassifiableMessageDetails(messageType, attempt.FailureDetails);
+
+            foreach (var classifier in classifiers)
+            {
+                var failureGroupTitle = classifier.ClassifyFailure(failureDetails);
+                if (failureGroupTitle == null)
+                {
+                    continue;
+                }
+
+                var prefix = string.Format(GroupPrefixFormat, attempt.Headers.ProcessingEndpointName());
+
+                var fullTitle = $"{prefix}{failureGroupTitle}";
+                yield return new FailedMessage.FailureGroup
+                {
+                    Id = DeterministicGuid.MakeId(classifier.Name, fullTitle).ToString(),
+                    Title = fullTitle,
+                    Type = classifier.Name
+                };
+            }
+        }
+
         private static string GetMessageType(FailedMessage.ProcessingAttempt processingAttempt)
         {
             object messageType;
@@ -127,19 +155,6 @@ private static string GetMessageType(FailedMessage.ProcessingAttempt processingA
             return null;
         }
 
-        public static FailedMessage.FailureGroup CreateSplitFailureGroup(FailedMessage.ProcessingAttempt attempt, string messageType, FailedMessageStatus orignalStatus)
-        {
-            var classifier = new SplitFailedMessageClassifer();
-            var classification = classifier.ClassifyFailure(messageType, orignalStatus, attempt);
-
-            return new FailedMessage.FailureGroup
-            {
-                Id = DeterministicGuid.MakeId(classifier.Name, classification).ToString(),
-                Title = classification,
-                Type = classifier.Name
-            };
-        }
-
         class ProcessingAttemptRecord
         {
             public ProcessingAttemptRecord(FailedMessage.ProcessingAttempt attempt, int index)
@@ -181,5 +196,6 @@ struct MigrationStats
         public const int PageSize = 1024;
         public const string SplitFromUniqueMessageIdHeader = "CollapsedSubscribers.SplitFromUniqueMessageId";
         public const string OriginalStatusHeader = "CollapsedSubscribers.OriginalStatus";
+        public const string GroupPrefixFormat = "Issue 842 - {0} - ";
     }
 }

src/ServiceControl/Recoverability/Grouping/ClassifyFailedMessageEnricher.cs

@@ -12,7 +12,7 @@ class ClassifyFailedMessageEnricher : IFailedMessageEnricher
 
         public ClassifyFailedMessageEnricher(IEnumerable<IFailureClassifier> classifiers)
         {
-            this.classifiers = classifiers.Where(c => c.ApplyToNewFailures).ToArray();
+            this.classifiers = classifiers.ToArray();
         }
 
         public IEnumerable<FailedMessage.FailureGroup> Enrich(string messageType, FailureDetails failureDetails)

src/ServiceControl/Recoverability/Grouping/FailedMessageClassification.cs

@@ -17,7 +17,6 @@ protected override void Setup(FeatureConfigurationContext context)
             context.Container.ConfigureComponent<ExceptionTypeAndStackTraceFailureClassifier>(DependencyLifecycle.SingleInstance);
             context.Container.ConfigureComponent<MessageTypeFailureClassifier>(DependencyLifecycle.SingleInstance);
             context.Container.ConfigureComponent<ClassifyFailedMessageEnricher>(DependencyLifecycle.SingleInstance);
-            context.Container.ConfigureComponent<SplitFailedMessageClassifer>(DependencyLifecycle.SingleInstance);
         }
 
         class ReclassifyErrorsAtStartup : FeatureStartupTask

src/ServiceControl/Recoverability/Grouping/Groupers/ExceptionTypeAndStackTraceFailureClassifier.cs

@@ -25,8 +25,6 @@ public string ClassifyFailure(ClassifiableMessageDetails failure)
             return GetNonStandardClassification(exception.ExceptionType);
         }
 
-        public bool ApplyToNewFailures => true;
-
         static string GetNonStandardClassification(string exceptionType)
         {
             return exceptionType + ": 0";

src/ServiceControl/Recoverability/Grouping/Groupers/IFailureClassifier.cs

@@ -4,6 +4,5 @@ public interface IFailureClassifier
     {
         string Name { get; }
         string ClassifyFailure(ClassifiableMessageDetails failureDetails);
-        bool ApplyToNewFailures { get; }
     }
 }

src/ServiceControl/Recoverability/Grouping/Groupers/MessageTypeFailureClassifier.cs

@@ -9,7 +9,5 @@ public string ClassifyFailure(ClassifiableMessageDetails failureDetails)
         {
             return failureDetails.MessageType;
         }
-
-        public bool ApplyToNewFailures => true;
     }
 }

src/ServiceControl/Recoverability/Grouping/Groupers/SplitFailedMessageClassifer.cs

@@ -389,7 +389,6 @@
     <Compile Include="MessageFailures\FailedMessageViewIndexNotifications.cs" />
     <Compile Include="MessageFailures\FailedMessagesFeature.cs" />
     <Compile Include="MessageFailures\Handlers\UnArchiveMessagesHandler.cs" />
-    <Compile Include="Recoverability\Grouping\Groupers\SplitFailedMessageClassifer.cs" />
     <Compile Include="Recoverability\Grouping\IFailedMessageEnricher.cs" />
     <Compile Include="MessageFailures\Handlers\UnArchiveMessagesByRangeHandler.cs" />
     <Compile Include="MessageFailures\IHaveStatus.cs" />