Merge branch 'main' into bug_fix

microsoft · May 2, 2023 · 821870e · 821870e
2 parents 7308e91 + f3ec0e5
commit 821870e
Show file tree

Hide file tree

Showing 6 changed files with 87 additions and 38 deletions.
diff --git a/src/ApiService/ApiService/OneFuzzTypes/Events.cs b/src/ApiService/ApiService/OneFuzzTypes/Events.cs
@@ -348,14 +348,25 @@ public record EventNotificationFailed(
     Error? Error
 ) : BaseEvent();
 
-public record DownloadableEventMessage : EventMessage {
+public record DownloadableEventMessage : EventMessage, ITruncatable<DownloadableEventMessage> {
     public Uri SasUrl { get; init; }
 
     public DownloadableEventMessage(Guid EventId, EventType EventType, BaseEvent Event, Guid InstanceId, string InstanceName, DateTime CreatedAt, Uri SasUrl)
         : base(EventId, EventType, Event, InstanceId, InstanceName, CreatedAt) {
         this.SasUrl = SasUrl;
     }
+
+    public override DownloadableEventMessage Truncate(int maxLength) {
+        if (this.Event is ITruncatable<BaseEvent> truncatableEvent) {
+            return this with {
+                Event = truncatableEvent.Truncate(maxLength)
+            };
+        } else {
+            return this;
+        }
+    }
 }
+
 public record EventMessage(
     Guid EventId,
     EventType EventType,
@@ -366,7 +377,17 @@ public record EventMessage(
     String InstanceName,
     DateTime CreatedAt,
     String Version = "1.0"
-);
+) : ITruncatable<EventMessage> {
+    public virtual EventMessage Truncate(int maxLength) {
+        if (this.Event is ITruncatable<BaseEvent> truncatableEvent) {
+            return this with {
+                Event = truncatableEvent.Truncate(maxLength)
+            };
+        } else {
+            return this;
+        }
+    }
+}
 
 public class BaseEventConverter : JsonConverter<BaseEvent> {
     public override BaseEvent? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) {

diff --git a/src/ApiService/ApiService/onefuzzlib/Events.cs b/src/ApiService/ApiService/onefuzzlib/Events.cs
@@ -11,8 +11,13 @@ public record SignalREvent
     (
         string Target,
         List<DownloadableEventMessage> arguments
-    );
-
+    ) : ITruncatable<SignalREvent> {
+        public SignalREvent Truncate(int maxLength) {
+            return this with {
+                arguments = arguments.Select(x => x.Truncate(maxLength)).ToList()
+            };
+        }
+    }
 
     public interface IEvents {
         Async.Task SendEvent(BaseEvent anEvent);
@@ -47,8 +52,16 @@ public Events(ILogTracer log, IOnefuzzContext context) {
         }
 
         public virtual async Async.Task QueueSignalrEvent(DownloadableEventMessage message) {
+            var tags = new (string, string)[] {
+                ("event_type", message.EventType.ToString()),
+                ("event_id", message.EventId.ToString())
+            };
             var ev = new SignalREvent("events", new List<DownloadableEventMessage>() { message });
-            await _queue.SendMessage("signalr-events", JsonSerializer.Serialize(ev, _options), StorageType.Config);
+            var queueResult = await _queue.QueueObject("signalr-events", ev, StorageType.Config, serializerOptions: _options);
+
+            if (!queueResult) {
+                _log.WithTags(tags).Error($"Fsailed to queue signalr event");
+            }
         }
 
         public async Async.Task SendEvent(BaseEvent anEvent) {

diff --git a/src/ApiService/ApiService/onefuzzlib/Queue.cs b/src/ApiService/ApiService/onefuzzlib/Queue.cs
@@ -10,7 +10,7 @@
 namespace Microsoft.OneFuzz.Service;
 public interface IQueue {
     Async.Task SendMessage(string name, string message, StorageType storageType, TimeSpan? visibilityTimeout = null, TimeSpan? timeToLive = null);
-    Async.Task<bool> QueueObject<T>(string name, T obj, StorageType storageType, TimeSpan? visibilityTimeout = null, TimeSpan? timeToLive = null);
+    Async.Task<bool> QueueObject<T>(string name, T obj, StorageType storageType, TimeSpan? visibilityTimeout = null, TimeSpan? timeToLive = null, JsonSerializerOptions? serializerOptions = null);
     Task<Uri> GetQueueSas(string name, StorageType storageType, QueueSasPermissions permissions, TimeSpan? duration = null);
     ResourceIdentifier GetResourceId(string queueName, StorageType storageType);
     Task<IList<T>> PeekQueue<T>(string name, StorageType storageType);
@@ -57,23 +57,40 @@ public async Task<QueueClient> GetQueueClient(string name, StorageType storageTy
     public Task<QueueServiceClient> GetQueueClientService(StorageType storageType)
         => _storage.GetQueueServiceClientForAccount(_storage.GetPrimaryAccount(storageType));
 
-    public async Task<bool> QueueObject<T>(string name, T obj, StorageType storageType, TimeSpan? visibilityTimeout = null, TimeSpan? timeToLive = null) {
+    public async Task<bool> QueueObject<T>(string name, T obj, StorageType storageType, TimeSpan? visibilityTimeout = null, TimeSpan? timeToLive = null, JsonSerializerOptions? serializerOptions = null) {
         var queueClient = await GetQueueClient(name, storageType);
+        serializerOptions ??= EntityConverter.GetJsonSerializerOptions();
         try {
-            var serialized = JsonSerializer.Serialize(obj, EntityConverter.GetJsonSerializerOptions());
-            var res = await queueClient.SendMessageAsync(serialized, visibilityTimeout: visibilityTimeout, timeToLive);
-            if (res.GetRawResponse().IsError) {
-                _log.Error($"Failed to send {serialized:Tag:Message} in {name:Tag:QueueName} due to {res.GetRawResponse().ReasonPhrase:Tag:Error}");
-                return false;
-            } else {
-                return true;
-            }
+            return await QueueObjectInternal(obj, queueClient, serializerOptions, visibilityTimeout, timeToLive);
         } catch (Exception ex) {
             _log.Exception(ex, $"Failed to queue message in {name:Tag:QueueName}");
+            if (IsMessageTooLargeException(ex) &&
+                obj is ITruncatable<T> truncatable) {
+                obj = truncatable.Truncate(1000);
+                try {
+                    return await QueueObjectInternal(obj, queueClient, serializerOptions, visibilityTimeout, timeToLive);
+                } catch (Exception ex2) {
+                    _log.Exception(ex2, $"Failed to queue message in {name:Tag:QueueName} after truncation");
+                }
+            }
             return false;
         }
     }
 
+    private async Task<bool> QueueObjectInternal<T>(T obj, QueueClient queueClient, JsonSerializerOptions serializerOptions, TimeSpan? visibilityTimeout = null, TimeSpan? timeToLive = null) {
+        var serialized = JsonSerializer.Serialize(obj, serializerOptions);
+        var res = await queueClient.SendMessageAsync(serialized, visibilityTimeout: visibilityTimeout, timeToLive);
+        if (res.GetRawResponse().IsError) {
+            _log.Error($"Failed to send {serialized:Tag:Message} in {queueClient.Name:Tag:QueueName} due to {res.GetRawResponse().ReasonPhrase:Tag:Error}");
+            return false;
+        } else {
+            return true;
+        }
+    }
+
+    private static bool IsMessageTooLargeException(Exception ex) =>
+        ex is RequestFailedException rfe && rfe.Message.Contains("The request body is too large");
+
     public async Task<Uri> GetQueueSas(string name, StorageType storageType, QueueSasPermissions permissions, TimeSpan? duration) {
         var queueClient = await GetQueueClient(name, storageType);
         var now = DateTimeOffset.UtcNow;

diff --git a/src/ApiService/ApiService/onefuzzlib/WebhookOperations.cs b/src/ApiService/ApiService/onefuzzlib/WebhookOperations.cs
@@ -4,7 +4,6 @@
 using System.Text.Json;
 using System.Threading.Tasks;
 using ApiService.OneFuzzLib.Orm;
-using Azure;
 using Microsoft.OneFuzz.Service.OneFuzzLib.Orm;
 
 namespace Microsoft.OneFuzz.Service;
@@ -61,20 +60,7 @@ private async Async.Task AddEvent(Webhook webhook, DownloadableEventMessage even
             }
         }
 
-        try {
-            await _context.WebhookMessageLogOperations.QueueWebhook(message);
-        } catch (RequestFailedException ex) {
-            if (ex.Message.Contains("The request body is too large") && eventMessage.Event is ITruncatable<BaseEvent> truncatableEvent) {
-                _logTracer.WithTags(tags).Warning($"The WebhookMessageLog was too long for Azure Queue. Truncating event data and trying again.");
-                message = message with {
-                    Event = truncatableEvent.Truncate(1000)
-                };
-                await _context.WebhookMessageLogOperations.QueueWebhook(message);
-            } else {
-                // Not handled
-                throw ex;
-            }
-        }
+        await _context.WebhookMessageLogOperations.QueueWebhook(message);
     }
 
     public async Async.Task<OneFuzzResultVoid> Send(WebhookMessageLog messageLog) {

diff --git a/src/ApiService/ApiService/onefuzzlib/notifications/Ado.cs b/src/ApiService/ApiService/onefuzzlib/notifications/Ado.cs
@@ -72,8 +72,11 @@ public static async Async.Task<OneFuzzResultVoid> Validate(AdoTemplate config) {
             try {
                 connection = new VssConnection(config.BaseUrl, new VssBasicCredential(string.Empty, token.Value));
                 await connection.ConnectAsync();
-            } catch {
-                return OneFuzzResultVoid.Error(ErrorCode.ADO_VALIDATION_INVALID_PAT, $"Failed to connect to {config.BaseUrl} using the provided token");
+            } catch (Exception e) {
+                return OneFuzzResultVoid.Error(ErrorCode.ADO_VALIDATION_INVALID_PAT, new string[] {
+                    $"Failed to connect to {config.BaseUrl} using the provided token",
+                    $"Exception: {e}"
+                });
             }
         } else {
             return OneFuzzResultVoid.Error(ErrorCode.ADO_VALIDATION_INVALID_PAT, "Auth token is missing or invalid");
@@ -98,8 +101,11 @@ public static async Async.Task<OneFuzzResultVoid> Validate(AdoTemplate config) {
                     }
                 );
             }
-        } catch {
-            return OneFuzzResultVoid.Error(ErrorCode.ADO_VALIDATION_INVALID_FIELDS, "Failed to query and compare the valid fields for this project");
+        } catch (Exception e) {
+            return OneFuzzResultVoid.Error(ErrorCode.ADO_VALIDATION_INVALID_FIELDS, new string[] {
+                "Failed to query and compare the valid fields for this project",
+                $"Exception: {e}"
+            });
         }
 
         return OneFuzzResultVoid.Ok;

diff --git a/src/ApiService/ApiService/onefuzzlib/notifications/GithubIssues.cs b/src/ApiService/ApiService/onefuzzlib/notifications/GithubIssues.cs
@@ -35,17 +35,23 @@ public static async Async.Task<OneFuzzResultVoid> Validate(GithubIssuesTemplate
             try {
                 gh = GetGitHubClient(auth.Value.User, auth.Value.PersonalAccessToken);
                 var _ = await gh.User.Get(auth.Value.User);
-            } catch {
-                return OneFuzzResultVoid.Error(ErrorCode.GITHUB_VALIDATION_INVALID_PAT, $"Failed to login to github.com with user {auth.Value.User} and the provided Personal Access Token");
+            } catch (Exception e) {
+                return OneFuzzResultVoid.Error(ErrorCode.GITHUB_VALIDATION_INVALID_PAT, new string[] {
+                    $"Failed to login to github.com with user {auth.Value.User} and the provided Personal Access Token",
+                    $"Exception: {e}"
+                });
             }
         } else {
             return OneFuzzResultVoid.Error(ErrorCode.GITHUB_VALIDATION_INVALID_PAT, $"GithubAuth is missing or invalid");
         }
 
         try {
             var _ = await gh.Repository.Get(config.Organization, config.Repository);
-        } catch {
-            return OneFuzzResultVoid.Error(ErrorCode.GITHUB_VALIDATION_INVALID_REPOSITORY, $"Failed to access repository: {config.Organization}/{config.Repository}");
+        } catch (Exception e) {
+            return OneFuzzResultVoid.Error(ErrorCode.GITHUB_VALIDATION_INVALID_REPOSITORY, new string[] {
+                $"Failed to access repository: {config.Organization}/{config.Repository}",
+                $"Exception: {e}"
+            });
         }
 
         return OneFuzzResultVoid.Ok;