Merge pull request #67 from nowsprinting/feature/regex_ignore_message

Make ignore-messages can be specified by regex

README.md

@@ -134,7 +134,7 @@ Set up a filter to catch abnormal log messages and notify using Reporter.
   <dt>Handle Error</dt><dd>Report when error message is detected in log</dd>
   <dt>Handle Assert</dt><dd>Report when assert message is detected in log</dd>
   <dt>Handle Warning</dt><dd>Report when warning message is detected in log</dd>
-  <dt>Ignore Messages</dt><dd>Log messages containing this string will not be report</dd>
+  <dt>Ignore Messages</dt><dd>Log messages containing this string will not be reported. Regex is also available.</dd>
 </dl>
 
 
@@ -368,7 +368,7 @@ This Agent instance (.asset file) can contain the following.
 
 <dl>
   <dt>Agent</dt><dd>Working Agent. If this Agent exits first, the TimeBombAgent will fail.</dd>
-  <dt>Defuse Message</dt><dd>Defuse the time bomb when this message comes to the log first. Can specify regex.</dd>
+  <dt>Defuse Message</dt><dd>Defuse the time bomb when this message comes to the log first. Regex is also available.</dd>
 </dl>
 
 

README_ja.md

@@ -131,7 +131,7 @@ v1.0.0時点では `EmergencyExitAgent` の使用を想定しています。
   <dt>handle Error</dt><dd>エラーを検知したらレポータで通知します</dd>
   <dt>handle Assert</dt><dd>アサート違反を検知したらレポータで通知します</dd>
   <dt>handle Warning</dt><dd>警告を検知したらレポータで通知します</dd>
-  <dt>Ignore Messages</dt><dd>ここに設定した文字列を含むメッセージはレポータで通知しません</dd>
+  <dt>Ignore Messages</dt><dd>ここに設定した文字列を含むメッセージはレポータで通知しません。正規表現でも指定できます</dd>
 </dl>
 
 

Runtime/Utilities/LogMessageHandler.cs

@@ -2,6 +2,9 @@
 // This software is released under the MIT License.
 
 using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text.RegularExpressions;
 using Cysharp.Threading.Tasks;
 using DeNA.Anjin.Reporters;
 using DeNA.Anjin.Settings;
@@ -17,6 +20,7 @@ public class LogMessageHandler : IDisposable
     {
         private readonly AutopilotSettings _settings;
         private readonly AbstractReporter _reporter;
+        private List<Regex> _ignoreMessagesRegexes;
 
         /// <summary>
         /// Constructor
@@ -63,7 +67,7 @@ public async void HandleLog(string logString, string stackTrace, LogType type)
             }
         }
 
-        private static bool IsIgnoreMessage(string logString, string stackTrace, LogType type,
+        private bool IsIgnoreMessage(string logString, string stackTrace, LogType type,
             AutopilotSettings settings)
         {
             if (type == LogType.Log)
@@ -91,12 +95,14 @@ private static bool IsIgnoreMessage(string logString, string stackTrace, LogType
                 return true;
             }
 
-            foreach (var ignoreMessage in settings.ignoreMessages)
+            if (_ignoreMessagesRegexes == null)
             {
-                if (logString.Contains(ignoreMessage))
-                {
-                    return true;
-                }
+                _ignoreMessagesRegexes = CreateIgnoreMessageRegexes(_settings);
+            }
+
+            if (_ignoreMessagesRegexes.Exists(regex => regex.IsMatch(logString)))
+            {
+                return true;
             }
 
             if (stackTrace.Contains(nameof(LogMessageHandler)) || stackTrace.Contains(nameof(SlackAPI)))
@@ -107,5 +113,27 @@ private static bool IsIgnoreMessage(string logString, string stackTrace, LogType
 
             return false;
         }
+
+        private static List<Regex> CreateIgnoreMessageRegexes(AutopilotSettings settings)
+        {
+            List<Regex> regexs = new();
+            foreach (var message in settings.ignoreMessages)
+            {
+                Regex pattern;
+                try
+                {
+                    pattern = new Regex(message);
+                }
+                catch (ArgumentException e)
+                {
+                    Debug.LogException(e);
+                    continue;
+                }
+
+                regexs.Add(pattern);
+            }
+
+            return regexs;
+        }
     }
 }

Tests/Runtime/Utilities/LogMessageHandlerTest.cs

@@ -7,6 +7,7 @@
 using DeNA.Anjin.TestDoubles;
 using NUnit.Framework;
 using UnityEngine;
+using UnityEngine.TestTools;
 
 namespace DeNA.Anjin.Utilities
 {
@@ -152,6 +153,53 @@ public async Task HandleLog_ContainsIgnoreMessage_notReported()
             Assert.That(spyReporter.Arguments, Is.Empty);
         }
 
+        [Test]
+        public async Task HandleLog_MatchIgnoreMessagePattern_notReported()
+        {
+            var settings = CreateEmptyAutopilotSettings();
+            var spyReporter = ScriptableObject.CreateInstance<SpyReporter>();
+            var sut = new LogMessageHandler(settings, spyReporter);
+
+            settings.ignoreMessages = new[] { "ignore.+ignore" };
+            settings.handleException = true;
+            sut.HandleLog("ignore_xxx_ignore", string.Empty, LogType.Exception);
+            await UniTask.NextFrame();
+
+            Assert.That(spyReporter.Arguments, Is.Empty);
+        }
+
+        [Test]
+        public async Task HandleLog_NotMatchIgnoreMessagePattern_Reported()
+        {
+            var settings = CreateEmptyAutopilotSettings();
+            var spyReporter = ScriptableObject.CreateInstance<SpyReporter>();
+            var sut = new LogMessageHandler(settings, spyReporter);
+
+            settings.ignoreMessages = new[] { "ignore.+ignore" };
+            settings.handleException = true;
+            sut.HandleLog("ignore", string.Empty, LogType.Exception);
+            await UniTask.NextFrame();
+
+            Assert.That(spyReporter.Arguments, Is.Not.Empty);
+        }
+
+        [Test]
+        public async Task HandleLog_InvalidIgnoreMessagePattern_ThrowArgumentExceptionAndReported()
+        {
+            var settings = CreateEmptyAutopilotSettings();
+            var spyReporter = ScriptableObject.CreateInstance<SpyReporter>();
+            var sut = new LogMessageHandler(settings, spyReporter);
+
+            settings.ignoreMessages = new[] { "[a" }; // invalid pattern
+            settings.handleException = true;
+
+            sut.HandleLog("ignore", string.Empty, LogType.Exception);
+            await UniTask.NextFrame();
+
+            LogAssert.Expect(LogType.Exception, "ArgumentException: parsing \"[a\" - Unterminated [] set.");
+            Assert.That(spyReporter.Arguments, Is.Not.Empty); // Report is executed
+        }
+
         [Test]
         public async Task HandleLog_StacktraceByLogMessageHandler_notReported()
         {