Renamed HTTPError to PushServiceError

README.md

@@ -17,6 +17,7 @@ A server-side Swift implementation of the WebPush standard.
 ## Quick Links
 
 - [Documentation](https://swiftpackageindex.com/mochidev/swift-webpush/documentation)
+- [Symbol Exploration](https://swiftinit.org/docs/mochidev.swift-webpush)
 - [Updates on Mastodon](https://mastodon.social/tags/SwiftWebPush)
 
 ## Installation

Sources/WebPush/Errors/HTTPError.swift → Sources/WebPush/Errors/PushServiceError.swift

@@ -1,5 +1,5 @@
 //
-//  HTTPError.swift
+//  PushServiceError.swift
 //  swift-webpush
 //
 //  Created by Dimitri Bouniol on 2024-12-13.
@@ -9,12 +9,12 @@
 import AsyncHTTPClient
 import Foundation
 
-/// An unknown HTTP error was encountered.
+/// An unknown Push Service error was encountered.
 ///
 /// - SeeAlso: [RFC 8030 Generic Event Delivery Using HTTP Push](https://datatracker.ietf.org/doc/html/rfc8030)
 /// - SeeAlso: [RFC 8292 Voluntary Application Server Identification (VAPID) for Web Push](https://datatracker.ietf.org/doc/html/rfc8292)
 /// - SeeAlso: [Sending web push notifications in web apps and browsers — Review responses for push notification errors](https://developer.apple.com/documentation/usernotifications/sending-web-push-notifications-in-web-apps-and-browsers#Review-responses-for-push-notification-errors)
-public struct HTTPError: LocalizedError, Sendable {
+public struct PushServiceError: LocalizedError, Sendable {
     /// The HTTP response that was returned from the push service..
     public let response: HTTPClientResponse
 
@@ -28,11 +28,11 @@ public struct HTTPError: LocalizedError, Sendable {
     }
 
     public var errorDescription: String? {
-        "A \(response.status) HTTP error was encountered: \(capturedResponseDescription)."
+        "A \(response.status) Push Service error was encountered: \(capturedResponseDescription)."
     }
 }
 
-extension HTTPError: Hashable {
+extension PushServiceError: Hashable {
     public static func == (lhs: Self, rhs: Self) -> Bool {
         "\(lhs.capturedResponseDescription)" == "\(rhs.capturedResponseDescription)"
     }

Sources/WebPush/WebPushManager.swift

@@ -499,7 +499,7 @@ public actor WebPushManager: Sendable {
             logger.error("The encrypted payload was too large and was rejected by the push service.")
             throw MessageTooLargeError()
         // TODO: 429 too many requests, 500 internal server error, 503 server shutting down - check config and perform a retry after a delay?
-        default: throw HTTPError(response: response)
+        default: throw PushServiceError(response: response)
         }
         logger.trace("Successfully sent notification")
     }

Tests/WebPushTests/ErrorTests.swift

@@ -22,12 +22,12 @@ import Testing
         #expect("\(Base64URLDecodingError().localizedDescription)" == "The Base64 data could not be decoded.")
     }
 
-    @Test func httpError() {
+    @Test func pushServiceError() {
         let response = HTTPClientResponse(status: .notFound)
-        #expect(HTTPError(response: response) == HTTPError(response: response))
-        #expect(HTTPError(response: response).hashValue == HTTPError(response: response).hashValue)
-        #expect(HTTPError(response: response) != HTTPError(response: HTTPClientResponse(status: .internalServerError)))
-        #expect("\(HTTPError(response: response).localizedDescription)" == "A 404 Not Found HTTP error was encountered: \(response).")
+        #expect(PushServiceError(response: response) == PushServiceError(response: response))
+        #expect(PushServiceError(response: response).hashValue == PushServiceError(response: response).hashValue)
+        #expect(PushServiceError(response: response) != PushServiceError(response: HTTPClientResponse(status: .internalServerError)))
+        #expect("\(PushServiceError(response: response).localizedDescription)" == "A 404 Not Found Push Service error was encountered: \(response).")
     }
 
     @Test func messageTooLargeError() {

Tests/WebPushTests/WebPushManagerTests.swift

@@ -567,7 +567,7 @@ struct WebPushManagerTests {
                     }))
                 )
 
-                await #expect(throws: HTTPError.self) {
+                await #expect(throws: PushServiceError.self) {
                     try await manager.send(string: "hello", to: .mockedSubscriber())
                 }
             }