1703 fix logs file in verbose execution not saved on exception (#1608)

Closes
SoftUni-Internal/exam-systems-issues#1703

**Summary of the changes made**:
1. {Describe your changes in the list}
2.

Author: gogo4ds

PubSub/OJS.PubSub.Worker.Models/Submissions/ProcessedSubmissionPubSubModel.cs

@@ -26,6 +26,8 @@ public ProcessedSubmissionPubSubModel()
 
     public string? WorkerName { get; set; }
 
+    public byte[]? VerboseLogFile { get; set; }
+
     public void SetExecutionResult(ExecutionResultServiceModel executionResultModel)
     {
         this.ExecutionResult = executionResultModel;

Servers/Worker/OJS.Servers.Worker/Consumers/SubmissionsForProcessingConsumer.cs

@@ -2,57 +2,48 @@ namespace OJS.Servers.Worker.Consumers;
 
 using MassTransit;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
 using OJS.Services.Common;
 using OJS.Services.Worker.Business;
 using OJS.Services.Infrastructure.Extensions;
 using System;
 using System.Threading.Tasks;
 using OJS.PubSub.Worker.Models.Submissions;
 using OJS.Services.Common.Extensions;
-using OJS.Services.Common.Models.Submissions;
 using OJS.Services.Common.Models.Submissions.ExecutionContext;
 using OJS.Services.Infrastructure;
 using OJS.Services.Infrastructure.Constants;
+using OJS.Services.Worker.Models.Configuration;
 using OJS.Workers.Common.Exceptions;
+using OJS.Workers.Common.Helpers;
 using OJS.Workers.Common.Models;
 using ConfigurationException = OJS.Workers.Common.Exceptions.ConfigurationException;
 
-public class SubmissionsForProcessingConsumer : IConsumer<SubmissionForProcessingPubSubModel>
+public class SubmissionsForProcessingConsumer(
+    ISubmissionsBusinessService submissionsBusiness,
+    IPublisherService publisher,
+    IHostInfoService hostInfoService,
+    ILogger<SubmissionsForProcessingConsumer> logger,
+    IDatesService dates,
+    IOptions<SubmissionExecutionConfig> executionConfigAccessor)
+    : IConsumer<SubmissionForProcessingPubSubModel>
 {
-    private readonly ISubmissionsBusinessService submissionsBusiness;
-    private readonly IPublisherService publisher;
-    private readonly IHostInfoService hostInfoService;
-    private readonly ILogger<SubmissionsForProcessingConsumer> logger;
-    private readonly IDatesService dates;
-
-    public SubmissionsForProcessingConsumer(
-        ISubmissionsBusinessService submissionsBusiness,
-        IPublisherService publisher,
-        IHostInfoService hostInfoService,
-        ILogger<SubmissionsForProcessingConsumer> logger,
-        IDatesService dates)
-    {
-        this.submissionsBusiness = submissionsBusiness;
-        this.publisher = publisher;
-        this.hostInfoService = hostInfoService;
-        this.logger = logger;
-        this.dates = dates;
-    }
+    private readonly SubmissionExecutionConfig executionConfig = executionConfigAccessor.Value;
 
     public async Task Consume(ConsumeContext<SubmissionForProcessingPubSubModel> context)
     {
-        var startedExecutionOn = this.dates.GetUtcNowOffset();
-        var workerName = this.hostInfoService.GetHostIp();
+        var startedExecutionOn = dates.GetUtcNowOffset();
+        var workerName = hostInfoService.GetHostIp();
 
-        this.logger.LogStartingProcessingSubmission(context.Message.Id, workerName);
+        logger.LogStartingProcessingSubmission(context.Message.Id, workerName);
 
         var submissionStartedProcessingPubSubModel = new SubmissionStartedProcessingPubSubModel
         {
             SubmissionId = context.Message.Id,
             ProcessingStartedAt = startedExecutionOn,
         };
 
-        await this.publisher.Publish(submissionStartedProcessingPubSubModel);
+        await publisher.Publish(submissionStartedProcessingPubSubModel);
 
         var result = new ProcessedSubmissionPubSubModel(context.Message.Id)
         {
@@ -62,9 +53,9 @@ public async Task Consume(ConsumeContext<SubmissionForProcessingPubSubModel> con
         try
         {
             var submission = context.Message.Map<SubmissionServiceModel>();
-            this.logger.LogExecutingSubmission(submission.Id, submission.TrimDetails());
-            var executionResult = await this.submissionsBusiness.ExecuteSubmission(submission);
-            this.logger.LogProducedExecutionResult(submission.Id, executionResult);
+            logger.LogExecutingSubmission(submission.Id, submission.TrimDetails());
+            var executionResult = await submissionsBusiness.ExecuteSubmission(submission);
+            logger.LogProducedExecutionResult(submission.Id, executionResult);
 
             result.SetExecutionResult(executionResult);
         }
@@ -75,19 +66,29 @@ public async Task Consume(ConsumeContext<SubmissionForProcessingPubSubModel> con
                 StrategyException => ExceptionType.Strategy,
                 SolutionException => ExceptionType.Solution,
                 ConfigurationException => ExceptionType.Configuration,
-                _ => ExceptionType.Other
+                _ => ExceptionType.Other,
             };
 
-            this.logger.LogErrorProcessingSubmission(context.Message.Id, result.WorkerName, exception);
+            logger.LogErrorProcessingSubmission(context.Message.Id, result.WorkerName, exception);
             result.SetException(exception, true, exceptionType);
         }
-
         finally
         {
             result.SetStartedAndCompletedExecutionOn(startedExecutionOn.UtcDateTime, completedExecutionOn: DateTime.UtcNow);
+
+            if (context.Message.Verbosely)
+            {
+                // If the submission is marked as verbose, try to read the log file and attach it to the result
+                var logFilePath = FileHelpers.BuildSubmissionLogFilePath(context.Message.Id);
+                if (FileHelpers.FileExists(logFilePath))
+                {
+                    result.VerboseLogFile = await FileHelpers.ReadFileUpToBytes(logFilePath, this.executionConfig.SubmissionVerboseLogFileMaxBytes);
+                    FileHelpers.DeleteFile(logFilePath);
+                }
+            }
         }
 
-        await this.publisher.Publish(result);
-        this.logger.LogPublishedProcessedSubmission(context.Message.Id, result.WorkerName);
+        await publisher.Publish(result);
+        logger.LogPublishedProcessedSubmission(context.Message.Id, result.WorkerName);
     }
 }

Services/Common/OJS.Services.Common.Models/Submissions/ExecutionResultServiceModel.cs

@@ -19,8 +19,6 @@ public class ExecutionResultServiceModel : IMapExplicitly
 
         public OutputResult? OutputResult { get; set; }
 
-        public byte[]? VerboseLogFile { get; set; }
-
         public void RegisterMappings(IProfileExpression configuration)
             => configuration
                 .CreateMap(typeof(ExecutionResult<TestResult>), typeof(ExecutionResultServiceModel))

Services/Common/OJS.Services.Common.Models/Submissions/SubmissionExecutionResult.cs

@@ -16,5 +16,7 @@ public class SubmissionExecutionResult
         public DateTime? CompletedExecutionOn { get; set; }
 
         public string? WorkerName { get; set; }
+
+        public byte[]? VerboseLogFile { get; set; }
     }
 }

Services/Common/OJS.Workers/OJS.Workers.Common/IExecutionContext.cs

@@ -20,8 +20,6 @@ public interface IExecutionContext<TInput>
 
         int MemoryLimit { get; }
 
-        int VerboseLogFileMaxBytes { get; }
-
         TInput Input { get; set; }
     }
 }

Services/Common/OJS.Workers/OJS.Workers.ExecutionStrategies/BaseExecutionStrategy.cs

@@ -46,25 +46,9 @@ public async Task<IExecutionResult<TResult>> SafeExecute<TInput, TResult>(
         try
         {
             executionContext.Code = this.PreprocessCode(executionContext);
-            var result = await this.InternalExecute(executionContext, new ExecutionResult<TResult>());
+            return await this.InternalExecute(executionContext, new ExecutionResult<TResult>());
 
-            if (submission.Verbosely)
-            {
-                // If the submission is marked as verbose, try read the log file and attach it to the result
-                var logFilePath = FileHelpers.BuildSubmissionLogFilePath(submissionId);
-                if (FileHelpers.FileExists(logFilePath))
-                {
-                    result.VerboseLogFile = await FileHelpers.ReadFileUpToBytes(logFilePath, executionContext.VerboseLogFileMaxBytes);
-                }
-                else
-                {
-                    result.ProcessingComment = $"No verbose log file found in {logFilePath}";
-                }
-            }
-
-            return result;
-
-            // Catch logic is handled by the caller
+            // The caller handles catch logic
         }
         finally
         {
@@ -75,7 +59,6 @@ await Task.Run(() =>
                 try
                 {
                     DirectoryHelpers.SafeDeleteDirectory(this.WorkingDirectory, true);
-                    FileHelpers.DeleteFile(FileHelpers.BuildSubmissionLogFilePath(submissionId));
                 }
                 catch (Exception ex)
                 {

Services/Common/OJS.Workers/OJS.Workers.ExecutionStrategies/Models/ExecutionContext.cs

@@ -22,8 +22,6 @@ public class ExecutionContext<TInput> : IExecutionContext<TInput>
 
         public int MemoryLimit { get; set; }
 
-        public int VerboseLogFileMaxBytes { get; set; }
-
         public TInput Input { get; set; }
     }
 }

Services/UI/OJS.Services.Ui.Business/Implementations/SubmissionsBusinessService.cs

@@ -505,9 +505,9 @@ await this.transactionsProvider.ExecuteInTransaction(async () =>
             await this.submissionsForProcessingData.SetProcessingState(submissionForProcessing, SubmissionProcessingState.Processed);
         });
 
-        if (executionResult?.VerboseLogFile != null)
+        if (submissionExecutionResult.VerboseLogFile != null)
         {
-            await this.fileIo.SaveFile(this.GetLogFilePath(submission.Id), executionResult.VerboseLogFile);
+            await this.fileIo.SaveFile(this.GetLogFilePath(submission.Id), submissionExecutionResult.VerboseLogFile);
         }
 
         this.logger.LogSubmissionProcessedSuccessfully(submission.Id, submissionForProcessing);

Services/Worker/OJS.Services.Worker.Business/Implementations/SubmissionExecutor.cs

@@ -57,7 +57,6 @@ private IExecutionContext<TInput> CreateExecutionContext<TInput>(OjsSubmission<T
                     MemoryLimit = submission.MemoryLimit,
                     TimeLimit = submission.TimeLimit,
                     Input = submission.Input,
-                    VerboseLogFileMaxBytes = this.executionConfig.SubmissionVerboseLogFileMaxBytes,
                 };
             }
             catch (Exception ex)