Add basic error reporting (#107)

SRGSSR · Oct 17, 2022 · f366d3c · f366d3c
1 parent 69b93ea
commit f366d3c
Show file tree

Hide file tree

Showing 42 changed files with 969 additions and 77 deletions.
diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Analytics.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Analytics.xcscheme
@@ -26,7 +26,8 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      language = "en">
       <Testables>
          <TestableReference
             skipped = "NO"

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Circumspect.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Circumspect.xcscheme
@@ -27,6 +27,7 @@
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       shouldUseLaunchSchemeArgsEnv = "YES"
+      language = "en"
       codeCoverageEnabled = "YES">
       <Testables>
          <TestableReference

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Core.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Core.xcscheme
@@ -27,6 +27,7 @@
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       shouldUseLaunchSchemeArgsEnv = "YES"
+      language = "en"
       codeCoverageEnabled = "YES">
       <Testables>
          <TestableReference

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/CoreBusiness.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/CoreBusiness.xcscheme
@@ -27,6 +27,7 @@
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       shouldUseLaunchSchemeArgsEnv = "YES"
+      language = "en"
       codeCoverageEnabled = "YES">
       <Testables>
          <TestableReference

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Diagnostics.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Diagnostics.xcscheme
@@ -27,6 +27,7 @@
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       shouldUseLaunchSchemeArgsEnv = "YES"
+      language = "en"
       codeCoverageEnabled = "YES">
       <Testables>
          <TestableReference

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Pillarbox-Package.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Pillarbox-Package.xcscheme
@@ -195,6 +195,7 @@
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       shouldUseLaunchSchemeArgsEnv = "YES"
+      language = "en"
       codeCoverageEnabled = "YES">
       <Testables>
          <TestableReference

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/Player.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/Player.xcscheme
@@ -27,6 +27,7 @@
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       shouldUseLaunchSchemeArgsEnv = "YES"
+      language = "en"
       codeCoverageEnabled = "YES">
       <Testables>
          <TestableReference

diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/UserInterface.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/UserInterface.xcscheme
@@ -27,6 +27,7 @@
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       shouldUseLaunchSchemeArgsEnv = "YES"
+      language = "en"
       codeCoverageEnabled = "YES">
       <Testables>
          <TestableReference

diff --git a/Demo/Sources/ExamplesView.swift b/Demo/Sources/ExamplesView.swift
@@ -101,13 +101,18 @@ private struct Example: Identifiable {
             media: MediaURL.appleAdvanced_16_9_HEVC_h264_HLS
         ),
         Example(
-            title: "Unknown media",
-            description: "This media does not exist",
+            title: "Expired content",
+            description: "This content is not available anymore",
+            media: MediaURN.expired
+        ),
+        Example(
+            title: "Unknown content",
+            description: "This content does not exist",
             media: MediaURN.unknown
         ),
         Example(
             title: "Empty",
-            description: "No media is provided",
+            description: "No content is provided",
             media: .empty
         )
     ]

diff --git a/Demo/Sources/Media.swift b/Demo/Sources/Media.swift
@@ -45,6 +45,7 @@ enum MediaURN {
     static let dvrAudio = Media.urn("urn:rts:audio:3262363")
     static let onDemandAudio = Media.urn("urn:rsi:audio:8833144")
 
+    static let expired = Media.urn("urn:rts:video:13382911")
     static let unknown = Media.urn("urn:srf:video:unknown")
 }
 

diff --git a/Demo/Sources/PlayerView.swift b/Demo/Sources/PlayerView.swift
@@ -11,6 +11,32 @@ import UserInterface
 
 // MARK: View
 
+private struct ContentView: View {
+    @ObservedObject var player: Player
+    @State private var isUserInterfaceHidden = false
+
+    var body: some View {
+        ZStack {
+            Group {
+                VideoView(player: player)
+                ControlsView(player: player, isUserInterfaceHidden: isUserInterfaceHidden)
+            }
+            .onTapGesture {
+                isUserInterfaceHidden.toggle()
+            }
+            .ignoresSafeArea()
+#if os(iOS)
+            Slider(player: player)
+                .tint(.white)
+                .opacity(isUserInterfaceHidden ? 0 : 1)
+                .padding()
+                .frame(maxWidth: .infinity, maxHeight: .infinity, alignment: .bottom)
+#endif
+        }
+        .animation(.easeInOut(duration: 0.2), value: isUserInterfaceHidden)
+    }
+}
+
 private struct ControlsView: View {
     @ObservedObject var player: Player
     let isUserInterfaceHidden: Bool
@@ -34,6 +60,18 @@ private struct ControlsView: View {
     }
 }
 
+private struct MessageView: View {
+    let message: String
+
+    var body: some View {
+        Text(message)
+            .multilineTextAlignment(.center)
+            .foregroundColor(.white)
+            .padding()
+            .frame(maxWidth: .infinity, maxHeight: .infinity)
+    }
+}
+
 private struct NextButton: View {
     @ObservedObject var player: Player
 
@@ -98,28 +136,22 @@ struct PlayerView: View {
     let medias: [Media]
 
     @StateObject private var player = Player()
-    @State private var isUserInterfaceHidden = false
 
     var body: some View {
         ZStack {
-            Group {
-                VideoView(player: player)
-                ControlsView(player: player, isUserInterfaceHidden: isUserInterfaceHidden)
+            if !player.items.isEmpty {
+                switch player.playbackState {
+                case let .failed(error: error):
+                    MessageView(message: error.localizedDescription)
+                default:
+                    ContentView(player: player)
+                }
             }
-            .onTapGesture {
-                isUserInterfaceHidden.toggle()
+            else {
+                MessageView(message: "No content")
             }
-            .ignoresSafeArea()
-#if os(iOS)
-            Slider(player: player)
-                .tint(.white)
-                .opacity(isUserInterfaceHidden ? 0 : 1)
-                .padding()
-                .frame(maxWidth: .infinity, maxHeight: .infinity, alignment: .bottom)
-#endif
         }
         .background(.black)
-        .animation(.easeInOut(duration: 0.2), value: isUserInterfaceHidden)
         .onAppear {
             play()
         }

diff --git a/Sources/Circumspect/Expectations.swift b/Sources/Circumspect/Expectations.swift
@@ -573,10 +573,11 @@ public extension XCTestCase {
         let cancellable = publisher.sink { completion in
             switch completion {
             case .finished:
-                expectation.fulfill()
-            case .failure:
                 break
+            case .failure:
+                XCTFail("The publisher incorrectly failed", file: file, line: line)
             }
+            expectation.fulfill()
         } receiveValue: { _ in
         }
         defer {
@@ -592,6 +593,7 @@ public extension XCTestCase {
 
     /// Expect a publisher to complete with a failure.
     func expectFailure<P: Publisher>(
+        _ error: Error? = nil,
         from publisher: P,
         timeout: TimeInterval = 10,
         file: StaticString = #file,
@@ -602,10 +604,13 @@ public extension XCTestCase {
         let cancellable = publisher.sink { completion in
             switch completion {
             case .finished:
-                break
-            case .failure:
-                expectation.fulfill()
+                XCTFail("The publisher incorrectly succeeded", file: file, line: line)
+            case let .failure(actualError):
+                if let error {
+                    XCTAssertEqual(error as NSError, actualError as NSError, file: file, line: line)
+                }
             }
+            expectation.fulfill()
         } receiveValue: { _ in
         }
         defer {

diff --git a/Sources/CoreBusiness/AssetResourceLoaderDelegate.swift b/Sources/CoreBusiness/AssetResourceLoaderDelegate.swift
@@ -35,14 +35,7 @@ final class AssetResourceLoaderDelegate: NSObject, AVAssetResourceLoaderDelegate
 
     private func processLoadingRequest(_ loadingRequest: AVAssetResourceLoadingRequest) -> Bool {
         guard let url = loadingRequest.request.url, let urn = URLCoding.decodeUrn(from: url) else { return false }
-        cancellable = DataProvider(environment: environment).mediaComposition(forUrn: urn)
-            .map(\.mainChapter.recommendedResource)
-            .tryMap { resource in
-                guard let resource else {
-                    throw ResourceLoadingError.notFound
-                }
-                return resource
-            }
+        cancellable = DataProvider(environment: environment).recommendedPlayableResource(forUrn: urn)
             .sink(receiveCompletion: { completion in
                 switch completion {
                 case .finished:
@@ -62,6 +55,6 @@ private extension AVAssetResourceLoadingRequest {
         var redirectRequest = request
         redirectRequest.url = url
         redirect = redirectRequest
-        response = HTTPURLResponse(url: url, statusCode: 303, httpVersion: nil, headerFields: nil)
+        response = HTTPURLResponse(url: url, statusCode: 302, httpVersion: nil, headerFields: nil)
     }
 }
diff --git a/Sources/CoreBusiness/BlockingReason.swift b/Sources/CoreBusiness/BlockingReason.swift
@@ -0,0 +1,63 @@
+//
+//  Copyright (c) SRG SSR. All rights reserved.
+//
+//  License information is available from the LICENSE file.
+//
+
+import Foundation
+
+enum BlockingReason: String, Decodable {
+    case ageRating12 = "AGERATING12"
+    case ageRating18 = "AGERATING18"
+    case commercial = "COMMERCIAL"
+    case endDate = "ENDDATE"
+    case geoblocked = "GEOBLOCK"
+    case legal = "LEGAL"
+    case startDate = "STARTDATE"
+    case unknown = "UNKNOWN"
+
+    public var description: String {
+        switch self {
+        case .ageRating12:
+            return NSLocalizedString(
+                "To protect children this content is only available between 8PM and 6AM.",
+                comment: "Blocking reason description message"
+            )
+        case .ageRating18:
+            return NSLocalizedString(
+                "To protect children this content is only available between 10PM and 5AM.",
+                comment: "Blocking reason description message"
+            )
+        case .commercial:
+            return NSLocalizedString(
+                "This commercial content is not available.",
+                comment: "Blocking reason description message"
+            )
+        case .endDate:
+            return NSLocalizedString(
+                "This content is not available anymore.",
+                comment: "Blocking reason description message"
+            )
+        case .geoblocked:
+            return NSLocalizedString(
+                "This content is not available outside Switzerland.",
+                comment: "Blocking reason description message"
+            )
+        case .legal:
+            return NSLocalizedString(
+                "This content is not available due to legal restrictions.",
+                comment: "Blocking reason description message"
+            )
+        case .startDate:
+            return NSLocalizedString(
+                "This content is not available yet. Please try again later.",
+                comment: "Blocking reason description message"
+            )
+        case .unknown:
+            return NSLocalizedString(
+                "This content is not available.",
+                comment: "Blocking reason description message"
+            )
+        }
+    }
+}
diff --git a/Sources/CoreBusiness/Chapter.swift b/Sources/CoreBusiness/Chapter.swift
@@ -8,14 +8,37 @@ import Foundation
 
 struct Chapter: Decodable {
     enum CodingKeys: String, CodingKey {
-        case urn
-        case title
+        case blockingReason = "blockReason"
+        case endDate = "validTo"
         case resources = "resourceList"
+        case startDate = "validFrom"
+        case title
+        case urn
     }
 
+    private let blockingReason: BlockingReason?
+
     let urn: String
     let title: String
     let resources: [Resource]
+
+    let startDate: Date?
+    let endDate: Date?
+
+    func blockingReason(at date: Date = Date()) -> BlockingReason? {
+        if blockingReason != .none {
+            return blockingReason
+        }
+        else if let startDate, date < startDate {
+            return .startDate
+        }
+        else if let endDate, date > endDate {
+            return .endDate
+        }
+        else {
+            return .none
+        }
+    }
 }
 
 extension Chapter {

diff --git a/Sources/CoreBusiness/CoreBusiness.swift b/Sources/CoreBusiness/CoreBusiness.swift