Improve session connection 09/02/2025 (#39)

paul-fresquet · web-flow · commit 6c711149a823 · 2025-02-09T11:37:44.000+01:00
diff --git a/src/ByteSync.Client/Assets/Resources/Resources.Designer.cs b/src/ByteSync.Client/Assets/Resources/Resources.Designer.cs
diff --git a/src/ByteSync.Client/Assets/Resources/Resources.fr.resx b/src/ByteSync.Client/Assets/Resources/Resources.fr.resx
@@ -1541,4 +1541,10 @@ Voulez-vous enregistrer ce nouveau Profil de Session avec ce nom ?</value>
 	<data name="JoinCloudSession_TimeoutError" xml:space="preserve">
 		<value>Le délai d'attente a expiré.</value>
 	</data>
+	<data name="JoinCloudSession_CanceledByUser" xml:space="preserve">
+		<value>Opération annulée par l'utilisateur.</value>
+	</data>
+	<data name="CreateCloudSession_CanceledByUser" xml:space="preserve">
+		<value>Opération annulée par l'utilisateur.</value>
+	</data>
 </root>
diff --git a/src/ByteSync.Client/Assets/Resources/Resources.resx b/src/ByteSync.Client/Assets/Resources/Resources.resx
@@ -1679,4 +1679,10 @@ Do you want to save this new Session Profile with this name?</value>
   <data name="JoinCloudSession_TimeoutError" xml:space="preserve">
     <value>The waiting period has expired.</value>
   </data>
+  <data name="JoinCloudSession_CanceledByUser" xml:space="preserve">
+    <value>Operation canceled by the user.</value>
+  </data>
+  <data name="CreateCloudSession_CanceledByUser" xml:space="preserve">
+    <value>Operation canceled by the user.</value>
+  </data>
 </root>
diff --git a/src/ByteSync.Client/Business/Sessions/Connecting/CreateSessionStatus.cs b/src/ByteSync.Client/Business/Sessions/Connecting/CreateSessionStatus.cs
@@ -4,4 +4,5 @@ public enum CreateSessionStatus
 {
     Success = 1,
     Error = 2,
+    CanceledByUser = 3,
 }
diff --git a/src/ByteSync.Client/Interfaces/Services/Sessions/Connecting/ICloudSessionConnectionService.cs b/src/ByteSync.Client/Interfaces/Services/Sessions/Connecting/ICloudSessionConnectionService.cs
@@ -15,4 +15,6 @@ public interface ICloudSessionConnectionService
     Task OnJoinSessionError(JoinSessionError joinSessionError);
     
     Task OnCreateSessionError(CreateSessionError createSessionError);
+    
+    Task HandleJoinSessionError(Exception exception);
 }
diff --git a/src/ByteSync.Client/Services/Sessions/Connecting/CloudSessionConnectionService.cs b/src/ByteSync.Client/Services/Sessions/Connecting/CloudSessionConnectionService.cs
@@ -94,4 +94,29 @@ public async Task OnCreateSessionError(CreateSessionError createSessionError)
 
         await InitializeConnection(SessionConnectionStatus.NoSession);
     }
+
+    public async Task HandleJoinSessionError(Exception exception)
+    {
+        _logger.LogError(exception, "An error occurred while joining the Cloud Session");
+            
+        var status = JoinSessionStatus.UnexpectedError;
+        
+        if ((exception is TaskCanceledException || exception.InnerException is TaskCanceledException)
+            && _cloudSessionConnectionRepository.CancellationToken.IsCancellationRequested)
+        {
+            status = JoinSessionStatus.CanceledByUser;
+        }
+        else if (exception is TimeoutException)
+        {
+            status = JoinSessionStatus.TimeoutError;
+        }
+            
+        var joinSessionError = new JoinSessionError
+        {
+            Exception = exception,
+            Status = status
+        };
+            
+        await OnJoinSessionError(joinSessionError);
+    }
 }
diff --git a/src/ByteSync.Client/Services/Sessions/Connecting/CreateSessionService.cs b/src/ByteSync.Client/Services/Sessions/Connecting/CreateSessionService.cs
@@ -76,15 +76,21 @@ public CreateSessionService(ICloudSessionConnectionRepository cloudSessionConnec
         }
         catch (Exception ex)
         {
+            var status = CreateSessionStatus.Error;
+            if (ex is TaskCanceledException || ex.InnerException is TaskCanceledException)
+            {
+                status = CreateSessionStatus.CanceledByUser;
+            }
+            
             var createSessionError = new CreateSessionError
             {
                 Exception = ex,
-                Status = CreateSessionStatus.Error
+                Status = status
             };
             
             await _cloudSessionConnectionService.OnCreateSessionError(createSessionError);
-
-            throw;
+            
+            return null;
         }
     }
 
diff --git a/src/ByteSync.Client/Services/Sessions/Connecting/Joining/CloudSessionPasswordExchangeKeyGivenService.cs b/src/ByteSync.Client/Services/Sessions/Connecting/Joining/CloudSessionPasswordExchangeKeyGivenService.cs
@@ -90,21 +90,7 @@ await _cloudSessionConnectionRepository.WaitOrThrowAsync(request.SessionId,
         }
         catch (Exception ex)
         {
-            _logger.LogError(ex, "OnCloudSessionPasswordExchangeKeyGiven");
-            
-            var status = JoinSessionStatus.UnexpectedError;
-            if (ex is TimeoutException)
-            {
-                status = JoinSessionStatus.TimeoutError;
-            }
-            
-            var joinSessionError = new JoinSessionError
-            {
-                Exception = ex,
-                Status = status
-            };
-            
-            await _cloudSessionConnectionService.OnJoinSessionError(joinSessionError);
+            await _cloudSessionConnectionService.HandleJoinSessionError(ex);
         }
     }
 }
diff --git a/src/ByteSync.Client/Services/Sessions/Connecting/Joining/JoinSessionService.cs b/src/ByteSync.Client/Services/Sessions/Connecting/Joining/JoinSessionService.cs
@@ -47,22 +47,7 @@ public async Task JoinSession(string sessionId, string sessionPassword, RunCloud
         }
         catch (Exception ex)
         {
-            var status = JoinSessionStatus.UnexpectedError;
-            if (ex is TimeoutException)
-            {
-                status = JoinSessionStatus.TimeoutError;
-            }
-
-            
-            var joinSessionError = new JoinSessionError
-            {
-                Exception = ex,
-                Status = status
-            };
-            
-            await _cloudSessionConnectionService.OnJoinSessionError(joinSessionError);
-
-            throw;
+            await _cloudSessionConnectionService.HandleJoinSessionError(ex);
         }
     }
 
@@ -122,7 +107,8 @@ private async Task DoStartJoinSession(string sessionId, string sessionPassword,
         else
         {
             await _cloudSessionConnectionRepository.WaitOrThrowAsync(sessionId,
-                data => data.WaitForPasswordExchangeKeyEvent, data => data.WaitTimeSpan, "Keys exchange failed: no key received");
+                data => data.WaitForPasswordExchangeKeyEvent, data => data.WaitTimeSpan, "Keys exchange failed: no key received", 
+                _cloudSessionConnectionRepository.CancellationToken);
         }
     }
 }
diff --git a/src/ByteSync.Client/Services/Sessions/Connecting/Joining/YouJoinedSessionService.cs b/src/ByteSync.Client/Services/Sessions/Connecting/Joining/YouJoinedSessionService.cs
@@ -107,7 +107,8 @@ public async Task Process(CloudSessionResult cloudSessionResult, ValidateJoinClo
                 var encryptedSessionMemberPrivateData = _dataEncrypter.EncryptSessionMemberPrivateData(sessionMemberPrivateData);
                 var finalizeParameters = new FinalizeJoinCloudSessionParameters(parameters, encryptedSessionMemberPrivateData);
 
-                var finalizeJoinSessionResult = await _cloudSessionApiClient.FinalizeJoinCloudSession(finalizeParameters);
+                var finalizeJoinSessionResult = await _cloudSessionApiClient.FinalizeJoinCloudSession(finalizeParameters, 
+                    _cloudSessionConnectionRepository.CancellationToken);
 
                 if (finalizeJoinSessionResult.Status == FinalizeJoinSessionStatuses.AuthIsNotChecked)
                 {
diff --git a/src/ByteSync.Client/ViewModels/Home/CreateCloudSessionViewModel.cs b/src/ByteSync.Client/ViewModels/Home/CreateCloudSessionViewModel.cs
@@ -107,6 +107,10 @@ private void OnCreateSessionError(CreateSessionError? createSessionError)
             case CreateSessionStatus.Error:
                 UpdateErrorMessage(nameof(Resources.CreateCloudSession_UnknownError), createSessionError.Exception);
                 break;
+            
+            case CreateSessionStatus.CanceledByUser:
+                UpdateErrorMessage(nameof(Resources.CreateCloudSession_CanceledByUser));
+                break;
         }
     }
     
diff --git a/src/ByteSync.Client/ViewModels/Home/JoinCloudSessionViewModel.cs b/src/ByteSync.Client/ViewModels/Home/JoinCloudSessionViewModel.cs
@@ -195,6 +195,10 @@ private void OnCloudSessionJoinError(JoinSessionError? joinSessionError)
             case JoinSessionStatus.TimeoutError:
                 UpdateErrorMessage(nameof(Resources.JoinCloudSession_TimeoutError), joinSessionError.Exception);
                 break;
+            
+            case JoinSessionStatus.CanceledByUser:
+                UpdateErrorMessage(nameof(Resources.JoinCloudSession_CanceledByUser));
+                break;
 
             default:
                 UpdateErrorMessage(nameof(Resources.JoinCloudSession_UnkownError), joinSessionError.Exception);
diff --git a/src/ByteSync.Common/Business/Sessions/Cloud/Connections/JoinSessionStatus.cs b/src/ByteSync.Common/Business/Sessions/Cloud/Connections/JoinSessionStatus.cs
@@ -13,5 +13,5 @@ public enum JoinSessionStatus
     WrongPassword = 9,
     UnexpectedError = 10,
     TimeoutError = 11,
-    Unknown_12 = 12,
+    CanceledByUser = 12,
 }
diff --git a/src/ByteSync.Common/Controls/BaseRepository.cs b/src/ByteSync.Common/Controls/BaseRepository.cs
@@ -3,14 +3,15 @@
 using System.Threading;
 using System.Threading.Tasks;
 using ByteSync.Common.Helpers;
+using ByteSync.Common.Interfaces;
 using Serilog;
 
 // ReSharper disable UnusedType.Global
 // ReSharper disable UnusedMember.Global
 // ReSharper disable MemberCanBeProtected.Global
 namespace ByteSync.Common.Controls;
 
-public abstract class BaseRepository<T>
+public abstract class BaseRepository<T> : IRepository<T>
 {
     protected BaseRepository()
     {
@@ -136,16 +137,18 @@ public T2 Get<T2>(string? dataId, Func<T, T2> func)
         return CheckAndRun(dataId, func);
     }
     
-    public async Task WaitOrThrowAsync(string dataId, Func<T, EventWaitHandle> func, TimeSpan? timeout, string exceptionMessage)
+    public async Task WaitOrThrowAsync(string dataId, Func<T, EventWaitHandle> func, TimeSpan? timeout, string exceptionMessage, 
+        CancellationToken cancellationToken = default)
     {
-        await WaitOrThrowAsync(dataId, func, _ => timeout, exceptionMessage);
+        await WaitOrThrowAsync(dataId, func, _ => timeout, exceptionMessage, cancellationToken);
     }
     
-    public async Task WaitOrThrowAsync(string dataId, Func<T, EventWaitHandle> func, Func<T, TimeSpan?> getTimeSpan, string exceptionMessage)
+    public async Task WaitOrThrowAsync(string dataId, Func<T, EventWaitHandle> func, Func<T, TimeSpan?> getTimeSpan, string exceptionMessage,
+        CancellationToken cancellationToken = default)
     {
         await Task.Run(() =>
         {
-            bool isWaitOK = Wait(dataId, func, getTimeSpan);
+            bool isWaitOK = Wait(dataId, func, getTimeSpan, cancellationToken);
             
             if (!isWaitOK)
             {
@@ -167,7 +170,7 @@ public async Task<bool> WaitAsync(string dataId, Func<T, EventWaitHandle> func,
         });
     }
 
-    public bool Wait(string dataId, Func<T, EventWaitHandle> func, Func<T, TimeSpan?> getTimeSpan)
+    public bool Wait(string dataId, Func<T, EventWaitHandle> func, Func<T, TimeSpan?> getTimeSpan, CancellationToken cancellationToken = default)
     {
         EventWaitHandle? waitHandle = null;
         TimeSpan? timeout = null;
@@ -182,13 +185,17 @@ public bool Wait(string dataId, Func<T, EventWaitHandle> func, Func<T, TimeSpan?
         
         CheckAndRun(dataId, myFunc);
         
-        // Le code ci-dessous doit être exécuté en dehors du "lock"
         timeout ??= new TimeSpan(-1);
         List<WaitHandle> waitHandles = new List<WaitHandle> {waitHandle!};
         if (endEvent != null)
         {
             waitHandles.Add(endEvent);
         }
+        if (cancellationToken.CanBeCanceled)
+        {
+            waitHandles.Add(cancellationToken.WaitHandle);
+        }
+        
         int index = WaitHandle.WaitAny(waitHandles.ToArray(), timeout.Value);
 
         if (index == 0)
diff --git a/src/ByteSync.Common/Interfaces/IRepository.cs b/src/ByteSync.Common/Interfaces/IRepository.cs
@@ -22,13 +22,15 @@ public interface IRepository<T>
     
     T2 Get<T2>(string lobbyId, Func<T, T2> func);
 
-    public Task WaitOrThrowAsync(string dataId, Func<T, EventWaitHandle> func, TimeSpan? timeout, string exceptionMessage);
+    public Task WaitOrThrowAsync(string dataId, Func<T, EventWaitHandle> func, TimeSpan? timeout, string exceptionMessage,
+        CancellationToken cancellationToken = default);
 
-    public Task WaitOrThrowAsync(string dataId, Func<T, EventWaitHandle> func, Func<T, TimeSpan?> getTimeSpan, string exceptionMessage);
+    public Task WaitOrThrowAsync(string dataId, Func<T, EventWaitHandle> func, Func<T, TimeSpan?> getTimeSpan, string exceptionMessage,
+        CancellationToken cancellationToken = default);
     
     public Task<bool> WaitAsync(string dataId, Func<T, EventWaitHandle> func, TimeSpan? timeout);
 
     public Task<bool> WaitAsync(string dataId, Func<T, EventWaitHandle> func, Func<T, TimeSpan?> getTimeSpan);
 
-    public bool Wait(string dataId, Func<T, EventWaitHandle> func, Func<T, TimeSpan?> getTimeSpan);
+    public bool Wait(string dataId, Func<T, EventWaitHandle> func, Func<T, TimeSpan?> getTimeSpan, CancellationToken cancellationToken = default);
 }
diff --git a/tests/ByteSync.Client.Tests/Controls/Sessions/Connecting/CreateSessionServiceTests.cs b/tests/ByteSync.Client.Tests/Controls/Sessions/Connecting/CreateSessionServiceTests.cs
@@ -234,15 +234,13 @@ public async Task CreateCloudSession_ShouldThrowTaskCanceledException_WhenCancel
             .ReturnsAsync(dummyResult);
 
         // Act
-        Func<Task> act = async () => await _service.CreateCloudSession(request);
+        await _service.CreateCloudSession(request);
 
         // Assert
-        await act.Should().ThrowAsync<TaskCanceledException>();
-
         _cloudSessionConnectionServiceMock.Verify(x => x.OnCreateSessionError(
                 It.Is<CreateSessionError>(err =>
                     err.Exception is TaskCanceledException &&
-                    err.Status == CreateSessionStatus.Error)),
+                    err.Status == CreateSessionStatus.CanceledByUser)),
             Times.Once);
     }
 
@@ -261,11 +259,9 @@ public async Task CreateCloudSession_ShouldThrowException_WhenCloudSessionApiCli
             .ThrowsAsync(exception);
 
         // Act
-        Func<Task> act = async () => await _service.CreateCloudSession(request);
+        await _service.CreateCloudSession(request);
 
         // Assert
-        await act.Should().ThrowAsync<InvalidOperationException>().WithMessage("Test exception");
-
         _cloudSessionConnectionServiceMock.Verify(x => x.OnCreateSessionError(
                 It.Is<CreateSessionError>(err =>
                     err.Exception == exception &&

Original file line number	Diff line number	Diff line change
`@@ -4,4 +4,5 @@ public enum CreateSessionStatus`
`4`	`4`	`{`
`5`	`5`	`Success = 1,`
`6`	`6`	`Error = 2,`
	`7`	`+ CanceledByUser = 3,`
`7`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,4 +15,6 @@ public interface ICloudSessionConnectionService`
`15`	`15`	`Task OnJoinSessionError(JoinSessionError joinSessionError);`
`16`	`16`
`17`	`17`	`Task OnCreateSessionError(CreateSessionError createSessionError);`
	`18`	`+`
	`19`	`+ Task HandleJoinSessionError(Exception exception);`
`18`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,15 +76,21 @@ public CreateSessionService(ICloudSessionConnectionRepository cloudSessionConnec`
`76`	`76`	`}`
`77`	`77`	`catch (Exception ex)`
`78`	`78`	`{`
	`79`	`+ var status = CreateSessionStatus.Error;`
	`80`	`+ if (ex is TaskCanceledException \|\| ex.InnerException is TaskCanceledException)`
	`81`	`+ {`
	`82`	`+ status = CreateSessionStatus.CanceledByUser;`
	`83`	`+ }`
	`84`	`+`
`79`	`85`	`var createSessionError = new CreateSessionError`
`80`	`86`	`{`
`81`	`87`	`Exception = ex,`
`82`		`- Status = CreateSessionStatus.Error`
	`88`	`+ Status = status`
`83`	`89`	`};`
`84`	`90`
`85`	`91`	`await _cloudSessionConnectionService.OnCreateSessionError(createSessionError);`
`86`		`-`
`87`		`- throw;`
	`92`	`+`
	`93`	`+ return null;`
`88`	`94`	`}`
`89`	`95`	`}`
`90`	`96`
Original file line number	Diff line number	Diff line change
`@@ -90,21 +90,7 @@ await _cloudSessionConnectionRepository.WaitOrThrowAsync(request.SessionId,`
`90`	`90`	`}`
`91`	`91`	`catch (Exception ex)`
`92`	`92`	`{`
`93`		`- _logger.LogError(ex, "OnCloudSessionPasswordExchangeKeyGiven");`
`94`		`-`
`95`		`- var status = JoinSessionStatus.UnexpectedError;`
`96`		`- if (ex is TimeoutException)`
`97`		`- {`
`98`		`- status = JoinSessionStatus.TimeoutError;`
`99`		`- }`
`100`		`-`
`101`		`- var joinSessionError = new JoinSessionError`
`102`		`- {`
`103`		`- Exception = ex,`
`104`		`- Status = status`
`105`		`- };`
`106`		`-`
`107`		`- await _cloudSessionConnectionService.OnJoinSessionError(joinSessionError);`
	`93`	`+ await _cloudSessionConnectionService.HandleJoinSessionError(ex);`
`108`	`94`	`}`
`109`	`95`	`}`
`110`	`96`	`}`
Original file line number	Diff line number	Diff line change
`@@ -47,22 +47,7 @@ public async Task JoinSession(string sessionId, string sessionPassword, RunCloud`
`47`	`47`	`}`
`48`	`48`	`catch (Exception ex)`
`49`	`49`	`{`
`50`		`- var status = JoinSessionStatus.UnexpectedError;`
`51`		`- if (ex is TimeoutException)`
`52`		`- {`
`53`		`- status = JoinSessionStatus.TimeoutError;`
`54`		`- }`
`55`		`-`
`56`		`-`
`57`		`- var joinSessionError = new JoinSessionError`
`58`		`- {`
`59`		`- Exception = ex,`
`60`		`- Status = status`
`61`		`- };`
`62`		`-`
`63`		`- await _cloudSessionConnectionService.OnJoinSessionError(joinSessionError);`
`64`		`-`
`65`		`- throw;`
	`50`	`+ await _cloudSessionConnectionService.HandleJoinSessionError(ex);`
`66`	`51`	`}`
`67`	`52`	`}`
`68`	`53`
`@@ -122,7 +107,8 @@ private async Task DoStartJoinSession(string sessionId, string sessionPassword,`
`122`	`107`	`else`
`123`	`108`	`{`
`124`	`109`	`await _cloudSessionConnectionRepository.WaitOrThrowAsync(sessionId,`
`125`		`- data => data.WaitForPasswordExchangeKeyEvent, data => data.WaitTimeSpan, "Keys exchange failed: no key received");`
	`110`	`+ data => data.WaitForPasswordExchangeKeyEvent, data => data.WaitTimeSpan, "Keys exchange failed: no key received",`
	`111`	`+ _cloudSessionConnectionRepository.CancellationToken);`
`126`	`112`	`}`
`127`	`113`	`}`
`128`	`114`	`}`
Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,8 @@ public async Task Process(CloudSessionResult cloudSessionResult, ValidateJoinClo`
`107`	`107`	`var encryptedSessionMemberPrivateData = _dataEncrypter.EncryptSessionMemberPrivateData(sessionMemberPrivateData);`
`108`	`108`	`var finalizeParameters = new FinalizeJoinCloudSessionParameters(parameters, encryptedSessionMemberPrivateData);`
`109`	`109`
`110`		`- var finalizeJoinSessionResult = await _cloudSessionApiClient.FinalizeJoinCloudSession(finalizeParameters);`
	`110`	`+ var finalizeJoinSessionResult = await _cloudSessionApiClient.FinalizeJoinCloudSession(finalizeParameters,`
	`111`	`+ _cloudSessionConnectionRepository.CancellationToken);`
`111`	`112`
`112`	`113`	`if (finalizeJoinSessionResult.Status == FinalizeJoinSessionStatuses.AuthIsNotChecked)`
`113`	`114`	`{`