Issue mozilla-mobile#2325: Deprecate Pocket code moving to a-c.

The code is already available in a-c: it just needs to be exposed and perhaps refactored a little bit to support being exposed.
mcomella · May 24, 2019 · 6b04a62 · 6b04a62
1 parent 8ad0ceb
commit 6b04a62
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 0 deletions.
diff --git a/app/src/androidTest/java/org/mozilla/tv/firefox/helpers/CustomPocketFeedStateProvider.kt b/app/src/androidTest/java/org/mozilla/tv/firefox/helpers/CustomPocketFeedStateProvider.kt
@@ -2,6 +2,8 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+@file:Suppress("DEPRECATION") // PocketVideoParser.
+
 package org.mozilla.tv.firefox.helpers
 
 import android.app.Application

diff --git a/app/src/main/java/org/mozilla/tv/firefox/pocket/PocketEndpointRaw.kt b/app/src/main/java/org/mozilla/tv/firefox/pocket/PocketEndpointRaw.kt
@@ -17,6 +17,7 @@ import java.util.concurrent.TimeoutException
 private const val LOGTAG = "PocketEndpointRaw"
 
 /** Make requests to the Pocket endpoint and returns raw data: see [PocketEndpoint] for more. */
+@Deprecated("Move to android-components implementation #1976")
 class PocketEndpointRaw(
     private val appVersion: String,
     private val pocketGlobalVideoEndpoint: Uri?

diff --git a/app/src/main/java/org/mozilla/tv/firefox/pocket/PocketVideoParser.kt b/app/src/main/java/org/mozilla/tv/firefox/pocket/PocketVideoParser.kt
@@ -14,6 +14,7 @@ private const val LOGTAG = "PocketVideoParser"
 /**
  * Handles marshalling [PocketViewModel.FeedItem.Video] objects from JSON.
  */
+@Deprecated("Move to android-components implementation #1976")
 object PocketVideoParser {
 
     // Ideally, this functionality would be in a separate class but 1) we're short on time and 2) this

diff --git a/app/src/main/java/org/mozilla/tv/firefox/pocket/PocketViewModel.kt b/app/src/main/java/org/mozilla/tv/firefox/pocket/PocketViewModel.kt
@@ -41,6 +41,7 @@ class PocketViewModel(
             val authors: String
         ) : FeedItem() {
             companion object {
+                @Suppress("DEPRECATION") // We need PocketVideoParser until we move to a-c's impl.
                 fun fromJSONObject(jsonObject: JSONObject) = PocketVideoParser.parse(jsonObject)
             }
         }

diff --git a/app/src/main/java/org/mozilla/tv/firefox/utils/ServiceLocator.kt b/app/src/main/java/org/mozilla/tv/firefox/utils/ServiceLocator.kt
@@ -2,6 +2,10 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+// We want the Pocket code from a-c: #1976. Unfortunately, the compiler won't let
+// us suppress individual lines so we have to suppress the file.
+@file:Suppress("DEPRECATION")
+
 package org.mozilla.tv.firefox.utils
 
 import android.app.Application
@@ -87,6 +91,7 @@ open class ServiceLocator(val app: Application) {
     val screenshotStoreWrapper by lazy { PinnedTileImageUtilWrapper(app) }
     val formattedDomainWrapper by lazy { FormattedDomainWrapper(app) }
     val channelRepo by lazy { ChannelRepo(pinnedTileRepo) }
+    @Suppress("DEPRECATION") // We need PocketEndpointRaw until we move to a-c's impl.
     val pocketEndpointRaw by lazy { PocketEndpointRaw(appVersion, buildConfigDerivables.globalPocketVideoEndpoint) }
     val pocketVideoStore by lazy { PocketVideoStore(app, app.assets, pocketVideoParser::convertVideosJSON) }
     val pocketVideoFetchScheduler by lazy { PocketVideoFetchScheduler(isPocketEnabledByLocale) }

diff --git a/app/src/test/java/org/mozilla/tv/firefox/pocket/PocketVideoParserTest.kt b/app/src/test/java/org/mozilla/tv/firefox/pocket/PocketVideoParserTest.kt
@@ -2,6 +2,8 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+@file:Suppress("DEPRECATION") // The class under test is deprecated.
+
 package org.mozilla.tv.firefox.pocket
 
 import org.json.JSONObject