Bug 1867079 - Set requestAnalysisCreationStatus deprecation for 124 r…

…=geckoview-reviewers,owlish

Differential Revision: https://phabricator.services.mozilla.com/D196468

mobile/android/geckoview/api.txt

@@ -50,6 +50,7 @@ import java.lang.Boolean;
 import java.lang.CharSequence;
 import java.lang.Class;
 import java.lang.Comparable;
+import java.lang.Deprecated;
 import java.lang.Double;
 import java.lang.Exception;
 import java.lang.Float;
@@ -84,6 +85,7 @@ import org.mozilla.geckoview.CompositorController;
 import org.mozilla.geckoview.ContentBlocking;
 import org.mozilla.geckoview.ContentBlockingController;
 import org.mozilla.geckoview.CrashHandler;
+import org.mozilla.geckoview.DeprecationSchedule;
 import org.mozilla.geckoview.ExperimentDelegate;
 import org.mozilla.geckoview.GeckoDisplay;
 import org.mozilla.geckoview.GeckoResult;
@@ -1030,7 +1032,7 @@ package org.mozilla.geckoview {
     method @AnyThread public void reload(int);
     method @AnyThread @NonNull public GeckoResult<String> reportBackInStock(@NonNull String);
     method @AnyThread @NonNull public GeckoResult<GeckoSession.ReviewAnalysis> requestAnalysis(@NonNull String);
-    method @AnyThread @NonNull public GeckoResult<String> requestAnalysisCreationStatus(@NonNull String);
+    method @AnyThread @Deprecated @DeprecationSchedule(version=124,id="shopping-status") @NonNull public GeckoResult<String> requestAnalysisCreationStatus(@NonNull String);
     method @AnyThread @NonNull public GeckoResult<GeckoSession.AnalysisStatusResponse> requestAnalysisStatus(@NonNull String);
     method @AnyThread @NonNull public GeckoResult<String> requestCreateAnalysis(@NonNull String);
     method @AnyThread @NonNull public GeckoResult<List<GeckoSession.Recommendation>> requestRecommendations(@NonNull String);

mobile/android/geckoview/src/androidTest/java/org/mozilla/geckoview/test/ReviewQualityCheckerTest.kt

@@ -132,9 +132,6 @@ class ReviewQualityCheckerTest : BaseSessionTest() {
         val createResult = mainSession.requestCreateAnalysis("https://www.example.com/mock/")
         assertThat("Analysis status should match", sessionRule.waitForResult(createResult), equalTo("pending"))
 
-        val creationStatus = mainSession.requestAnalysisCreationStatus("https://www.example.com/mock/")
-        assertThat("Analysis status should match", sessionRule.waitForResult(creationStatus), equalTo("in_progress"))
-
         val status = "in_progress"
         val progress = 90.9
 

mobile/android/geckoview/src/main/java/org/mozilla/geckoview/GeckoSession.java

@@ -3017,11 +3017,16 @@ public void restoreState(final @NonNull SessionState state) {
   }
 
   /**
-   * Request the status of the current analysis of product's reviews for a given product URL.
+   * This method is scheduled for deprecation, see Bug 1867079 for details. Please switch to
+   * requestAnalysisStatus for the same functionality.
+   *
+   * <p>Request the status of the current analysis of product's reviews for a given product URL.
    *
    * @param url The URL of the product page.
    * @return a {@link GeckoResult} result of status of analysis.
    */
+  @Deprecated
+  @DeprecationSchedule(version = 124, id = "shopping-status")
   @AnyThread
   public @NonNull GeckoResult<String> requestAnalysisCreationStatus(@NonNull final String url) {
     final GeckoBundle bundle = new GeckoBundle(1);

mobile/android/geckoview/src/main/java/org/mozilla/geckoview/doc-files/CHANGELOG.md

@@ -15,6 +15,7 @@ exclude: true
 
 ## v123
 - For Translations, added [`checkPairDownloadSize`][123.1] and [`TranslationsException.ERROR_MODEL_LANGUAGE_REQUIRED`][123.2] as an error state.
+- ⚠️ Deprecated [`GeckoSession.requestAnalysisCreationStatus`][119.2] by 124, please use [`GeckoSession.requestCreateAnalysis`][122.2] instead.
 
 [123.1]: {{javadoc_uri}}/TranslationsController.RuntimeTranslation.html#checkPairDownloadSize(java.lang.String,java.lang.String)
 [123.2]: {{javadoc_uri}}/TranslationsController.TranslationsException.html#ERROR_MODEL_LANGUAGE_REQUIRED
@@ -84,7 +85,7 @@ exclude: true
 ## v119
 - Added `remoteType` to GeckoView child crash intent. ([bug 1851518]({{bugzilla}}1851518))
 
-- [119.1]: {{javadoc_uri}}/GeckoSession.html#requestCreateAnalysis(String)
+[119.1]: {{javadoc_uri}}/GeckoSession.html#requestCreateAnalysis(String)
 [119.2]: {{javadoc_uri}}/GeckoSession.html#requestAnalysisCreationStatus(String)
 [119.3]: {{javadoc_uri}}/GeckoSession.html#pollForAnalysisCompleted(String)
 
@@ -1500,4 +1501,4 @@ to allow adding gecko profiler markers.
 [65.24]: {{javadoc_uri}}/CrashReporter.html#sendCrashReport(android.content.Context,android.os.Bundle,java.lang.String)
 [65.25]: {{javadoc_uri}}/GeckoResult.html
 
-[api-version]: b0284760f2703400eb95830f92c699bf66ccc9bb
+[api-version]: 3f36799dec8719407927be36c724f5020bb127dc