Test run workmanager

opensrp · Oct 8, 2022 · 5830f89 · 5830f89
1 parent 2c94dec
commit 5830f89
Show file tree

Hide file tree

Showing 32 changed files with 808 additions and 86 deletions.
diff --git a/opensrp-core/build.gradle b/opensrp-core/build.gradle
@@ -237,6 +237,14 @@ dependencies {
     compileOnly 'com.google.firebase:firebase-perf'
     // Add the dependency for the Performance Monitoring library
 
+    // WorkManager
+    def work_version = "2.7.1"
+    implementation "androidx.work:work-runtime:$work_version"
+    implementation "androidx.work:work-gcm:$work_version"
+    implementation "androidx.work:work-multiprocess:$work_version"
+    implementation "com.google.guava:listenablefuture:9999.0-empty-to-avoid-conflict-with-guava"
+    testImplementation "androidx.work:work-testing:$work_version"
+
     //Mockito
     def mockitoVersion = '4.6.1'
     testImplementation("org.mockito:mockito-core:$mockitoVersion")

diff --git a/opensrp-core/src/main/java/org/smartregister/sync/RequestParamsBuilder.java b/opensrp-core/src/main/java/org/smartregister/sync/RequestParamsBuilder.java
@@ -0,0 +1,90 @@
+package org.smartregister.sync;
+
+import org.json.JSONException;
+import org.json.JSONObject;
+import org.smartregister.AllConstants;
+import org.smartregister.CoreLibrary;
+import org.smartregister.sync.intent.BaseSyncIntentService;
+
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+import timber.log.Timber;
+
+/**
+ * A helper class for building the url request for intent services
+ */
+public class RequestParamsBuilder {
+
+    private final Map<String, Object> paramMap;
+    private final StringBuilder getSyncParamsBuilder;
+    private final JSONObject postSyncParamsBuilder;
+
+    public RequestParamsBuilder() {
+        this.paramMap = new LinkedHashMap<>();
+        this.getSyncParamsBuilder = new StringBuilder();
+        this.postSyncParamsBuilder = new JSONObject();
+    }
+
+    public RequestParamsBuilder addServerVersion(long value) {
+        paramMap.put(AllConstants.SERVER_VERSION, value);
+        return this;
+    }
+
+    public RequestParamsBuilder addEventPullLimit(int value) {
+        paramMap.put(AllConstants.LIMIT, value);
+        return this;
+    }
+
+    public RequestParamsBuilder configureSyncFilter(String syncFilterParam, String syncFilterValue) {
+        paramMap.put(syncFilterParam, syncFilterValue);
+        return this;
+    }
+
+    public RequestParamsBuilder returnCount(boolean value) {
+        paramMap.put(AllConstants.RETURN_COUNT, value);
+        return this;
+    }
+
+    public RequestParamsBuilder addParam(String key, Object value) {
+        paramMap.put(key, value);
+        return this;
+    }
+
+    public RequestParamsBuilder removeParam(String key) {
+        paramMap.remove(key);
+        return this;
+    }
+
+    public String build() {
+
+        for (Map.Entry<String, Object> entry : paramMap.entrySet()) {
+
+            if (CoreLibrary.getInstance().getSyncConfiguration().isSyncUsingPost()) {
+
+                try {
+                    postSyncParamsBuilder.put(entry.getKey(), entry.getValue());
+                } catch (JSONException e) {
+                    Timber.e(e);
+                }
+
+            } else {
+
+                if (0 != getSyncParamsBuilder.length()) {
+                    getSyncParamsBuilder.append('&');
+                }
+
+                getSyncParamsBuilder.append(entry.getKey()).append('=').append(entry.getValue());
+            }
+
+        }
+
+        return CoreLibrary.getInstance().getSyncConfiguration().isSyncUsingPost() ? postSyncParamsBuilder.toString() : getSyncParamsBuilder.toString();
+    }
+
+    @Override
+    public String toString() {
+        return build();
+    }
+
+}
diff --git a/opensrp-core/src/main/java/org/smartregister/sync/helper/SyncSettingsServiceHelper.java b/opensrp-core/src/main/java/org/smartregister/sync/helper/SyncSettingsServiceHelper.java
@@ -15,7 +15,7 @@
 import org.smartregister.domain.SyncStatus;
 import org.smartregister.repository.AllSharedPreferences;
 import org.smartregister.service.HTTPAgent;
-import org.smartregister.sync.intent.BaseSyncIntentService;
+import org.smartregister.sync.RequestParamsBuilder;
 import org.smartregister.sync.intent.SettingsSyncIntentService;
 import org.smartregister.util.JsonFormUtils;
 import org.smartregister.util.Utils;
@@ -95,7 +95,7 @@ private void getExtraSettings(JSONArray settings, String accessToken) throws JSO
         JSONArray completeExtraSettings = new JSONArray();
         if (getInstance().getSyncConfiguration() != null && getInstance().getSyncConfiguration().hasExtraSettingsSync()) {
             String syncParams = getInstance().getSyncConfiguration().getExtraStringSettingsParameters();
-            BaseSyncIntentService.RequestParamsBuilder builder = new BaseSyncIntentService.RequestParamsBuilder().addParam(AllConstants.SERVER_VERSION, "0").addParam(AllConstants.RESOLVE, getInstance().getSyncConfiguration().resolveSettings());
+            RequestParamsBuilder builder = new RequestParamsBuilder().addParam(AllConstants.SERVER_VERSION, "0").addParam(AllConstants.RESOLVE, getInstance().getSyncConfiguration().resolveSettings());
             String url = SettingsSyncIntentService.SETTINGS_URL + "?" + syncParams + "&" + builder.toString();
             JSONArray extraSettings = pullSettings(url, accessToken);
             if (extraSettings != null) {

diff --git a/opensrp-core/src/main/java/org/smartregister/sync/intent/BaseSyncIntentService.java b/opensrp-core/src/main/java/org/smartregister/sync/intent/BaseSyncIntentService.java
@@ -17,6 +17,8 @@
 /**
  * Created by Vincent Karuri on 26/08/2019
  */
+
+@Deprecated
 public class BaseSyncIntentService extends IntentService {
 
     public BaseSyncIntentService(String name) {
@@ -31,81 +33,4 @@ protected void onHandleIntent(Intent intent) {
         httpAgent.setReadTimeout(coreLibrary.getSyncConfiguration().getReadTimeout());
     }
 
-    /**
-     * A helper class for building the url request for intent services
-     */
-    public static class RequestParamsBuilder {
-
-        private final Map<String, Object> paramMap;
-        private final StringBuilder getSyncParamsBuilder;
-        private final JSONObject postSyncParamsBuilder;
-
-        public RequestParamsBuilder() {
-            this.paramMap = new LinkedHashMap<>();
-            this.getSyncParamsBuilder = new StringBuilder();
-            this.postSyncParamsBuilder = new JSONObject();
-        }
-
-        public RequestParamsBuilder addServerVersion(long value) {
-            paramMap.put(AllConstants.SERVER_VERSION, value);
-            return this;
-        }
-
-        public RequestParamsBuilder addEventPullLimit(int value) {
-            paramMap.put(AllConstants.LIMIT, value);
-            return this;
-        }
-
-        public RequestParamsBuilder configureSyncFilter(String syncFilterParam, String syncFilterValue) {
-            paramMap.put(syncFilterParam, syncFilterValue);
-            return this;
-        }
-
-        public RequestParamsBuilder returnCount(boolean value) {
-            paramMap.put(AllConstants.RETURN_COUNT, value);
-            return this;
-        }
-
-        public RequestParamsBuilder addParam(String key, Object value) {
-            paramMap.put(key, value);
-            return this;
-        }
-
-        public RequestParamsBuilder removeParam(String key) {
-            paramMap.remove(key);
-            return this;
-        }
-
-        public String build() {
-
-            for (Map.Entry<String, Object> entry : paramMap.entrySet()) {
-
-                if (CoreLibrary.getInstance().getSyncConfiguration().isSyncUsingPost()) {
-
-                    try {
-                        postSyncParamsBuilder.put(entry.getKey(), entry.getValue());
-                    } catch (JSONException e) {
-                        Timber.e(e);
-                    }
-
-                } else {
-
-                    if (0 != getSyncParamsBuilder.length()) {
-                        getSyncParamsBuilder.append('&');
-                    }
-
-                    getSyncParamsBuilder.append(entry.getKey()).append('=').append(entry.getValue());
-                }
-
-            }
-
-            return CoreLibrary.getInstance().getSyncConfiguration().isSyncUsingPost() ? postSyncParamsBuilder.toString() : getSyncParamsBuilder.toString();
-        }
-
-        @Override
-        public String toString() {
-            return build();
-        }
-
-    }
 }
diff --git a/opensrp-core/src/main/java/org/smartregister/sync/intent/CampaignIntentService.java b/opensrp-core/src/main/java/org/smartregister/sync/intent/CampaignIntentService.java
@@ -28,6 +28,7 @@
 
 import static org.smartregister.AllConstants.CAMPAIGNS;
 
+@Deprecated
 public class CampaignIntentService extends BaseSyncIntentService {
     public static final String CAMPAIGN_URL = "/rest/campaign/";
     private static final String TAG = "CampaignIntentService";

diff --git a/...-core/src/main/java/org/smartregister/sync/intent/DocumentConfigurationIntentService.java b/...-core/src/main/java/org/smartregister/sync/intent/DocumentConfigurationIntentService.java
@@ -19,6 +19,7 @@
  *
  * @author cozej4 https://github.com/cozej4
  */
+@Deprecated
 public class DocumentConfigurationIntentService extends BaseSyncIntentService {
     private HTTPAgent httpAgent;
     private ManifestRepository manifestRepository;

diff --git a/opensrp-core/src/main/java/org/smartregister/sync/intent/ExtendedSyncIntentService.java b/opensrp-core/src/main/java/org/smartregister/sync/intent/ExtendedSyncIntentService.java
@@ -9,7 +9,7 @@
 
 import timber.log.Timber;
 
-
+@Deprecated
 public class ExtendedSyncIntentService extends BaseSyncIntentService {
 
     private ActionService actionService = CoreLibrary.getInstance().context().actionService();

diff --git a/opensrp-core/src/main/java/org/smartregister/sync/intent/LocationIntentService.java b/opensrp-core/src/main/java/org/smartregister/sync/intent/LocationIntentService.java
@@ -11,6 +11,7 @@
 import org.smartregister.util.DateTimeTypeConverter;
 import org.smartregister.util.PropertiesConverter;
 
+@Deprecated
 public class LocationIntentService extends BaseSyncIntentService {
     private static final String TAG = "LocationIntentService";
     public static Gson gson = new GsonBuilder().setDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ")

diff --git a/opensrp-core/src/main/java/org/smartregister/sync/intent/PlanIntentService.java b/opensrp-core/src/main/java/org/smartregister/sync/intent/PlanIntentService.java
@@ -8,6 +8,7 @@
 /**
  * Created by Vincent Karuri on 08/05/2019
  */
+@Deprecated
 public class PlanIntentService extends BaseSyncIntentService {
 
     private static final String TAG = "PlanIntentService";

diff --git a/opensrp-core/src/main/java/org/smartregister/sync/intent/SyncAllLocationsIntentService.java b/opensrp-core/src/main/java/org/smartregister/sync/intent/SyncAllLocationsIntentService.java
@@ -12,7 +12,7 @@
 import org.smartregister.util.PropertiesConverter;
 
 import timber.log.Timber;
-
+@Deprecated
 public class SyncAllLocationsIntentService extends BaseSyncIntentService {
     private static final String TAG = "SyncAllLocationsIntentService";
 

diff --git a/opensrp-core/src/main/java/org/smartregister/sync/intent/SyncIntentService.java b/opensrp-core/src/main/java/org/smartregister/sync/intent/SyncIntentService.java
@@ -41,6 +41,7 @@
 import org.smartregister.repository.AllSharedPreferences;
 import org.smartregister.repository.EventClientRepository;
 import org.smartregister.service.HTTPAgent;
+import org.smartregister.sync.RequestParamsBuilder;
 import org.smartregister.sync.helper.ECSyncHelper;
 import org.smartregister.sync.helper.ValidateAssignmentHelper;
 import org.smartregister.util.NetworkUtils;
@@ -170,7 +171,7 @@ private synchronized void fetchRetry(final int count, boolean returnCount) {
 
             startEventTrace(FETCH, 0);
 
-            BaseSyncIntentService.RequestParamsBuilder syncParamBuilder = new BaseSyncIntentService.RequestParamsBuilder().
+            RequestParamsBuilder syncParamBuilder = new RequestParamsBuilder().
                     configureSyncFilter(configs.getSyncFilterParam().value(), configs.getSyncFilterValue()).addServerVersion(lastSyncDatetime).addEventPullLimit(getEventPullLimit());
 
             Response resp = getUrlResponse(baseUrl + SYNC_URL, syncParamBuilder, configs, returnCount);
@@ -216,7 +217,7 @@ private synchronized void fetchRetry(final int count, boolean returnCount) {
      * @param configs              the Sync Configuration object with various configurations
      * @param returnCount          a boolean flag, whether to return the total count of records as part of the response (field - total_records)
      */
-    protected Response getUrlResponse(@NonNull String baseURL, @NonNull BaseSyncIntentService.RequestParamsBuilder requestParamsBuilder, @NonNull SyncConfiguration configs, boolean returnCount) {
+    protected Response getUrlResponse(@NonNull String baseURL, @NonNull RequestParamsBuilder requestParamsBuilder, @NonNull SyncConfiguration configs, boolean returnCount) {
         Response response;
         String requestUrl = baseURL;
 

diff --git a/...src/main/java/org/smartregister/sync/intent/SyncLocationsByLevelAndTagsIntentService.java b/...src/main/java/org/smartregister/sync/intent/SyncLocationsByLevelAndTagsIntentService.java
@@ -6,6 +6,7 @@
 
 import timber.log.Timber;
 
+@Deprecated
 public class SyncLocationsByLevelAndTagsIntentService extends BaseSyncIntentService {
 
     private static final String TAG = "SyncLocationsByLevelAndTagsIntentService";

diff --git a/...core/src/main/java/org/smartregister/sync/intent/SyncLocationsByTeamIdsIntentService.java b/...core/src/main/java/org/smartregister/sync/intent/SyncLocationsByTeamIdsIntentService.java
@@ -6,6 +6,7 @@
 
 import timber.log.Timber;
 
+@Deprecated
 public class SyncLocationsByTeamIdsIntentService extends BaseSyncIntentService {
 
     private static final String TAG = "SyncLocationsByTeamIdsIntentService";

diff --git a/opensrp-core/src/main/java/org/smartregister/sync/intent/SyncTaskIntentService.java b/opensrp-core/src/main/java/org/smartregister/sync/intent/SyncTaskIntentService.java
@@ -4,6 +4,7 @@
 
 import org.smartregister.sync.helper.TaskServiceHelper;
 
+@Deprecated
 public class SyncTaskIntentService extends BaseSyncIntentService {
     private static final String TAG = "SyncTaskIntentService";
     private TaskServiceHelper taskServiceHelper;

diff --git a/opensrp-core/src/main/java/org/smartregister/sync/intent/ValidateIntentService.java b/opensrp-core/src/main/java/org/smartregister/sync/intent/ValidateIntentService.java
@@ -28,6 +28,7 @@
 /**
  * Created by keyman on 11/10/2017.
  */
+@Deprecated
 public class ValidateIntentService extends BaseSyncIntentService {
 
     private Context context;

diff --git a/opensrp-core/src/main/java/org/smartregister/sync/wm/worker/BaseWorker.kt b/opensrp-core/src/main/java/org/smartregister/sync/wm/worker/BaseWorker.kt
@@ -0,0 +1,22 @@
+package org.smartregister.sync.wm.worker
+
+import android.content.Context
+import androidx.work.Worker
+import androidx.work.WorkerParameters
+import org.smartregister.CoreLibrary
+
+abstract class BaseWorker(context: Context, workerParams: WorkerParameters) : Worker(context, workerParams){
+
+    fun beforeWork(){
+        val coreLibrary = CoreLibrary.getInstance()
+        val syncConfiguration = coreLibrary.syncConfiguration
+        if (syncConfiguration != null){
+            coreLibrary.context().httpAgent
+                .apply {
+                    connectTimeout = syncConfiguration.connectTimeout
+                    readTimeout = syncConfiguration.readTimeout
+                }
+        }
+    }
+
+}