Skip to content

Commit

Permalink
MLIBZ-2043: automatic pagination (#231)
Browse files Browse the repository at this point in the history 
* MLIBZ-2043: automatic pagination

* changes after running a performance test, so we can keep our lazy load strategy

* deleting username / password
  • Loading branch information
@heyzooi
heyzooi committed Sep 13, 2017
1 parent 160c857 commit bc56832
Show file tree
Hide file tree
Showing 14 changed files with 627 additions and 227 deletions.
75 changes: 47 additions & 28 deletions Kinvey/Kinvey/DataStore.swift
View file
Expand Up @@ -75,6 +75,8 @@ open class DataStore<T: Persistable> where T: NSObject {

fileprivate let uuid = UUID()

private let autoPagination: Bool

/// TTL (Time to Live) defines a filter of how old the data returned from the DataStore can be.
open var ttl: TTL? {
didSet {
Expand Down Expand Up @@ -113,15 +115,15 @@ open class DataStore<T: Persistable> where T: NSObject {
- parameter tag: A tag/nickname for your `DataStore` which will cache instances with the same tag name. Default value: `Kinvey.defaultTag`
- returns: An instance of `DataStore` which can be a new instance or a cached instance if you are passing a `tag` parameter.
*/
open class func collection(_ type: StoreType = .cache, deltaSet: Bool? = nil, client: Client = sharedClient, tag: String = defaultTag) -> DataStore {
open class func collection(_ type: StoreType = .cache, deltaSet: Bool? = nil, autoPagination: Bool = false, client: Client = sharedClient, tag: String = defaultTag) -> DataStore {
if !client.isInitialized() {
fatalError("Client is not initialized. Call Kinvey.sharedClient.initialize(...) to initialize the client before creating a DataStore.")
}
let key = DataStoreTypeTag(persistableType: T.self, tag: tag, type: type)
var dataStore = client.dataStoreInstances[key] as? DataStore
if dataStore == nil {
let fileURL = client.fileURL(tag)
dataStore = DataStore<T>(type: type, deltaSet: deltaSet ?? false, client: client, fileURL: fileURL, encryptionKey: client.encryptionKey)
dataStore = DataStore<T>(type: type, deltaSet: deltaSet ?? false, autoPagination: autoPagination, client: client, fileURL: fileURL, encryptionKey: client.encryptionKey)
client.dataStoreInstances[key] = dataStore
}
return dataStore!
Expand All @@ -139,15 +141,17 @@ open class DataStore<T: Persistable> where T: NSObject {
return DataStore<NewType>(
type: type,
deltaSet: deltaSet,
autoPagination: autoPagination,
client: client,
fileURL: fileURL,
encryptionKey: client.encryptionKey
)
}

fileprivate init(type: StoreType, deltaSet: Bool, client: Client, fileURL: URL?, encryptionKey: Data?) {
fileprivate init(type: StoreType, deltaSet: Bool, autoPagination: Bool, client: Client, fileURL: URL?, encryptionKey: Data?) {
self.type = type
self.deltaSet = deltaSet
self.autoPagination = autoPagination
self.client = client
self.fileURL = fileURL
collectionName = T.collectionName()
Expand Down Expand Up @@ -397,14 +401,13 @@ open class DataStore<T: Persistable> where T: NSObject {
let operation = FindOperation<T>(
query: Query(query: query, persistableType: T.self),
deltaSet: deltaSet,
autoPagination: autoPagination,
readPolicy: readPolicy,
cache: cache,
options: options
)
let request = operation.execute { result in
DispatchQueue.main.async {
completionHandler(result)
}
completionHandler(result)
}
return request
}
Expand Down Expand Up @@ -603,8 +606,13 @@ open class DataStore<T: Persistable> where T: NSObject {
let request = operation.execute { result in
switch result {
case .success(let results):
let array = results.map {
AggregationCustomResult<T>(value: T(JSON: $0)!, custom: $0)
let array = results.map { (json) -> AggregationCustomResult<T> in
var json = json
json[Entity.Key.entityId] = groupId
return AggregationCustomResult<T>(
value: T(JSON: json)!,
custom: json
)
}
DispatchQueue.main.async {
completionHandler(.success(array))
Expand Down Expand Up @@ -712,10 +720,12 @@ open class DataStore<T: Persistable> where T: NSObject {
let request = operation.execute { result in
switch result {
case .success(let results):
let array = results.map {
AggregationCountResult<T, Count>(
value: T(JSON: $0)!,
count: $0[aggregation.resultKey] as! Count
let array = results.map { (json) -> AggregationCountResult<T, Count> in
var json = json
json[Entity.Key.entityId] = groupId
return AggregationCountResult<T, Count>(
value: T(JSON: json)!,
count: json[aggregation.resultKey] as! Count
)
}
DispatchQueue.main.async {
Expand Down Expand Up @@ -831,10 +841,12 @@ open class DataStore<T: Persistable> where T: NSObject {
let request = operation.execute { result in
switch result {
case .success(let results):
let array = results.map {
AggregationSumResult<T, Sum>(
value: T(JSON: $0)!,
sum: $0[aggregation.resultKey] as! Sum
let array = results.map { (json) -> AggregationSumResult<T, Sum> in
var json = json
json[Entity.Key.entityId] = groupId
return AggregationSumResult<T, Sum>(
value: T(JSON: json)!,
sum: json[aggregation.resultKey] as! Sum
)
}
DispatchQueue.main.async {
Expand Down Expand Up @@ -950,10 +962,12 @@ open class DataStore<T: Persistable> where T: NSObject {
let request = operation.execute { result in
switch result {
case .success(let results):
let array = results.map {
AggregationAvgResult<T, Avg>(
value: T(JSON: $0)!,
avg: $0[aggregation.resultKey] as! Avg
let array = results.map { (json) -> AggregationAvgResult<T, Avg> in
var json = json
json[Entity.Key.entityId] = groupId
return AggregationAvgResult<T, Avg>(
value: T(JSON: json)!,
avg: json[aggregation.resultKey] as! Avg
)
}
DispatchQueue.main.async {
Expand Down Expand Up @@ -1069,10 +1083,12 @@ open class DataStore<T: Persistable> where T: NSObject {
let request = operation.execute { result in
switch result {
case .success(let results):
let array = results.map {
AggregationMinResult<T, Min>(
value: T(JSON: $0)!,
min: $0[aggregation.resultKey] as! Min
let array = results.map { (json) -> AggregationMinResult<T, Min> in
var json = json
json[Entity.Key.entityId] = groupId
return AggregationMinResult<T, Min>(
value: T(JSON: json)!,
min: json[aggregation.resultKey] as! Min
)
}
DispatchQueue.main.async {
Expand Down Expand Up @@ -1188,10 +1204,12 @@ open class DataStore<T: Persistable> where T: NSObject {
let request = operation.execute { result in
switch result {
case .success(let results):
let array = results.map {
AggregationMaxResult<T, Max>(
value: T(JSON: $0)!,
max: $0[aggregation.resultKey] as! Max
let array = results.map { (json) -> AggregationMaxResult<T, Max> in
var json = json
json[Entity.Key.entityId] = groupId
return AggregationMaxResult<T, Max>(
value: T(JSON: json)!,
max: json[aggregation.resultKey] as! Max
)
}
DispatchQueue.main.async {
Expand Down Expand Up @@ -1785,6 +1803,7 @@ open class DataStore<T: Persistable> where T: NSObject {
query: Query(query: query, persistableType: T.self),
deltaSet: deltaSet,
deltaSetCompletionHandler: deltaSetCompletionHandler,
autoPagination: autoPagination,
readPolicy: .forceNetwork,
cache: cache,
options: options
Expand Down
4 changes: 4 additions & 0 deletions Kinvey/Kinvey/Entity.swift
View file
Expand Up @@ -58,6 +58,10 @@ open class Entity: Object, Persistable {

/// This function can be used to validate JSON prior to mapping. Return nil to cancel mapping at this point
public required init?(map: Map) {
guard let entityId: String = map[Key.entityId].value(), !entityId.isEmpty else {
return nil
}

super.init()
}

Expand Down
11 changes: 9 additions & 2 deletions Kinvey/Kinvey/Error.swift
View file
Expand Up @@ -17,6 +17,9 @@ public enum Error: Swift.Error, LocalizedError, CustomStringConvertible, CustomD
/// Constant for 401 responses where the credentials are not valid to complete the request.
public static let InvalidCredentials = "InvalidCredentials"

/// Constant for 400 response where the number of results exceeded the limit.
public static let ResultSetSizeExceeded = "ResultSetSizeExceeded"

/// Error where Object ID is required.
case objectIdMissing

Expand Down Expand Up @@ -68,6 +71,8 @@ public enum Error: Swift.Error, LocalizedError, CustomStringConvertible, CustomD
/// Error forbidden
case forbidden(description: String)

/// Error when the number of results exceeded the limit
case resultSetSizeExceeded(debug: String, description: String)

/// Error localized description.
public var description: String {
Expand All @@ -80,7 +85,8 @@ public enum Error: Swift.Error, LocalizedError, CustomStringConvertible, CustomD
.invalidOperation(let description),
.missingConfiguration(_, _, _, let description),
.appNotFound(let description),
.forbidden(let description):
.forbidden(let description),
.resultSetSizeExceeded(_, let description):
return description
case .objectIdMissing:
return NSLocalizedString("Error.objectIdMissing", bundle: bundle, comment: "")
Expand Down Expand Up @@ -116,7 +122,8 @@ public enum Error: Swift.Error, LocalizedError, CustomStringConvertible, CustomD
case .methodNotAllowed(_, _, let debug, _),
.dataLinkEntityNotFound(_, _, let debug, _),
.missingConfiguration(_, _, let debug, _),
.unauthorized(_, _, _, let debug, _):
.unauthorized(_, _, _, let debug, _),
.resultSetSizeExceeded(let debug, _):
return debug
default:
return description
Expand Down

0 comments on commit bc56832

Please sign in to comment.