Search code examples
swiftnsmutableurlrequestswift-extensionsurlrequest

How to Extend URLRequest


The result of trying to write maintainable, clean code:

func fetchNumbersFromServer(completion: @escaping (NumbersResult) -> Void) {
    let urlString = "https://some-site.com/some-file"
    var request = URLRequest(url: URL.init(string: urlString)!)
    // I want to configure the request, yet make the code extenda
    request = URLRequest.configure(request: request)
    // create URLSession configuration, delegate and session
    ...
    session.dataTask(with: request) { (data, response, error) -> Void in
        // handle response
    }.resume()
}

extension URLRequest {

    static func configure(request: URLRequest) -> URLRequest {
        // request in must be made mutable
        var request = request
        request.setValue("some user agent", forHTTPHeaderField: "User-Agent")
        request.timeoutInterval = 10

        return request
    }

}

By using a type method, this works to modify the request. However, it feels awkward to me, so I was wondering if there was a better (or more effective) way to accomplish 'configuring' the URLRequest.


Solution

  • You can just create a URLRequest custom initializer and set a default value for the parameters:

    extension URLRequest {
        init(_ url: URL, userAgent: String = "your default user agent", cachePolicy: CachePolicy = .useProtocolCachePolicy, timeInterval: TimeInterval = 60) {
            self.init(url: url, cachePolicy: cachePolicy, timeoutInterval: timeInterval)
            setValue(userAgent, forHTTPHeaderField: "User-Agent")
        }
    }
    
    struct NumbersResult { }
    
    func fetchNumbersFromServer(request: URLRequest, completion: @escaping (NumbersResult) -> ()) {
        URLSession.shared.dataTask(with: request) { data, response, error  in
            // handle response
        }.resume()
    }
    
    let url = URL(string: "https://www.google.com")!
    let request = URLRequest(url)  // you can also pass another userAgent, cachePolicy and timeInterval here if needed
    fetchNumbersFromServer(request: request) { numbers in
    
    }