Request Interceptor

RequestInterceptorとはRequestAdaptorとRequestRetrierを合体させて一つにしたもの。

じゃあそれぞれ一体どんな役割を持っているのかということを解説しよう。

RequestAdapter

Alamofire’s RequestAdapter protocol allows each URLRequest that’s to be performed by a Session to be inspected and mutated before being issued over the network. One very common use of an adapter is to add an Authorization header to requests behind a certain type of authentication.

Alamofire の公式ドキュメントにはこうある。

要するにこれを使えばリクエストを送る前にヘッダー部分に認証用のキーを追加できる、とある。

1
func adapt(_ urlRequest: URLRequest, for session: Session, completion: @escaping (Result<URLRequest, Error>) -> Void)

RequestAdapterは上のようなプロトコルを持っているので、準拠するクラス等はこれに適合する必要がある。

1
let accessToken: String
2

3
func adapt(_ urlRequest: URLRequest, for session: Session, completion: @escaping (Result<URLRequest, Error>) -> Void) {
4
    var urlRequest = urlRequest
5
    urlRequest.headers.add(.authorization(bearerToken: accessToken))
6

7
    completion(.success(urlRequest))
8
}

サンプルコードによるとこんな感じで使う。

この場合はどこかでaccessTokenを持っておいて、その値をリクエストが送られる前に認証に adapt(適合)するように変化させるというわけである、なるほど賢い。

RequestRetrier

Alamofire’s RequestRetrier protocol allows a Request that encountered an Error while being executed to be retried. This includes Errors produced at any stage of Alamofire’s request pipeline.

Alamofire の公式ドキュメントにはこうある。

つまり、リクエストを送ってエラーが発生したときに自動的に実行される Delegate のようなものである。

1
func retry(_ request: Request, for session: Session, dueTo error: Error, completion: @escaping (RetryResult) -> Void)

で、準拠するのに必要なプロトコルは上の通り。

RetryResultは以下で表される Enum で、次のような値を持っている。

1
/// Outcome of determination whether retry is necessary.
2
public enum RetryResult {
3
    /// Retry should be attempted immediately.
4
    case retry
5
    /// Retry should be attempted after the associated `TimeInterval`.
6
    case retryWithDelay(TimeInterval)
7
    /// Do not retry.
8
    case doNotRetry
9
    /// Do not retry due to the associated `Error`.
10
    case doNotRetryWithError(Error)
11
}

これを使って実装すると以下のようなサンプルコードになる。

1
open func retry(_ request: Request, for session: Session, dueTo error: Error, completion: @escaping (RetryResult) -> Void) {
2
    if request.retryCount < retryLimit,
3
       let httpMethod = request.request?.method,
4
       retryableHTTPMethods.contains(httpMethod),
5
       shouldRetry(response: request.response, error: error) {
6
        let timeDelay = pow(Double(exponentialBackoffBase), Double(request.retryCount)) * exponentialBackoffScale
7
        completion(.retryWithDelay(timeDelay))
8
    } else {
9
        completion(.doNotRetry)
10
    }
11
}

リトライ回数がretryLimit以下なら遅延を入れて再実行するという仕組みである。

retryLimitは関数内で定義しても意味ないので、まあ親クラスが持っているとかそんなんだとおもう。

これを使えばadaptでリクエストごとに自動的に認証用ヘッダーを付け、有効期限切れで失敗すればretryでトークンを再生成してリトライするという挙動が簡単に実装できそうな気がする。

で、この仕組みを開発中の SplatNet2 ライブラリに組み込んでみることにしました。

SplatNet2

エラー処理を特に何も考えないのであればDataResponsePublisherを使うのが手っ取り早いのだが、SplatNet2 では正しくエラーを返したかったためエラーの中身を変換してから利用するAnyPublisherを採用した。

SplatNet2クラスをRequestInterceptorプロトコルに準拠させ、以下のような感じでコードを書く。

1
extension SplatNet2: RequestInterceptor {
2
    public func adapt(_ urlRequest: URLRequest, for session: Session, completion: @escaping (Swift.Result<URLRequest, Error>) -> Void) {
3
        var urlRequest = urlRequest
4
        // ヘッダーにUserAgentを追加
5
        urlRequest.headers.add(.userAgent("Salmonia3/tkgling"))
6
        // ヘッダーに認証情報を追加
7
        urlRequest.headers.add(HTTPHeader(name: "cookie", value: "iksm_session=\(iksmSession)"))
8
        completion(.success(urlRequest))
9
    }
10

11
    public func retry(_ request: Request, for session: Session, dueTo error: Error, completion: @escaping (RetryResult) -> Void) {
12
        // リトライ回数が一回以下の場合実行する
13
        if request.retryCount < 1 {
14
        getCookie(sessionToken: sessionToken)
15
            .sink(receiveCompletion: { result in
16
                switch result {
17
                    case .finished:
18
                        break
19
                    case .failure(let error):
20
                        // 認証情報の再生成に失敗したらリトライせずに終了
21
                        completion(.doNotRetry)
22
                }
23
            }, receiveValue: { response in
24
                self.account = response
25
                // 成功したのでリトライする
26
                completion(.retry)
27
            })
28
            .store(in: &task)
29
        }
30
    }
31
}

これだけで認証に失敗したらリトライして再生成ができる。

個別に何かを書く必要もない、神かな？

Request Interceptorで有効期限付きAPIにリクエストを送る

Request Interceptor

RequestAdapter

RequestRetrier

SplatNet2