Merge pull request #400 from nventive/dev/maso/killswitchabs

feat: added kill switch

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 
 Prefix your items with `(Template)` if the change is about the template and not the resulting application.
 
+## 3.4.X
+- Added a kill switch feature to the app.
+
 ## 3.3.X
 - Added a forced update feature to the app.
 

doc/Architecture.md

@@ -141,7 +141,11 @@ This application uses [DynamicData](https://github.com/reactivemarbles/DynamicDa
 
 ### Forced Update
 
-This application uses the [IUpdateRequiredService](/src/app/ApplicationTemplate.Business/ForcedUpdates/IUpdateRequiredService.cs) which exposes an event that allows you to know when you should redirect the user to a page that will lead him to the appstore where he can update the app. 
+This application uses the [IUpdateRequiredService](../src/app/ApplicationTemplate.Business/ForcedUpdates/IUpdateRequiredService.cs) which exposes an event that allows you to know when you should redirect the user to a page that will lead him to the appstore where he can update the app. 
+
+### Kill Switch
+
+This application uses the [IKillSwitchService](../src/app/ApplicationTemplate.Business/KillSwitch/IKillSwitchService.cs) which exposes an event that allows you to know when you the Kill switch is activated and when it gets deactivated.
 
 ## Presentation
 

doc/KillSwitch.md

@@ -0,0 +1,8 @@
+# Kill Switch
+
+The kill switch feature is for when you want to temporarily lock the user out of the app. 
+This could be used for example when the server is down for some time, to avoid the users getting a ton of errors and getting reports from those users.
+
+To trigger the kill switch, we suscribe to the `KillSwitchActivationChanged` `event` from the `KillSwitchService` in the [CoreStartup](../src/app/ApplicationTemplate.Presentation/CoreStartup.cs#L223).
+
+If the kill switch is activated, the user is brought to the `KillSwitchPage` where he can see a message that tells him the app is currently unavailable. If the kill switch is deactivated afterwards, the user is brought back to the initial navigation flow, which means he will be in the login page if he is not connected and to the home page if he is connected. 

src/app/ApplicationTemplate.Access/ApiClients/KillSwitch/IKillSwitchRepository.cs

@@ -0,0 +1,17 @@
+using System;
+
+namespace ApplicationTemplate.DataAccess;
+
+/// <summary>
+/// Interface for the repository that gets when the kill switch is activated.
+/// </summary>
+public interface IKillSwitchRepository
+{
+	/// <summary>
+	/// Observes and reports the activation or deactivation of the kill switch.
+	/// </summary>
+	/// <returns>
+	/// An <see cref="IObservable{Boolean}"/> that indicates whether the kill switch is activated or not.
+	/// </returns>
+	public IObservable<bool> ObserveKillSwitchActivation();
+}

src/app/ApplicationTemplate.Access/ApiClients/KillSwitch/KillSwitchRepositoryMock.cs

@@ -0,0 +1,33 @@
+using System;
+using System.Reactive.Subjects;
+using DynamicData;
+
+namespace ApplicationTemplate.DataAccess;
+
+/// <summary>
+/// Mock implementation of the kill switch repository.
+/// </summary>
+public sealed class KillSwitchRepositoryMock : IKillSwitchRepository, IDisposable
+{
+	private readonly Subject<bool> _killSwitchActivatedSubject = new();
+	private bool _killSwitchActivated = false;
+
+	/// <inheritdoc/>
+	public IObservable<bool> ObserveKillSwitchActivation() => _killSwitchActivatedSubject;
+
+	/// <summary>
+	/// Change the kill switch activation status.
+	/// </summary>
+	public void ChangeKillSwitchActivation()
+	{
+		_killSwitchActivated = !_killSwitchActivated;
+
+		_killSwitchActivatedSubject.OnNext(_killSwitchActivated);
+	}
+
+	/// <inheritdoc/>
+	public void Dispose()
+	{
+		_killSwitchActivatedSubject.Dispose();
+	}
+}

src/app/ApplicationTemplate.Business/KillSwitch/IKillSwitchService.cs

@@ -0,0 +1,17 @@
+using System;
+
+namespace ApplicationTemplate.Business;
+
+/// <summary>
+/// Service that handles the kill switch.
+/// </summary>
+public interface IKillSwitchService
+{
+	/// <summary>
+	/// Observes and reports the activation or deactivation of the kill switch.
+	/// </summary>
+	/// <returns>
+	/// An <see cref="IObservable{Boolean}"/> that indicates whether the kill switch is activated or not.
+	/// </returns>
+	public IObservable<bool> ObserveKillSwitchActivation();
+}

src/app/ApplicationTemplate.Business/KillSwitch/KillSwitchService.cs

@@ -0,0 +1,30 @@
+using System;
+using System.Reactive.Linq;
+using ApplicationTemplate.DataAccess;
+using Microsoft.Extensions.Logging;
+
+namespace ApplicationTemplate.Business;
+
+/// <summary>
+/// Implementation of the IKillSwitchService.
+/// </summary>
+public sealed class KillSwitchService : IKillSwitchService
+{
+	private readonly IKillSwitchRepository _killSwitchRepository;
+	private readonly ILogger<KillSwitchService> _logger;
+
+	/// <summary>
+	/// Initializes a new instance of the <see cref="KillSwitchService"/> class.
+	/// </summary>
+	/// <param name="killSwitchRepository">The <see cref="IKillSwitchRepository"/>.</param>
+	/// <param name="logger">The <see cref="ILogger{KillSwitchService}"/>.</param>
+	public KillSwitchService(IKillSwitchRepository killSwitchRepository, ILogger<KillSwitchService> logger)
+	{
+		_killSwitchRepository = killSwitchRepository;
+		_logger = logger;
+	}
+
+	/// <inheritdoc/>
+	public IObservable<bool> ObserveKillSwitchActivation() => _killSwitchRepository.ObserveKillSwitchActivation()
+		.Do(isActive => _logger.LogInformation("Kill switch is now {isActive}.", isActive));
+}

src/app/ApplicationTemplate.Presentation/Configuration/ApiConfiguration.cs

@@ -43,6 +43,7 @@ public static IServiceCollection AddApi(this IServiceCollection services, IConfi
 			.AddPosts(configuration)
 			.AddUserProfile()
 			.AddMinimumVersion()
+			.AddKillSwitch()
 			.AddDadJokes(configuration);
 
 		return services;
@@ -60,6 +61,12 @@ private static IServiceCollection AddMinimumVersion(this IServiceCollection serv
 		return services.AddSingleton<IMinimumVersionReposiory, MinimumVersionRepositoryMock>();
 	}
 
+	private static IServiceCollection AddKillSwitch(this IServiceCollection services)
+	{
+		// This one doesn't have an actual remote API yet. It's always a mock implementation.
+		return services.AddSingleton<IKillSwitchRepository, KillSwitchRepositoryMock>();
+	}
+
 	private static IServiceCollection AddAuthentication(this IServiceCollection services)
 	{
 		// This one doesn't have an actual remote API yet. It's always a mock implementation.

src/app/ApplicationTemplate.Presentation/Configuration/AppServicesConfiguration.cs

@@ -32,6 +32,7 @@ public static IServiceCollection AddAppServices(this IServiceCollection services
 			.AddSingleton<IAuthenticationService, AuthenticationService>()
 			.AddSingleton<IUserProfileService, UserProfileService>()
 			.AddSingleton<IUpdateRequiredService, UpdateRequiredService>()
+			.AddSingleton<IKillSwitchService, KillSwitchService>()
 			.AddSingleton<DiagnosticsCountersService>();
 	}
 }

src/app/ApplicationTemplate.Presentation/CoreStartup.cs

@@ -77,6 +77,7 @@ protected override async Task StartServices(IServiceProvider services, bool isFi
 			services.GetRequiredService<DiagnosticsCountersService>().Start();
 			await ExecuteInitialNavigation(CancellationToken.None, services);
 			SuscribeToRequiredUpdate(services);
+			SuscribeToKillSwitch(services);
 		}
 	}
 
@@ -219,6 +220,57 @@ void ForceUpdate(object sender, EventArgs e)
 		}
 	}
 
+	private void SuscribeToKillSwitch(IServiceProvider serviceProvider)
+	{
+		var killSwitchService = serviceProvider.GetRequiredService<IKillSwitchService>();
+		var navigationController = serviceProvider.GetRequiredService<ISectionsNavigator>();
+
+		killSwitchService.ObserveKillSwitchActivation()
+			.SelectManyDisposePrevious(async (activated, ct) =>
+			{
+				Logger.LogTrace("Kill switch activation changed to {Activated}.", activated);
+
+				if (activated)
+				{
+					await OnKillSwitchActivated(ct);
+				}
+				else
+				{
+					await OnKillSwitchDeactivated(ct);
+				}
+			})
+			.Subscribe()
+			.DisposeWith(Disposables);
+
+		async Task OnKillSwitchActivated(CancellationToken ct)
+		{
+			// Clear all navigation stacks and show the kill switch page.
+			// We clear the navigation stack to avoid weird animations once the kill switch is deactivated.
+			foreach (var modal in navigationController.State.Modals)
+			{
+				await navigationController.CloseModal(ct);
+			}
+
+			foreach (var stack in navigationController.State.Sections)
+			{
+				await ClearNavigationStack(ct, stack.Value);
+			}
+
+			await navigationController.NavigateAndClear(ct, () => new KillSwitchPageViewModel());
+
+			Logger.LogInformation("Navigated to kill switch page succesfully.");
+		}
+
+		async Task OnKillSwitchDeactivated(CancellationToken ct)
+		{
+			if (navigationController.GetActiveViewModel() is KillSwitchPageViewModel)
+			{
+				await ExecuteInitialNavigation(ct, serviceProvider);
+				Logger.LogInformation("The kill switch was deactivated.");
+			}
+		}
+	}
+
 	/// <summary>
 	/// Starts deactivating and reactivating ViewModels based on navigation.
 	/// </summary>

src/app/ApplicationTemplate.Presentation/ViewModels/Diagnostics/Navigation/NavigationDebuggerViewModel.cs

@@ -48,4 +48,17 @@ public NavigationDebuggerViewModel()
 	{
 		this.GetService<IMinimumVersionReposiory>().CheckMinimumVersion();
 	});
+
+	/// <summary>
+	/// Gets a command that raises the kill switch event.
+	/// </summary>
+	public IDynamicCommand TriggerKillSwitch => this.GetCommand(() =>
+	{
+		var killSwitchRepository = this.GetService<IKillSwitchRepository>();
+
+		if (killSwitchRepository is KillSwitchRepositoryMock killSwitchRepositoryMock)
+		{
+			killSwitchRepositoryMock.ChangeKillSwitchActivation();
+		}
+	});
 }

src/app/ApplicationTemplate.Presentation/ViewModels/KillSwitchPageViewModel.cs

@@ -0,0 +1,8 @@
+namespace ApplicationTemplate.Presentation;
+
+/// <summary>
+/// ViewModel for the kill switch page.
+/// </summary>
+public sealed class KillSwitchPageViewModel : ViewModel
+{
+}

src/app/ApplicationTemplate.Shared.Views/ApplicationTemplate.Shared.Views.projitems

@@ -64,6 +64,9 @@
     <Compile Include="$(MSBuildThisFileDirectory)Content\ForcedUpdate\ForcedUpdatePage.xaml.cs">
       <DependentUpon>ForcedUpdatePage.xaml</DependentUpon>
     </Compile>
+    <Compile Include="$(MSBuildThisFileDirectory)Content\KillSwitch\KillSwitchPage.xaml.cs">
+      <DependentUpon>KillSwitchPage.xaml</DependentUpon>
+    </Compile>
     <Compile Include="$(MSBuildThisFileDirectory)Content\Menu.xaml.cs">
       <DependentUpon>Menu.xaml</DependentUpon>
     </Compile>
@@ -243,6 +246,10 @@
       <SubType>Designer</SubType>
       <Generator>MSBuild:Compile</Generator>
     </Page>
+    <Page Include="$(MSBuildThisFileDirectory)Content\KillSwitch\KillSwitchPage.xaml">
+      <SubType>Designer</SubType>
+      <Generator>MSBuild:Compile</Generator>
+    </Page>
     <Page Include="$(MSBuildThisFileDirectory)Content\Menu.xaml">
       <SubType>Designer</SubType>
       <Generator>MSBuild:Compile</Generator>

src/app/ApplicationTemplate.Shared.Views/Configuration/NavigationConfiguration.cs

@@ -43,6 +43,7 @@ public static IServiceCollection AddNavigation(this IServiceCollection services)
 		{ typeof(SentEmailConfirmationPageViewModel), typeof(SentEmailConfirmationPage) },
 		{ typeof(ResetPasswordPageViewModel), typeof(ResetPasswordPage) },
 		{ typeof(ForcedUpdatePageViewModel), typeof(ForcedUpdatePage) },
+		{ typeof(KillSwitchPageViewModel), typeof(KillSwitchPage) },
 	};
 
 	/// <summary>

src/app/ApplicationTemplate.Shared.Views/Content/Diagnostics/NavigationDebuggerView.xaml

@@ -92,20 +92,28 @@
 				   Style="{StaticResource NavigationDebuggerTextBlockStyle}" />
 
 		<!-- Clear and Reinitialize buttons -->
-		<StackPanel Orientation="Horizontal"
+		<StackPanel Orientation="Vertical"
 					Spacing="8">
-
-			<Button Content="Clear all pages"
-					Style="{StaticResource NavigationDebuggerButtonStyle}"
-					Command="{Binding Clear}" />
-
-			<Button Content="Reinitialize navigation"
-					Style="{StaticResource NavigationDebuggerButtonStyle}"
-					Command="{Binding Reinitialize}" />
+			<StackPanel Orientation="Horizontal"
+						Spacing="8">
+				<Button Content="Clear all pages"
+						Style="{StaticResource NavigationDebuggerButtonStyle}"
+						Command="{Binding Clear}" />
 
-			<Button Content="Force update"
-					Style="{StaticResource NavigationDebuggerButtonStyle}"
-					Command="{Binding NavigateToForceUpdatePage}" />
+				<Button Content="Reinitialize navigation"
+						Style="{StaticResource NavigationDebuggerButtonStyle}"
+						Command="{Binding Reinitialize}" />
+			</StackPanel>
+
+			<StackPanel Orientation="Horizontal"
+						Spacing="8">
+				<Button Content="Force update"
+						Style="{StaticResource NavigationDebuggerButtonStyle}"
+						Command="{Binding NavigateToForceUpdatePage}" />
+				<Button Content="Toggle kill switch"
+						Style="{StaticResource NavigationDebuggerButtonStyle}"
+						Command="{Binding TriggerKillSwitch}" />
+			</StackPanel>
 		</StackPanel>
 	</StackPanel>
 </UserControl>

src/app/ApplicationTemplate.Shared.Views/Content/KillSwitch/KillSwitchPage.xaml

@@ -0,0 +1,19 @@
+<Page x:Class="ApplicationTemplate.Views.Content.KillSwitchPage"
+	  xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+	  xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+	  xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
+	  xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+	  Background="{ThemeResource ApplicationPageBackgroundThemeBrush}"
+	  mc:Ignorable="d">
+
+	<Grid>
+
+		<TextBlock x:Uid="KillSwitchMessage"
+				   HorizontalAlignment="Center"
+				   VerticalAlignment="Center"
+				   FontSize="24"
+				   Text="The app is not available at the moment, please come back later"
+				   Margin="24" />
+
+	</Grid>
+</Page>

src/app/ApplicationTemplate.Shared.Views/Content/KillSwitch/KillSwitchPage.xaml.cs

@@ -0,0 +1,12 @@
+using Microsoft.UI.Xaml.Controls;
+
+namespace ApplicationTemplate.Views.Content
+{
+	public sealed partial class KillSwitchPage : Page
+	{
+		public KillSwitchPage()
+		{
+			this.InitializeComponent();
+		}
+	}
+}

src/app/ApplicationTemplate.Shared.Views/Strings/en/Resources.resw

@@ -449,4 +449,7 @@ it's happening!</value>
   <data name="ForcedUpdateContent.Text" xml:space="preserve">
     <value>An update is required to continue using the application.</value>
   </data>
+  <data name="KillSwitchMessage.Text" xml:space="preserve">
+    <value>The app is not available at the moment, please come back later.</value>
+  </data>
 </root>

src/app/ApplicationTemplate.Shared.Views/Strings/fr/Resources.resw

@@ -449,4 +449,7 @@ Je pense que nous savons tous pourquoi nous sommes ici."</value>
   <data name="ForcedUpdateContent.Text" xml:space="preserve">
     <value>Une mise à jour de l'application est nécessaire pour continuer de l'utiliser.</value>
   </data>
+  <data name="KillSwitchMessage.Text" xml:space="preserve">
+    <value>L'application n'est pas disponible pour le moment, veuillez revenir plus tard.</value>
+  </data>
 </root>

src/app/ApplicationTemplate.Tests.Functional/ForceUpdate/ForceUpdatesShould.cs

@@ -25,8 +25,7 @@ public async Task RedirectTheAppToForceUpdatePage()
 		// This will raise the update required event.
 		minimumVersionReposiory.CheckMinimumVersion();
 
-		// Waits for the navigation to be completed, we need the StartWith in case the navigation already finished before we started observing.
-		await sectionNavigator.ObserveCurrentState().StartWith(sectionNavigator.State).Where(x => x.LastRequestState != NavigatorRequestState.Processing).FirstAsync();
+		await WaitForNavigation(viewModelType: typeof(ForcedUpdatePageViewModel), isDestination: true);
 
 		// Assert
 		ActiveViewModel.Should().BeOfType<ForcedUpdatePageViewModel>();
@@ -47,8 +46,7 @@ public async Task DisableTheBackButton()
 		// This will raise the update required event.
 		minimumVersionReposiory.CheckMinimumVersion();
 
-		// Waits for the navigation to be completed, we need the StartWith in case the navigation already finished before we started observing.
-		await sectionNavigator.ObserveCurrentState().StartWith(sectionNavigator.State).Where(x => x.LastRequestState != NavigatorRequestState.Processing).FirstAsync();
+		await WaitForNavigation(viewModelType: typeof(ForcedUpdatePageViewModel), isDestination: true);
 
 		NavigateBackUsingHardwareButton();