Merge pull request #9869 from wordpress-mobile/issue/9852-localdraftstarter-upload-from-anywhere

LocalDraftUploadStarter: Upload from anywhere

Author: shiki

RELEASE-NOTES.txt

@@ -1,6 +1,7 @@
 12.5
 -----
-* Fixed local drafts not automatically pushed to the server.
+* Fixed local drafts not automatically pushed to the server. 
+* Local Drafts will be automatically uploaded to the server as soon as internet connection is available.
 
 12.4
 -----

WordPress/src/main/java/org/wordpress/android/WordPress.java

@@ -74,13 +74,14 @@
 import org.wordpress.android.ui.stats.StatsWidgetProvider;
 import org.wordpress.android.ui.stats.datasets.StatsDatabaseHelper;
 import org.wordpress.android.ui.stats.datasets.StatsTable;
+import org.wordpress.android.ui.uploads.LocalDraftUploadStarter;
 import org.wordpress.android.ui.uploads.UploadService;
-import org.wordpress.android.util.CrashLoggingUtils;
 import org.wordpress.android.util.AppLog;
 import org.wordpress.android.util.AppLog.AppLogListener;
 import org.wordpress.android.util.AppLog.LogLevel;
 import org.wordpress.android.util.AppLog.T;
 import org.wordpress.android.util.BitmapLruCache;
+import org.wordpress.android.util.CrashLoggingUtils;
 import org.wordpress.android.util.DateTimeUtils;
 import org.wordpress.android.util.FluxCUtils;
 import org.wordpress.android.util.LocaleManager;
@@ -141,6 +142,7 @@ public class WordPress extends MultiDexApplication implements HasServiceInjector
     @Inject SiteStore mSiteStore;
     @Inject MediaStore mMediaStore;
     @Inject ZendeskHelper mZendeskHelper;
+    @Inject LocalDraftUploadStarter mLocalDraftUploadStarter;
 
     @Inject @Named("custom-ssl") RequestQueue mRequestQueue;
     public static RequestQueue sRequestQueue;
@@ -276,6 +278,9 @@ public void onLog(T tag, LogLevel logLevel, String message) {
         mApplicationLifecycleMonitor = new ApplicationLifecycleMonitor();
         ProcessLifecycleOwner.get().getLifecycle().addObserver(this);
 
+        // Make the UploadStarter observe the app process so it can auto-start uploads
+        mLocalDraftUploadStarter.activateAutoUploading((ProcessLifecycleOwner) ProcessLifecycleOwner.get());
+
         initAnalytics(SystemClock.elapsedRealtime() - startDate);
 
         createNotificationChannelsOnSdk26();

WordPress/src/main/java/org/wordpress/android/modules/ThreadModule.kt

@@ -12,6 +12,7 @@ const val UI_SCOPE = "UI_SCOPE"
 const val DEFAULT_SCOPE = "DEFAULT_SCOPE"
 const val UI_THREAD = "UI_THREAD"
 const val BG_THREAD = "BG_THREAD"
+const val IO_THREAD = "IO_THREAD"
 
 @Module
 class ThreadModule {
@@ -39,6 +40,12 @@ class ThreadModule {
         return Dispatchers.Default
     }
 
+    @Provides
+    @Named(IO_THREAD)
+    fun provideIoDispatcher(): CoroutineDispatcher {
+        return Dispatchers.IO
+    }
+
     @Provides
     fun provideDebouncer(): Debouncer {
         return Debouncer()

WordPress/src/main/java/org/wordpress/android/ui/posts/PostListMainViewModel.kt

@@ -5,7 +5,6 @@ import android.arch.lifecycle.LifecycleOwner
 import android.arch.lifecycle.LifecycleRegistry
 import android.arch.lifecycle.LiveData
 import android.arch.lifecycle.MutableLiveData
-import android.arch.lifecycle.Observer
 import android.arch.lifecycle.ViewModel
 import android.content.Intent
 import kotlinx.coroutines.CoroutineDispatcher
@@ -44,7 +43,6 @@ import org.wordpress.android.util.NetworkUtilsWrapper
 import org.wordpress.android.util.ToastUtils.Duration
 import org.wordpress.android.util.analytics.AnalyticsUtils
 import org.wordpress.android.viewmodel.SingleLiveEvent
-import org.wordpress.android.viewmodel.helpers.ConnectionStatus
 import org.wordpress.android.viewmodel.helpers.DialogHolder
 import org.wordpress.android.viewmodel.helpers.ToastMessageHolder
 import org.wordpress.android.viewmodel.posts.PostFetcher
@@ -68,11 +66,10 @@ class PostListMainViewModel @Inject constructor(
     mediaStore: MediaStore,
     private val networkUtilsWrapper: NetworkUtilsWrapper,
     private val prefs: AppPrefsWrapper,
-    private val localDraftUploadStarter: LocalDraftUploadStarter,
-    private val connectionStatus: LiveData<ConnectionStatus>,
     private val postListEventListenerFactory: PostListEventListener.Factory,
     @Named(UI_THREAD) private val mainDispatcher: CoroutineDispatcher,
-    @Named(BG_THREAD) private val bgDispatcher: CoroutineDispatcher
+    @Named(BG_THREAD) private val bgDispatcher: CoroutineDispatcher,
+    private val localDraftUploadStarter: LocalDraftUploadStarter
 ) : ViewModel(), LifecycleOwner, CoroutineScope {
     private val lifecycleRegistry = LifecycleRegistry(this)
     override fun getLifecycle(): Lifecycle = lifecycleRegistry
@@ -217,9 +214,7 @@ class PostListMainViewModel @Inject constructor(
         )
         lifecycleRegistry.markState(Lifecycle.State.STARTED)
 
-        connectionStatus.observe(this, Observer {
-            localDraftUploadStarter.uploadLocalDrafts(scope = this@PostListMainViewModel, site = site)
-        })
+        localDraftUploadStarter.queueUploadFromSite(site)
     }
 
     override fun onCleared() {

WordPress/src/main/java/org/wordpress/android/ui/uploads/LocalDraftUploadStarter.kt

@@ -1,41 +1,138 @@
 package org.wordpress.android.ui.uploads
 
+import android.arch.lifecycle.Lifecycle.Event
+import android.arch.lifecycle.LifecycleObserver
+import android.arch.lifecycle.LiveData
+import android.arch.lifecycle.OnLifecycleEvent
+import android.arch.lifecycle.ProcessLifecycleOwner
 import android.content.Context
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Job
+import kotlinx.coroutines.coroutineScope
 import kotlinx.coroutines.launch
 import org.wordpress.android.fluxc.model.SiteModel
 import org.wordpress.android.fluxc.store.PostStore
+import org.wordpress.android.fluxc.store.SiteStore
 import org.wordpress.android.modules.BG_THREAD
+import org.wordpress.android.modules.IO_THREAD
+import org.wordpress.android.util.CrashLoggingUtils
 import org.wordpress.android.util.NetworkUtilsWrapper
+import org.wordpress.android.util.skip
+import org.wordpress.android.viewmodel.helpers.ConnectionStatus
 import javax.inject.Inject
 import javax.inject.Named
+import javax.inject.Singleton
+import kotlin.coroutines.CoroutineContext
 
 /**
- * Provides a way to find and upload all local drafts.
+ * Automatically uploads local drafts.
+ *
+ * Auto-uploads happen when the app is placed in the foreground or when the internet connection is restored. In
+ * addition to this, call sites can also request an immediate execution by calling [upload].
+ *
+ * The method [activateAutoUploading] must be called once, preferably during app creation, for the auto-uploads to work.
  */
+@Singleton
 class LocalDraftUploadStarter @Inject constructor(
     /**
      * The Application context
      */
     private val context: Context,
     private val postStore: PostStore,
+    private val siteStore: SiteStore,
+    @Named(BG_THREAD) private val bgDispatcher: CoroutineDispatcher,
+    @Named(IO_THREAD) private val ioDispatcher: CoroutineDispatcher,
+    private val uploadServiceFacade: UploadServiceFacade,
+    private val networkUtilsWrapper: NetworkUtilsWrapper,
+    private val connectionStatus: LiveData<ConnectionStatus>
+) : CoroutineScope {
+    private val job = Job()
+
+    override val coroutineContext: CoroutineContext get() = job + bgDispatcher
+
     /**
-     * The Coroutine dispatcher used for querying in FluxC.
+     * The hook for making this class automatically launch uploads whenever the app is placed in the foreground.
      */
-    @Named(BG_THREAD) private val bgDispatcher: CoroutineDispatcher,
-    private val networkUtilsWrapper: NetworkUtilsWrapper
-) {
-    fun uploadLocalDrafts(scope: CoroutineScope, site: SiteModel) = scope.launch(bgDispatcher) {
+    private val processLifecycleObserver = object : LifecycleObserver {
+        @OnLifecycleEvent(Event.ON_START)
+        fun onAppComesFromBackground() {
+            queueUploadFromAllSites()
+        }
+    }
+
+    /**
+     * Activates the necessary observers for this class to start auto-uploading.
+     *
+     * This must be called during [org.wordpress.android.WordPress]' creation like so:
+     *
+     * ```
+     * mLocalDraftUploadStarter.activateAutoUploading(ProcessLifecycleOwner.get())
+     * ```
+     */
+    fun activateAutoUploading(processLifecycleOwner: ProcessLifecycleOwner) {
+        // Since this class is meant to be a Singleton, it should be fine (I think) to use observeForever in here.
+        // We're skipping the first emitted value because the processLifecycleObserver below will also trigger an
+        // immediate upload.
+        connectionStatus.skip(1).observeForever {
+            queueUploadFromAllSites()
+        }
+
+        processLifecycleOwner.lifecycle.addObserver(processLifecycleObserver)
+    }
+
+    private fun queueUploadFromAllSites() = launch {
+        val sites = siteStore.sites
+        try {
+            checkConnectionAndUpload(sites = sites)
+        } catch (e: Exception) {
+            CrashLoggingUtils.log(e)
+        }
+    }
+
+    /**
+     * Upload all local drafts from the given [site].
+     */
+    fun queueUploadFromSite(site: SiteModel) = launch {
+        try {
+            checkConnectionAndUpload(sites = listOf(site))
+        } catch (e: Exception) {
+            CrashLoggingUtils.log(e)
+        }
+    }
+
+    /**
+     * If there is an internet connection, uploads all local drafts belonging to [sites].
+     *
+     * This coroutine will suspend until all the [upload] operations have completed. If one of them fails, all query
+     * and queuing attempts ([upload]) will be canceled. The exception will be thrown by this method.
+     */
+    private suspend fun checkConnectionAndUpload(sites: List<SiteModel>) = coroutineScope {
         if (!networkUtilsWrapper.isNetworkAvailable()) {
-            return@launch
+            return@coroutineScope
         }
 
+        sites.forEach {
+            launch(ioDispatcher) {
+                upload(site = it)
+            }
+        }
+    }
+
+    /**
+     * This is meant to be used by [checkConnectionAndUpload] only.
+     */
+    private fun upload(site: SiteModel) {
         postStore.getLocalDraftPosts(site)
-                .filterNot { UploadService.isPostUploadingOrQueued(it) }
+                .filterNot { uploadServiceFacade.isPostUploadingOrQueued(it) }
                 .forEach { localDraft ->
-                    val intent = UploadService.getUploadPostServiceIntent(context, localDraft, false, false, true)
-                    context.startService(intent)
+                    uploadServiceFacade.uploadPost(
+                            context = context,
+                            post = localDraft,
+                            trackAnalytics = false,
+                            publish = false,
+                            isRetry = true
+                    )
                 }
     }
 }

WordPress/src/main/java/org/wordpress/android/ui/uploads/UploadServiceFacade.kt

@@ -0,0 +1,20 @@
+package org.wordpress.android.ui.uploads
+
+import android.content.Context
+import org.wordpress.android.fluxc.model.PostModel
+import javax.inject.Inject
+
+/**
+ * An injectable class built on top of [UploadService].
+ *
+ * The main purpose of this is to provide testability for classes that use [UploadService]. This should never
+ * contain any static methods.
+ */
+class UploadServiceFacade @Inject constructor() {
+    fun uploadPost(context: Context, post: PostModel, trackAnalytics: Boolean, publish: Boolean, isRetry: Boolean) {
+        val intent = UploadService.getUploadPostServiceIntent(context, post, trackAnalytics, publish, isRetry)
+        context.startService(intent)
+    }
+
+    fun isPostUploadingOrQueued(post: PostModel) = UploadService.isPostUploadingOrQueued(post)
+}

WordPress/src/main/java/org/wordpress/android/util/LiveDataUtils.kt

@@ -2,6 +2,7 @@ package org.wordpress.android.util
 
 import android.arch.lifecycle.LiveData
 import android.arch.lifecycle.MediatorLiveData
+import android.arch.lifecycle.Observer
 import android.arch.lifecycle.Transformations
 import kotlinx.coroutines.CoroutineScope
 import org.wordpress.android.viewmodel.SingleMediatorLiveEvent
@@ -224,3 +225,33 @@ fun <T> LiveData<T>.filter(predicate: (T) -> Boolean): LiveData<T> {
     }
     return mediator
 }
+
+/**
+ * Suppresses the first n items by this [LiveData].
+ *
+ * Consider this for example:
+ *
+ * ```
+ * val connectionStatusLiveData = getConnectionStatusLiveData()
+ * connectionStatusLiveData.skip(1).observe(this, Observer {
+ *     refresh()
+ * })
+ * ```
+ *
+ * The first value emitted by `connectionStatusLiveData` would be ignored and [Observer] will not be called.
+ */
+fun <T> LiveData<T>.skip(times: Int): LiveData<T> {
+    check(times > 0) { "The number of times to skip must be greater than 0" }
+
+    var skipped = 0
+    val mediator = MediatorLiveData<T>()
+    mediator.addSource(this) { value ->
+        skipped += 1
+
+        if (skipped > times) {
+            mediator.value = value
+        }
+    }
+
+    return mediator
+}

WordPress/src/main/java/org/wordpress/android/viewmodel/posts/PostListViewModel.kt

@@ -7,8 +7,8 @@ import android.arch.lifecycle.LifecycleRegistry
 import android.arch.lifecycle.LiveData
 import android.arch.lifecycle.MediatorLiveData
 import android.arch.lifecycle.Observer
+import android.arch.lifecycle.ViewModel
 import android.arch.paging.PagedList
-import kotlinx.coroutines.CoroutineDispatcher
 import org.wordpress.android.fluxc.Dispatcher
 import org.wordpress.android.fluxc.model.LocalOrRemoteId.LocalId
 import org.wordpress.android.fluxc.model.PostModel
@@ -20,7 +20,6 @@ import org.wordpress.android.fluxc.model.list.PostListDescriptor.PostListDescrip
 import org.wordpress.android.fluxc.store.AccountStore
 import org.wordpress.android.fluxc.store.ListStore
 import org.wordpress.android.fluxc.store.PostStore
-import org.wordpress.android.modules.BG_THREAD
 import org.wordpress.android.ui.posts.AuthorFilterSelection.EVERYONE
 import org.wordpress.android.ui.posts.AuthorFilterSelection.ME
 import org.wordpress.android.ui.posts.PostUtils
@@ -29,14 +28,12 @@ import org.wordpress.android.ui.uploads.LocalDraftUploadStarter
 import org.wordpress.android.util.AppLog
 import org.wordpress.android.util.NetworkUtilsWrapper
 import org.wordpress.android.util.SiteUtils
-import org.wordpress.android.viewmodel.ScopedViewModel
 import org.wordpress.android.viewmodel.SingleLiveEvent
 import org.wordpress.android.viewmodel.helpers.ConnectionStatus
 import org.wordpress.android.viewmodel.posts.PostListEmptyUiState.RefreshError
 import org.wordpress.android.viewmodel.posts.PostListItemIdentifier.LocalPostId
 import org.wordpress.android.viewmodel.posts.PostListItemType.PostListItemUiState
 import javax.inject.Inject
-import javax.inject.Named
 
 typealias PagedPostList = PagedList<PostListItemType>
 
@@ -49,9 +46,8 @@ class PostListViewModel @Inject constructor(
     private val listItemUiStateHelper: PostListItemUiStateHelper,
     private val networkUtilsWrapper: NetworkUtilsWrapper,
     private val localDraftUploadStarter: LocalDraftUploadStarter,
-    connectionStatus: LiveData<ConnectionStatus>,
-    @Named(BG_THREAD) bgDispatcher: CoroutineDispatcher
-) : ScopedViewModel(bgDispatcher), LifecycleOwner {
+    connectionStatus: LiveData<ConnectionStatus>
+) : ViewModel(), LifecycleOwner {
     private val isStatsSupported: Boolean by lazy {
         SiteUtils.isAccessedViaWPComRest(connector.site) && connector.site.hasCapabilityViewStats
     }
@@ -154,7 +150,7 @@ class PostListViewModel @Inject constructor(
     // Public Methods
 
     fun swipeToRefresh() {
-        localDraftUploadStarter.uploadLocalDrafts(scope = this, site = connector.site)
+        localDraftUploadStarter.queueUploadFromSite(connector.site)
         fetchFirstPage()
     }