Merge pull request #10 from emu-sync/dev

Local backups + restore + syc logs

Author: emu-sync

CHANGELOG.md

@@ -56,4 +56,20 @@ This is the same release as 1.0.2, but with a fix for Windows not correctly iden
 # v1.0.5
 
 ## Fixes
-- Fixed an issue where nested folder structure wasn't being retained on restore from Windows to Linux.
+- Fixed an issue where nested folder structure wasn't being retained on restore from Windows to Linux.
+
+# v1.0.6
+
+## Local game backups
+- EmuSync automatically creates a local backup of your game save before downloading a newer version.
+    - Backups are stored locally on each of your devices.
+    - Control how many backups are kept in the **This device** section (default: 10).
+- Easily restore from any previous backup if an incorrect save overwrites your progress.
+    - Ideal for recovering from incorrect sync issues.
+
+## Local sync history
+- You can now keep track of when EmuSync uploads or downloads files for your configured games.
+    - Useful for troubleshooting and understanding exactly when AutoSync occurs.
+
+## Other
+- Tweaked the layout of several sections to provide clearer visual structure (hopefully!).

NEWS.md

@@ -3,8 +3,7 @@ There is a now Decky plugin available for SteamDeck users! Please check out how
 
 The status of your game syncs can now be checked via the Decky plugin, as well as manually syncing your game saves - no more hopping into desktop mode each time.
 
-## Features I plan to add
+## Local game backups & restore mechanism
+The latest version of EmuSync will now keep local backups whenever it downloads new files, so if something goes horribly wrong, there is a now a disaster recovery option!
 
-- Device specific sync log/history so you can review when saves were uploaded from/downloaded to the device.
-- Local backups of game save files whenever new files are downloaded to a device.
-  - This will also include a restore from backup mechanism.
+Read more about game backups [here](https://github.com/emu-sync/EmuSync/wiki/Local-game-backups).

README.md

@@ -7,9 +7,9 @@
 ## 📖 About
 
 Game save files are stored in different places across OS platforms, which can make syncing a challenge.
-EmuSync aims to simplify this by mapping locations from multiple devices to a single sync point. 
+EmuSync aims to simplify this by mapping locations from multiple devices to a single sync point, using your chosen cloud storage provider as the storage point.
 
-Easily set up which games you want keep backed up and let EmuSync handle the rest! It even works in Gaming mode on the SteamDeck - check out the Decky plugin [here](https://github.com/emu-sync/EmuSync-DeckyPlugin).
+Easily set up which games you want to keep backed up and let EmuSync handle the rest! It even works in Gaming mode on the SteamDeck - check out the Decky plugin [here](https://github.com/emu-sync/EmuSync-DeckyPlugin).
 
 - If you're having trouble with EmuSync, or want to see in more detail how to use it, please see our [Wiki](https://github.com/emu-sync/EmuSync/wiki).
 - Want to see what EmuSync looks like before you download it? Check out the [Preview](https://github.com/emu-sync/EmuSync/wiki/Preview-EmuSync) page in our wiki.
@@ -38,7 +38,8 @@ Confirmed working devices (but not limited to):
 - Define and manage your game save locations.
 - Automatically detect game saves, making the configuration of your game syncs a breeze.
 - Automatically and manually sync game saves.
-- A Decky plugin for SteamDeck users so you can check on the status of your game syncs without having to hop into desktop mode
+- Local backup & restore mechanism.
+- A Decky plugin for SteamDeck users so you can check on the status of your game syncs without having to hop into desktop mode.
     - [EmuSync-DeckyPlugin](https://github.com/emu-sync/EmuSync-DeckyPlugin)
 
 ## 🛠️ Installation

src/EmuSync.Agent/Background/GameSyncWorker.cs

@@ -71,7 +71,7 @@ private async Task<TimeSpan> TryGetLoopDelayAsync(CancellationToken cancellation
 
             return syncSource?.AutoSyncFrequency ?? _options.LoopDelayTimeSpan;
         }
-        catch (Exception ex)
+        catch
         {
             return _options.LoopDelayTimeSpan;
         }

src/EmuSync.Agent/Background/LudusaviManifestWorker.cs

@@ -52,7 +52,6 @@ protected override async Task ExecuteAsync(CancellationToken cancellationToken)
                     {
                         var result = await _manifestScanner.ScanForSaveFilesAsync(gameDefinitions, cancellationToken);
 
-                        _lastScanTime = DateTime.UtcNow;
                         _countOfGamesFound = result.FoundGames.Count;
                     }
                 }
@@ -62,6 +61,7 @@ protected override async Task ExecuteAsync(CancellationToken cancellationToken)
                 }
                 finally
                 {
+                    _lastScanTime = DateTime.UtcNow;
                     _scanInProgress = false;
                 }
             }

src/EmuSync.Agent/Controllers/GameController.cs

@@ -1,7 +1,6 @@
 using EmuSync.Agent.Dto.Game;
 using EmuSync.Domain;
 using EmuSync.Domain.Extensions;
-using EmuSync.Domain.Services;
 using EmuSync.Domain.Services.Interfaces;
 using EmuSync.Services.LudusaviImporter;
 using EmuSync.Services.Managers.Interfaces;
@@ -18,7 +17,8 @@ public class GameController(
     IGameSyncStatusCache gameSyncStatusCache,
     IGameSyncService gameSyncService,
     ISyncTasks syncTasks,
-    IApiCache apiCache
+    IApiCache apiCache,
+    ILocalGameSaveBackupService localGameSaveBackupService
 ) : CustomControllerBase(logger, validator)
 {
     private readonly IGameManager _manager = manager;
@@ -27,9 +27,10 @@ IApiCache apiCache
     private readonly IGameSyncService _gameSyncService = gameSyncService;
     private readonly ISyncTasks _syncTasks = syncTasks;
     private readonly IApiCache _apiCache = apiCache;
+    private readonly ILocalGameSaveBackupService _localGameSaveBackupService = localGameSaveBackupService;
 
     [HttpGet]
-    public async Task<IActionResult> GetList( CancellationToken cancellationToken = default)
+    public async Task<IActionResult> GetList(CancellationToken cancellationToken = default)
     {
         List<GameEntity>? list = _apiCache.Games.Value;
 
@@ -39,7 +40,7 @@ public async Task<IActionResult> GetList( CancellationToken cancellationToken =
             if (list != null) _apiCache.Games.Set(list);
         }
 
-        //if we have games, just reprocess all the file watchers that might be attached / re-evaluate the sync statuses
+        //if we have games, just re-evaluate the sync statuses
         if (list != null && list.Count > 0)
         {
             await _gameSyncService.TryDetectGameSyncStatusesAsync(list, cancellationToken);
@@ -61,7 +62,7 @@ public async Task<IActionResult> GetList( CancellationToken cancellationToken =
     }
 
     [HttpGet("{id}")]
-    public async Task<IActionResult> GetById(string id, CancellationToken cancellationToken = default)
+    public async Task<IActionResult> GetById([FromRoute]string id, CancellationToken cancellationToken = default)
     {
         GameEntity? entity = _apiCache.GetGame(id);
         entity ??= await _manager.GetAsync(id, cancellationToken);
@@ -71,7 +72,6 @@ public async Task<IActionResult> GetById(string id, CancellationToken cancellati
             return NotFoundWithErrors($"No game found with ID {id}");
         }
 
-        //even if we fetch, just update the watcher - we might have an outdated on this device
         await TryUpdateSyncTaskAsync(entity, cancellationToken);
 
         GameDto response = entity.ToDto();
@@ -89,6 +89,16 @@ public async Task<IActionResult> GetSuggestions(CancellationToken cancellationTo
         return Ok(response);
     }
 
+    [HttpGet("{id}/Backups")]
+    public async Task<IActionResult> GetGameBackups([FromRoute] string id, CancellationToken cancellationToken = default)
+    {
+        List<LocalGameBackupManifestEntity> manifests = await _localGameSaveBackupService.GetBackupsAsync(id, cancellationToken);
+
+        List<GameBackupManifestDto> response = manifests.ConvertAll(x => x.ToDto());
+
+        return Ok(response);
+    }
+
     [HttpPost]
     public async Task<IActionResult> Create([FromBody] CreateGameDto requestBody, CancellationToken cancellationToken = default)
     {

src/EmuSync.Agent/Controllers/GameSyncController.cs

@@ -79,7 +79,7 @@ public async Task<IActionResult> SyncNow([FromRoute] string id, CancellationToke
             return NotFoundWithErrors($"No game found with ID {id}");
         }
 
-        await _manager.SyncGameAsync(syncSource.Id, game, cancellationToken);
+        await _manager.SyncGameAsync(syncSource.Id, game, isAutoSync: false, cancellationToken);
 
         _gameSyncStatusCache.AddOrUpdate(id, GameSyncStatus.InSync);
 
@@ -89,7 +89,7 @@ public async Task<IActionResult> SyncNow([FromRoute] string id, CancellationToke
     [HttpPost("{id}/ForceUpload")]
     public async Task<IActionResult> ForceUpload([FromRoute] string id, CancellationToken cancellationToken = default)
     {
-        LogRequest($"{nameof(ForceUpload)}/{id}");
+        LogRequest($"{id}/{nameof(ForceUpload)}");
 
         SyncSourceEntity? syncSource = await _syncSourceManager.GetLocalAsync(cancellationToken);
 
@@ -106,7 +106,7 @@ public async Task<IActionResult> ForceUpload([FromRoute] string id, Cancellation
             return NotFoundWithErrors($"No game found with ID {id}");
         }
 
-        await _manager.ForceUploadGameAsync(syncSource.Id, game, cancellationToken);
+        await _manager.ForceUploadGameAsync(syncSource.Id, game, isAutoSync: false, cancellationToken);
 
         _gameSyncStatusCache.AddOrUpdate(id, GameSyncStatus.InSync);
 
@@ -116,7 +116,7 @@ public async Task<IActionResult> ForceUpload([FromRoute] string id, Cancellation
     [HttpPost("{id}/ForceDownload")]
     public async Task<IActionResult> ForceDownload([FromRoute] string id, CancellationToken cancellationToken = default)
     {
-        LogRequest($"{nameof(ForceDownload)}/{id}");
+        LogRequest($"{id}/{nameof(ForceDownload)}");
 
         SyncSourceEntity? syncSource = await _syncSourceManager.GetLocalAsync(cancellationToken);
 
@@ -133,7 +133,34 @@ public async Task<IActionResult> ForceDownload([FromRoute] string id, Cancellati
             return NotFoundWithErrors($"No game found with ID {id}");
         }
 
-        await _manager.ForceDownloadGameAsync(syncSource.Id, game, cancellationToken);
+        await _manager.ForceDownloadGameAsync(syncSource.Id, game, isAutoSync: false, cancellationToken);
+
+        _gameSyncStatusCache.AddOrUpdate(id, GameSyncStatus.InSync);
+
+        return Ok();
+    }
+
+    [HttpPost("{id}/RestoreFromBackup/{backupId}")]
+    public async Task<IActionResult> RestoreFromBackup([FromRoute] string id, [FromRoute] string backupId, CancellationToken cancellationToken = default)
+    {
+        LogRequest($"{id}/{nameof(RestoreFromBackup)}/{backupId}");
+
+        SyncSourceEntity? syncSource = await _syncSourceManager.GetLocalAsync(cancellationToken);
+
+        if (syncSource == null)
+        {
+            return BadRequest("No sync source has been set up");
+        }
+
+        //always fetch latest game on force
+        GameEntity? game = await _gameManager.GetAsync(id, cancellationToken);
+
+        if (game == null)
+        {
+            return NotFoundWithErrors($"No game found with ID {id}");
+        }
+
+        await _manager.RestoreFromBackup(syncSource.Id, game, backupId, cancellationToken);
 
         _gameSyncStatusCache.AddOrUpdate(id, GameSyncStatus.InSync);
 

src/EmuSync.Agent/Controllers/LocalSyncLogController.cs

@@ -0,0 +1,35 @@
+using EmuSync.Agent.Dto.LocalSyncLog;
+using EmuSync.Domain.Services.Interfaces;
+
+namespace EmuSync.Agent.Controllers;
+
+[ApiController]
+[Route("[controller]")]
+public class LocalSyncLogController(
+    ILogger<LocalSyncLogController> logger,
+    IValidationService validator,
+    ILocalSyncLog localSyncLog
+) : CustomControllerBase(logger, validator)
+{
+    private readonly ILocalSyncLog _localSyncLog = localSyncLog;
+
+    [HttpGet]
+    public async Task<IActionResult> GetAllLogs(CancellationToken cancellationToken = default)
+    {
+        List<LocalSyncLogEntity> localSyncLogs = await _localSyncLog.GetAllLogsAsync(cancellationToken);
+
+        List<LocalSyncLogDto> response = localSyncLogs.ConvertAll(log => log.ToDto());
+
+        return Ok(response);
+    }
+
+    [HttpGet("Game/{gameId}")]
+    public async Task<IActionResult> GetLogsForGame(string gameId, CancellationToken cancellationToken = default)
+    {
+        List<LocalSyncLogEntity> localSyncLogs = await _localSyncLog.GetAllLogsForGameAsync(gameId, cancellationToken);
+
+        List<LocalSyncLogDto> response = localSyncLogs.ConvertAll(log => log.ToDto());
+
+        return Ok(response);
+    }
+}

src/EmuSync.Agent/Controllers/SyncSourceController.cs

@@ -63,7 +63,7 @@ public async Task<IActionResult> GetGameScanDetails(CancellationToken cancellati
 
         var diff = lastScanTime - now;
 
-        GameScanDetails response = new()
+        GameScanDetailsDto response = new()
         {
             LastScanSeconds = diff.TotalSeconds,
             InProgress = LudusaviManifestWorker.ScanInProgress,

src/EmuSync.Agent/Controllers/SystemController.cs

@@ -1,5 +1,4 @@
 using EmuSync.Agent.Dto.System;
-using EmuSync.Services.LudusaviImporter;
 using System.Reflection;
 
 namespace EmuSync.Agent.Controllers;