Remove FXIOS-6735 [v120] remove pocket feature flag (#16825)

* Remove .pocket feature flag

* Show pocket settings even when the feature is turned off

* Return directly

* Adjust tests

Author: lmarceau

Client/FeatureFlags/NimbusFlaggableFeature.swift

@@ -23,7 +23,6 @@ enum NimbusFeatureFlagID: String, CaseIterable {
     case isToolbarCFREnabled
     case jumpBackIn
     case libraryCoordinatorRefactor
-    case pocket
     case qrCodeCoordinatorRefactor
     case recentlySaved
     case reduxIntegration
@@ -68,8 +67,6 @@ struct NimbusFlaggableFeature: HasNimbusSearchBar {
             return FlagKeys.InactiveTabs
         case .jumpBackIn:
             return FlagKeys.JumpBackInSection
-        case .pocket:
-            return FlagKeys.ASPocketStories
         case .recentlySaved:
             return FlagKeys.RecentlySavedSection
         case .topSites:
@@ -113,14 +110,7 @@ struct NimbusFlaggableFeature: HasNimbusSearchBar {
             return true
         }
 
-        let nimbusValue = nimbusLayer.checkNimbusConfigFor(featureID)
-
-        switch featureID {
-        case .pocket:
-            return nimbusValue && PocketProvider.islocaleSupported(Locale.current.identifier)
-        default:
-            return nimbusValue
-        }
+        return nimbusLayer.checkNimbusConfigFor(featureID)
     }
 
     /// Returns whether or not the feature's state was changed by the user. If no

Client/Frontend/Home/HomepageViewModel.swift

@@ -148,9 +148,10 @@ class HomepageViewModel: FeatureFlaggable {
             historyHighlightsDataAdaptor: historyDataAdaptor,
             wallpaperManager: wallpaperManager)
 
-        let pocketDataAdaptor = PocketDataAdaptorImplementation(pocketAPI: PocketProvider())
+        let pocketDataAdaptor = PocketDataAdaptorImplementation(pocketAPI: PocketProvider(prefs: profile.prefs))
         self.pocketViewModel = PocketViewModel(pocketDataAdaptor: pocketDataAdaptor,
                                                theme: theme,
+                                               prefs: profile.prefs,
                                                wallpaperManager: wallpaperManager)
         pocketDataAdaptor.delegate = pocketViewModel
 

Client/Frontend/Home/Pocket/PocketViewModel.swift

@@ -29,14 +29,17 @@ class PocketViewModel {
     private var dataAdaptor: PocketDataAdaptor
     private var pocketStoriesViewModels = [PocketStandardCellViewModel]()
     private var wallpaperManager: WallpaperManager
+    private var prefs: Prefs
 
     init(pocketDataAdaptor: PocketDataAdaptor,
          isZeroSearch: Bool = false,
          theme: Theme,
+         prefs: Prefs,
          wallpaperManager: WallpaperManager) {
         self.dataAdaptor = pocketDataAdaptor
         self.isZeroSearch = isZeroSearch
         self.theme = theme
+        self.prefs = prefs
         self.wallpaperManager = wallpaperManager
     }
 
@@ -119,7 +122,7 @@ class PocketViewModel {
 }
 
 // MARK: HomeViewModelProtocol
-extension PocketViewModel: HomepageViewModelProtocol, FeatureFlaggable {
+extension PocketViewModel: HomepageViewModelProtocol {
     var sectionType: HomepageSectionType {
         return .pocket
     }
@@ -184,10 +187,8 @@ extension PocketViewModel: HomepageViewModelProtocol, FeatureFlaggable {
     }
 
     var isEnabled: Bool {
-        // For Pocket, the user preference check returns a user preference if it exists in
-        // UserDefaults, and, if it does not, it will return a default preference based on
-        // a (nimbus pocket section enabled && Pocket.isLocaleSupported) check
-        return featureFlags.isFeatureEnabled(.pocket, checking: .buildAndUser)
+        let isFeatureEnabled = prefs.boolForKey(PrefsKeys.UserFeatureFlagPrefs.ASPocketStories) ?? true
+        return isFeatureEnabled && PocketProvider.islocaleSupported(Locale.current.identifier)
     }
 
     var hasData: Bool {

Client/Frontend/Settings/HomepageSettings/HomePageSettingViewController.swift

@@ -29,7 +29,7 @@ class HomePageSettingViewController: SettingsTableViewController, FeatureFlaggab
     }
 
     var isPocketSectionEnabled: Bool {
-        return featureFlags.isFeatureEnabled(.pocket, checking: .buildOnly)
+        return PocketProvider.islocaleSupported(Locale.current.identifier)
     }
 
     var isHistoryHighlightsSectionEnabled: Bool {
@@ -133,11 +133,13 @@ class HomePageSettingViewController: SettingsTableViewController, FeatureFlaggab
             PocketAppName.shortName.rawValue)
 
         let pocketSetting = BoolSetting(
-            with: .pocket,
-            titleText: NSAttributedString(string: .Settings.Homepage.CustomizeFirefoxHome.ThoughtProvokingStories),
-            statusText: NSAttributedString(string: pocketStatusText)) { [weak self] _ in
-                self?.tableView.reloadData()
-        }
+            prefs: profile.prefs,
+            theme: themeManager.currentTheme,
+            prefKey: PrefsKeys.UserFeatureFlagPrefs.ASPocketStories,
+            defaultValue: true,
+            titleText: .Settings.Homepage.CustomizeFirefoxHome.ThoughtProvokingStories,
+            statusText: pocketStatusText
+        )
 
         let jumpBackInSetting = BoolSetting(with: .jumpBackIn,
                                             titleText: NSAttributedString(string: .Settings.Homepage.CustomizeFirefoxHome.JumpBackIn))

Client/Nimbus/NimbusFeatureFlagLayer.swift

@@ -23,7 +23,6 @@ final class NimbusFeatureFlagLayer {
             return checkCredentialAutofillCoordinatorRefactorFeature(from: nimbus)
 
         case .jumpBackIn,
-                .pocket,
                 .recentlySaved,
                 .historyHighlights,
                 .topSites:
@@ -117,7 +116,6 @@ final class NimbusFeatureFlagLayer {
         case .jumpBackIn: nimbusID = HomeScreenSection.jumpBackIn
         case .recentlySaved: nimbusID = HomeScreenSection.recentlySaved
         case .historyHighlights: nimbusID = HomeScreenSection.recentExplorations
-        case .pocket: nimbusID = HomeScreenSection.pocket
         default: return false
         }
 
@@ -173,10 +171,6 @@ final class NimbusFeatureFlagLayer {
         return config.configuration.version.rawValue
     }
 
-    private func checkNimbusForPocketSponsoredStoriesFeature(using nimbus: FxNimbus) -> Bool {
-        return nimbus.features.homescreenFeature.value().pocketSponsoredStories
-    }
-
     private func checkReduxIntegrationFeature(from nimbus: FxNimbus) -> Bool {
         let config = nimbus.features.reduxIntegrationFeature.value()
         return config.enabled

Client/Telemetry/TelemetryWrapper.swift

@@ -214,7 +214,7 @@ class TelemetryWrapper: TelemetryWrapperProtocol, FeatureFlaggable {
     func recordFinishedLaunchingPreferenceMetrics(notification: NSNotification) {
         guard let profile = self.profile else { return }
         // Pocket stories visible
-        if let pocketStoriesVisible = profile.prefs.boolForKey(PrefsKeys.FeatureFlags.ASPocketStories) {
+        if let pocketStoriesVisible = profile.prefs.boolForKey(PrefsKeys.UserFeatureFlagPrefs.ASPocketStories) {
             GleanMetrics.FirefoxHomePage.pocketStoriesVisible.set(pocketStoriesVisible)
         } else {
             GleanMetrics.FirefoxHomePage.pocketStoriesVisible.set(true)
@@ -324,7 +324,8 @@ class TelemetryWrapper: TelemetryWrapperProtocol, FeatureFlaggable {
         let isRecentlySavedEnabled = featureFlags.isFeatureEnabled(.recentlySaved, checking: .buildAndUser)
         GleanMetrics.Preferences.recentlySaved.set(isRecentlySavedEnabled)
 
-        let isPocketEnabled = featureFlags.isFeatureEnabled(.pocket, checking: .buildAndUser)
+        let isFeatureEnabled = prefs.boolForKey(PrefsKeys.UserFeatureFlagPrefs.ASPocketStories) ?? true
+        let isPocketEnabled = isFeatureEnabled && PocketProvider.islocaleSupported(Locale.current.identifier)
         GleanMetrics.Preferences.pocket.set(isPocketEnabled)
 
         let startAtHomeOption = prefs.stringForKey(PrefsKeys.UserFeatureFlagPrefs.StartAtHome) ?? StartAtHomeSetting.afterFourHours.rawValue

Providers/Pocket/PocketProvider.swift

@@ -33,6 +33,7 @@ class PocketProvider: PocketStoriesProviding, FeatureFlaggable, URLCaching {
     private static let SupportedLocales = ["en_CA", "en_US", "en_GB", "en_ZA", "de_DE", "de_AT", "de_CH"]
 
     private let pocketGlobalFeed: String
+    private var prefs: Prefs
 
     static let GlobalFeed = "https://getpocket.cdn.mozilla.net/v3/firefox/global-recs"
     static let MoreStoriesURL = {
@@ -45,8 +46,10 @@ class PocketProvider: PocketStoriesProviding, FeatureFlaggable, URLCaching {
     }()
 
     // Allow endPoint to be overriden for testing
-    init(endPoint: String = PocketProvider.GlobalFeed) {
+    init(endPoint: String = PocketProvider.GlobalFeed,
+         prefs: Prefs) {
         self.pocketGlobalFeed = endPoint
+        self.prefs = prefs
     }
 
     var urlCache: URLCache {
@@ -65,7 +68,7 @@ class PocketProvider: PocketStoriesProviding, FeatureFlaggable, URLCaching {
 
     // Fetch items from the global pocket feed
     func fetchStories(items: Int, completion: @escaping (StoryResult) -> Void) {
-        let isFeatureEnabled = featureFlags.isFeatureEnabled(.pocket, checking: .buildOnly)
+        let isFeatureEnabled = prefs.boolForKey(PrefsKeys.UserFeatureFlagPrefs.ASPocketStories) ?? true
         let isCurrentLocaleSupported = PocketProvider.islocaleSupported(Locale.current.identifier)
 
         // Check if we should use mock data

Shared/Prefs.swift

@@ -68,7 +68,6 @@ public struct PrefsKeys {
 
     // For ease of use, please list keys alphabetically.
     public struct FeatureFlags {
-        public static let ASPocketStories = "ASPocketStoriesUserPrefsKey"
         public static let CustomWallpaper = "CustomWallpaperUserPrefsKey"
         public static let FirefoxSuggest = "FirefoxSuggest"
         public static let HistoryHighlightsSection = "HistoryHighlightsSectionUserPrefsKey"
@@ -81,6 +80,7 @@ public struct PrefsKeys {
     }
 
     public struct UserFeatureFlagPrefs {
+        public static let ASPocketStories = "ASPocketStoriesUserPrefsKey"
         public static let SponsoredShortcuts = "SponsoredShortcutsUserPrefsKey"
         public static let StartAtHome = "StartAtHomeUserPrefsKey"
     }

Tests/ClientTests/FeatureFlagManagerTests.swift

@@ -46,8 +46,6 @@ class FeatureFlagManagerTests: XCTestCase, FeatureFlaggable {
         XCTAssertTrue(featureFlags.isFeatureEnabled(.inactiveTabs, checking: .userOnly))
         XCTAssertTrue(featureFlags.isFeatureEnabled(.jumpBackIn, checking: .buildOnly))
         XCTAssertTrue(featureFlags.isFeatureEnabled(.jumpBackIn, checking: .userOnly))
-        XCTAssertTrue(featureFlags.isFeatureEnabled(.pocket, checking: .buildOnly))
-        XCTAssertTrue(featureFlags.isFeatureEnabled(.pocket, checking: .userOnly))
         XCTAssertTrue(featureFlags.isFeatureEnabled(.recentlySaved, checking: .buildOnly))
         XCTAssertTrue(featureFlags.isFeatureEnabled(.recentlySaved, checking: .userOnly))
         XCTAssertTrue(featureFlags.isFeatureEnabled(.reportSiteIssue, checking: .buildOnly))

Tests/ClientTests/Frontend/Home/Pocket/PocketFeedTests.swift

@@ -4,6 +4,7 @@
 
 import UIKit
 import GCDWebServers
+import Shared
 import XCTest
 
 @testable import Client
@@ -41,7 +42,7 @@ class PocketStoriesTests: XCTestCase {
 
     func testPocketStoriesCaching() {
         let expect = expectation(description: "Pocket")
-        let pocketFeed = PocketProvider(endPoint: pocketAPI)
+        let pocketFeed = PocketProvider(endPoint: pocketAPI, prefs: MockProfilePrefs())
         let feedNumber = 11
 
         pocketFeed.fetchStories(items: feedNumber) { result in

Tests/ClientTests/Frontend/Home/Pocket/PocketViewModelTests.swift

@@ -38,7 +38,7 @@ final class PocketViewModelTests: XCTestCase, FeatureFlaggable {
     }
 
     func testFeatureFlagDisablesSection() {
-        featureFlags.set(feature: .pocket, to: false)
+        profile.prefs.setBool(false, forKey: PrefsKeys.UserFeatureFlagPrefs.ASPocketStories)
         let subject = createSubject()
         XCTAssertFalse(subject.isEnabled)
     }
@@ -218,6 +218,7 @@ extension PocketViewModelTests {
         let subject = PocketViewModel(pocketDataAdaptor: adaptor,
                                       isZeroSearch: isZeroSearch,
                                       theme: LightTheme(),
+                                      prefs: profile.prefs,
                                       wallpaperManager: WallpaperManager())
         trackForMemoryLeaks(subject, file: file, line: line)
         return subject

nimbus-features/homescreenFeature.yaml

@@ -13,7 +13,6 @@ features:
             "jump-back-in": true,
             "recently-saved": true,
             "recent-explorations": true,
-            "pocket": true
           }
       pocket-sponsored-stories:
         description: >
@@ -29,7 +28,6 @@ features:
             "jump-back-in": true,
             "recently-saved": true,
             "recent-explorations": true,
-            "pocket": true
           },
           "pocket-sponsored-stories": true
         }
@@ -40,7 +38,6 @@ features:
             "jump-back-in": true,
             "recently-saved": true,
             "recent-explorations": true,
-            "pocket": true
           },
           "pocket-sponsored-stories": false
         }
@@ -57,5 +54,3 @@ enums:
         description: The tabs the user was looking immediately before being interrupted.
       recent-explorations:
         description: The tab groups
-      pocket:
-        description: The pocket section. This should only be available in the US.