-
Notifications
You must be signed in to change notification settings - Fork 525
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Bugfix - Request Cancellation Race Conditions in ImageDownloader (#372)
* Updated Alamofire submodule and pod dependency to 5.0.0-beta.7 * Fixed several issues related to async task creation in ImageDownloader
- Loading branch information
Showing
6 changed files
with
237 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,199 @@ | ||
| // | ||
| // ImageDownloaderStressTests.swift | ||
| // | ||
| // Copyright (c) 2019 Alamofire Software Foundation (http://alamofire.org/) | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
| // | ||
|
|
||
| @testable import Alamofire | ||
| @testable import AlamofireImage | ||
| import Foundation | ||
| import XCTest | ||
|
|
||
| class ImageDownloaderStressTestCase: BaseTestCase { | ||
| let imageCount = 10 | ||
| var kittenCache: Set<String> = [] | ||
|
|
||
| // MARK: - Setup and Teardown | ||
|
|
||
| override func setUp() { | ||
| super.setUp() | ||
| kittenCache.removeAll() | ||
| } | ||
|
|
||
| // MARK: - Tests - Common Use Cases | ||
|
|
||
| func testThatItCanDownloadManyImagesInParallel() { | ||
| // Given | ||
| let imageRequests = (1...imageCount).map { _ in randomKittenURLRequest() } | ||
| let imageDownloader = ImageDownloader(configuration: .ephemeral) | ||
|
|
||
| let expect = expectation(description: "all requests should complete") | ||
| expect.expectedFulfillmentCount = imageRequests.count | ||
|
|
||
| var receipts: [RequestReceipt] = [] | ||
| var responses: [DataResponse<Image>] = [] | ||
|
|
||
| // When | ||
| for imageRequest in imageRequests { | ||
| let receipt = imageDownloader.download(imageRequest) { response in | ||
| responses.append(response) | ||
| expect.fulfill() | ||
| } | ||
|
|
||
| receipt.flatMap { receipts.append($0) } | ||
| } | ||
|
|
||
| waitForExpectations(timeout: 10, handler: nil) | ||
|
|
||
| // Then | ||
| XCTAssertEqual(receipts.count, imageCount) | ||
| XCTAssertEqual(responses.count, imageCount) | ||
| responses.forEach { XCTAssertTrue($0.result.isSuccess) } | ||
| } | ||
|
|
||
| func testThatItCanDownloadManyImagesInParallelWhileCancellingRequests() { | ||
| // Given | ||
| let cancelledImageCount = 4 | ||
| let imageRequests = (1...imageCount).map { _ in randomKittenURLRequest() } | ||
| let imageDownloader = ImageDownloader(configuration: .ephemeral) | ||
|
|
||
| let expect = expectation(description: "all requests should complete") | ||
| expect.expectedFulfillmentCount = imageRequests.count | ||
|
|
||
| var receipts: [RequestReceipt] = [] | ||
| var responses: [DataResponse<Image>] = [] | ||
|
|
||
| // When | ||
| for imageRequest in imageRequests { | ||
| let receipt = imageDownloader.download(imageRequest) { response in | ||
| responses.append(response) | ||
| expect.fulfill() | ||
| } | ||
|
|
||
| receipt.flatMap { receipts.append($0) } | ||
| } | ||
|
|
||
| receipts.suffix(cancelledImageCount).forEach { imageDownloader.cancelRequest(with: $0) } | ||
|
|
||
| waitForExpectations(timeout: 10, handler: nil) | ||
|
|
||
| // Then | ||
| XCTAssertEqual(receipts.count, imageCount) | ||
| XCTAssertEqual(responses.count, imageCount) | ||
|
|
||
| let successCount = responses.reduce(0) { count, response in response.result.isSuccess ? count + 1 : count } | ||
| let failureCount = responses.reduce(0) { count, response in response.result.isFailure ? count + 1 : count } | ||
|
|
||
| XCTAssertEqual(successCount, imageCount - cancelledImageCount) | ||
| XCTAssertEqual(failureCount, cancelledImageCount) | ||
| } | ||
|
|
||
| // MARK: - Tests - Uncommon Use Cases (External Abuse) | ||
|
|
||
| func testThatItCanDownloadManyImagesInParallelWhileResumingRequestsExternally() { | ||
| // Given | ||
| let imageRequests = (1...imageCount).map { _ in randomKittenURLRequest() } | ||
| let imageDownloader = ImageDownloader(configuration: .ephemeral) | ||
|
|
||
| let expect = expectation(description: "all requests should complete") | ||
| expect.expectedFulfillmentCount = imageRequests.count | ||
|
|
||
| var receipts: [RequestReceipt] = [] | ||
| var responses: [DataResponse<Image>] = [] | ||
|
|
||
| // When | ||
| for imageRequest in imageRequests { | ||
| let receipt = imageDownloader.download(imageRequest) { response in | ||
| responses.append(response) | ||
| expect.fulfill() | ||
| } | ||
|
|
||
| receipt.flatMap { receipts.append($0) } | ||
| } | ||
|
|
||
| receipts.suffix(4).forEach { $0.request.resume() } | ||
|
|
||
| waitForExpectations(timeout: 10, handler: nil) | ||
|
|
||
| // Then | ||
| XCTAssertEqual(receipts.count, imageCount) | ||
| XCTAssertEqual(responses.count, imageCount) | ||
| responses.forEach { XCTAssertTrue($0.result.isSuccess) } | ||
| } | ||
|
|
||
| func testThatItCanDownloadManyImagesInParallelWhileCancellingRequestsExternally() { | ||
| // Given | ||
| let cancelledImageCount = 4 | ||
| let imageRequests = (1...imageCount).map { _ in randomKittenURLRequest() } | ||
| let imageDownloader = ImageDownloader(configuration: .ephemeral) | ||
|
|
||
| let expect = expectation(description: "all requests should complete") | ||
| expect.expectedFulfillmentCount = imageRequests.count | ||
|
|
||
| var receipts: [RequestReceipt] = [] | ||
| var responses: [DataResponse<Image>] = [] | ||
|
|
||
| // When | ||
| for imageRequest in imageRequests { | ||
| let receipt = imageDownloader.download(imageRequest) { response in | ||
| responses.append(response) | ||
| expect.fulfill() | ||
| } | ||
|
|
||
| receipt.flatMap { receipts.append($0) } | ||
| } | ||
|
|
||
| receipts.suffix(cancelledImageCount).forEach { $0.request.cancel() } | ||
|
|
||
| waitForExpectations(timeout: 10, handler: nil) | ||
|
|
||
| // Then | ||
| XCTAssertEqual(receipts.count, imageCount) | ||
| XCTAssertEqual(responses.count, imageCount) | ||
|
|
||
| let successCount = responses.reduce(0) { count, response in response.result.isSuccess ? count + 1 : count } | ||
| let failureCount = responses.reduce(0) { count, response in response.result.isFailure ? count + 1 : count } | ||
|
|
||
| XCTAssertEqual(successCount, imageCount - cancelledImageCount) | ||
| XCTAssertEqual(failureCount, cancelledImageCount) | ||
| } | ||
|
|
||
| private func randomKittenURLRequest() -> URLRequest { | ||
| let urlString = uniqueKittenURLString() | ||
| let url = URL(string: urlString)! | ||
|
|
||
| return URLRequest(url: url) | ||
| } | ||
|
|
||
| private func uniqueKittenURLString() -> String { | ||
| let width = Int.random(in: 100...400) | ||
| let height = Int.random(in: 100...400) | ||
|
|
||
| let urlString = "https://placekitten.com/\(width)/\(height)" | ||
|
|
||
| if kittenCache.contains(urlString) { | ||
| return uniqueKittenURLString() | ||
| } else { | ||
| kittenCache.insert(urlString) | ||
| return urlString | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters