Create new convention for transferring DTOs to entities.

immense · Jul 26, 2023 · 6e1c231 · 6e1c231
1 parent c8d1e9c
commit 6e1c231
Show file tree

Hide file tree

Showing 11 changed files with 126 additions and 83 deletions.
diff --git a/Agent/Services/ExternalScriptingShell.cs b/Agent/Services/ExternalScriptingShell.cs
@@ -1,6 +1,7 @@
 using Immense.RemoteControl.Shared.Extensions;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
+using Remotely.Shared.Dtos;
 using Remotely.Shared.Enums;
 using Remotely.Shared.Models;
 using System;
@@ -17,7 +18,7 @@ public interface IExternalScriptingShell
 {
     Process? ShellProcess { get; }
     Task Init(ScriptingShell shell, string shellProcessName, string lineEnding, string connectionId);
-    Task<ScriptResult> WriteInput(string input, TimeSpan timeout);
+    Task<ScriptResultDto> WriteInput(string input, TimeSpan timeout);
 }
 
 public class ExternalScriptingShell : IExternalScriptingShell
@@ -129,7 +130,7 @@ public async Task Init(ScriptingShell shell, string shellProcessName, string lin
         }
     }
 
-    public async Task<ScriptResult> WriteInput(string input, TimeSpan timeout)
+    public async Task<ScriptResultDto> WriteInput(string input, TimeSpan timeout)
     {
         await _writeLock.WaitAsync();
         var sw = Stopwatch.StartNew();
@@ -186,9 +187,9 @@ public async Task<ScriptResult> WriteInput(string input, TimeSpan timeout)
         return GeneratePartialResult(input, sw.Elapsed);
     }
 
-    private ScriptResult GenerateCompletedResult(string input, TimeSpan runtime)
+    private ScriptResultDto GenerateCompletedResult(string input, TimeSpan runtime)
     {
-        return new ScriptResult()
+        return new ScriptResultDto()
         {
             Shell = _shell,
             RunTime = runtime,
@@ -202,9 +203,9 @@ private ScriptResult GenerateCompletedResult(string input, TimeSpan runtime)
         };
     }
 
-    private ScriptResult GeneratePartialResult(string input, TimeSpan runtime)
+    private ScriptResultDto GeneratePartialResult(string input, TimeSpan runtime)
     {
-        var partialResult = new ScriptResult()
+        var partialResult = new ScriptResultDto()
         {
             Shell = _shell,
             RunTime = runtime,

diff --git a/Agent/Services/PsCoreShell.cs b/Agent/Services/PsCoreShell.cs
@@ -1,5 +1,6 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
+using Remotely.Shared.Dtos;
 using Remotely.Shared.Models;
 using System;
 using System.Collections.Concurrent;
@@ -15,7 +16,7 @@ public interface IPsCoreShell
     string? SenderConnectionId { get; set; }
 
     CommandCompletion GetCompletions(string inputText, int currentIndex, bool? forward);
-    Task<ScriptResult> WriteInput(string input);
+    Task<ScriptResultDto> WriteInput(string input);
 }
 
 public class PsCoreShell : IPsCoreShell
@@ -83,7 +84,7 @@ public CommandCompletion GetCompletions(string inputText, int currentIndex, bool
         return _lastCompletion;
     }
 
-    public async Task<ScriptResult> WriteInput(string input)
+    public async Task<ScriptResultDto> WriteInput(string input)
     {
         var deviceId = _configService.GetConnectionInfo().DeviceID;
         var sw = Stopwatch.StartNew();
@@ -121,7 +122,7 @@ public async Task<ScriptResult> WriteInput(string input)
             var errorAndWarningOut = errorOut.Concat(warningOut).ToArray();
 
 
-            return new ScriptResult()
+            return new ScriptResultDto()
             {
                 DeviceID = _configService.GetConnectionInfo().DeviceID,
                 SenderConnectionID = SenderConnectionId,
@@ -136,7 +137,7 @@ public async Task<ScriptResult> WriteInput(string input)
         catch (Exception ex)
         {
             _logger.LogError(ex, "Error while writing input to PSCore.");
-            return new ScriptResult()
+            return new ScriptResultDto()
             {
                 DeviceID = deviceId,
                 SenderConnectionID = SenderConnectionId,

diff --git a/Agent/Services/ScriptExecutor.cs b/Agent/Services/ScriptExecutor.cs
@@ -3,6 +3,7 @@
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
 using Remotely.Shared;
+using Remotely.Shared.Dtos;
 using Remotely.Shared.Enums;
 using Remotely.Shared.Models;
 using Remotely.Shared.Utilities;
@@ -151,7 +152,7 @@ public async Task RunScript(Guid savedScriptId,
         }
     }
 
-    private async Task<ScriptResult> ExecuteScriptContent(
+    private async Task<ScriptResultDto> ExecuteScriptContent(
         ScriptingShell shell,
         string terminalSessionId,
         string command,
@@ -196,7 +197,7 @@ private async Task<ScriptResult> ExecuteScriptContent(
         }
         throw new InvalidOperationException($"Unknown shell type: {shell}");
     }
-    private async Task<ScriptResultResponse?> SendResultsToApi(ScriptResult result, string expiringToken)
+    private async Task<ScriptResultResponse?> SendResultsToApi(ScriptResultDto result, string expiringToken)
     {
         var targetURL = _configService.GetConnectionInfo().Host + $"/API/ScriptResults";
 

diff --git a/Server/API/ScriptResultsController.cs b/Server/API/ScriptResultsController.cs
@@ -1,8 +1,12 @@
-using Microsoft.AspNetCore.Mvc;
+using Immense.RemoteControl.Shared.Extensions;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Build.Framework;
 using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.Logging;
 using Remotely.Server.Auth;
 using Remotely.Server.Extensions;
 using Remotely.Server.Services;
+using Remotely.Shared.Dtos;
 using Remotely.Shared.Models;
 using System;
 using System.Text;
@@ -16,11 +20,16 @@ public class ScriptResultsController : ControllerBase
 {
     private readonly IDataService _dataService;
     private readonly IEmailSenderEx _emailSender;
+    private readonly ILogger<ScriptResultsController> _logger;
 
-    public ScriptResultsController(IDataService dataService, IEmailSenderEx emailSenderEx)
+    public ScriptResultsController(
+        IDataService dataService, 
+        IEmailSenderEx emailSenderEx,
+        ILogger<ScriptResultsController> logger)
     {
         _dataService = dataService;
         _emailSender = emailSenderEx;
+        _logger = logger;
     }
 
     [HttpGet]
@@ -54,9 +63,15 @@ public ActionResult<FileResult> DownloadResults(string scriptId)
 
     [HttpPost]
     [ServiceFilter(typeof(ExpiringTokenFilter))]
-    public async Task<ActionResult<ScriptResultResponse>> Post([FromBody] ScriptResult result)
+    public async Task<ActionResult<ScriptResultResponse>> Post([FromBody] ScriptResultDto result)
     {
-        _dataService.AddOrUpdateScriptResult(result);
+        var scriptResult = await _dataService.AddScriptResult(result);
+
+        if (!scriptResult.IsSuccess)
+        {
+            _logger.LogResult(scriptResult);
+            return BadRequest();
+        }
 
         var errorOut = result.ErrorOutput ?? Array.Empty<string>();
 
@@ -72,7 +87,7 @@ public async Task<ActionResult<ScriptResultResponse>> Post([FromBody] ScriptResu
             if (savedScript.GenerateAlertOnError)
             {
                 await _dataService.AddAlert(result.DeviceID,
-                    result.OrganizationID,
+                    savedScript.OrganizationID,
                     $"Alert triggered while running script {savedScript.Name}.",
                     string.Join("\n", errorOut));
             }
@@ -108,12 +123,12 @@ await _emailSender.SendEmailAsync(savedScript.SendErrorEmailTo,
 
         if (result.ScriptRunId.HasValue)
         {
-            await _dataService.AddScriptResultToScriptRun(result.ID, result.ScriptRunId.Value);
+            await _dataService.AddScriptResultToScriptRun(scriptResult.Value.ID, result.ScriptRunId.Value);
         }
 
         return new ScriptResultResponse()
         {
-            Id = result.ID
+            Id = scriptResult.Value.ID
         };
     }
 }
diff --git a/Server/Components/AuthComponentBase.cs b/Server/Components/AuthComponentBase.cs
@@ -28,6 +28,8 @@ protected override async Task OnInitializedAsync()
 
     public bool IsAuthenticated { get; private set; }
 
+    public bool IsUserSet => _user is not null;
+
     public RemotelyUser User
     {
         get => _user ?? throw new InvalidOperationException("User has not been resolved yet.");

diff --git a/Server/Components/AuthorizedIndex.razor b/Server/Components/AuthorizedIndex.razor
@@ -16,11 +16,11 @@
 <DevicesFrame />
 <ChatFrame />
 
-@code { 
+@code {
 
     protected override void OnAfterRender(bool firstRender)
     {
-        if (AppConfig.Require2FA && !User.TwoFactorEnabled)
+        if (AppConfig.Require2FA && IsUserSet && !User.TwoFactorEnabled)
         {
             NavManager.NavigateTo("/TwoFactorRequired");
         }
@@ -31,7 +31,7 @@
     {
         await base.OnInitializedAsync();
 
-        if (IsAuthenticated == true && User is null)
+        if (IsAuthenticated == true && !IsUserSet)
         {
             await SignInManager.SignOutAsync();
             NavManager.NavigateTo("/");

diff --git a/Server/Services/DataService.cs b/Server/Services/DataService.cs
@@ -36,10 +36,9 @@ public interface IDataService
 
     Task<Result> AddOrUpdateSavedScript(SavedScript script, string userId);
 
-    void AddOrUpdateScriptResult(ScriptResult scriptResult);
-
     Task AddOrUpdateScriptSchedule(ScriptSchedule schedule);
 
+    Task<Result<ScriptResult>> AddScriptResult(ScriptResultDto dto);
     Task<Result> AddScriptResultToScriptRun(string scriptResultId, int scriptRunId);
 
     Task AddScriptRun(ScriptRun scriptRun);
@@ -228,8 +227,8 @@ Task UpdateBrandingInfo(
 public class DataService : IDataService
 {
     private readonly IApplicationConfig _appConfig;
-    private readonly IHostEnvironment _hostEnvironment;
     private readonly IAppDbFactory _appDbFactory;
+    private readonly IHostEnvironment _hostEnvironment;
     private readonly ILogger<DataService> _logger;
 
     public DataService(
@@ -446,33 +445,6 @@ public async Task<Result> AddOrUpdateSavedScript(SavedScript script, string user
         return Result.Ok();
     }
 
-    public void AddOrUpdateScriptResult(ScriptResult result)
-    {
-        using var dbContext = _appDbFactory.GetContext();
-
-        var device = dbContext.Devices.Find(result.DeviceID);
-
-        if (device is null)
-        {
-            return;
-        }
-
-        result.OrganizationID = device.OrganizationID;
-
-        var existingResult = dbContext.ScriptResults.Find(result.ID);
-        if (existingResult is not null)
-        {
-            var entry = dbContext.Entry(existingResult);
-            entry.CurrentValues.SetValues(result);
-            entry.State = EntityState.Modified;
-        }
-        else
-        {
-            dbContext.ScriptResults.Add(result);
-        }
-        dbContext.SaveChanges();
-    }
-
     public async Task AddOrUpdateScriptSchedule(ScriptSchedule schedule)
     {
         using var dbContext = _appDbFactory.GetContext();
@@ -516,6 +488,31 @@ public async Task AddOrUpdateScriptSchedule(ScriptSchedule schedule)
         await dbContext.SaveChangesAsync();
     }
 
+    public async Task<Result<ScriptResult>> AddScriptResult(ScriptResultDto dto)
+    {
+        using var dbContext = _appDbFactory.GetContext();
+
+        var device = dbContext.Devices.Find(dto.DeviceID);
+
+        if (device is null)
+        {
+            return Result.Fail<ScriptResult>("Device not found.");
+        }
+
+        var scriptResult = new ScriptResult
+        {
+            DeviceID = dto.DeviceID,
+            OrganizationID = device.OrganizationID
+        };
+
+        var entry = dbContext.Attach(scriptResult);
+        entry.CurrentValues.SetValues(dto);
+        entry.State = EntityState.Added;
+        await dbContext.ScriptResults.AddAsync(scriptResult);
+        await dbContext.SaveChangesAsync();
+        return Result.Ok(scriptResult);
+    }
+
     public async Task<Result> AddScriptResultToScriptRun(string scriptResultId, int scriptRunId)
     {
         using var dbContext = _appDbFactory.GetContext();

diff --git a/Shared/DtoEntityBases/ScriptResultBase.cs b/Shared/DtoEntityBases/ScriptResultBase.cs
@@ -0,0 +1,37 @@
+using Remotely.Shared.Enums;
+using Remotely.Shared.Models;
+using Remotely.Shared.Utilities;
+using System;
+using System.Text.Json.Serialization;
+
+namespace Remotely.Shared.DtoEntityBases;
+
+public abstract class ScriptResultBase
+{
+    public virtual required string DeviceID { get; set; }
+
+    public virtual string[]? ErrorOutput { get; set; }
+
+    public virtual bool HadErrors { get; set; }
+
+    public virtual ScriptInputType InputType { get; set; }
+
+    [JsonConverter(typeof(TimeSpanJsonConverter))]
+    public virtual TimeSpan RunTime { get; set; }
+
+    public virtual string ScriptInput { get; set; } = string.Empty;
+
+    public virtual int? ScheduleId { get; set; }
+    public virtual Guid? SavedScriptId { get; set; }
+
+    public virtual int? ScriptRunId { get; set; }
+
+
+    public virtual string? SenderConnectionID { get; set; }
+    public virtual string? SenderUserName { get; set; } = null!;
+    public virtual ScriptingShell Shell { get; set; }
+    public virtual string[]? StandardOutput { get; set; }
+
+    public virtual DateTimeOffset TimeStamp { get; set; } = DateTimeOffset.Now;
+
+}
diff --git a/Shared/Dtos/ScriptResultDto.cs b/Shared/Dtos/ScriptResultDto.cs
@@ -0,0 +1,13 @@
+using Remotely.Shared.DtoEntityBases;
+using Remotely.Shared.Enums;
+using Remotely.Shared.Models;
+using Remotely.Shared.Utilities;
+using System;
+using System.Text.Json.Serialization;
+
+namespace Remotely.Shared.Dtos;
+
+public class ScriptResultDto : ScriptResultBase
+{
+
+}
diff --git a/Shared/Models/ScriptResultResponse.cs → Shared/Dtos/ScriptResultResponse.cs b/Shared/Models/ScriptResultResponse.cs → Shared/Dtos/ScriptResultResponse.cs
@@ -4,7 +4,7 @@
 using System.Text;
 using System.Threading.Tasks;
 
-namespace Remotely.Shared.Models;
+namespace Remotely.Shared.Dtos;
 public class ScriptResultResponse
 {
     public required string Id { get; init; }