javier
13b9c74a38
CI / Build and test (push) Canceled after 0s
Documentation / Build documentation (push) Canceled after 0s
Documentation / Deploy to GitHub Pages (push) Canceled after 0s
This PR contains the work done to fix a cancellation-mapping bug in `AmiiboLiveClient`, bring the client under offline test coverage, add the conformances SwiftUI and persistence need, and moves CI and documentation publishing to GitHub Actions. All public API changes are additive.
### Fix
- `AmiiboLiveClient` reported an early task cancellation as `.unknown("CancellationError()")`. The OpenAPI runtime wraps every error in `ClientError`, so the `CancellationError` check never matched; it now also checks the wrapped error and throws `.cancelled`.
### Tests
- `ThrowingTransport` and `StubTransport` test doubles let the live client run offline. New tests cover error mapping, HTTP status → error mapping, `oneOf` object-vs-list decoding, `"amiibo": null`, sorting, filter → query encoding, `Platform`/`Release` mapping, and the date transcoder.
- Models gained `package` memberwise initializers so tests can build real fixtures without `@testable`. These are not public API.
- The test target now depends on `OpenAPIRuntime` and `HTTPTypes` (both already in the dependency graph).
### API
- Models are `Codable` and `Identifiable` (`Amiibo.id` is its `identifier`; the key/name models use `key`).
- Filters are `Hashable`.
### Documentation
- Doc comments trimmed library-wide; one repeated `- Throws:` sentence appeared 24 times. `Library.md` and the README tightened to match.
### CI and docs publishing
- `ci.yml`: build and offline tests on PRs and pushes to `main`.
- `live-tests.yml`: weekly and on-demand run against the live API.
- `docs.yml`: builds DocC on PRs, deploys to GitHub Pages on `main`. Pinned to Xcode 26 because swift-docc-plugin 1.5.0 fails to launch its tools under Xcode 27.
- The generated `docs/` folder (327 files) is removed from the repository and ignored.
Reviewed-on: #31
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
60 lines
2.3 KiB
Swift
60 lines
2.3 KiB
Swift
// ===----------------------------------------------------------------------===
|
|
//
|
|
// This source file is part of the Amiibo Service open source project
|
|
//
|
|
// Copyright (c) 2026 Röck+Cöde VoF. and the Amiibo Service project authors
|
|
// Licensed under Apache license v2.0
|
|
//
|
|
// See LICENSE for license information
|
|
// See CONTRIBUTORS for the list of Amiibo Service project authors
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
// ===----------------------------------------------------------------------===
|
|
|
|
import Foundation
|
|
|
|
/// An error thrown by ``AmiiboService`` and ``AmiiboClient`` methods.
|
|
public enum AmiiboServiceError: Error {
|
|
/// The request was malformed or contained invalid filter parameters.
|
|
case badRequest
|
|
/// The request was cancelled before a response was received.
|
|
case cancelled
|
|
/// The response body could not be decoded into the expected model.
|
|
case decoding
|
|
/// The service is unreachable due to a network or server issue.
|
|
case notAvailable
|
|
/// No results were found matching the given filter criteria.
|
|
///
|
|
/// When no amiibos match, ``AmiiboService/getAmiibos(_:)`` returns an empty array instead of throwing this error.
|
|
case notFound
|
|
/// The server returned an undocumented HTTP status code.
|
|
case undocumented(_ statusCode: Int)
|
|
/// Any other error, with a description of the underlying one.
|
|
case unknown(_ description: String)
|
|
}
|
|
|
|
// MARK: - Equatable
|
|
|
|
extension AmiiboServiceError: Equatable {}
|
|
|
|
// MARK: - LocalizedError
|
|
|
|
extension AmiiboServiceError: LocalizedError {
|
|
|
|
// MARK: Properties
|
|
|
|
public var errorDescription: String? {
|
|
switch self {
|
|
case .badRequest: "The request was malformed or contained invalid filter parameters."
|
|
case .cancelled: "The request was cancelled before a response was received."
|
|
case .decoding: "The response body could not be decoded into the expected model."
|
|
case .notAvailable: "The backend service is currently unreachable due to a network or server issue."
|
|
case .notFound: "No results were found matching the given filter criteria."
|
|
case .undocumented(let statusCode): "The server returned an undocumented HTTP status code: \(statusCode)."
|
|
case .unknown(let description): "An unexpected error occurred: \(description)"
|
|
}
|
|
}
|
|
|
|
}
|