Add an event when an error occurs in the Cytrus watcher

Author: Lounek09

Cyberia.Cytrusaurus/CytrusWatcher.cs

@@ -62,14 +62,24 @@ public interface ICytrusWatcher
     Task CheckAsync();
 
     /// <summary>
-    /// Delegate for the NewCytrusFileDetected event.
+    /// Delegate for the <see cref="NewCytrusFileDetected"/> event.
     /// </summary>
     delegate ValueTask NewCytrusFileDetectedEventHandler(ICytrusWatcher sender, NewCytrusFileDetectedEventArgs eventArgs);
 
     /// <summary>
     /// Event that is triggered when a new Cytrus file is detected.
     /// </summary>
     event NewCytrusFileDetectedEventHandler? NewCytrusFileDetected;
+
+    /// <summary>
+    /// Delegate for the <see cref="CytrusErrored"/> event.
+    /// </summary>
+    delegate ValueTask CytrusErroredEventHandler(ICytrusWatcher sender, CytrusErroredEventArgs eventArgs);
+
+    /// <summary>
+    /// Event that is triggered when an error occurs while processing Cytrus data.
+    /// </summary>
+    event CytrusErroredEventHandler? CytrusErrored;
 }
 
 public sealed class CytrusWatcher : ICytrusWatcher
@@ -149,7 +159,8 @@ await _onlineMonitoredFileRepository.UpsertAsync(new OnlineMonitoredFile
         }
         catch (HttpRequestException e)
         {
-            Log.Error(e, "An error occurred while sending Get request to {CytrusUrl}", $"{BaseUrl}/{CytrusFileName}");
+            await OnCytrusErroredAsync(new CytrusErroredEventArgs(e, "An error occurred while sending a GET request to the Cytrus URL, see the logs for more details."));
+            Log.Error(e, "An error occurred while sending a GET request to {CytrusUrl}", $"{BaseUrl}/{CytrusFileName}");
             return;
         }
 
@@ -164,6 +175,9 @@ await _onlineMonitoredFileRepository.UpsertAsync(new OnlineMonitoredFile
         var cytrus = DeserializeCytrus(json);
         if (cytrus is null)
         {
+            await OnCytrusErroredAsync(new CytrusErroredEventArgs("Failed to deserialize the Cytrus data from the response content, see the logs for more details."));
+            Log.Error("Failed to deserialize the Cytrus data from the response content:\n{CytrusJson}", json);
+
             return;
         }
 
@@ -177,7 +191,7 @@ await _onlineMonitoredFileRepository.UpsertAsync(new OnlineMonitoredFile
         File.WriteAllText(CytrusPath, json);
 
         Log.Information("Cytrus update detected :\n{CytrusDiff}", diff);
-        await OnNewCytrusFileDetected(new NewCytrusFileDetectedEventArgs(Cytrus, OldCytrus, diff));
+        await OnNewCytrusFileDetectedAsync(new NewCytrusFileDetectedEventArgs(Cytrus, OldCytrus, diff));
     }
 
     /// <summary>
@@ -238,9 +252,9 @@ await _onlineMonitoredFileRepository.UpsertAsync(new OnlineMonitoredFile
     public event ICytrusWatcher.NewCytrusFileDetectedEventHandler? NewCytrusFileDetected;
 
     /// <summary>
-    /// Triggers the NewCytrusFileDetected event.
+    /// Triggers the <see cref="NewCytrusFileDetected"/> event.
     /// </summary>
-    internal async ValueTask OnNewCytrusFileDetected(NewCytrusFileDetectedEventArgs eventArgs)
+    internal async ValueTask OnNewCytrusFileDetectedAsync(NewCytrusFileDetectedEventArgs eventArgs)
     {
         var handler = NewCytrusFileDetected;
         if (handler is not null)
@@ -249,5 +263,19 @@ internal async ValueTask OnNewCytrusFileDetected(NewCytrusFileDetectedEventArgs
         }
     }
 
+    public event ICytrusWatcher.CytrusErroredEventHandler? CytrusErrored;
+
+    /// <summary>
+    /// Triggers the <see cref="CytrusErrored"/> event.
+    /// </summary>
+    internal async ValueTask OnCytrusErroredAsync(CytrusErroredEventArgs eventArgs)
+    {
+        var handler = CytrusErrored;
+        if (handler is not null)
+        {
+            await handler.Invoke(this, eventArgs);
+        }
+    }
+
     #endregion
 }

Cyberia.Cytrusaurus/EventArgs/CytrusErroredEventArgs.cs

@@ -0,0 +1,39 @@
+using System.Diagnostics.CodeAnalysis;
+
+namespace Cyberia.Cytrusaurus.EventArgs;
+
+/// <summary>
+/// Represents the event arguments for when an error occurs in the Cytrus watcher.
+/// </summary>
+public sealed class CytrusErroredEventArgs : System.EventArgs
+{
+    /// <summary>
+    /// Gets the exception that occurred, if any.
+    /// </summary>
+    public Exception? Exception { get; init; }
+
+    /// <summary>
+    /// Gets the error message.
+    /// </summary>
+    public required string ErrorMessage { get; init; }
+
+    /// <inheritdoc cref="CytrusErroredEventArgs(Exception?, string)"/>
+    [SetsRequiredMembers]
+    public CytrusErroredEventArgs(string errorMessage)
+        : this(null, errorMessage)
+    {
+
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="CytrusErroredEventArgs"/> class.
+    /// </summary>
+    /// <param name="errorMessage">The error message.</param>
+    /// <param name="exception">The exception that occurred, if any.</param>
+    [SetsRequiredMembers]
+    public CytrusErroredEventArgs(Exception? exception, string errorMessage)
+    {
+        Exception = exception;
+        ErrorMessage = errorMessage;
+    }
+}

Cyberia.Cytrusaurus/EventArgs/NewCytrusFileDetectedEventArgs.cs

@@ -1,5 +1,7 @@
 using Cyberia.Cytrusaurus.Models;
 
+using System.Diagnostics.CodeAnalysis;
+
 namespace Cyberia.Cytrusaurus.EventArgs;
 
 /// <summary>
@@ -10,24 +12,25 @@ public sealed class NewCytrusFileDetectedEventArgs : System.EventArgs
     /// <summary>
     /// Gets the current Cytrus data.
     /// </summary>
-    public Cytrus Cytrus { get; init; }
+    public required Cytrus Cytrus { get; init; }
 
     /// <summary>
     /// Gets the old Cytrus data.
     /// </summary>
-    public Cytrus OldCytrus { get; init; }
+    public required Cytrus OldCytrus { get; init; }
 
     /// <summary>
     /// Gets the difference between the current and old Cytrus data.
     /// </summary>
-    public string Diff { get; init; }
+    public required string Diff { get; init; }
 
     /// <summary>
     /// Initializes a new instance of the <see cref="NewCytrusFileDetectedEventArgs"/> class.
     /// </summary>
     /// <param name="cytrus">The current Cytrus data.</param>
     /// <param name="oldCytrus">The old Cytrus data.</param>
     /// <param name="diff">The difference between the current and old Cytrus data.</param>
+    [SetsRequiredMembers]
     internal NewCytrusFileDetectedEventArgs(Cytrus cytrus, Cytrus oldCytrus, string diff)
     {
         Cytrus = cytrus;

Cyberia.Langzilla/EventArgs/CheckLangFinishedEventArgs.cs

@@ -1,5 +1,7 @@
 using Cyberia.Langzilla.Models;
 
+using System.Diagnostics.CodeAnalysis;
+
 namespace Cyberia.Langzilla.EventArgs;
 
 /// <summary>
@@ -10,18 +12,19 @@ public sealed class CheckLangFinishedEventArgs : System.EventArgs
     /// <summary>
     /// The checked lang repository.
     /// </summary>
-    public LangsRepository Repository { get; init; }
+    public required LangsRepository Repository { get; init; }
 
     /// <summary>
     /// The list of the updated langs.
     /// </summary>
-    public IReadOnlyList<Lang> UpdatedLangs { get; init; }
+    public required IReadOnlyList<Lang> UpdatedLangs { get; init; }
 
     /// <summary>
     /// Initializes a new instance of the <see cref="CheckLangFinishedEventArgs"/> class.
     /// </summary>
     /// <param name="repository">The checked lang repository.</param>
     /// <param name="updatedLangs">The list of updated langs.</param>
+    [SetsRequiredMembers]
     internal CheckLangFinishedEventArgs(LangsRepository repository, IReadOnlyList<Lang> updatedLangs)
     {
         Repository = repository;

Cyberia.Langzilla/EventArgs/CheckLangStartedEventArgs.cs

@@ -1,5 +1,7 @@
 using Cyberia.Langzilla.Models;
 
+using System.Diagnostics.CodeAnalysis;
+
 namespace Cyberia.Langzilla.EventArgs;
 
 /// <summary>
@@ -10,12 +12,13 @@ public sealed class CheckLangStartedEventArgs : System.EventArgs
     /// <summary>
     /// The checked lang repository.
     /// </summary>
-    public LangsRepository Repository { get; init; }
+    public required LangsRepository Repository { get; init; }
 
     /// <summary>
     /// Initializes a new instance of the <see cref="CheckLangStartedEventArgs"/> class.
     /// </summary>
     /// <param name="repository">The checked lang repository.</param>
+    [SetsRequiredMembers]
     internal CheckLangStartedEventArgs(LangsRepository repository)
     {
         Repository = repository;

Cyberia.Salamandra/Commands/Admin/Parse/ParseCommandModule.cs

@@ -36,7 +36,7 @@ public async Task EffectsExecuteAsync(SlashCommandContext ctx,
         var effects = EffectFactory.CreateMany(value);
         if (effects.Count > 0)
         {
-            var embed = _embedBuilderService.CreateEmbedBuilder(EmbedCategory.Tools, "Tools", culture)
+            var embed = _embedBuilderService.CreateBaseEmbedBuilder(EmbedCategory.Tools, "Tools", culture)
                 .WithTitle("Item effects parser");
 
             _embedBuilderService.AddEffectFields(embed, "Effects :", effects, true, culture);
@@ -59,7 +59,7 @@ public async Task CriteriaExecuteAsync(SlashCommandContext ctx,
         var criteria = CriterionFactory.CreateMany(value);
         if (criteria.Count > 0)
         {
-            var embed = _embedBuilderService.CreateEmbedBuilder(EmbedCategory.Tools, "Tools", culture)
+            var embed = _embedBuilderService.CreateBaseEmbedBuilder(EmbedCategory.Tools, "Tools", culture)
                 .WithTitle("Criteria parser");
 
             _embedBuilderService.AddCriteriaFields(embed, criteria, culture);

Cyberia.Salamandra/Commands/Admin/Search/SearchCommandModule.cs

@@ -72,7 +72,7 @@ public async Task CriterionExecuteAsync(SlashCommandContext ctx,
                 return;
         }
 
-        var embed = _embedBuilderService.CreateEmbedBuilder(EmbedCategory.Tools, "Tools", culture)
+        var embed = _embedBuilderService.CreateBaseEmbedBuilder(EmbedCategory.Tools, "Tools", culture)
             .WithTitle($"Search criterion {criterionId} in {location}")
             .WithDescription(descriptionBuilder.ToString().WithMaxLength(Constant.MaxEmbedDescriptionSize));
 
@@ -119,7 +119,7 @@ public async Task EffectExecuteAsync(SlashCommandContext ctx,
                 return;
         }
 
-        var embed = _embedBuilderService.CreateEmbedBuilder(EmbedCategory.Tools, "Tools", culture)
+        var embed = _embedBuilderService.CreateBaseEmbedBuilder(EmbedCategory.Tools, "Tools", culture)
             .WithTitle($"Search effect {effectId} in {location}")
             .WithDescription(descriptionBuilder.ToString().WithMaxLength(Constant.MaxEmbedDescriptionSize));
 
@@ -151,7 +151,7 @@ public async Task ItemSpriteExecuteAsync(SlashCommandContext ctx,
             }
         }
 
-        var embed = _embedBuilderService.CreateEmbedBuilder(EmbedCategory.Tools, "Tools", culture)
+        var embed = _embedBuilderService.CreateBaseEmbedBuilder(EmbedCategory.Tools, "Tools", culture)
             .WithTitle($"Search gfx {gfxId} in {_dofusDatacenter.ItemsRepository.GetItemTypeNameById(itemTypeId, culture)} ({itemTypeId})")
             .WithThumbnail(await ImageUrlProvider.GetImagePathAsync($"items/{itemTypeId}", gfxId, CdnImageSize.Size128))
             .WithDescription(descriptionBuilder.ToString().WithMaxLength(Constant.MaxEmbedDescriptionSize));

Cyberia.Salamandra/Commands/Data/Cytrus/CytrusCommandModule.cs

@@ -52,7 +52,7 @@ public async Task ShowExecuteAsync(SlashCommandContext ctx)
     {
         var culture = await _cultureService.GetCultureAsync(ctx.Interaction);
 
-        var embed = _embedBuilderService.CreateEmbedBuilder(EmbedCategory.Tools, "Cytrus", culture)
+        var embed = _embedBuilderService.CreateBaseEmbedBuilder(EmbedCategory.Tools, "Cytrus", culture)
             .WithDescription(CytrusWatcher.CytrusUrl)
             .AddField("Name", _cytrusWatcher.Cytrus.Name.Capitalize(), true)
             .AddField("Version", _cytrusWatcher.Cytrus.Version.ToString(), true)

Cyberia.Salamandra/Commands/Data/Langs/LangsMessageBuilder.cs

@@ -68,7 +68,7 @@ private Task<DiscordEmbedBuilder> EmbedBuilder()
         var type = _repository.Type.ToStringFast();
         var language = _repository.Language.ToStringFast();
 
-        var embed = _embedBuilderService.CreateEmbedBuilder(EmbedCategory.Tools, "Langs", _culture)
+        var embed = _embedBuilderService.CreateBaseEmbedBuilder(EmbedCategory.Tools, "Langs", _culture)
             .WithTitle($"Langs {type} in {language}");
 
         if (_repository.Langs.Count > 0)

Cyberia.Salamandra/Commands/Dofus/Breed/BreedMessageBuilder.cs

@@ -86,7 +86,7 @@ public static string GetPacket(int breedId)
 
     private async Task<DiscordEmbedBuilder> EmbedBuilder()
     {
-        var embed = _embedBuilderService.CreateEmbedBuilder(EmbedCategory.Breeds, Translation.Get<BotTranslations>("Embed.Breed.Author", _culture), _culture)
+        var embed = _embedBuilderService.CreateBaseEmbedBuilder(EmbedCategory.Breeds, Translation.Get<BotTranslations>("Embed.Breed.Author", _culture), _culture)
             .WithTitle($"{_breedData.LongName.ToString(_culture)} ({_breedData.Id})")
             .WithDescription(Formatter.Italic(_breedData.Description.ToString(_culture)))
             .WithThumbnail(await _breedData.GetIconImagePathAsync(CdnImageSize.Size128))