javierandjavier
0c41e5d4ce
This PR contains the work done to cleans up the library after the Swift 6.2 migration: drops the legacy conditional-compilation paths, hardens the OpenAPI specification, removes boilerplate from the live client, and makes the live test suite resilient to changes in the upstream service data.
* Swift 6.2 baseline
* Adopted swift-tools-version: 6.2, which allowed removing every #if swift(>=6.0) / #if swift(>=6.2) branch and natural-language test names are now the only code paths.
* `AmiiboClient` client now refines `Sendable`, and both `AmiiboLiveClient` and `AmiiboService` conform to it, so instances can be shared across concurrency domains.
* Live client
* Extracted a generic `perform(_:)` helper that wraps every generated API call and funnels transport errors through the existing error mapper — replaces six repeated do/catch blocks and lets the private fetch* methods use typed throws end-to-end.
* Added the internal `KeyNamePayload` protocol and a generic makeModels(from:), collapsing the four near-identical mapping/sorting blocks for amiibo series, types, game characters and game series into one.
* The server URL is now resolved once into a static let constant instead of on every initialization.
* Improved error mapping: URLError.cancelled → .cancelled, .cannotParseResponse → .decoding, and .dataNotAllowed, .internationalRoamingOff, .secureConnectionFailed now map to .notAvailable.
* Simplified the Amiibo.Platform initializer ([Amiibo+Platform.swift](vscode-webview://1m6rk4uhpaukb4hrbp3j54p77iq693fq2ql7o9oup2pca1omf7f6/Sources/AmiiboService/Public/Models/Amiibo/Amiibo+Platform.swift)) using optional chaining and ?? [] instead of nested guards and immediately-invoked closures.
* Set the en_US_POSIX locale on both fixed-format date formatters so the user's locale or 12/24-hour setting can no longer break parsing.
* OpenAPI specification
* Replaced the shared Tuple schema with explicit per-type schemas (AmiiboSeries, AmiiboType, GameCharacter, GameSeries), so the generated code exposes real properties instead of allOf wrappers with .value1 accessors.
* Extracted named list schemas (AmiiboList, AmiiboSeriesList, …) for the wrapper payloads, which turns the generated .case2 enum cases into readable .AmiiboSeriesList cases.
* Added validation patterns and length bounds to the id, head, tail and key query parameters, and collapsed the redundant pattern/minLength/maxLength triplets on head/tail into ^[0-9a-fA-F]{8}$.
* Extracted the shared InternalServerError response, replacing the five inline 500 descriptions.
* Documented the two non-standard date/time decoding behaviours (date-only strings for release dates, offset-less timestamps for lastUpdated) and why the optional amiibo wrapper property must stay optional.
* Corrected the info.version value from v1.0.0 to 1.0.0.
* ⚠️ Breaking changes
* Minimum Swift version raised from 5.10 to 6.2.
* `AmiiboServiceError.unknown` now carries a String description of the underlying error.
* `AmiiboClient` requires Sendable conformance, so existing custom mock clients must be Sendable.
Reviewed-on: #28
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
267 lines
7.9 KiB
Swift
267 lines
7.9 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 AmiiboService
|
|
import Foundation
|
|
import Testing
|
|
|
|
@Suite("Amiibo Service [Mock]", .tags(.mock))
|
|
struct AmiiboServiceMockTests {
|
|
|
|
// MARK: Get Amiibos tests
|
|
|
|
@Test("returns empty amiibos when mock provides an empty list")
|
|
func getAmiibosEmpty() async throws {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient(amiibos: []))
|
|
|
|
// WHEN
|
|
let amiibos = try await service.getAmiibos()
|
|
|
|
// THEN
|
|
#expect(amiibos.isEmpty)
|
|
}
|
|
|
|
@Test("throws notFound when mock provides no amiibos")
|
|
func getAmiibosNotFound() async {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient())
|
|
|
|
// WHEN
|
|
// THEN
|
|
await #expect(throws: AmiiboServiceError.notFound) {
|
|
try await service.getAmiibos()
|
|
}
|
|
}
|
|
|
|
@Test("throws error for amiibos when mock is configured with error", arguments: Errors.all)
|
|
func getAmiibosThrows(error: AmiiboServiceError) async {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient(error: error))
|
|
|
|
// WHEN
|
|
// THEN
|
|
await #expect(throws: error) {
|
|
try await service.getAmiibos()
|
|
}
|
|
}
|
|
|
|
// MARK: Get Amiibo Series tests
|
|
|
|
@Test("returns empty amiibo series when mock provides an empty list")
|
|
func getAmiiboSeriesEmpty() async throws {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient(amiiboSeries: []))
|
|
|
|
// WHEN
|
|
let amiiboSeries = try await service.getAmiiboSeries()
|
|
|
|
// THEN
|
|
#expect(amiiboSeries.isEmpty)
|
|
}
|
|
|
|
@Test("throws notFound when mock provides no amiibo series")
|
|
func getAmiiboSeriesNotFound() async {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient())
|
|
|
|
// WHEN
|
|
// THEN
|
|
await #expect(throws: AmiiboServiceError.notFound) {
|
|
try await service.getAmiiboSeries()
|
|
}
|
|
}
|
|
|
|
@Test("throws error for amiibo series when mock is configured with error", arguments: Errors.all)
|
|
func getAmiiboSeriesThrows(error: AmiiboServiceError) async {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient(error: error))
|
|
|
|
// WHEN
|
|
// THEN
|
|
await #expect(throws: error) {
|
|
try await service.getAmiiboSeries()
|
|
}
|
|
}
|
|
|
|
// MARK: Get Amiibo Types tests
|
|
|
|
@Test("returns empty amiibo types when mock provides an empty list")
|
|
func getAmiiboTypesEmpty() async throws {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient(amiiboTypes: []))
|
|
|
|
// WHEN
|
|
let amiiboTypes = try await service.getAmiiboTypes()
|
|
|
|
// THEN
|
|
#expect(amiiboTypes.isEmpty)
|
|
}
|
|
|
|
@Test("throws notFound when mock provides no amiibo types")
|
|
func getAmiiboTypesNotFound() async {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient())
|
|
|
|
// WHEN
|
|
// THEN
|
|
await #expect(throws: AmiiboServiceError.notFound) {
|
|
try await service.getAmiiboTypes()
|
|
}
|
|
}
|
|
|
|
@Test("throws error for amiibo types when mock is configured with error", arguments: Errors.all)
|
|
func getAmiiboTypesThrows(error: AmiiboServiceError) async {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient(error: error))
|
|
|
|
// WHEN
|
|
// THEN
|
|
await #expect(throws: error) {
|
|
try await service.getAmiiboTypes()
|
|
}
|
|
}
|
|
|
|
// MARK: Get Game Characters tests
|
|
|
|
@Test("returns empty game characters when mock provides an empty list")
|
|
func getGameCharactersEmpty() async throws {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient(gameCharacters: []))
|
|
|
|
// WHEN
|
|
let gameCharacters = try await service.getGameCharacters()
|
|
|
|
// THEN
|
|
#expect(gameCharacters.isEmpty)
|
|
}
|
|
|
|
@Test("throws notFound when mock provides no game characters")
|
|
func getGameCharactersNotFound() async {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient())
|
|
|
|
// WHEN
|
|
// THEN
|
|
await #expect(throws: AmiiboServiceError.notFound) {
|
|
try await service.getGameCharacters()
|
|
}
|
|
}
|
|
|
|
@Test("throws error for game characters when mock is configured with error", arguments: Errors.all)
|
|
func getGameCharactersThrows(error: AmiiboServiceError) async {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient(error: error))
|
|
|
|
// WHEN
|
|
// THEN
|
|
await #expect(throws: error) {
|
|
try await service.getGameCharacters()
|
|
}
|
|
}
|
|
|
|
// MARK: Get Game Series tests
|
|
|
|
@Test("returns empty game series when mock provides an empty list")
|
|
func getGameSeriesEmpty() async throws {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient(gameSeries: []))
|
|
|
|
// WHEN
|
|
let gameSeries = try await service.getGameSeries()
|
|
|
|
// THEN
|
|
#expect(gameSeries.isEmpty)
|
|
}
|
|
|
|
@Test("throws notFound when mock provides no game series")
|
|
func getGameSeriesNotFound() async {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient())
|
|
|
|
// WHEN
|
|
// THEN
|
|
await #expect(throws: AmiiboServiceError.notFound) {
|
|
try await service.getGameSeries()
|
|
}
|
|
}
|
|
|
|
@Test("throws error for game series when mock is configured with error", arguments: Errors.all)
|
|
func getGameSeriesThrows(error: AmiiboServiceError) async {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient(error: error))
|
|
|
|
// WHEN
|
|
// THEN
|
|
await #expect(throws: error) {
|
|
try await service.getGameSeries()
|
|
}
|
|
}
|
|
|
|
// MARK: Get Last Updated tests
|
|
|
|
@Test("returns date when mock provides a last updated date")
|
|
func getLastUpdated() async throws {
|
|
// GIVEN
|
|
let expectedDate = Date(timeIntervalSince1970: 1_700_000_000)
|
|
let service = AmiiboService(client: AmiiboMockClient(lastUpdated: expectedDate))
|
|
|
|
// WHEN
|
|
let lastUpdated = try await service.getLastUpdated()
|
|
|
|
// THEN
|
|
#expect(lastUpdated == expectedDate)
|
|
}
|
|
|
|
@Test("throws notFound when mock provides no last updated date")
|
|
func getLastUpdatedNotFound() async {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient())
|
|
|
|
// WHEN
|
|
// THEN
|
|
await #expect(throws: AmiiboServiceError.notFound) {
|
|
try await service.getLastUpdated()
|
|
}
|
|
}
|
|
|
|
@Test("throws error for last updated when mock is configured with error", arguments: Errors.all)
|
|
func getLastUpdatedThrows(error: AmiiboServiceError) async {
|
|
// GIVEN
|
|
let service = AmiiboService(client: AmiiboMockClient(error: error))
|
|
|
|
// WHEN
|
|
// THEN
|
|
await #expect(throws: error) {
|
|
try await service.getLastUpdated()
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
// MARK: - Arguments
|
|
|
|
private enum Errors {
|
|
/// All possible errors that can be thrown by the service.
|
|
static let all: [AmiiboServiceError] = [
|
|
.badRequest,
|
|
.cancelled,
|
|
.decoding,
|
|
.notAvailable,
|
|
.notFound,
|
|
.undocumented(500),
|
|
.unknown("An underlying error description.")
|
|
]
|
|
}
|