Word audio 2 (#24)

- added audio generation on word creation
- added logs
- added results for azure blob

My1kWordsEe/Components/Pages/Word.razor

@@ -8,8 +8,8 @@
 @using My1kWordsEe.Services.Cqs;
 
 @inject IJSRuntime JS
-@inject EnsureWordCommand EnsureWordCommand
-@inject CreateSampleCommand CreateSampleCommand
+@inject GetOrAddSampleWordCommand EnsureWordCommand
+@inject AddSampleSentenceCommand CreateSampleCommand
 
 @code {
     [Parameter]

My1kWordsEe/Models/Ee1kWords.cs

@@ -4,6 +4,9 @@
 
 namespace My1kWordsEe.Models
 {
+    /// <summary>
+    /// Represents a collection of 1k most common Estonian words.
+    /// </summary>
     public class Ee1kWords
     {
         public Ee1kWords()
@@ -32,7 +35,7 @@ public Ee1kWords WithSearch(string search)
                     Search = search,
                     SelectedWords = AllWords
                         .Where(w => w.Value.Contains(search, StringComparison.InvariantCultureIgnoreCase)
-                            || _allWordsDiacriticsFree[w.Value].Contains(search, StringComparison.InvariantCultureIgnoreCase))
+                            || AllWordsDiacriticsFree[w.Value].Contains(search, StringComparison.InvariantCultureIgnoreCase))
                         .ToArray()
                 };
             }
@@ -56,10 +59,10 @@ public Ee1kWords WithSelectedWord(string selectedWord)
 
         public static readonly EeWord[] AllWords = Load1kEeWords();
 
-        private static readonly IReadOnlyDictionary<string, string> _allWordsDiacriticsFree =
+        private static readonly IReadOnlyDictionary<string, string> AllWordsDiacriticsFree =
             AllWords.ToDictionary(w => w.Value, q => RemoveDiacritics(q.Value));
 
-        static string RemoveDiacritics(string stIn)
+        private static string RemoveDiacritics(string stIn)
         {
             string stFormD = stIn.Normalize(NormalizationForm.FormD);
             StringBuilder sb = new StringBuilder();

My1kWordsEe/Models/EeWord.cs

@@ -2,6 +2,10 @@
 
 namespace My1kWordsEe.Models
 {
+    /// <summary>
+    /// currently serves as view model for the 1k words page
+    /// todo: must be unified with <see cref="SampleWord"/>
+    /// </summary>
     [JsonSourceGenerationOptions(UseStringEnumConverter = true)]
     [JsonSerializable(typeof(EePartOfSpeech))]
     public record EeWord

My1kWordsEe/Models/PartsOfSpeech.cs

@@ -54,6 +54,9 @@ public enum EePartOfSpeech
         Kaassõna
     }
 
+    /// <summary>
+    /// Standard English parts of speech
+    /// </summary>
     public enum EnPartOfSpeech
     {
         Noun,

My1kWordsEe/Models/SampleSentence.cs

@@ -1,15 +1,33 @@
 namespace My1kWordsEe.Models
 {
-    public class SampleSentence
+    /// <summary>
+    /// Sample sentence illustrating the use of a give Estonian word
+    /// </summary>
+    public record SampleSentence
     {
-        public string EeWord { get; set; }
+        /// <summary>
+        /// Target Estonian word
+        /// </summary>
+        public string EeWord { get; init; }
 
-        public string EeSentence { get; set; }
+        /// <summary>
+        /// Illustrative sentence in Estonian
+        /// </summary>
+        public string EeSentence { get; init; }
 
-        public string EnSentence { get; set; }
+        /// <summary>
+        /// Translation of the illustrative sentence in English
+        /// </summary>
+        public string EnSentence { get; init; }
 
-        public Uri EeAudioUrl { get; set; }
+        /// <summary>
+        /// Sentence spoken in Estonian
+        /// </summary>
+        public Uri EeAudioUrl { get; init; }
 
-        public Uri ImageUrl { get; set; }
+        /// <summary>
+        /// Image associated with the sentence
+        /// </summary>
+        public Uri ImageUrl { get; init; }
     }
 }

My1kWordsEe/Models/SampleWord.cs

@@ -1,5 +1,8 @@
 namespace My1kWordsEe.Models
 {
+    /// <summary>
+    /// A word of the Estonian language with the respective translations and usage examples
+    /// </summary>
     public record SampleWord
     {
         private readonly string eeWord = "";
@@ -21,18 +24,27 @@ public string EeWord
         public string EnWord { get; init; }
 
         /// <summary>
-        /// Alternatives to EnWord
+        /// Alternative translations to English
         /// </summary>
         public string[] EnWords
         {
             get => this.enWords;
             init => this.enWords = value ?? this.enWords;
         }
 
+        /// <summary>
+        /// Explaining the word in English
+        /// </summary>
         public string EnExplanation { get; init; }
 
+        /// <summary>
+        /// Sample pronunciation of the word
+        /// </summary>
         public Uri EeAudioUrl { get; init; }
 
+        /// <summary>
+        /// Word usage examples
+        /// </summary>
         public SampleSentence[] Samples
         {
             get => this.samples;

My1kWordsEe/Program.cs

@@ -41,11 +41,16 @@ public static void Main(string[] args)
             }
 
             builder.Services.AddSingleton(new StabilityAiService(stabilityAiKey));
-            builder.Services.AddSingleton((p) => new OpenAiService(p.GetRequiredService<ILogger<OpenAiService>>(), openAiKey));
-            builder.Services.AddSingleton(new AzureBlobService(azureBlobConnectionString));
-            builder.Services.AddSingleton(new TartuNlpService());
-            builder.Services.AddSingleton<EnsureWordCommand>();
-            builder.Services.AddSingleton<CreateSampleCommand>();
+            builder.Services.AddSingleton((p) => new OpenAiService(
+                p.GetRequiredService<ILogger<OpenAiService>>(), openAiKey));
+            builder.Services.AddSingleton((p) => new AzureBlobService(
+                p.GetRequiredService<ILogger<AzureBlobService>>(), azureBlobConnectionString));
+            builder.Services.AddSingleton((p) => new TartuNlpService(
+                p.GetRequiredService<ILogger<TartuNlpService>>()));
+            builder.Services.AddSingleton<GetOrAddSampleWordCommand>();
+            builder.Services.AddSingleton<AddSampleSentenceCommand>();
+            builder.Services.AddSingleton<AddSampleWordCommand>();
+            builder.Services.AddSingleton<AddAudioCommand>();
 
             // Add services to the container.
             builder.Services.AddRazorComponents()

My1kWordsEe/Services/Cqs/AddAudioCommand.cs

@@ -0,0 +1,24 @@
+using CSharpFunctionalExtensions;
+
+using My1kWordsEe.Services.Db;
+
+namespace My1kWordsEe.Services.Cqs
+{
+    public class AddAudioCommand
+    {
+        private readonly TartuNlpService tartuNlpService;
+        private readonly AzureBlobService azureBlobService;
+
+        public AddAudioCommand(
+            TartuNlpService tartuNlpService,
+            AzureBlobService azureBlobService)
+        {
+            this.tartuNlpService = tartuNlpService;
+            this.azureBlobService = azureBlobService;
+        }
+
+        public Task<Result<Uri>> Invoke(string text) =>
+          this.tartuNlpService.GetSpeech(text).Bind(
+          this.azureBlobService.SaveAudio);
+    }
+}

My1kWordsEe/Services/Cqs/CreateSampleCommand.cs → My1kWordsEe/Services/Cqs/AddSampleSentenceCommand.cs

@@ -5,22 +5,22 @@
 
 namespace My1kWordsEe.Services.Cqs
 {
-    public class CreateSampleCommand
+    public class AddSampleSentenceCommand
     {
         private readonly AzureBlobService azureBlobService;
         private readonly OpenAiService openAiService;
-        private readonly TartuNlpService tartuNlpService;
+        private readonly AddAudioCommand addAudioCommand;
         private readonly StabilityAiService stabilityAiService;
 
-        public CreateSampleCommand(
+        public AddSampleSentenceCommand(
             AzureBlobService azureBlobService,
             OpenAiService openAiService,
-            TartuNlpService tartuNlpService,
+            AddAudioCommand createAudioCommand,
             StabilityAiService stabilityAiService)
         {
             this.azureBlobService = azureBlobService;
             this.openAiService = openAiService;
-            this.tartuNlpService = tartuNlpService;
+            this.addAudioCommand = createAudioCommand;
             this.stabilityAiService = stabilityAiService;
         }
 
@@ -64,12 +64,11 @@ public async Task<Result<SampleWord>> Invoke(SampleWord word)
         }
 
         private Task<Result<Uri>> GenerateImage(Sentence sentence) =>
-            this.openAiService.GetDallEPrompt(sentence.En)
-                .Bind(this.stabilityAiService.GenerateImage)
-                .Bind(image => Result.Of(this.azureBlobService.SaveImage(image)));
+            this.openAiService.GetDallEPrompt(sentence.En).Bind(
+            this.stabilityAiService.GenerateImage).Bind(
+            this.azureBlobService.SaveImage);
 
         private Task<Result<Uri>> GenerateSpeech(Sentence sentence) =>
-            this.tartuNlpService.GetSpeech(sentence.Ee)
-                .Bind(speech => Result.Of(this.azureBlobService.SaveAudio(speech)));
+            this.addAudioCommand.Invoke(sentence.Ee);
     }
 }

My1kWordsEe/Services/Cqs/AddSampleWordCommand.cs

@@ -0,0 +1,47 @@
+using CSharpFunctionalExtensions;
+
+using My1kWordsEe.Models;
+using My1kWordsEe.Services.Db;
+
+namespace My1kWordsEe.Services.Cqs
+{
+    public class AddSampleWordCommand
+    {
+        private readonly OpenAiService openAiService;
+        private readonly AzureBlobService azureBlobService;
+        private readonly AddAudioCommand addAudioCommand;
+
+        public AddSampleWordCommand(
+            OpenAiService openAiService,
+            AzureBlobService azureBlobService,
+            AddAudioCommand createAudioCommand)
+        {
+            this.azureBlobService = azureBlobService;
+            this.openAiService = openAiService;
+            this.addAudioCommand = createAudioCommand;
+        }
+
+        public async Task<Result<SampleWord>> Invoke(string eeWord)
+        {
+            (await openAiService.GetWordMetadata(eeWord)).Deconstruct(
+                out bool _,
+                out bool isAiFailure,
+                out SampleWord sampleWord,
+                out string aiError);
+
+            if (isAiFailure)
+            {
+                return Result.Failure<SampleWord>(aiError);
+            }
+
+            (await this.addAudioCommand.Invoke(eeWord)).Deconstruct(
+                out bool isAudioSaved,
+                out bool _,
+                out Uri audioUri);
+
+            sampleWord = isAudioSaved ? sampleWord with { EeAudioUrl = audioUri } : sampleWord;
+
+            return (await azureBlobService.SaveWordData(sampleWord)).Bind(_ => Result.Of(sampleWord));
+        }
+    }
+}

My1kWordsEe/Services/Cqs/GetOrAddSampleWordCommand.cs

@@ -0,0 +1,42 @@
+using CSharpFunctionalExtensions;
+
+using My1kWordsEe.Models;
+using My1kWordsEe.Services.Db;
+
+namespace My1kWordsEe.Services.Cqs
+{
+    public class GetOrAddSampleWordCommand
+    {
+        private readonly AzureBlobService azureBlobService;
+        private readonly AddSampleWordCommand addSampleWordCommand;
+
+        public GetOrAddSampleWordCommand(
+            AzureBlobService azureBlobService,
+            AddSampleWordCommand addSampleWordCommand)
+        {
+            this.azureBlobService = azureBlobService;
+            this.addSampleWordCommand = addSampleWordCommand;
+        }
+
+        public async Task<Result<SampleWord>> Invoke(string eeWord)
+        {
+            (await azureBlobService.GetWordData(eeWord)).Deconstruct(
+                out bool _,
+                out bool isBlobAccessFailure,
+                out Maybe<SampleWord> savedWord,
+                out string blobAccessError);
+
+            if (isBlobAccessFailure)
+            {
+                return Result.Failure<SampleWord>(blobAccessError);
+            }
+
+            if (savedWord.HasValue)
+            {
+                return savedWord.Value;
+            }
+
+            return await this.addSampleWordCommand.Invoke(eeWord);
+        }
+    }
+}