## Summary Updates the library to v4.5.1 of the App Store Connect API, and ships it as a breaking 2.0.0 release with pagination, API key authentication, rate limiting, and a lighter install for consumers. ## Breaking changes - **Minimum platforms:** iOS 14, macOS 11, tvOS 14, watchOS 7, and visionOS 1. - **Toolchain:** Swift 6.0+ (Xcode 16+). The package builds in the Swift 6 language mode. - **Runtime:** requires `swift-openapi-runtime` 1.11.0 or later. ## Changes - **API:** updated the OpenAPI specification to v4.5.1, covering 1,303 operations and 1,473 schemas. - **Pagination:** the spec patch adds the undocumented `cursor` query parameter to the 465 paged operations. `PagedDocumentLinks.nextCursor` reads the cursor from a page, and `PagedSequence` iterates every page. - **Authentication:** `APIKeyTokenProvider` signs ES256 tokens from an API key and reuses each one until a minute before it expires. `BearerAuthMiddleware` now accepts a token provider. - **Rate limiting:** `RateLimitMiddleware` retries `429` responses, waiting for `Retry-After` or backing off exponentially. - **Generated code:** committed to `Sources/ASConnectService/Sources/Public/Generated` instead of generated by a build plugin. Consumers now resolve 4 packages instead of 12, and Xcode no longer asks to trust a plugin. - **Tooling:** - `make oas-download` now downloads, patches, generates, and checks the docs in one go. - New `make oas-generate`, `make oas-validate`, and `make doc-check` targets. - The generator is pinned in `Tools/`, and the DocC plugin is only resolved by the documentation targets. - **Documentation:** the DocC catalog now lists every operation and schema in the spec, and the catalog and README are rewritten for the new APIs. - **Housekeeping:** Apache 2.0 license headers on every Swift file, including `Package.swift` and the tests. Reviewed-on: #5 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
214 lines
6.3 KiB
Swift
214 lines
6.3 KiB
Swift
// ===----------------------------------------------------------------------===
|
|
//
|
|
// This source file is part of the ASConnectService open source project
|
|
//
|
|
// Copyright (c) 2026 Röck+Cöde VoF. and the ASConnectService project authors
|
|
// Licensed under Apache license v2.0
|
|
//
|
|
// See LICENSE for license information
|
|
// See CONTRIBUTORS for the list of ASConnectService project authors
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
// ===----------------------------------------------------------------------===
|
|
|
|
import Foundation
|
|
import HTTPTypes
|
|
import OpenAPIRuntime
|
|
import Testing
|
|
|
|
// A non-testable import ensures that the middleware can be created from outside the module.
|
|
import ASConnectService
|
|
|
|
@Suite("BearerAuthMiddleware")
|
|
struct BearerAuthMiddlewareTests {
|
|
// MARK: Tests
|
|
|
|
@Test("Adds the Authorization header with the Bearer token to the request")
|
|
func addsAuthorizationHeader() async throws {
|
|
let middleware = BearerAuthMiddleware(token: .Token.jwt)
|
|
|
|
let (response, _) = try await middleware.intercept(
|
|
.get,
|
|
body: nil,
|
|
baseURL: .base,
|
|
operationID: "listApps",
|
|
next: { interceptedRequest, body, baseURL in
|
|
#expect(interceptedRequest.headerFields[.authorization] == "Bearer test-jwt-token")
|
|
return (HTTPResponse(status: .ok), nil)
|
|
}
|
|
)
|
|
|
|
#expect(response.status == .ok)
|
|
}
|
|
|
|
@Test("Forwards the request body to the next handler")
|
|
func forwardsRequestBody() async throws {
|
|
let middleware = BearerAuthMiddleware(token: .Token.jwt)
|
|
let requestBody: HTTPBody = HTTPBody("request-body")
|
|
|
|
// The next handler echoes the body back, so the test can read it.
|
|
let (_, receivedBody) = try await middleware.intercept(
|
|
.get,
|
|
body: requestBody,
|
|
baseURL: .base,
|
|
operationID: "createApp",
|
|
next: { _, body, _ in
|
|
(HTTPResponse(status: .created), body)
|
|
}
|
|
)
|
|
|
|
let bodyData = try await Data(collecting: try #require(receivedBody), upTo: .max)
|
|
|
|
#expect(bodyData == Data("request-body".utf8))
|
|
}
|
|
|
|
@Test("Forwards the base URL to the next handler")
|
|
func forwardsBaseURL() async throws {
|
|
let middleware = BearerAuthMiddleware(token: .Token.jwt)
|
|
let expectedBaseURL = URL.base
|
|
|
|
_ = try await middleware.intercept(
|
|
.get,
|
|
body: nil,
|
|
baseURL: expectedBaseURL,
|
|
operationID: "listApps",
|
|
next: { _, _, baseURL in
|
|
#expect(baseURL == expectedBaseURL)
|
|
|
|
return (HTTPResponse(status: .ok), nil)
|
|
}
|
|
)
|
|
}
|
|
|
|
@Test("Returns the response from the next handler")
|
|
func returnsNextHandlerResponse() async throws {
|
|
let middleware = BearerAuthMiddleware(token: .Token.jwt)
|
|
let expectedBody: HTTPBody = HTTPBody("response-body")
|
|
|
|
let (response, body) = try await middleware.intercept(
|
|
.get,
|
|
body: nil,
|
|
baseURL: .base,
|
|
operationID: "listApps",
|
|
next: { _, _, _ in
|
|
(HTTPResponse(status: .notFound), expectedBody)
|
|
}
|
|
)
|
|
|
|
#expect(response.status == .notFound)
|
|
|
|
let bodyData = try await Data(collecting: try #require(body), upTo: .max)
|
|
|
|
#expect(bodyData == Data("response-body".utf8))
|
|
}
|
|
|
|
@Test("Preserves existing request headers")
|
|
func preservesExistingHeaders() async throws {
|
|
let middleware = BearerAuthMiddleware(token: .Token.jwt)
|
|
|
|
var request = HTTPRequest.get
|
|
|
|
request.headerFields[.contentType] = "application/json"
|
|
|
|
_ = try await middleware.intercept(
|
|
request,
|
|
body: nil,
|
|
baseURL: .base,
|
|
operationID: "listApps",
|
|
next: { interceptedRequest, _, _ in
|
|
#expect(interceptedRequest.headerFields[.contentType] == "application/json")
|
|
#expect(interceptedRequest.headerFields[.authorization] == "Bearer \(String.Token.jwt)")
|
|
|
|
return (HTTPResponse(status: .ok), nil)
|
|
}
|
|
)
|
|
}
|
|
|
|
@Test("Asks the token provider for a token on every request")
|
|
func asksTokenProviderOnEveryRequest() async throws {
|
|
let tokens = TokenSequence()
|
|
let middleware = BearerAuthMiddleware {
|
|
await tokens.next()
|
|
}
|
|
|
|
for expectedToken in ["token-1", "token-2"] {
|
|
_ = try await middleware.intercept(
|
|
.get,
|
|
body: nil,
|
|
baseURL: .base,
|
|
operationID: "listApps",
|
|
next: { interceptedRequest, _, _ in
|
|
#expect(interceptedRequest.headerFields[.authorization] == "Bearer \(expectedToken)")
|
|
|
|
return (HTTPResponse(status: .ok), nil)
|
|
}
|
|
)
|
|
}
|
|
}
|
|
|
|
@Test("Rethrows the token provider error without calling the next handler")
|
|
func rethrowsTokenProviderError() async throws {
|
|
let middleware = BearerAuthMiddleware {
|
|
throw TokenError.expired
|
|
}
|
|
|
|
await #expect(throws: TokenError.expired) {
|
|
_ = try await middleware.intercept(
|
|
.get,
|
|
body: nil,
|
|
baseURL: .base,
|
|
operationID: "listApps",
|
|
next: { _, _, _ in
|
|
Issue.record("The next handler should not be called when the token provider throws")
|
|
|
|
return (HTTPResponse(status: .ok), nil)
|
|
}
|
|
)
|
|
}
|
|
}
|
|
}
|
|
|
|
// MARK: - Helpers
|
|
|
|
/// An actor that returns a new token every time it is asked for one.
|
|
private actor TokenSequence {
|
|
private var count = 0
|
|
|
|
func next() -> String {
|
|
count += 1
|
|
|
|
return "token-\(count)"
|
|
}
|
|
}
|
|
|
|
/// An error thrown by a token provider.
|
|
private enum TokenError: Error {
|
|
case expired
|
|
}
|
|
|
|
// MARK: - HTTPRequest+Samples
|
|
|
|
private extension HTTPRequest {
|
|
static let get = HTTPRequest(
|
|
method: .get,
|
|
scheme: "https",
|
|
authority: "api.appstoreconnect.apple.com",
|
|
path: "/v1/apps"
|
|
)
|
|
}
|
|
|
|
// MARK: - String+Samples
|
|
|
|
private extension String {
|
|
enum Token {
|
|
static let jwt: String = "test-jwt-token"
|
|
}
|
|
}
|
|
|
|
// MARK: - URL+Samples
|
|
|
|
private extension URL {
|
|
static let base = URL(string: "https://api.appstoreconnect.apple.com")!
|
|
}
|