Up Next reorder delay (#3836)

Author: bjtitus

PocketCastsTests/PlaybackQueueTests.swift

@@ -34,6 +34,36 @@ final class PlaybackQueueTests: XCTestCase {
                        "Should not include stale episode UUID in replacement list")
     }
 
+    func testRecentUserInteractionReturnsFalseWhenNoPreviousInteraction() {
+        let playbackQueue = PlaybackQueue()
+
+        XCTAssertFalse(playbackQueue.recentUserInteraction(now: Date(timeIntervalSince1970: 15)))
+    }
+
+    func testRecentUserInteractionReturnsTrueWithinGracePeriod() {
+        let playbackQueue = PlaybackQueue()
+        let interactionTime = Date(timeIntervalSince1970: 1_000)
+        playbackQueue.recordUpNextUserInteraction(at: interactionTime)
+
+        XCTAssertTrue(playbackQueue.recentUserInteraction(now: interactionTime.addingTimeInterval(3)))
+    }
+
+    func testRecentUserInteractionReturnsFalseAtGracePeriodBoundary() {
+        let playbackQueue = PlaybackQueue()
+        let interactionTime = Date(timeIntervalSince1970: 1_000)
+        playbackQueue.recordUpNextUserInteraction(at: interactionTime)
+
+        XCTAssertFalse(playbackQueue.recentUserInteraction(now: interactionTime.addingTimeInterval(10)))
+    }
+
+    func testRecentUserInteractionReturnsFalseOutsideGracePeriod() {
+        let playbackQueue = PlaybackQueue()
+        let interactionTime = Date(timeIntervalSince1970: 1_000)
+        playbackQueue.recordUpNextUserInteraction(at: interactionTime)
+
+        XCTAssertFalse(playbackQueue.recentUserInteraction(now: interactionTime.addingTimeInterval(11)))
+    }
+
     override func tearDown() {
         featureFlagMock.reset()
     }

podcasts/PlaybackManager.swift

@@ -154,6 +154,10 @@ class PlaybackManager: ServerPlaybackDelegate {
         player?.futureBufferAvailable() ?? 0
     }
 
+    func recordUpNextUserInteraction() {
+        queue.recordUpNextUserInteraction()
+    }
+
     func load(episode: BaseEpisode, autoPlay: Bool, overrideUpNext: Bool, saveCurrentEpisode: Bool = true, completion: (() -> Void)? = nil) {
         FileLog.shared.addMessage("Loading \(episode.displayableTitle()) with UUID \(episode.uuid) autoPlay \(autoPlay) overrideUpNext: \(overrideUpNext)")
 

podcasts/PlaybackQueue.swift

@@ -8,7 +8,28 @@ class PlaybackQueue: NSObject {
     private var topEpisode: BaseEpisode?
 
     private let syncTimerDelay: TimeInterval = 5
+    private let interactionGracePeriod: TimeInterval = 10
     private var syncTimer: Timer?
+    private var lastUserInteractionTime: Date?
+
+    // MARK: - User Interaction Tracking
+
+    func recordUpNextUserInteraction(at date: Date = Date()) {
+        lastUserInteractionTime = date
+    }
+
+    func recentUserInteraction(now: Date = Date()) -> Bool {
+        remainingInteractionDelay(now: now) != nil
+    }
+
+    private func remainingInteractionDelay(now: Date = Date()) -> TimeInterval? {
+        guard let lastUserInteractionTime else { return nil }
+
+        let elapsed = now.timeIntervalSince(lastUserInteractionTime)
+        let remaining = interactionGracePeriod - elapsed
+
+        return remaining > 0 ? remaining : nil
+    }
 
     // MARK: - Editing
 
@@ -400,27 +421,40 @@ class PlaybackQueue: NSObject {
 
     // MARK: - Sync Timer
 
-    private func startSyncTimer() {
+    private func cancelSyncTimer() {
+        syncTimer?.invalidate()
+        syncTimer = nil
+    }
+
+    private func startSyncTimer(after delay: TimeInterval? = nil) {
         cancelSyncTimer()
+        scheduleSyncTimer(after: delay ?? syncTimerDelay)
+    }
+
+    private func scheduleSyncTimer(after delay: TimeInterval) {
+        let scheduleTimer: () -> Void = { [weak self] in
+            guard let self else { return }
+
+            self.syncTimer = Timer.scheduledTimer(timeInterval: delay, target: self, selector: #selector(self.syncTimerFired), userInfo: nil, repeats: false)
+        }
 
         // schedule the timer on a thread that has a run loop, the main thread being a good option
         if Thread.isMainThread {
-            syncTimer = Timer.scheduledTimer(timeInterval: syncTimerDelay, target: self, selector: #selector(syncTimerFired), userInfo: nil, repeats: false)
+            scheduleTimer()
         } else {
-            DispatchQueue.main.sync { [weak self] () in
-                guard let self else { return }
-
-                self.syncTimer = Timer.scheduledTimer(timeInterval: self.syncTimerDelay, target: self, selector: #selector(self.syncTimerFired), userInfo: nil, repeats: false)
+            DispatchQueue.main.sync {
+                scheduleTimer()
             }
         }
     }
 
-    private func cancelSyncTimer() {
-        syncTimer?.invalidate()
-        syncTimer = nil
-    }
-
     @objc private func syncTimerFired() {
+        if let remainingDelay = remainingInteractionDelay() {
+            FileLog.shared.addMessage("PlaybackQueue: Delaying Up Next sync for \(Int(remainingDelay.rounded(.up))) seconds due to recent interaction")
+            startSyncTimer(after: remainingDelay)
+            return
+        }
+
         RefreshManager.shared.syncUpNext()
     }
 }

podcasts/UpNextViewController+Table.swift

@@ -212,7 +212,9 @@ extension UpNextViewController: UITableViewDelegate, UITableViewDataSource {
     func tableView(_ tableView: UITableView, targetIndexPathForMoveFromRowAt sourceIndexPath: IndexPath, toProposedIndexPath proposedDestinationIndexPath: IndexPath) -> IndexPath {
         let toSection = tableData[proposedDestinationIndexPath.section]
 
-        if toSection == .upNextSection { return proposedDestinationIndexPath }
+        if toSection == .upNextSection {
+            return proposedDestinationIndexPath
+        }
 
         return IndexPath(row: 0, section: sourceIndexPath.section)
     }

podcasts/UpNextViewController.swift

@@ -401,6 +401,7 @@ class UpNextViewController: UIViewController, UIGestureRecognizerDelegate {
 extension UpNextViewController {
     @objc func reorderingDidBegin() {
         isReorderInProgress = true
+        PlaybackManager.shared.recordUpNextUserInteraction()
     }
 
     @objc func reorderingDidEnd() {