|
| 1 | +// |
| 2 | +// PlayolaNetworkLoggingSessionTests.swift |
| 3 | +// PlayolaPlayer |
| 4 | +// |
| 5 | +// Created by Brian D Keane on 6/4/26. |
| 6 | +// |
| 7 | +import Foundation |
| 8 | +import PlayolaCore |
| 9 | +import Testing |
| 10 | +import os |
| 11 | + |
| 12 | +@testable import PlayolaPlayer |
| 13 | + |
| 14 | +/// Records events emitted to `PlayolaNetworkLogger.handler` in a thread-safe way. |
| 15 | +private final class EventRecorder: Sendable { |
| 16 | + private let storage = OSAllocatedUnfairLock<[PlayolaNetworkLogEvent]>(initialState: []) |
| 17 | + func record(_ event: PlayolaNetworkLogEvent) { storage.withLock { $0.append(event) } } |
| 18 | + var events: [PlayolaNetworkLogEvent] { storage.withLock { $0 } } |
| 19 | +} |
| 20 | + |
| 21 | +/// A `DateProviderProtocol` that returns queued dates in order, falling back to |
| 22 | +/// `Date()` once exhausted. Lets tests assert an exact `durationMS`. |
| 23 | +private final class QueueDateProvider: Sendable, DateProviderProtocol { |
| 24 | + private let dates: OSAllocatedUnfairLock<[Date]> |
| 25 | + init(_ dates: [Date]) { self.dates = OSAllocatedUnfairLock(initialState: dates) } |
| 26 | + func now() -> Date { |
| 27 | + dates.withLock { $0.isEmpty ? Date() : $0.removeFirst() } |
| 28 | + } |
| 29 | +} |
| 30 | + |
| 31 | +/// A session that always throws, to verify error pass-through. |
| 32 | +private struct ThrowingURLSession: URLSessionProtocol { |
| 33 | + let error: any Error & Sendable |
| 34 | + func data(for request: URLRequest) async throws -> (Data, URLResponse) { throw error } |
| 35 | +} |
| 36 | + |
| 37 | +private struct StubError: Error, Equatable { |
| 38 | + let id: Int |
| 39 | +} |
| 40 | + |
| 41 | +@Suite("PlayolaNetworkLoggingSession", .serialized) |
| 42 | +struct PlayolaNetworkLoggingSessionTests { |
| 43 | + |
| 44 | + @Test("Emits an event on success with correct method, url, status, and duration") |
| 45 | + func emitsEventOnSuccess() async throws { |
| 46 | + let recorder = EventRecorder() |
| 47 | + PlayolaNetworkLogger.handler = { recorder.record($0) } |
| 48 | + defer { PlayolaNetworkLogger.handler = nil } |
| 49 | + |
| 50 | + let url = URL(string: "https://test.com/v1/listeningSessions")! |
| 51 | + let requestBody = Data("{\"deviceId\":\"abc\"}".utf8) |
| 52 | + let responseBody = Data("{\"ok\":true}".utf8) |
| 53 | + |
| 54 | + var request = URLRequest(url: url) |
| 55 | + request.httpMethod = "POST" |
| 56 | + request.httpBody = requestBody |
| 57 | + request.addValue("Bearer secret-token", forHTTPHeaderField: "Authorization") |
| 58 | + |
| 59 | + let base = MockURLSession() |
| 60 | + base.addResponse(data: responseBody, statusCode: 200, url: url) |
| 61 | + |
| 62 | + let start = Date(timeIntervalSince1970: 1000) |
| 63 | + let session = PlayolaNetworkLoggingSession( |
| 64 | + wrapping: base, |
| 65 | + dateProvider: QueueDateProvider([start, start.addingTimeInterval(0.25)])) |
| 66 | + |
| 67 | + _ = try await session.data(for: request) |
| 68 | + |
| 69 | + let events = recorder.events |
| 70 | + #expect(events.count == 1) |
| 71 | + let event = try #require(events.first) |
| 72 | + #expect(event.method == "POST") |
| 73 | + #expect(event.url == url) |
| 74 | + #expect(event.statusCode == 200) |
| 75 | + #expect(event.durationMS == 250) |
| 76 | + #expect(event.timestamp == start) |
| 77 | + #expect(event.requestBody == requestBody) |
| 78 | + #expect(event.responseBody == responseBody) |
| 79 | + #expect(event.requestHeaders["Authorization"] == "Bearer secret-token") |
| 80 | + #expect(event.errorDescription == nil) |
| 81 | + } |
| 82 | + |
| 83 | + @Test("Transparently passes through the wrapped session's data and response") |
| 84 | + func passesThroughData() async throws { |
| 85 | + PlayolaNetworkLogger.handler = nil |
| 86 | + |
| 87 | + let url = URL(string: "https://test.com/v1/stations/123/schedule")! |
| 88 | + let responseBody = Data("schedule-json".utf8) |
| 89 | + |
| 90 | + let base = MockURLSession() |
| 91 | + base.addResponse(data: responseBody, statusCode: 201, url: url) |
| 92 | + |
| 93 | + let session = PlayolaNetworkLoggingSession(wrapping: base) |
| 94 | + let (data, response) = try await session.data(for: URLRequest(url: url)) |
| 95 | + |
| 96 | + #expect(data == responseBody) |
| 97 | + #expect((response as? HTTPURLResponse)?.statusCode == 201) |
| 98 | + #expect(base.requestCallCount == 1) |
| 99 | + } |
| 100 | + |
| 101 | + @Test("Emits an event on a thrown error and rethrows the original error unchanged") |
| 102 | + func emitsEventOnErrorAndRethrows() async throws { |
| 103 | + let recorder = EventRecorder() |
| 104 | + PlayolaNetworkLogger.handler = { recorder.record($0) } |
| 105 | + defer { PlayolaNetworkLogger.handler = nil } |
| 106 | + |
| 107 | + let url = URL(string: "https://test.com/v1/listeningSessions")! |
| 108 | + let thrownError = StubError(id: 42) |
| 109 | + let session = PlayolaNetworkLoggingSession(wrapping: ThrowingURLSession(error: thrownError)) |
| 110 | + |
| 111 | + var caught: Error? |
| 112 | + do { |
| 113 | + _ = try await session.data(for: URLRequest(url: url)) |
| 114 | + } catch { |
| 115 | + caught = error |
| 116 | + } |
| 117 | + |
| 118 | + #expect(caught as? StubError == thrownError) |
| 119 | + |
| 120 | + let events = recorder.events |
| 121 | + #expect(events.count == 1) |
| 122 | + let event = try #require(events.first) |
| 123 | + #expect(event.statusCode == nil) |
| 124 | + #expect(event.responseBody == nil) |
| 125 | + #expect(event.errorDescription != nil) |
| 126 | + #expect(event.url == url) |
| 127 | + } |
| 128 | + |
| 129 | + @Test("Does not emit when no handler is set") |
| 130 | + func doesNotEmitWithoutHandler() async throws { |
| 131 | + PlayolaNetworkLogger.handler = nil |
| 132 | + |
| 133 | + let url = URL(string: "https://test.com")! |
| 134 | + let base = MockURLSession() |
| 135 | + base.addResponse(data: Data(), statusCode: 200, url: url) |
| 136 | + |
| 137 | + let session = PlayolaNetworkLoggingSession(wrapping: base) |
| 138 | + _ = try await session.data(for: URLRequest(url: url)) |
| 139 | + |
| 140 | + #expect(base.requestCallCount == 1) |
| 141 | + } |
| 142 | +} |
0 commit comments