Use data client for peer review calls

maskaravivek · maskaravivek · commit 2de52c3c23f0 · 2019-05-06T09:53:49.000+05:30
diff --git a/app/src/main/java/fr/free/nrw/commons/di/CommonsApplicationModule.java b/app/src/main/java/fr/free/nrw/commons/di/CommonsApplicationModule.java
@@ -3,11 +3,12 @@
 import android.app.Activity;
 import android.content.ContentProviderClient;
 import android.content.Context;
-import androidx.collection.LruCache;
 import android.view.inputmethod.InputMethodManager;
 
 import com.google.gson.Gson;
 
+import org.wikipedia.dataclient.WikiSite;
+
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
@@ -16,6 +17,7 @@
 import javax.inject.Named;
 import javax.inject.Singleton;
 
+import androidx.collection.LruCache;
 import dagger.Module;
 import dagger.Provides;
 import fr.free.nrw.commons.BuildConfig;
@@ -24,7 +26,6 @@
 import fr.free.nrw.commons.auth.SessionManager;
 import fr.free.nrw.commons.data.DBOpenHelper;
 import fr.free.nrw.commons.kvstore.JsonKvStore;
-import fr.free.nrw.commons.kvstore.JsonKvStore;
 import fr.free.nrw.commons.location.LocationServiceManager;
 import fr.free.nrw.commons.settings.Prefs;
 import fr.free.nrw.commons.upload.UploadController;
diff --git a/app/src/main/java/fr/free/nrw/commons/di/NetworkingModule.java b/app/src/main/java/fr/free/nrw/commons/di/NetworkingModule.java
@@ -4,6 +4,8 @@
 
 import com.google.gson.Gson;
 
+import org.wikipedia.dataclient.ServiceFactory;
+import org.wikipedia.dataclient.WikiSite;
 import org.wikipedia.json.GsonUtil;
 
 import java.io.File;
@@ -20,6 +22,7 @@
 import fr.free.nrw.commons.mwapi.ApacheHttpClientMediaWikiApi;
 import fr.free.nrw.commons.mwapi.MediaWikiApi;
 import fr.free.nrw.commons.mwapi.OkHttpJsonApiClient;
+import fr.free.nrw.commons.review.ReviewInterface;
 import okhttp3.Cache;
 import okhttp3.HttpUrl;
 import okhttp3.OkHttpClient;
@@ -108,4 +111,16 @@ public Gson provideGson() {
         return GsonUtil.getDefaultGson();
     }
 
+    @Provides
+    @Singleton
+    @Named("commons-wikisite")
+    public WikiSite provideCommonsWikiSite() {
+        return new WikiSite(BuildConfig.COMMONS_URL);
+    }
+
+    @Provides
+    @Singleton
+    public ReviewInterface provideReviewInterface(@Named("commons-wikisite") WikiSite commonsWikiSite) {
+        return ServiceFactory.get(commonsWikiSite, BuildConfig.COMMONS_URL, ReviewInterface.class);
+    }
 }
diff --git a/app/src/main/java/fr/free/nrw/commons/mwapi/OkHttpJsonApiClient.java b/app/src/main/java/fr/free/nrw/commons/mwapi/OkHttpJsonApiClient.java
@@ -6,8 +6,6 @@
 import org.apache.commons.lang3.StringUtils;
 import org.wikipedia.dataclient.mwapi.MwQueryPage;
 import org.wikipedia.dataclient.mwapi.MwQueryResponse;
-import org.wikipedia.dataclient.mwapi.RecentChange;
-import org.wikipedia.util.DateUtil;
 
 import java.io.IOException;
 import java.lang.reflect.Type;
@@ -16,7 +14,6 @@
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
-import java.util.Random;
 
 import javax.inject.Inject;
 import javax.inject.Singleton;
@@ -406,80 +403,4 @@ private void putContinueValues(String keyword, Map<String, String> values) {
     private Map<String, String> getContinueValues(String keyword) {
         return defaultKvStore.getJson("query_continue_" + keyword, mapType);
     }
-
-    /**
-     * Returns recent changes on commons
-     *
-     * @return list of recent changes made
-     */
-    @Nullable
-    public Single<List<RecentChange>> getRecentFileChanges() {
-        final int RANDOM_SECONDS = 60 * 60 * 24 * 30;
-        final String FILE_NAMESPACE = "6";
-        Random r = new Random();
-        Date now = new Date();
-        Date startDate = new Date(now.getTime() - r.nextInt(RANDOM_SECONDS) * 1000L);
-
-        String rcStart = DateUtil.iso8601DateFormat(startDate);
-        HttpUrl.Builder urlBuilder = HttpUrl
-                .parse(commonsBaseUrl)
-                .newBuilder()
-                .addQueryParameter("action", "query")
-                .addQueryParameter("format", "json")
-                .addQueryParameter("formatversion", "2")
-                .addQueryParameter("list", "recentchanges")
-                .addQueryParameter("rcstart", rcStart)
-                .addQueryParameter("rcnamespace", FILE_NAMESPACE)
-                .addQueryParameter("rcprop", "title|ids")
-                .addQueryParameter("rctype", "new|log")
-                .addQueryParameter("rctoponly", "1");
-
-        Request request = new Request.Builder()
-                .url(urlBuilder.build())
-                .build();
-
-        return Single.fromCallable(() -> {
-            Response response = okHttpClient.newCall(request).execute();
-            if (response.body() != null && response.isSuccessful()) {
-                String json = response.body().string();
-                MwQueryResponse mwQueryPage = gson.fromJson(json, MwQueryResponse.class);
-                return mwQueryPage.query().getRecentChanges();
-            }
-            return new ArrayList<>();
-        });
-    }
-
-    /**
-     * Returns the first revision of the file
-     *
-     * @return Revision object
-     */
-    @Nullable
-    public Single<MwQueryPage.Revision> getFirstRevisionOfFile(String filename) {
-        HttpUrl.Builder urlBuilder = HttpUrl
-                .parse(commonsBaseUrl)
-                .newBuilder()
-                .addQueryParameter("action", "query")
-                .addQueryParameter("format", "json")
-                .addQueryParameter("formatversion", "2")
-                .addQueryParameter("prop", "revisions")
-                .addQueryParameter("rvprop", "timestamp|ids|user")
-                .addQueryParameter("titles", filename)
-                .addQueryParameter("rvdir", "newer")
-                .addQueryParameter("rvlimit", "1");
-
-        Request request = new Request.Builder()
-                .url(urlBuilder.build())
-                .build();
-
-        return Single.fromCallable(() -> {
-            Response response = okHttpClient.newCall(request).execute();
-            if (response.body() != null && response.isSuccessful()) {
-                String json = response.body().string();
-                MwQueryResponse mwQueryPage = gson.fromJson(json, MwQueryResponse.class);
-                return mwQueryPage.query().firstPage().revisions().get(0);
-            }
-            return null;
-        });
-    }
 }
diff --git a/app/src/main/java/fr/free/nrw/commons/review/ReviewActivity.java b/app/src/main/java/fr/free/nrw/commons/review/ReviewActivity.java
@@ -12,13 +12,19 @@
 import android.widget.Button;
 import android.widget.ProgressBar;
 import android.widget.TextView;
+
+import com.facebook.drawee.view.SimpleDraweeView;
+import com.google.android.material.navigation.NavigationView;
+import com.viewpagerindicator.CirclePageIndicator;
+
+import java.util.ArrayList;
+
+import javax.inject.Inject;
+
 import androidx.appcompat.widget.Toolbar;
 import androidx.drawerlayout.widget.DrawerLayout;
 import butterknife.BindView;
 import butterknife.ButterKnife;
-import com.facebook.drawee.view.SimpleDraweeView;
-import com.google.android.material.navigation.NavigationView;
-import com.viewpagerindicator.CirclePageIndicator;
 import fr.free.nrw.commons.Media;
 import fr.free.nrw.commons.R;
 import fr.free.nrw.commons.auth.AuthenticatedActivity;
@@ -29,8 +35,6 @@
 import io.reactivex.android.schedulers.AndroidSchedulers;
 import io.reactivex.disposables.CompositeDisposable;
 import io.reactivex.schedulers.Schedulers;
-import java.util.ArrayList;
-import javax.inject.Inject;
 
 public class ReviewActivity extends AuthenticatedActivity {
 
diff --git a/app/src/main/java/fr/free/nrw/commons/review/ReviewHelper.java b/app/src/main/java/fr/free/nrw/commons/review/ReviewHelper.java
@@ -1,20 +1,25 @@
 package fr.free.nrw.commons.review;
 
+
+import androidx.core.util.Pair;
+
 import org.wikipedia.dataclient.mwapi.MwQueryPage;
 import org.wikipedia.dataclient.mwapi.RecentChange;
+import org.wikipedia.util.DateUtil;
 
+import java.util.Collections;
+import java.util.Date;
 import java.util.List;
 import java.util.Random;
 
-import javax.annotation.Nullable;
 import javax.inject.Inject;
 import javax.inject.Singleton;
 
-import androidx.core.util.Pair;
 import fr.free.nrw.commons.Media;
 import fr.free.nrw.commons.mwapi.MediaWikiApi;
 import fr.free.nrw.commons.mwapi.OkHttpJsonApiClient;
-import io.reactivex.Single;
+import io.reactivex.Maybe;
+import io.reactivex.Observable;
 
 @Singleton
 public class ReviewHelper {
@@ -24,16 +29,29 @@ public class ReviewHelper {
 
     private final OkHttpJsonApiClient okHttpJsonApiClient;
     private final MediaWikiApi mediaWikiApi;
+    private final ReviewInterface reviewInterface;
 
     @Inject
-    public ReviewHelper(OkHttpJsonApiClient okHttpJsonApiClient, MediaWikiApi mediaWikiApi) {
+    public ReviewHelper(OkHttpJsonApiClient okHttpJsonApiClient,
+                        MediaWikiApi mediaWikiApi,
+                        ReviewInterface reviewInterface) {
         this.okHttpJsonApiClient = okHttpJsonApiClient;
         this.mediaWikiApi = mediaWikiApi;
+        this.reviewInterface = reviewInterface;
     }
 
-    Single<Media> getRandomMedia() {
-        return getRandomFileChange()
-                .flatMap(fileName -> okHttpJsonApiClient.getMedia(fileName, false));
+    private Observable<List<RecentChange>> getRecentChanges() {
+        final int RANDOM_SECONDS = 60 * 60 * 24 * 30;
+        Random r = new Random();
+        Date now = new Date();
+        Date startDate = new Date(now.getTime() - r.nextInt(RANDOM_SECONDS) * 1000L);
+
+        String rcStart = DateUtil.iso8601DateFormat(startDate);
+        return reviewInterface.getRecentChanges(rcStart).map(mwQueryResponse -> mwQueryResponse.query().getRecentChanges())
+                .map(recentChanges -> {
+                    Collections.shuffle(recentChanges);
+                    return recentChanges;
+                });
     }
 
     /**
@@ -43,57 +61,40 @@ Single<Media> getRandomMedia() {
      * - Checks if the file is nominated for deletion
      * - Retries upto 5 times for getting a file which is not nominated for deletion
      *
-     * @return
+     * @return Random file change
      */
-    private Single<String> getRandomFileChange() {
-        return okHttpJsonApiClient.getRecentFileChanges()
-                .map(this::findImageInRecentChanges)
-                .flatMap(title -> mediaWikiApi.pageExists("Commons:Deletion_requests/" + title)
-                        .map(pageExists -> new Pair<>(title, pageExists)))
-                .map((Pair<String, Boolean> pair) -> {
-                    if (!pair.second) {
-                        return pair.first;
+    public Maybe<Media> getRandomMedia() {
+        return getRecentChanges()
+                .flatMapIterable(changes -> changes)
+                .filter(this::isChangeReviewable)
+                .flatMapSingle(change -> mediaWikiApi.pageExists("Commons:Deletion_requests/" + change.getTitle())
+                        .map(exists -> new Pair<>(change.getTitle(), exists)))
+                .flatMapSingle(fileNamePair -> {
+                    if (fileNamePair.second != null && !fileNamePair.second) {
+                        return okHttpJsonApiClient.getMedia(fileNamePair.first, false);
                     }
-                    throw new Exception("Already nominated for deletion");
-                }).retry(MAX_RANDOM_TRIES);
+                    return null;
+                })
+                .filter(media -> media != null)
+                .firstElement();
     }
 
-    Single<MwQueryPage.Revision> getFirstRevisionOfFile(String fileName) {
-        return okHttpJsonApiClient.getFirstRevisionOfFile(fileName);
+    Observable<MwQueryPage.Revision> getFirstRevisionOfFile(String filename) {
+        return reviewInterface.getFirstRevisionOfFile(filename)
+                .map(response -> response.query().firstPage().revisions().get(0));
     }
 
-    @Nullable
-    private String findImageInRecentChanges(List<RecentChange> recentChanges) {
-        String imageTitle;
-        Random r = new Random();
-        int count = recentChanges.size();
-        // Build a range array
-        int[] randomIndexes = new int[count];
-        for (int i = 0; i < count; i++) {
-            randomIndexes[i] = i;
-        }
-        // Then shuffle it
-        for (int i = 0; i < count; i++) {
-            int swapIndex = r.nextInt(count);
-            int temp = randomIndexes[i];
-            randomIndexes[i] = randomIndexes[swapIndex];
-            randomIndexes[swapIndex] = temp;
+    private boolean isChangeReviewable(RecentChange recentChange) {
+        if (recentChange.getType().equals("log") && !(recentChange.getOldRevisionId() == 0)) {
+            return false;
         }
-        for (int i = 0; i < count; i++) {
-            int randomIndex = randomIndexes[i];
-            RecentChange recentChange = recentChanges.get(randomIndex);
-            if (recentChange.getType().equals("log") && !(recentChange.getOldRevisionId() == 0)) {
-                // For log entries, we only want ones where old_revid is zero, indicating a new file
-                continue;
-            }
-            imageTitle = recentChange.getTitle();
 
-            for (String imageExtension : imageExtensions) {
-                if (imageTitle.toLowerCase().endsWith(imageExtension)) {
-                    return imageTitle;
-                }
+        for (String extension : imageExtensions) {
+            if (recentChange.getTitle().endsWith(extension)) {
+                return true;
             }
         }
-        return null;
+
+        return false;
     }
 }
diff --git a/app/src/main/java/fr/free/nrw/commons/review/ReviewInterface.java b/app/src/main/java/fr/free/nrw/commons/review/ReviewInterface.java
@@ -0,0 +1,15 @@
+package fr.free.nrw.commons.review;
+
+import org.wikipedia.dataclient.mwapi.MwQueryResponse;
+
+import io.reactivex.Observable;
+import retrofit2.http.GET;
+import retrofit2.http.Query;
+
+public interface ReviewInterface {
+    @GET("w/api.php?action=query&format=json&formatversion=2&list=recentchanges&rcprop=title|ids&rctype=new|log&rctoponly=1&rcnamespace=6")
+    Observable<MwQueryResponse> getRecentChanges(@Query("rcstart") String rcStart);
+
+    @GET("w/api.php?action=query&format=json&formatversion=2&prop=revisions&rvprop=timestamp|ids|user&rvdir=newer&rvlimit=1")
+    Observable<MwQueryResponse> getFirstRevisionOfFile(@Query("titles") String titles);
+}
diff --git a/app/src/test/kotlin/fr/free/nrw/commons/review/ReviewHelperTest.kt b/app/src/test/kotlin/fr/free/nrw/commons/review/ReviewHelperTest.kt
