No issue: add isSyncActive method to FxaAccountManager

This got removed as part of mozilla-mobile#3579
... but we actually need it for the UIs!

components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/manager/FxaAccountManager.kt

@@ -307,6 +307,14 @@ open class FxaAccountManager(
         Unit
     }
 
+    /**
+     * Indicates if sync is currently running.
+     */
+    fun isSyncActive(): Boolean {
+        syncManager?.let { return it.isSyncActive() }
+        return false
+    }
+
     /**
      * Call this after registering your observers, and before interacting with this class.
      */

components/service/firefox-accounts/src/main/java/mozilla/components/service/fxa/sync/SyncManager.kt

@@ -107,6 +107,14 @@ abstract class SyncManager(
     // Currently the interfaces are the same, hence the name "pass-through".
     private val dispatcherStatusObserver = PassThroughSyncStatusObserver(syncStatusObserverRegistry)
 
+    /**
+     * Indicates if sync is currently running.
+     */
+    internal fun isSyncActive(): Boolean {
+        syncDispatcher?.let { return it.isSyncActive() }
+        return false
+    }
+
     internal fun registerSyncStatusObserver(observer: SyncStatusObserver) {
         syncStatusObserverRegistry.register(observer)
     }

components/service/firefox-accounts/src/test/java/mozilla/components/service/fxa/FxaAccountManagerTest.kt

@@ -263,6 +263,9 @@ class FxaAccountManagerTest {
 
         manager.initAsync().await()
 
+        // Can check if sync is running (it's not!), even if we don't have sync configured.
+        assertFalse(manager.isSyncActive())
+
         val syncStatusObserver = TestSyncStatusObserver()
         val lifecycleOwner: LifecycleOwner = mock()
         val lifecycle: Lifecycle = mock()
@@ -300,6 +303,7 @@ class FxaAccountManagerTest {
         verify(latestSyncManager!!.dispatcher.inner, times(1)).syncNow(anyBoolean())
 
         // Make sure sync status listeners are working.
+        // TODO fix these tests.
 //        // Test dispatcher -> sync manager -> account manager -> our test observer.
 //        latestSyncManager!!.dispatcherRegistry.notifyObservers { onStarted() }
 //        assertEquals(1, syncStatusObserver.onStartedCount)
@@ -389,6 +393,7 @@ class FxaAccountManagerTest {
         manager.syncNowAsync(startup = true).await()
         verify(latestSyncManager!!.dispatcher.inner, times(3)).syncNow(anyBoolean())
 
+        // TODO fix these tests
 //        assertEquals(0, syncStatusObserver.onStartedCount)
 //        assertEquals(0, syncStatusObserver.onIdleCount)
 //        assertEquals(0, syncStatusObserver.onErrorCount)
@@ -414,6 +419,14 @@ class FxaAccountManagerTest {
         verify(latestSyncManager!!.dispatcher.inner, times(2)).syncNow(anyBoolean())
         manager.syncNowAsync(startup = true).await()
         verify(latestSyncManager!!.dispatcher.inner, times(3)).syncNow(anyBoolean())
+
+        // Pretend sync is running.
+        `when`(latestSyncManager!!.dispatcher.inner.isSyncActive()).thenReturn(true)
+        assertTrue(manager.isSyncActive())
+
+        // Pretend sync is not running.
+        `when`(latestSyncManager!!.dispatcher.inner.isSyncActive()).thenReturn(false)
+        assertFalse(manager.isSyncActive())
     }
 
     @Test

docs/changelog.md

@@ -37,6 +37,9 @@ permalink: /changelog/
 * **lib-push-amazon**
   * 🆕 Added a new component for Amazon Device Messaging push support.
 
+* **service-firefox-account**
+ * Added `isSyncActive(): Boolean` method to `FxaAccountManager`
+
 # 5.0.0
 
 * [Commits](https://github.com/mozilla-mobile/android-components/compare/v4.0.0...v5.0.0)