Merge pull request #197 from spoonconsulting/fix-executor-service

Out of Memory Crash: executorService

Author: zfir

CHANGELOG.md

@@ -1,3 +1,6 @@
+## [4.0.1](https://github.com/spoonconsulting/cordova-plugin-background-upload/compare/4.0.0...4.0.1) (2022-03-04)
+* **android:** Fixed number of Threads for Executor Service and update Room
+
 ## [4.0.0](https://github.com/spoonconsulting/cordova-plugin-background-upload/compare/2.0.7...4.0.0) (2022-03-04)
 * **android:** Added WorkManager to handle uploads
 

README.md

@@ -2,7 +2,7 @@
 # cordova-plugin-background-upload
 This plugin provides a file upload functionality that can continue to run even while the app is in background. It includes progress updates suitable for long-term transfer operations of large files.
 
-[![npm version](https://badge.fury.io/js/cordova-plugin-background-upload.svg)](https://badge.fury.io/js/cordova-plugin-background-upload)
+[![npm version](https://badge.fury.io/js/@spoonconsulting%2Fcordova-plugin-background-upload.svg)](https://badge.fury.io/js/@spoonconsulting%2Fcordova-plugin-background-upload)
 [![Build Status](https://travis-ci.com/spoonconsulting/cordova-plugin-background-upload.svg?branch=master)](https://travis-ci.org/spoonconsulting/cordova-plugin-background-upload)
 
 **Supported Platforms**

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@spoonconsulting/cordova-plugin-background-upload",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Cordova plugin for uploading file in the background",
   "cordova": {
     "id": "@spoonconsulting/cordova-plugin-background-upload",

package.json

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0" xmlns:android="http://schemas.android.com/apk/res/android" id="@spoonconsulting/cordova-plugin-background-upload" version="4.0.0">
+<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0" xmlns:android="http://schemas.android.com/apk/res/android" id="@spoonconsulting/cordova-plugin-background-upload" version="4.0.1">
     <name>Cordova Background Upload Plugin</name>
     <description>Background Upload plugin for Cordova</description>
     <license>ISC</license>
@@ -15,11 +15,9 @@
    <dependency id="cordova-plugin-androidx-adapter" version="1.1.0"/>
    <dependency id="cordova-plugin-file" version="6.0.2"/>
     <platform name="android">
-        <framework src="com.sromku:simple-storage:1.2.0" />
         <framework src="androidx.work:work-runtime:2.7.1" />
-        <framework src="io.reactivex.rxjava3:rxjava:3.0.13" />
         <framework src="com.squareup.okhttp3:okhttp:4.9.0" />
-        <framework src="androidx.room:room-runtime:2.3.0" />
+        <framework src="androidx.room:room-runtime:2.4.2" />
         <framework src="src/android/config.gradle" custom="true" type="gradleReference"/>
         <config-file target="res/xml/config.xml" parent="/*">
             <feature name="FileTransferBackground">

plugin.xml

@@ -23,5 +23,11 @@ public static AckDatabase getInstance(final Context context) {
         return instance;
     }
 
+    public static void closeInstance() {
+        // not called for now
+        instance.close();
+        instance = null;
+    }
+
     public abstract UploadEventDao uploadEventDao();
 }

src/android/AckDatabase.java

@@ -14,6 +14,7 @@
 import androidx.work.ExistingWorkPolicy;
 import androidx.work.NetworkType;
 import androidx.work.OneTimeWorkRequest;
+import androidx.work.OutOfQuotaPolicy;
 import androidx.work.WorkInfo;
 import androidx.work.WorkManager;
 import androidx.work.WorkQuery;
@@ -37,6 +38,8 @@
 import java.util.Map;
 import java.util.UUID;
 import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Executors;
+import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.TimeUnit;
 
 public class FileTransferBackground extends CordovaPlugin {
@@ -52,6 +55,8 @@ public class FileTransferBackground extends CordovaPlugin {
     private static String currentTag;
     private static long currentTagFetchedAt;
 
+    private ScheduledExecutorService executorService = null;
+
     public void sendCallback(JSONObject obj) {
         /* we check the webview has been initialized */
         if (ready) {
@@ -116,7 +121,11 @@ private void sendError(final String id, final String reason, boolean userCancele
 
     @Override
     public boolean execute(String action, JSONArray args, final CallbackContext callbackContext) {
-        cordova.getThreadPool().execute(() -> {
+        if(executorService == null) {
+            executorService = Executors.newScheduledThreadPool(4);
+        }
+
+        executorService.schedule(() -> {
             try {
                 switch (action) {
                     case "initManager":
@@ -142,7 +151,7 @@ public boolean execute(String action, JSONArray args, final CallbackContext call
                 callbackContext.sendPluginResult(result);
                 exception.printStackTrace();
             }
-        });
+        } , 0, TimeUnit.MILLISECONDS);
 
         return true;
     }
@@ -181,8 +190,12 @@ private void initManager(String options, final CallbackContext callbackContext)
                 .uploadEventDao()
                 .getAll();
 
+        int ackDelay = 0;
         for (UploadEvent ack : uploadEvents) {
-            handleAck(ack.getOutputData());
+            executorService.schedule(() -> {
+                handleAck(ack.getOutputData());
+            }, ackDelay, TimeUnit.MILLISECONDS);
+            ackDelay += 200;
         }
 
         // Can't use observeForever anywhere else than the main thread
@@ -208,15 +221,15 @@ private void initManager(String options, final CallbackContext callbackContext)
                                 case BLOCKED:
                                 case ENQUEUED:
                                 case SUCCEEDED:
-                                    completedTasks = completedTasks + 1;
+                                    completedTasks++;
                                     // No db in main thread
-                                    cordova.getThreadPool().execute(() -> {
+                                    executorService.schedule(() -> {
                                         // The corresponding ACK is already in the DB, if it not, the task is just a leftover
                                         String id = info.getOutputData().getString(UploadTask.KEY_OUTPUT_ID);
                                         if (ackDatabase.uploadEventDao().exists(id)) {
                                             handleAck(info.getOutputData());
                                         }
-                                    });
+                                    }, 0, TimeUnit.MILLISECONDS);
                                     break;
                                 case FAILED:
                                     // The task can't fail completely so something really bad has happened.
@@ -319,7 +332,7 @@ private void addUpload(JSONObject jsonPayload) {
     private void startUpload(final String uploadId, final Data payload) {
         Log.d(TAG, "startUpload: Starting work via work manager");
 
-        OneTimeWorkRequest workRequest = new OneTimeWorkRequest.Builder(UploadTask.class)
+        OneTimeWorkRequest.Builder workRequestBuilder = new OneTimeWorkRequest.Builder(UploadTask.class)
                 .setConstraints(new Constraints.Builder()
                         .setRequiredNetworkType(NetworkType.CONNECTED)
                         .build()
@@ -328,8 +341,13 @@ private void startUpload(final String uploadId, final Data payload) {
                 .setBackoffCriteria(BackoffPolicy.LINEAR, 30, TimeUnit.SECONDS)
                 .addTag(FileTransferBackground.WORK_TAG_UPLOAD)
                 .addTag(getCurrentTag(cordova.getContext()))
-                .setInputData(payload)
-                .build();
+                .setInputData(payload);
+
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.S) {
+            workRequestBuilder.setExpedited(OutOfQuotaPolicy.RUN_AS_NON_EXPEDITED_WORK_REQUEST);
+        }
+
+        OneTimeWorkRequest workRequest = workRequestBuilder.build();
 
         WorkManager.getInstance(cordova.getContext())
                 .enqueueUniqueWork(uploadId, ExistingWorkPolicy.APPEND, workRequest);
@@ -365,7 +383,7 @@ private void removeUpload(String uploadId, CallbackContext context) {
                     PluginResult result = new PluginResult(PluginResult.Status.OK);
                     result.setKeepCallback(true);
                     context.sendPluginResult(result);
-                }, cordova.getThreadPool());
+                }, executorService);
     }
 
     private void acknowledgeEvent(String eventId, CallbackContext context) {

src/android/FileTransferBackground.java

@@ -206,7 +206,7 @@ public Result doWork() {
                         try {
                             response = currentCall.execute();
                         } catch (SocketTimeoutException e) {
-                            e.printStackTrace();
+                            return Result.retry();
                         } finally {
                             concurrentUploads.release();
                         }