Repository Public
1// SP Notes Core2// File: Tests/SPNotesAPITests/RetryTests.swift3// Description: Retry with backoff of idempotent requests (2.0): which requests are retried, which failures, the4// delays, Retry-After, the stable idempotency key, and the unchanged single attempt of everything else.5//6// Author: Simon-Pierre Boucher7// Contact: contact@spboucher.ai8import Foundation9import XCTest10@testable import SPNotesAPI1112/// Counts calls and plays replies in order (the last one repeats).13private final class Script: @unchecked Sendable {14 private let lock = NSLock()15 private var replies: [StubReply]16 private var waits: [TimeInterval] = []17 init(_ replies: [StubReply]) { self.replies = replies }18 func next() -> StubReply { lock.withLock { replies.count > 1 ? replies.removeFirst() : replies[0] } }19 func slept(_ seconds: TimeInterval) { lock.withLock { waits.append(seconds) } }20 var delays: [TimeInterval] { lock.withLock { waits } }21}2223final class RetryTests: XCTestCase {24 private func client(_ script: Script) async -> HTTPClient {25 StubServer.shared.reset { _ in script.next() }26 let (client, _) = TestEnv.client()27 await client.setRetrySleeper { script.slept($0) }28 return client29 }3031 func testPolicyDelays() {32 let p = RetryPolicy(maxAttempts: 5, baseDelay: 0.5, multiplier: 2, maxDelay: 3, jitter: 0)33 XCTAssertEqual(p.delay(retry: 1), 0.5)34 XCTAssertEqual(p.delay(retry: 2), 1)35 XCTAssertEqual(p.delay(retry: 3), 2)36 XCTAssertEqual(p.delay(retry: 4), 3) // capped37 XCTAssertEqual(p.delay(retry: 60), 3) // no overflow38 XCTAssertEqual(p.delay(retry: 1, retryAfter: 2), 2)39 XCTAssertEqual(p.delay(retry: 1, retryAfter: 100), 3) // Retry-After is capped too40 XCTAssertEqual(p.delay(retry: 3, retryAfter: 0.1), 2) // a shorter Retry-After does not shorten the backoff41 let jittered = RetryPolicy(maxAttempts: 3, baseDelay: 1, multiplier: 2, maxDelay: 10, jitter: 0.5)42 XCTAssertEqual(jittered.delay(retry: 1, random: 0), 1)43 XCTAssertEqual(jittered.delay(retry: 1, random: 1), 0.5)44 XCTAssertEqual(RetryPolicy(maxAttempts: 0, baseDelay: -1, multiplier: 0, maxDelay: -1, jitter: 7), RetryPolicy(maxAttempts: 1, baseDelay: 0, multiplier: 1, maxDelay: 0, jitter: 1))45 XCTAssertEqual(RetryPolicy.none.maxAttempts, 1)46 XCTAssertEqual(RetryPolicy.standard.maxAttempts, 3)47 }4849 func testSafeToRetryRules() {50 XCTAssertTrue(HTTPRequest.get("/api/x").isSafeToRetry)51 XCTAssertFalse(HTTPRequest(method: .post, path: "/api/x").isSafeToRetry)52 XCTAssertFalse(HTTPRequest(method: .patch, path: "/api/x").isSafeToRetry)53 XCTAssertFalse(HTTPRequest(method: .delete, path: "/api/x").isSafeToRetry)54 XCTAssertTrue(HTTPRequest(method: .post, path: "/api/x", idempotencyKey: "abcdefgh").isSafeToRetry)55 XCTAssertFalse(HTTPRequest(method: .post, path: "/api/auth/login/verify", idempotencyKey: "abcdefgh", ceremony: .complete("login")).isSafeToRetry)56 XCTAssertFalse(HTTPRequest(method: .post, path: "/api/auth/login/options", ceremony: .begin("login")).retrying().isSafeToRetry)57 let keyed = HTTPRequest(method: .post, path: "/api/x").retrying()58 XCTAssertNotNil(keyed.idempotencyKey?.range(of: "^[0-9a-f]{32}$", options: .regularExpression))59 XCTAssertTrue(keyed.isSafeToRetry)60 XCTAssertEqual(HTTPRequest(method: .post, path: "/api/x", idempotencyKey: "keepmekeepme").retrying().idempotencyKey, "keepmekeepme")61 XCTAssertNil(HTTPRequest.get("/api/x").retrying().idempotencyKey)62 let unkeyed = HTTPRequest(method: .post, path: "/api/x").retrying(addingKey: false)63 XCTAssertNil(unkeyed.idempotencyKey)64 XCTAssertFalse(unkeyed.isSafeToRetry)65 }6667 func testDefaultIsASingleAttempt() async throws {68 let script = Script([.json("{}", status: 503)])69 let client = await client(script)70 let error = await captureAPIError { try await client.send(.get("/api/health")) }71 XCTAssertEqual(error?.status, 503)72 XCTAssertEqual(StubServer.shared.requests.count, 1)73 XCTAssertTrue(script.delays.isEmpty)74 }7576 func testGetIsRetriedUntilItSucceeds() async throws {77 let script = Script([.json("{}", status: 503), .failure(.networkConnectionLost), .json("{\"ok\":true}")])78 let client = await client(script)79 let policy = RetryPolicy(maxAttempts: 4, baseDelay: 0.5, multiplier: 2, maxDelay: 8, jitter: 0)80 let response = try await client.send(HTTPRequest.get("/api/health").retrying(policy))81 XCTAssertEqual(response.status, 200)82 XCTAssertEqual(StubServer.shared.requests.count, 3)83 XCTAssertEqual(script.delays, [0.5, 1])84 // Each attempt has its own request id.85 XCTAssertEqual(Set(StubServer.shared.requests.compactMap { $0.header("x-request-id") }).count, 3)86 }8788 func testGivesUpAfterMaxAttemptsWithTheLastError() async throws {89 let script = Script([.json("{\"error\":\"x\"}", status: 502)])90 let client = await client(script)91 let error = await captureAPIError { try await client.send(HTTPRequest.get("/api/health").retrying(RetryPolicy(maxAttempts: 3, jitter: 0))) }92 XCTAssertEqual(error?.status, 502)93 XCTAssertEqual(StubServer.shared.requests.count, 3)94 XCTAssertEqual(script.delays.count, 2)95 }9697 func testNonRetryableFailuresAreNotRetried() async throws {98 for status in [400, 403, 404, 409, 422] {99 let script = Script([.json("{\"error\":\"x\"}", status: status)])100 let client = await client(script)101 _ = await captureAPIError { try await client.send(HTTPRequest.get("/api/x").retrying()) }102 XCTAssertEqual(StubServer.shared.requests.count, 1, "status \(status)")103 }104 // 401 ends the session and is never retried.105 let script = Script([.json("{\"error\":\"x\"}", status: 401)])106 let client = await client(script)107 let error = await captureAPIError { try await client.send(HTTPRequest.get("/api/x").retrying()) }108 XCTAssertEqual(error?.isUnauthenticated, true)109 XCTAssertEqual(StubServer.shared.requests.count, 1)110 // 503 not_configured needs an action on the server.111 let script2 = Script([.json("{\"error\":\"x\",\"code\":\"not_configured\"}", status: 503)])112 let client2 = await self.client(script2)113 _ = await captureAPIError { try await client2.send(HTTPRequest.get("/api/x").retrying()) }114 XCTAssertEqual(StubServer.shared.requests.count, 1)115 }116117 func testMutationWithoutKeyIsNeverRetriedEvenWithAPolicy() async throws {118 let script = Script([.json("{}", status: 503)])119 let client = await client(script)120 var request = HTTPRequest(method: .post, path: "/api/pages", body: Data("{}".utf8), contentType: "application/json")121 request.retry = .standard122 _ = await captureAPIError { try await client.send(request) }123 XCTAssertEqual(StubServer.shared.requests.count, 1)124 XCTAssertTrue(script.delays.isEmpty)125 }126127 func testMutationWithKeyIsRetriedWithTheSameKeyAndBody() async throws {128 let script = Script([.failure(.timedOut), .json("{\"error\":\"busy\",\"code\":\"in_progress\"}", status: 409), .json("{\"ok\":true}", headers: ["Idempotent-Replay": "true"])])129 let client = await client(script)130 let request = HTTPRequest(method: .post, path: "/api/tasks", body: Data("{\"title\":\"a\"}".utf8), contentType: "application/json").retrying(RetryPolicy(maxAttempts: 3, jitter: 0))131 let response = try await client.send(request)132 XCTAssertTrue(response.isIdempotentReplay)133 let seen = StubServer.shared.requests134 XCTAssertEqual(seen.count, 3)135 XCTAssertEqual(Set(seen.compactMap { $0.header("Idempotency-Key") }), [request.idempotencyKey!])136 XCTAssertEqual(Set(seen.map(\.bodyText)), ["{\"title\":\"a\"}"])137 XCTAssertEqual(Set(seen.compactMap { $0.header("Origin") }), ["https://notes.test"])138 }139140 func testRetryAfterHeaderIsHonoured() async throws {141 let script = Script([.json("{}", status: 429, headers: ["Retry-After": "3"]), .json("{}")])142 let client = await client(script)143 _ = try await client.send(HTTPRequest.get("/api/x").retrying(RetryPolicy(maxAttempts: 2, baseDelay: 0.1, maxDelay: 10, jitter: 0)))144 XCTAssertEqual(script.delays, [3])145 }146147 func testCancellationDuringBackoffStops() async throws {148 StubServer.shared.reset { _ in .json("{}", status: 503) }149 let (client, _) = TestEnv.client()150 await client.setRetrySleeper { _ in throw CancellationError() }151 let error = await captureAPIError { try await client.send(HTTPRequest.get("/api/x").retrying()) }152 XCTAssertEqual(error, .cancelled)153 XCTAssertEqual(StubServer.shared.requests.count, 1)154 }155156 func testRealSleeperWaits() async throws {157 let script = Script([.json("{}", status: 500), .json("{}")])158 StubServer.shared.reset { _ in script.next() }159 let (client, _) = TestEnv.client()160 let start = Date()161 _ = try await client.send(HTTPRequest.get("/api/x").retrying(RetryPolicy(maxAttempts: 2, baseDelay: 0.05, jitter: 0)))162 XCTAssertGreaterThanOrEqual(Date().timeIntervalSince(start), 0.045)163 }164}165