fix: Use OperationQueue instead of NSLock in `DefaultTokenInterceptor`

This commit is contained in:
Ivan Smolin 2022-08-26 21:53:03 +03:00
parent 2c8fc0a8a5
commit 0171f9d64f
27 changed files with 129 additions and 114 deletions

View File

@ -1,5 +1,9 @@
# Changelog
### 1.26.1
- **Fix**: Use OperationQueue instead of NSLock in `DefaultTokenInterceptor`
- **Update**: AsyncOperation refactoring
### 1.26.0
- **Add**: `TIEcommerce` module with Cart, products, promocodes, bonuses and other related actions.

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = "LeadKit"
s.version = "1.26.0"
s.version = "1.26.1"
s.summary = "iOS framework with a bunch of tools for rapid development"
s.homepage = "https://github.com/TouchInstinct/LeadKit"
s.license = "Apache License, Version 2.0"

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TIAppleMapUtils'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Set of helpers for map objects clustering and interacting using Apple MapKit.'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TIAuth'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Login, registration, confirmation and other related actions'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TIEcommerce'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Cart, products, promocodes, bonuses and other related actions'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -22,32 +22,14 @@
import Foundation
private final class MapAsyncOperation<Output, Failure: Error>: AsyncOperation<Output, Failure> {
private var dependencyObservation: NSKeyValueObservation?
private final class MapAsyncOperation<Output, Failure: Error>: DependendAsyncOperation<Output, Failure> {
public init<DependencyOutput, DependencyFailure: Error>(dependency: AsyncOperation<DependencyOutput, DependencyFailure>,
mapOutput: @escaping (DependencyOutput) -> Result<Output, Failure>,
mapFailure: @escaping (DependencyFailure) -> Failure) {
super.init()
cancelOnCancellation(of: dependency)
dependencyObservation = dependency.subscribe { [weak self] in
switch mapOutput($0) {
case let .success(result):
self?.handle(result: result)
case let .failure(error):
self?.handle(error: error)
}
} onFailure: { [weak self] in
self?.handle(error: mapFailure($0))
super.init(dependency: dependency) {
$0.mapError(mapFailure).flatMap(mapOutput)
}
addDependency(dependency) // keeps strong reference to dependency as well
state = .isReady
}
}

View File

@ -22,46 +22,45 @@
import Foundation
private final class ClosureObserverOperation<Output, Failure: Error>: AsyncOperation<Output, Failure> {
private var dependencyObservation: NSKeyValueObservation?
private final class ClosureObserverOperation<Output, Failure: Error>: DependendAsyncOperation<Output, Failure> {
public typealias OnResultClosure = (Result<Output, Failure>) -> Void
public init(dependency: AsyncOperation<Output, Failure>,
onSuccess: ((Output) -> Void)? = nil,
onFailure: ((Failure) -> Void)? = nil,
onResult: OnResultClosure? = nil,
callbackQueue: DispatchQueue = .main) {
super.init()
cancelOnCancellation(of: dependency)
dependencyObservation = dependency.subscribe { [weak self] result in
super.init(dependency: dependency) { result in
callbackQueue.async {
onSuccess?(result)
onResult?(result)
}
self?.handle(result: result)
} onFailure: { [weak self] error in
callbackQueue.async {
onFailure?(error)
}
self?.handle(error: error)
return result
}
addDependency(dependency) // keeps strong reference to dependency as well
state = .isReady
}
}
public extension AsyncOperation {
func observe(onResult: ((Result<Output, Failure>) -> Void)? = nil,
callbackQueue: DispatchQueue = .main) -> AsyncOperation<Output, Failure> {
ClosureObserverOperation(dependency: self,
onResult: onResult,
callbackQueue: callbackQueue)
}
func observe(onSuccess: ((Output) -> Void)? = nil,
onFailure: ((Failure) -> Void)? = nil,
callbackQueue: DispatchQueue = .main) -> AsyncOperation<Output, Failure> {
ClosureObserverOperation(dependency: self,
onSuccess: onSuccess,
onFailure: onFailure,
callbackQueue: callbackQueue)
let onResult: ClosureObserverOperation<Output, Failure>.OnResultClosure = {
switch $0 {
case let .success(output):
onSuccess?(output)
case let .failure(error):
onFailure?(error)
}
}
return observe(onResult: onResult, callbackQueue: callbackQueue)
}
}

View File

@ -25,7 +25,7 @@ import Foundation
open class AsyncOperation<Output, Failure: Error>: Operation {
open var result: Result<Output, Failure>?
var state: State? = nil { // isReady == false
var state: State? = nil { // nil -> isReady == false
// KVO support
willSet {
willChangeValue(forKey: newValue.orReady.rawValue)
@ -77,34 +77,21 @@ open class AsyncOperation<Output, Failure: Error>: Operation {
// MARK: - Methods for subclass override
open func handle(result: Output) {
self.result = .success(result)
state = .isFinished
}
open func handle(error: Failure) {
self.result = .failure(error)
open func handle(result: Result<Output, Failure>) {
self.result = result
state = .isFinished
}
// MARK: - Completion observation
public func subscribe(onSuccess: ((Output) -> Void)? = nil,
onFailure: ((Failure) -> Void)? = nil) -> NSKeyValueObservation {
public func subscribe(onResult: ((Result<Output, Failure>) -> Void)? = nil) -> NSKeyValueObservation {
observe(\.isFinished, options: [.new]) { object, change in
if let isFinished = change.newValue, isFinished {
switch object.result {
case let .success(result)?:
onSuccess?(result)
case let .failure(failure)?:
onFailure?(failure)
default:
assertionFailure("Got nil result from operation when isFinished was true!")
if let result = object.result {
onResult?(result)
} else {
assertionFailure("Got nil result from operation but isFinished is true!")
}
}
}

View File

@ -48,13 +48,7 @@ public final class ClosureAsyncOperation<Output, Failure: Error>: AsyncOperation
super.start()
cancellableTask = cancellableTaskClosure { [weak self] in
switch $0 {
case let .success(result):
self?.handle(result: result)
case let .failure(error):
self?.handle(error: error)
}
self?.handle(result: $0)
}
}

View File

@ -0,0 +1,45 @@
//
// Copyright (c) 2022 Touch Instinct
//
// 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.
//
import Foundation
open class DependendAsyncOperation<Output, Failure: Error>: AsyncOperation<Output, Failure> {
public var dependencyObservation: NSKeyValueObservation?
public init<DependencyOutput, DependencyFailure: Error>(dependency: AsyncOperation<DependencyOutput, DependencyFailure>,
resultObservation: @escaping (Result<DependencyOutput, DependencyFailure>) -> Result<Output, Failure>) {
super.init()
cancelOnCancellation(of: dependency)
dependencyObservation = dependency.subscribe { [weak self] in
self?.result = resultObservation($0)
self?.state = .isReady
}
addDependency(dependency) // keeps strong reference to dependency as well
state = nil // prevent start of current operation if result is not yet provided by dependency
}
}

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TIFoundationUtils'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Set of helpers for Foundation framework classes.'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TIGoogleMapUtils'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Set of helpers for map objects clustering and interacting using Google Maps SDK.'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TIKeychainUtils'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Set of helpers for Keychain classes.'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TIMapUtils'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Set of helpers for map objects clustering and interacting.'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TIMoyaNetworking'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Moya + Swagger network service.'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -30,7 +30,7 @@ open class DefaultTokenInterceptor<RefreshError: Error>: RequestInterceptor {
public typealias RequestModificationClosure = (URLRequest) -> URLRequest
let refreshLock = NSLock()
let processingQueue = OperationQueue()
let shouldRefreshToken: ShouldRefreshTokenClosure
let refreshTokenClosure: RefreshTokenClosure
@ -45,6 +45,8 @@ open class DefaultTokenInterceptor<RefreshError: Error>: RequestInterceptor {
self.shouldRefreshToken = shouldRefreshTokenClosure
self.refreshTokenClosure = refreshTokenClosure
self.requestModificationClosure = requestModificationClosure
processingQueue.maxConcurrentOperationCount = 1
}
// MARK: - RequestAdapter
@ -62,7 +64,7 @@ open class DefaultTokenInterceptor<RefreshError: Error>: RequestInterceptor {
let modifiedRequest = requestModificationClosure?(urlRequest) ?? urlRequest
validateAndRepair(validationClosure: { shouldRefreshToken(urlRequest, nil, nil) },
validateAndRepair(validationClosure: { self.shouldRefreshToken(urlRequest, nil, nil) },
completion: adaptCompletion,
defaultCompletionResult: modifiedRequest,
recoveredCompletionResult: modifiedRequest)
@ -88,36 +90,38 @@ open class DefaultTokenInterceptor<RefreshError: Error>: RequestInterceptor {
}
}
validateAndRepair(validationClosure: { shouldRefreshToken(request.request, request.response, error) },
validateAndRepair(validationClosure: { self.shouldRefreshToken(request.request, request.response, error) },
completion: retryCompletion,
defaultCompletionResult: defaultRetryStrategy,
recoveredCompletionResult: .retry)
.add(to: retryBag)
}
open func validateAndRepair<T>(validationClosure: () -> Bool,
open func validateAndRepair<T>(validationClosure: @escaping () -> Bool,
completion: @escaping (Result<T, RefreshError>) -> Void,
defaultCompletionResult: T,
recoveredCompletionResult: T) -> Cancellable {
refreshLock.lock()
if validationClosure() {
return refreshTokenClosure { [refreshLock] in
refreshLock.unlock()
if let error = $0 {
completion(.failure(error))
} else {
completion(.success(recoveredCompletionResult))
let operation = ClosureAsyncOperation<T, RefreshError>(cancellableTaskClosure: { [refreshTokenClosure] operationCompletion in
if validationClosure() {
return refreshTokenClosure {
if let error = $0 {
operationCompletion(.failure(error))
} else {
operationCompletion(.success(recoveredCompletionResult))
}
}
} else {
operationCompletion(.success(defaultCompletionResult))
return Cancellables.nonCancellable()
}
} else {
refreshLock.unlock()
})
.observe(onResult: completion,
callbackQueue: .global())
completion(.success(defaultCompletionResult))
operation.add(to: processingQueue)
return Cancellables.nonCancellable()
}
return operation
}
}

View File

@ -52,7 +52,7 @@ open class EndpointResponseTokenInterceptor<AE, NE>: DefaultTokenInterceptor<End
return Cancellables.nonCancellable()
}
return validateAndRepair(validationClosure: { isTokenInvalidErrorResultClosure(firstErrorResult) },
return validateAndRepair(validationClosure: { self.isTokenInvalidErrorResultClosure(firstErrorResult) },
completion: completion,
defaultCompletionResult: defaultRetryStrategy,
recoveredCompletionResult: .retry)

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TINetworking'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Swagger-frendly networking layer helpers.'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TINetworkingCache'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Caching results of EndpointRequests.'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TIPagination'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Generic pagination component.'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TISwiftUICore'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Core UI elements: protocols, views and helpers..'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TISwiftUtils'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Bunch of useful helpers for Swift development.'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TITableKitUtils'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Set of helpers for TableKit classes.'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TITransitions'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Set of custom transitions to present controller. '
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TIUIElements'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Bunch of useful protocols and views.'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TIUIKitCore'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Core UI elements: protocols, views and helpers.'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }

View File

@ -1,6 +1,6 @@
Pod::Spec.new do |s|
s.name = 'TIYandexMapUtils'
s.version = '1.26.0'
s.version = '1.26.1'
s.summary = 'Set of helpers for map objects clustering and interacting using Yandex Maps SDK.'
s.homepage = 'https://github.com/TouchInstinct/LeadKit/tree/' + s.version.to_s + '/' + s.name
s.license = { :type => 'MIT', :file => 'LICENSE' }