Shift contributions to use Room DB (commons-app#3324)

* Part of commons-app#3127
* Added Room Dependency
* Shifted ContributionsDao to use RoomDB

* Save and Fetch contributions via RoomDAO

* Bugfixes, fixed test cases, injected schedulers for ContributionsPresenter

* removed stetho

* Fixed ReviewHelperTest cases

* Fixed test cases in DeleteHelperTest

* Fetch all contributions [TODO add pagination to use this, maybe later in a seperate PR]

* Update Schema false in AppDatabase

* removed parameter from fetchControbutions

* Added logs for fetch contributions

* Fixed test case ContributionsPresenter

* Added an autogenerate primary key, submit save contributions on executor

* fixed getItemAtPosition

* MainActivity Config changes +=orientation

* BugFixes
* Make AppDataBase Singleton
* Set _id as autogenerate primary key [replacing the previously used filename, seems like they are not unique]
* Replace Execxutor Utils with Subscribers on Singles in UploadService
* BugFix, Upload Progress

* Remove un-nescessary null check on contributions in ContributionsListAdapter

* removed ContributionsListFragment [not-implemeted]

* Review suggested changes
* removed un-nescessary null checks
* provide ContributionsDao
* Minor bug fixes

* wip

* delete existing contributions table (from the existing db) on upgrade

* remove un-nescessary null checks in test classes

* shifted media to be a local variable in ReviewHelperTest

* removed captured folder

* Dispose composite disposables in UploadService

* replaced size check with isEmpty ContributionsPresenter

* transform saveContributions to a Completable

* Addressed comments in review
* Typo in Contributions
* ReasonBuilderTest (create media object instead of mocking)
* Use global Gson object instead of creating a new one in Converters

* Provide Gson to Converters from the CommonsApplicationComponent

* use static method instead of field instead of static field to provide GSON in Converters

* Modified gitignore to exclude captures/*

Author: ashishkumar468

.gitignore

@@ -38,3 +38,4 @@ app/src/main/jniLibs
 #Below removes all the HTML files related to OpenCV documentation. The documentation can be otherwise found at:
 #https://docs.opencv.org/3.3.0/
 /libraries/opencv/javadoc/
+captures/*

app/build.gradle

@@ -102,7 +102,14 @@ dependencies {
 
     //swipe_layout
     implementation 'com.daimajia.swipelayout:library:1.2.0@aar'
+
+    //Room
+    def room_version= '2.2.3'
+    implementation "androidx.room:room-runtime:$room_version"
+    kapt "androidx.room:room-compiler:$room_version" // For Kotlin use kapt instead of annotationProcessor
     implementation 'com.squareup.retrofit2:retrofit:2.7.1'
+    implementation "androidx.room:room-rxjava2:$room_version"
+    testImplementation "androidx.arch.core:core-testing:2.1.0"
 }
 
 android {

app/src/main/AndroidManifest.xml

@@ -85,7 +85,7 @@
             android:name=".contributions.MainActivity"
             android:icon="@mipmap/ic_launcher"
             android:label="@string/app_name"
-            android:configChanges="screenSize|keyboard" />
+            android:configChanges="screenSize|keyboard|orientation" />
         <activity
             android:name=".settings.SettingsActivity"
             android:label="@string/title_activity_settings" />
@@ -157,18 +157,6 @@
                 android:name="android.accounts.AccountAuthenticator"
                 android:resource="@xml/authenticator" />
         </service>
-        <service
-            android:name=".contributions.ContributionsSyncService"
-            android:exported="true"
-            android:process=":sync">
-            <intent-filter>
-                <action android:name="android.content.SyncAdapter" />
-            </intent-filter>
-
-            <meta-data
-                android:name="android.content.SyncAdapter"
-                android:resource="@xml/contributions_sync_adapter" />
-        </service>
 
         <service
             android:name="org.acra.sender.SenderService"
@@ -184,12 +172,6 @@
                 android:name="android.support.FILE_PROVIDER_PATHS"
                 android:resource="@xml/provider_paths" />
         </provider>
-        <provider
-            android:name=".contributions.ContributionsContentProvider"
-            android:authorities="${applicationId}.contributions.contentprovider"
-            android:exported="false"
-            android:label="@string/provider_contributions"
-            android:syncable="true" />
 
         <provider
             android:name=".category.CategoryContentProvider"

app/src/main/java/fr/free/nrw/commons/CommonsApplication.java

@@ -6,6 +6,7 @@
 import android.app.NotificationManager;
 import android.content.Context;
 import android.database.sqlite.SQLiteDatabase;
+import android.database.sqlite.SQLiteException;
 import android.os.Build;
 import android.os.Process;
 import android.util.Log;
@@ -44,8 +45,8 @@
 import fr.free.nrw.commons.category.CategoryDao;
 import fr.free.nrw.commons.concurrency.BackgroundPoolExceptionHandler;
 import fr.free.nrw.commons.concurrency.ThreadPoolService;
-import fr.free.nrw.commons.contributions.ContributionDao;
 import fr.free.nrw.commons.data.DBOpenHelper;
+import fr.free.nrw.commons.db.AppDatabase;
 import fr.free.nrw.commons.di.ApplicationlessInjection;
 import fr.free.nrw.commons.kvstore.JsonKvStore;
 import fr.free.nrw.commons.logging.FileLoggingTree;
@@ -60,6 +61,7 @@
 import okhttp3.OkHttpClient;
 import timber.log.Timber;
 
+import static fr.free.nrw.commons.data.DBOpenHelper.CONTRIBUTIONS_TABLE;
 import static org.acra.ReportField.ANDROID_VERSION;
 import static org.acra.ReportField.APP_VERSION_CODE;
 import static org.acra.ReportField.APP_VERSION_NAME;
@@ -126,6 +128,9 @@ public AppLanguageLookUpTable getLanguageLookUpTable() {
         return languageLookUpTable;
     }
 
+    @Inject
+    AppDatabase appDatabase;
+
     /**
      * Used to declare and initialize various components and dependencies
      */
@@ -306,11 +311,13 @@ private void updateAllDatabases() {
         SQLiteDatabase db = dbOpenHelper.getWritableDatabase();
 
         CategoryDao.Table.onDelete(db);
-        ContributionDao.Table.onDelete(db);
+        dbOpenHelper.deleteTable(db,CONTRIBUTIONS_TABLE);//Delete the contributions table in the existing db on older versions
+        appDatabase.getContributionDao().deleteAll();
         BookmarkPicturesDao.Table.onDelete(db);
         BookmarkLocationsDao.Table.onDelete(db);
     }
 
+
     /**
      * Interface used to get log-out events
      */

app/src/main/java/fr/free/nrw/commons/Media.java

@@ -6,6 +6,8 @@
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.room.Entity;
+import androidx.room.PrimaryKey;
 
 import org.apache.commons.lang3.StringUtils;
 import org.wikipedia.dataclient.mwapi.MwQueryPage;
@@ -26,6 +28,7 @@
 import fr.free.nrw.commons.utils.CommonsDateUtil;
 import fr.free.nrw.commons.utils.MediaDataExtractorUtil;
 
+@Entity
 public class Media implements Parcelable {
 
     public static final Media EMPTY = new Media("");
@@ -42,25 +45,25 @@ public Media[] newArray(int i) {
     };
 
     // Primary metadata fields
-    protected Uri localUri;
-    private String thumbUrl;
-    protected String imageUrl;
-    protected String filename;
-    protected String description; // monolingual description on input...
-    protected String discussion;
-    protected long dataLength;
-    protected Date dateCreated;
-    protected @Nullable Date dateUploaded;
-    protected int width;
-    protected int height;
-    protected String license;
-    protected String licenseUrl;
-    protected String creator;
-    protected ArrayList<String> categories; // as loaded at runtime?
-    protected boolean requestedDeletion;
-    private Map<String, String> descriptions; // multilingual descriptions as loaded
-    private HashMap<String, Object> tags = new HashMap<>();
-    private @Nullable LatLng coordinates;
+    public Uri localUri;
+    public String thumbUrl;
+    public String imageUrl;
+    public String filename;
+    public String description; // monolingual description on input...
+    public String discussion;
+    long dataLength;
+    public Date dateCreated;
+    @Nullable public  Date dateUploaded;
+    public int width;
+    public int height;
+    public String license;
+    public String licenseUrl;
+    public String creator;
+    public ArrayList<String> categories; // as loaded at runtime?
+    public boolean requestedDeletion;
+    public HashMap<String, String> descriptions; // multilingual descriptions as loaded
+    public HashMap<String, String> tags = new HashMap<>();
+    @Nullable public  LatLng coordinates;
 
     /**
      * Provides local constructor
@@ -118,7 +121,7 @@ public Media(Parcel in) {
         dateCreated = (Date) in.readSerializable();
         dateUploaded = (Date) in.readSerializable();
         creator = in.readString();
-        tags = (HashMap<String, Object>) in.readSerializable();
+        tags = (HashMap<String, String>) in.readSerializable();
         width = in.readInt();
         height = in.readInt();
         license = in.readString();
@@ -218,7 +221,7 @@ public Object getTag(String key) {
      * @param key Media key
      * @param value Media value
      */
-    public void setTag(String key, Object value) {
+    public void setTag(String key, String value) {
         tags.put(key, value);
     }
 

app/src/main/java/fr/free/nrw/commons/contributions/Contribution.java

@@ -6,6 +6,8 @@
 
 import androidx.annotation.NonNull;
 import androidx.annotation.StringDef;
+import androidx.room.Entity;
+import androidx.room.PrimaryKey;
 
 import org.apache.commons.lang3.StringUtils;
 
@@ -21,6 +23,7 @@
 
 import static java.lang.annotation.RetentionPolicy.SOURCE;
 
+@Entity(tableName = "contribution")
 public class  Contribution extends Media {
 
     //{{According to Exif data|2009-01-09}}
@@ -54,17 +57,19 @@ public Contribution[] newArray(int i) {
     public static final String SOURCE_CAMERA = "camera";
     public static final String SOURCE_GALLERY = "gallery";
     public static final String SOURCE_EXTERNAL = "external";
-
-    private Uri contentUri;
-    private String source;
-    private String editSummary;
-    private int state;
-    private long transferred;
-    private String decimalCoords;
-    private boolean isMultiple;
-    private String wikiDataEntityId;
-    private Uri contentProviderUri;
-    private String dateCreatedSource;
+    @PrimaryKey (autoGenerate = true)
+    @NonNull
+    public long _id;
+    public Uri contentUri;
+    public String source;
+    public String editSummary;
+    public int state;
+    public long transferred;
+    public String decimalCoords;
+    public boolean isMultiple;
+    public String wikiDataEntityId;
+    public Uri contentProviderUri;
+    public String dateCreatedSource;
 
     public Contribution(Uri contentUri, String filename, Uri localUri, String imageUrl, Date dateCreated,
                         int state, long dataLength, Date dateUploaded, long transferred,