Do not show user indicators when the view controller is not visible

Riot/Modules/Common/ActivityIndicator/UserIndicatorPresenterWrapper.swift

@@ -30,21 +30,23 @@ import CommonKit
         self.presenter = presenter
     }
 
-    @objc func presentActivityIndicator() {
-        presentActivityIndicator(label: VectorL10n.homeSyncing)
+    @objc func presentLoadingIndicator() {
+        presentLoadingIndicator(label: VectorL10n.homeSyncing)
     }
 
-    @objc func presentActivityIndicator(label: String) {
+    @objc func presentLoadingIndicator(label: String) {
         guard loadingIndicator == nil else {
-            // The app is very liberal with calling `presentActivityIndicator` (often not matched by corresponding `removeCurrentActivityIndicator`),
+            // The app is very liberal with calling `presentLoadingIndicator` (often not matched by corresponding `dismissLoadingIndicator`),
             // so there is no reason to keep adding new indiciators if there is one already showing.
             return
         }
 
+        MXLog.debug("[UserIndicatorPresenterWrapper] Present loading indicator")
         loadingIndicator = presenter.present(.loading(label: label, isInteractionBlocking: false))
     }
 
-    @objc func dismissActivityIndicator() {
+    @objc func dismissLoadingIndicator() {
+        MXLog.debug("[UserIndicatorPresenterWrapper] Dismiss loading indicator")
         loadingIndicator = nil
     }
 

Riot/Modules/Common/Recents/RecentsViewController.m

@@ -64,6 +64,9 @@ @interface RecentsViewController () <CreateRoomCoordinatorBridgePresenterDelegat
     // when the user selects it.
     UISearchBar *tableSearchBar;
 
+    // Flag indicating whether the view controller is (at least partially) visible and not dissapearing
+    BOOL isViewVisible;
+
     // Observe kThemeServiceDidChangeThemeNotification to handle user interface theme change.
     __weak id kThemeServiceDidChangeThemeNotificationObserver;
 }
@@ -264,6 +267,7 @@ - (void)didReceiveMemoryWarning
 - (void)viewWillAppear:(BOOL)animated
 {
     [super viewWillAppear:animated];
+    isViewVisible = YES;
 
     [self.screenTracker trackScreen];
 
@@ -301,6 +305,7 @@ - (void)viewWillAppear:(BOOL)animated
 - (void)viewWillDisappear:(BOOL)animated
 {
     [super viewWillDisappear:animated];
+    isViewVisible = NO;
 
     // Leave potential editing mode
     [self cancelEditionMode:NO];
@@ -2408,24 +2413,24 @@ - (BOOL)providesCustomActivityIndicator {
 }
 
 - (void)startActivityIndicatorWithLabel:(NSString *)label {
-    if (self.indicatorPresenter) {
-        [self.indicatorPresenter presentActivityIndicatorWithLabel:label];
+    if (self.indicatorPresenter && isViewVisible) {
+        [self.indicatorPresenter presentLoadingIndicatorWithLabel:label];
     } else {
         [super startActivityIndicator];
     }
 }
 
 - (void)startActivityIndicator {
-    if (self.indicatorPresenter) {
-        [self.indicatorPresenter presentActivityIndicator];
+    if (self.indicatorPresenter && isViewVisible) {
+        [self.indicatorPresenter presentLoadingIndicator];
     } else {
         [super startActivityIndicator];
     }
 }
 
 - (void)stopActivityIndicator {
     if (self.indicatorPresenter) {
-        [self.indicatorPresenter dismissActivityIndicator];
+        [self.indicatorPresenter dismissLoadingIndicator];
     } else {
         [super stopActivityIndicator];
     }

Riot/Modules/Room/RoomViewController.m

@@ -567,7 +567,9 @@ - (void)viewWillDisappear:(BOOL)animated
     isAppeared = NO;
 
     [VoiceMessageMediaServiceProvider.sharedProvider pauseAllServices];
-    [self stopActivityIndicator];
+
+    // Stop the loading indicator even if the session is still in progress
+    [self stopLoadingUserIndicator];
 }
 
 - (void)viewDidAppear:(BOOL)animated
@@ -935,10 +937,14 @@ - (void)onMatrixSessionChange
     self.updateRoomReadMarker = NO;
 }
 
+#pragma mark - Loading indicators
+
 - (BOOL)providesCustomActivityIndicator {
     return [self.delegate roomViewControllerCanDelegateUserIndicators:self];
 }
 
+// Override of a legacy method to determine whether to use a newer implementation instead.
+// Will be removed in the future https://github.com/vector-im/element-ios/issues/5608
 - (void)startActivityIndicator {
     if ([self providesCustomActivityIndicator]) {
         [self.delegate roomViewControllerDidStartLoading:self];
@@ -947,6 +953,8 @@ - (void)startActivityIndicator {
     }
 }
 
+// Override of a legacy method to determine whether to use a newer implementation instead.
+// Will be removed in the future https://github.com/vector-im/element-ios/issues/5608
 - (void)stopActivityIndicator
 {
     if (notificationTaskProfile)
@@ -956,14 +964,22 @@ - (void)stopActivityIndicator
         notificationTaskProfile = nil;
     }
     if ([self providesCustomActivityIndicator]) {
+        // The legacy super implementation of `stopActivityIndicator` contains a number of checks grouped under `canStopActivityIndicator`
+        // to determine whether the indicator can be stopped or not (and the method should thus rather be called `stopActivityIndicatorIfPossible`).
+        // Since the newer indicators are not calling super implementation, the check for `canStopActivityIndicator` has to be performed manually.
         if ([self canStopActivityIndicator]) {
-            [self.delegate roomViewControllerDidStopLoading:self];
+            [self stopLoadingUserIndicator];
         }
     } else {
         [super stopActivityIndicator];
     }
 }
 
+- (void)stopLoadingUserIndicator
+{
+    [self.delegate roomViewControllerDidStopLoading:self];
+}
+
 - (void)displayRoom:(MXKRoomDataSource *)dataSource
 {
     // Remove potential preview Data

changelog.d/5801.bugfix

@@ -0,0 +1 @@
+Activity Indicators: Do not show user indicators when the view controller is not visible