mbrucedogs/mvm_core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

enhancement

Browse Source
This commit is contained in:
Suresh, Kamlesh 2021-03-05 17:23:06 -05:00
parent 7006ea83df
commit 931d10f45a
5 changed files with 87 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
MVMCore/MVMCore/ActionHandling/MVMCoreActionHandler.h
View File

@ -97,7 +97,7 @@ extern NSString * _Nonnull const KeyActionTypeOpen;
+ (void)defaultLogAction:(nullable NSDictionary *)actionInformation additionalData:(nullable NSDictionary *)additionalData delegateObject:(nullable DelegateObject *)delegateObject;
/// Sends the request to the load handler.
+ (void)defaultHandleOpenPageForRequestParameters:(nonnull MVMCoreRequestParameters *)requestParameters additionalData:(nullable NSDictionary *)additionalData delegateObject:(nullable DelegateObject *)delegateObject;
+ (void)defaultHandleOpenPageForRequestParameters:(nonnull MVMCoreRequestParameters *)requestParameters actionInformation:(nullable NSDictionary *)actionInformation additionalData:(nullable NSDictionary *)additionalData delegateObject:(nullable DelegateObject *)delegateObject;
/// By default, throws an error, calling defaultHandleActionError.
+ (void)defaultHandleUnknownActionType:(nullable NSString *)actionType actionInformation:(nullable NSDictionary *)actionInformation additionalData:(nullable NSDictionary *)additionalData delegateObject:(nullable DelegateObject *)delegateObject;

21
MVMCore/MVMCore/ActionHandling/MVMCoreActionHandler.m
View File

@ -162,14 +162,14 @@ NSString * const KeyActionTypeOpen = @"openPage";
}
MVMCoreRequestParameters *requestParameters = [[MVMCoreRequestParameters alloc] initWithActionMap:actionInformation];
requestParameters.clientParamters = [actionInformation dict:KeyClientParameters];
[self updateRequestParametersBeforeHandleOpenPageAction:requestParameters callBack:^(MVMCoreRequestParameters * _Nonnull requestParameters) {
if ([delegateObject.actionDelegate respondsToSelector:@selector(handleOpenPageForRequestParameters:actionInformation:additionalData:)]) {
[delegateObject.actionDelegate handleOpenPageForRequestParameters:requestParameters actionInformation:actionInformation additionalData:additionalData];
} else {
[MVMCoreActionHandler defaultHandleOpenPageForRequestParameters:requestParameters additionalData:additionalData delegateObject:delegateObject];
[MVMCoreActionHandler defaultHandleOpenPageForRequestParameters:requestParameters
actionInformation:actionInformation
additionalData:additionalData
delegateObject:delegateObject];
}
}];
}
@ -268,7 +268,10 @@ NSString * const KeyActionTypeOpen = @"openPage";
if ([delegateObject.actionDelegate respondsToSelector:@selector(handleOpenPageForRequestParameters:actionInformation:additionalData:)]) {
[delegateObject.actionDelegate handleOpenPageForRequestParameters:requestParameters actionInformation:actionInformation additionalData:dataForPage];
} else {
[MVMCoreActionHandler defaultHandleOpenPageForRequestParameters:requestParameters additionalData:additionalData delegateObject:delegateObject];
[MVMCoreActionHandler defaultHandleOpenPageForRequestParameters:requestParameters
actionInformation:actionInformation
additionalData:additionalData
delegateObject:delegateObject];
}
}];
}];
@ -417,9 +420,11 @@ NSString * const KeyActionTypeOpen = @"openPage";
// Currently no default log action but this will eventually be server driven.
}
+ (void)defaultHandleOpenPageForRequestParameters:(nonnull MVMCoreRequestParameters *)requestParameters additionalData:(nullable NSDictionary *)additionalData delegateObject:(nullable DelegateObject *)delegateObject {
if (requestParameters.clientParamters) {
[[MVMCoreActionHandler sharedActionHandler] getClientParameter:requestParameters.clientParamters
+ (void)defaultHandleOpenPageForRequestParameters:(nonnull MVMCoreRequestParameters *)requestParameters actionInformation:(nullable NSDictionary *)actionInformation additionalData:(nullable NSDictionary *)additionalData delegateObject:(nullable DelegateObject *)delegateObject {
NSDictionary *clientParamters = [actionInformation dict:KeyClientParameters];
if (clientParamters) {
[[MVMCoreActionHandler sharedActionHandler] getClientParameter:clientParamters
requestParameters: requestParameters.parameters
showLoadingOverlay: !requestParameters.backgroundRequest
completionHandler: ^(NSDictionary * _Nullable jsonDictionary) {

2
MVMCore/MVMCore/LoadHandling/MVMCoreRequestParameters.h
View File

@ -89,8 +89,6 @@ typedef NS_ENUM(NSInteger, MFLoadStyle) {
// If the request was created with an action map.
@property (nullable, strong, nonatomic) NSDictionary *actionMap;
@property (nullable, strong, nonatomic) NSDictionary *clientParamters;
@property (nullable, strong, nonatomic) NSNumber *customTimeoutTime;
// Will open support panel at the end of the load.

45
MVMCore/MVMCore/Models/ActionType/Client Parameters/ClientParameterProtocol.swift
View File

@ -9,7 +9,48 @@
import Foundation
public protocol ClientParameterProtocol {
init()
static var name: String { get }
func fetchClientParameters(for paramModel: ClientParameterModelProtocol, requestParameters: [String: Any], timingOutIn timeout: Double, completionHandler:@escaping (AnyHashable?) -> ())
init()
init(_ clientParameterModel:ClientParameterModelProtocol)
var isFlatMap: Bool { get }
var clientParameterModel:ClientParameterModelProtocol? { get set}
func defaultErrorString() -> String
func fetchClientParameters(requestParameters: [String: Any], timingOutIn timeout: Double, completionHandler:@escaping (AnyHashable?) -> ())
/// The handler should call this methos to pass the paramter back to the caller.
func returnParameters(_ paramter: [String: AnyHashable]?, completionHandler: @escaping (AnyHashable?) -> ())
/// Default parameter for timout scenarios. It will use the protocol extension method bydefault. Can override to send custom values.
func defaultValue() -> AnyHashable
}
public extension ClientParameterProtocol {
var isFlatMap: Bool { false }
func defaultErrorString() -> String {
return "failed_to_collect"
}
func defaultValue() -> AnyHashable {
return [Self.name: defaultErrorString()]
}
init(_ clientParameterModel:ClientParameterModelProtocol) {
self.init()
self.clientParameterModel = clientParameterModel
}
func returnParameters(_ parameter: [String: AnyHashable]?, completionHandler: @escaping (AnyHashable?) -> ()) {
guard let parameter = parameter else {
return completionHandler(nil)
}
if isFlatMap {
completionHandler(parameter)
} else {
completionHandler([Self.name :parameter])
}
}
}

64
MVMCore/MVMCore/Models/ActionType/Client Parameters/ClientParameterRegistry.swift
View File

@ -23,9 +23,9 @@ import Foundation
mapping[T.name] = handler
}
open func createParametersHandler(_ actionType: String) -> ClientParameterProtocol? {
guard let parameterType = mapping[actionType] else { return nil }
return parameterType.init()
open func createParametersHandler(_ clientParameterModel: ClientParameterModelProtocol) -> ClientParameterProtocol? {
guard let parameterType = mapping[clientParameterModel.type] else { return nil }
return parameterType.init(clientParameterModel)
}
static func getClientParameterModel(_ clientParameters: [String: Any]) throws -> ClientParameterModel? {
@ -58,17 +58,32 @@ import Foundation
let parametersWorkQueue = DispatchQueue(label: "com.mva.clientparameter")
let group = DispatchGroup()
let defaultErrorString = "failed_to_collect."
//let defaultErrorString = "failed_to_collect."
// Dispatch setup on queue to ensure setup is complete before completion callbacks.
parametersWorkQueue.async(group: group, qos: .userInitiated) { [weak self] in
guard let self = self else { return }
var returnedList: [[String: AnyHashable]] = []
var parameterHandlerList: [ClientParameterProtocol] = []
var returnedList = [[String: AnyHashable]](repeating: [:], count: clientParameterModel.list.count)
// Create the handler list so that same object can be used when merging. Merging needs default value in case of timeout
for parameterModel in clientParameterModel.list {
if let parameterHandler = self.createParametersHandler(parameterModel) {
parameterHandlerList.append(parameterHandler)
}
}
var mergedParametersList: [String: AnyHashable] {
var parametersList: [String: AnyHashable] = [:]
var index = 0
for item in returnedList {
parametersList = parametersList.merging(item) { (_, new) in new }
if item.count == 0, let defaultValue = parameterHandlerList[index].defaultValue() as? [String: AnyHashable] {
parametersList = parametersList.merging(defaultValue) { (_, new) in new }
} else {
parametersList = parametersList.merging(item) { (_, new) in new }
}
index += 1
}
return parametersList
}
@ -89,31 +104,22 @@ import Foundation
// Setup timeout.
parametersWorkQueue.asyncAfter(deadline: .now() + .seconds(Int(timeout)), execute: timeoutWorkItem)
// Setup the parameter execution.
for parameterModel in clientParameterModel.list {
// Setup default timeout / nil error. This will be replaced as parameters are collected.
if !(parameterModel.isFlatMap ?? false) {
returnedList.append([parameterModel.type: ["error": defaultErrorString]])
}
var index = -1
for parameterHandler in parameterHandlerList {
group.enter()
// Dispatch asynchronous injection.
self.getParameterFromHandler(parameterModel,
requestParameters: requestParameters,
before: timeout) { (receivedParameter) in
index += 1
parameterHandler.fetchClientParameters(requestParameters: requestParameters,
timingOutIn: timeout) { (receivedParameter) in
// Queue the results for merge.
parametersWorkQueue.async {
if parameterModel.isFlatMap ?? false, let receivedParameter = receivedParameter as? [String: AnyHashable] {
// parametersList = parametersList.merging(receivedParameter) { (_, new) in new }
returnedList.append(receivedParameter)
} else if let receivedParameter = receivedParameter {
returnedList.append([parameterModel.type: receivedParameter])
if let receivedParameter = receivedParameter as? [String: AnyHashable] {
returnedList[index] = receivedParameter
}
group.leave() // Leaving is only done after setup (barriered).
}
}
}
}
// Callback when all parameters have been merged.
@ -121,16 +127,6 @@ import Foundation
}
}
func getParameterFromHandler( _ parameterModel: ClientParameterModelProtocol, requestParameters: [String: Any], before timeout: Double, completionHandler:@escaping (AnyHashable?) -> ()) {
guard let parameterHandler = createParametersHandler(parameterModel.type) else {
return completionHandler(nil)
}
parameterHandler.fetchClientParameters(for: parameterModel,
requestParameters: requestParameters,
timingOutIn: timeout,
completionHandler: completionHandler)
}
/// Add all registry here.
open func registerParameters() { }