Add ability to suppress logging of known unsuccessful API calls (commons-app#5526)

Author: psh

app/src/main/java/fr/free/nrw/commons/MediaDataExtractor.kt

@@ -43,7 +43,7 @@ class MediaDataExtractor @Inject constructor(private val mediaClient: MediaClien
         return Single.ambArray(
             mediaClient.getMediaById(PAGE_ID_PREFIX + media.pageId)
                 .onErrorResumeNext { Single.never() },
-            mediaClient.getMedia(media.filename)
+            mediaClient.getMediaSuppressingErrors(media.filename)
                 .onErrorResumeNext { Single.never() }
         )
 

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

@@ -67,6 +67,8 @@ public Response intercept(@NonNull final Chain chain) throws IOException {
     }
 
     public static class UnsuccessfulResponseInterceptor implements Interceptor {
+        private static final String SUPPRESS_ERROR_LOG = "x-commons-suppress-error-log";
+        public static final String SUPPRESS_ERROR_LOG_HEADER = SUPPRESS_ERROR_LOG+": true";
         private static final List<String> DO_NOT_INTERCEPT = Collections.singletonList(
             "api.php?format=json&formatversion=2&errorformat=plaintext&action=upload&ignorewarnings=1");
 
@@ -75,7 +77,16 @@ public static class UnsuccessfulResponseInterceptor implements Interceptor {
         @Override
         @NonNull
         public Response intercept(@NonNull final Chain chain) throws IOException {
-            final Response rsp = chain.proceed(chain.request());
+            final Request rq = chain.request();
+
+            // If the request contains our special "suppress errors" header, make note of it
+            // but don't pass that on to the server.
+            final boolean suppressErrors = rq.headers().names().contains(SUPPRESS_ERROR_LOG);
+            final Request request = rq.newBuilder()
+                .removeHeader(SUPPRESS_ERROR_LOG)
+                .build();
+
+            final Response rsp = chain.proceed(request);
 
             // Do not intercept certain requests and let the caller handle the errors
             if(isExcludedUrl(chain.request())) {
@@ -89,7 +100,12 @@ public Response intercept(@NonNull final Chain chain) throws IOException {
                         }
                     }
                 } catch (final IOException e) {
-                    Timber.e(e);
+                    // Log the error as debug (and therefore, "expected") or at error level
+                    if (suppressErrors) {
+                        Timber.d(e, "Suppressed (known / expected) error");
+                    } else {
+                        Timber.e(e);
+                    }
                 }
                 return rsp;
             }

app/src/main/java/fr/free/nrw/commons/media/MediaClient.kt

@@ -130,6 +130,17 @@ class MediaClient @Inject constructor(
             .map { it.first() }
     }
 
+    /**
+     * Fetches Media object from the imageInfo API but suppress (known) errors
+     *
+     * @param titles the tiles to be searched for. Can be filename or template name
+     * @return
+     */
+    fun getMediaSuppressingErrors(titles: String?): Single<Media> {
+        return responseMapper(mediaInterface.getMediaSuppressingErrors(titles))
+            .map { it.first() }
+    }
+
     /**
      * The method returns the picture of the day
      *

app/src/main/java/fr/free/nrw/commons/media/MediaInterface.java

@@ -1,9 +1,12 @@
 package fr.free.nrw.commons.media;
 
+import static fr.free.nrw.commons.OkHttpConnectionFactory.UnsuccessfulResponseInterceptor.SUPPRESS_ERROR_LOG_HEADER;
+
 import io.reactivex.Single;
 import java.util.Map;
 import fr.free.nrw.commons.wikidata.mwapi.MwQueryResponse;
 import retrofit2.http.GET;
+import retrofit2.http.Headers;
 import retrofit2.http.Query;
 import retrofit2.http.QueryMap;
 
@@ -103,6 +106,17 @@ Single<MwQueryResponse> getMediaListFromSearch(@Query("gsrsearch") String keywor
         MEDIA_PARAMS_WITH_CATEGORY_DETAILS)
     Single<MwQueryResponse> getMedia(@Query("titles") String title);
 
+    /**
+     * Fetches Media object from the imageInfo API but suppress (known) errors
+     *
+     * @param title       the tiles to be searched for. Can be filename or template name
+     * @return
+     */
+    @GET("w/api.php?action=query&format=json&formatversion=2" +
+        MEDIA_PARAMS_WITH_CATEGORY_DETAILS)
+    @Headers(SUPPRESS_ERROR_LOG_HEADER)
+    Single<MwQueryResponse> getMediaSuppressingErrors(@Query("titles") String title);
+
     /**
      * Fetches Media object from the imageInfo API
      *
@@ -111,6 +125,7 @@ Single<MwQueryResponse> getMediaListFromSearch(@Query("gsrsearch") String keywor
      */
     @GET("w/api.php?action=query&format=json&formatversion=2" +
             MEDIA_PARAMS)
+    @Headers(SUPPRESS_ERROR_LOG_HEADER)
     Single<MwQueryResponse> getMediaById(@Query("pageids") String pageIds);
 
     /**
@@ -125,6 +140,7 @@ Single<MwQueryResponse> getMediaListFromSearch(@Query("gsrsearch") String keywor
     Single<MwQueryResponse> getMediaWithGenerator(@Query("titles") String title);
 
     @GET("w/api.php?format=json&action=parse&prop=text")
+    @Headers(SUPPRESS_ERROR_LOG_HEADER)
     Single<MwParseResponse> getPageHtml(@Query("page") String title);
 
     /**