fix: invert API for the smart cache (#32)

muxinc · May 8, 2024 · 5ece69d · 5ece69d
1 parent 5c371f5
commit 5ece69d
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 24 deletions.
diff --git a/Sources/MuxPlayerSwift/PublicAPI/Extensions/AVPlayerItem+Mux.swift b/Sources/MuxPlayerSwift/PublicAPI/Extensions/AVPlayerItem+Mux.swift
@@ -77,11 +77,9 @@ fileprivate func makePlaybackURL(
 
     }
 
-    let isReverseProxyEnabled = !playbackOptions.disableCaching
+    let isReverseProxyEnabled = playbackOptions.enableSmartCache
 
     if isReverseProxyEnabled {
-        var nonProxiedURLComponents = components
-
         // TODO: clean up
         components.queryItems = (components.queryItems ?? []) + [
             URLQueryItem(

diff --git a/Sources/MuxPlayerSwift/PublicAPI/Options/PlaybackOptions.swift b/Sources/MuxPlayerSwift/PublicAPI/Options/PlaybackOptions.swift
@@ -134,8 +134,7 @@ public struct PlaybackOptions {
 
     var customDomain: String?
 
-    // TODO: workshop API spelling
-    var disableCaching: Bool = false
+    var enableSmartCache: Bool = false
 }
 
 extension PlaybackOptions {
@@ -149,10 +148,13 @@ extension PlaybackOptions {
     ///   video the player will download
     ///   - renditionOrder: ordering of available renditions
     ///   in the manifest
+    ///   - enableSmartCache: enable smart cache to store
+    ///   on-demand HTTP live stream on disk
     public init(
         maximumResolutionTier: MaxResolutionTier = .default,
         minimumResolutionTier: MinResolutionTier = .default,
-        renditionOrder: RenditionOrder = .default
+        renditionOrder: RenditionOrder = .default,
+        enableSmartCache: Bool = false
     ) {
         self.playbackPolicy = .public(
             PublicPlaybackOptions(
@@ -162,6 +164,7 @@ extension PlaybackOptions {
                 useRedundantStreams: true
             )
         )
+        self.enableSmartCache = enableSmartCache
     }
 
 
@@ -182,11 +185,14 @@ extension PlaybackOptions {
     ///   video the player will download
     ///   - renditionOrder: ordering of available renditions
     ///   in the manifest
+    ///   - enableSmartCache: enable smart cache to store
+    ///   on-demand HTTP live stream on disk
     public init(
         customDomain: String,
         maximumResolutionTier: MaxResolutionTier = .default,
         minimumResolutionTier: MinResolutionTier = .default,
-        renditionOrder: RenditionOrder = .default
+        renditionOrder: RenditionOrder = .default,
+        enableSmartCache: Bool = false
     ) {
         self.customDomain = customDomain
         self.playbackPolicy = .public(
@@ -197,6 +203,7 @@ extension PlaybackOptions {
                 useRedundantStreams: true
             )
         )
+        self.enableSmartCache = enableSmartCache
     }
 
     /// Initializes playback options with a

diff --git a/Tests/MuxPlayerSwift/PlaybackURLTests.swift b/Tests/MuxPlayerSwift/PlaybackURLTests.swift
@@ -10,8 +10,7 @@ import XCTest
 final class PlaybackURLTests: XCTestCase {
     func testPlaybackURL() throws {
 
-        var playbackOptions = PlaybackOptions()
-        playbackOptions.disableCaching = true
+        let playbackOptions = PlaybackOptions()
 
         let playerItem = AVPlayerItem(
             playbackID: "abc",
@@ -43,10 +42,9 @@ final class PlaybackURLTests: XCTestCase {
         ]
 
         for tier in tiers {
-            var playbackOptions = PlaybackOptions(
+            let playbackOptions = PlaybackOptions(
                 maximumResolutionTier: tier
             )
-            playbackOptions.disableCaching = true
 
             let playerItem = AVPlayerItem(
                 playbackID: "abc",
@@ -90,10 +88,9 @@ final class PlaybackURLTests: XCTestCase {
         ]
 
         for tier in tiers {
-            var playbackOptions = PlaybackOptions(
+            let playbackOptions = PlaybackOptions(
                 minimumResolutionTier: tier
             )
-            playbackOptions.disableCaching = true
 
             let playerItem = AVPlayerItem(
                 playbackID: "abc",
@@ -122,10 +119,9 @@ final class PlaybackURLTests: XCTestCase {
         ]
 
         for tier in tiers {
-            var playbackOptions = PlaybackOptions(
+            let playbackOptions = PlaybackOptions(
                 renditionOrder: tier
             )
-            playbackOptions.disableCaching = true
 
             let playerItem = AVPlayerItem(
                 playbackID: "abc",
@@ -140,11 +136,10 @@ final class PlaybackURLTests: XCTestCase {
     }
 
     func testMultiplePlaybackOptionParams() throws {
-        var playbackOptions = PlaybackOptions(
+        let playbackOptions = PlaybackOptions(
             maximumResolutionTier: MaxResolutionTier.upTo2160p,
             minimumResolutionTier: MinResolutionTier.atLeast1440p
         )
-        playbackOptions.disableCaching = true
 
         let playerItem = AVPlayerItem(
             playbackID: "abc",
@@ -159,10 +154,9 @@ final class PlaybackURLTests: XCTestCase {
 
     func testCustomDomainPlaybackURL() throws {
 
-        var playbackOptions = PlaybackOptions(
+        let playbackOptions = PlaybackOptions(
             customDomain: "play.example.com"
         )
-        playbackOptions.disableCaching = true
 
         let playerItem = AVPlayerItem(
             playbackID: "abc",
@@ -177,10 +171,9 @@ final class PlaybackURLTests: XCTestCase {
 
     func testSignedPlaybackURL() throws {
 
-        var playbackOptions = PlaybackOptions(
+        let playbackOptions = PlaybackOptions(
             playbackToken: "WhoooopsNotAnActualToken"
         )
-        playbackOptions.disableCaching = true
 
         let playerItem = AVPlayerItem(
             playbackID: "abc",
@@ -195,11 +188,10 @@ final class PlaybackURLTests: XCTestCase {
 
     func testCustomDomainSignedPlaybackURL() throws {
 
-        var playbackOptions = PlaybackOptions(
+        let playbackOptions = PlaybackOptions(
             customDomain: "play.example.com",
             playbackToken: "WhoooopsNotAnActualToken"
         )
-        playbackOptions.disableCaching = true
 
         let playerItem = AVPlayerItem(
             playbackID: "abc",
@@ -420,7 +412,8 @@ final class PlaybackURLTests: XCTestCase {
 
     func testReverseProxyTargetingURL() throws {
         let playbackOptions = PlaybackOptions(
-            customDomain: "play.example.com"
+            customDomain: "play.example.com",
+            enableSmartCache: true
         )
 
         let playerItem = AVPlayerItem(