FreshRSS
/
NetNewsWire
mirror of https://github.com/Ranchero-Software/NetNewsWire.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1138 from kielgillard/starredarticlepaging 

Feedly: Implement paging
This commit is contained in:
Maurice Parker 2019-10-16 07:34:22 -05:00 committed by GitHub
parent d2428e876b 05cb3773de
commit 740a2f8b9c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 151 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Frameworks/Account/Feedly/FeedlyAPICaller.swift
View File

@ -89,12 +89,7 @@ final class FeedlyAPICaller {
}
}
func getStream(for collection: FeedlyCollection, newerThan: Date? = nil, unreadOnly: Bool? = nil, completionHandler: @escaping (Result<FeedlyStream, Error>) -> ()) {
let id = FeedlyCategoryResourceId(id: collection.id)
getStream(for: id, newerThan: newerThan, unreadOnly: unreadOnly, completionHandler: completionHandler)
}
func getStream(for resource: FeedlyResourceId, newerThan: Date?, unreadOnly: Bool?, completionHandler: @escaping (Result<FeedlyStream, Error>) -> ()) {
func getStream(for resource: FeedlyResourceId, continuation: String? = nil, newerThan: Date?, unreadOnly: Bool?, completionHandler: @escaping (Result<FeedlyStream, Error>) -> ()) {
guard let accessToken = credentials?.secret else {
return DispatchQueue.main.async {
completionHandler(.failure(CredentialsError.incompleteCredentials))
@ -103,7 +98,7 @@ final class FeedlyAPICaller {
var components = baseUrlComponents
components.path = "/v3/streams/contents"
// If you change these, check AccountFeedlySyncTest.set(testFiles:with:).
var queryItems = [URLQueryItem]()
if let date = newerThan {
@ -118,6 +113,11 @@ final class FeedlyAPICaller {
queryItems.append(queryItem)
}
if let value = continuation, !value.isEmpty {
let queryItem = URLQueryItem(name: "continuation", value: value)
queryItems.append(queryItem)
}
queryItems.append(contentsOf: [
URLQueryItem(name: "count", value: "1000"),
URLQueryItem(name: "streamId", value: resource.id),

42
Frameworks/Account/Feedly/FeedlyCompoundOperation.swift
View File

@ -11,11 +11,28 @@ import Foundation
/// An operation with a queue of its own.
final class FeedlyCompoundOperation: FeedlyOperation {
private let operationQueue = OperationQueue()
private let operations: [Operation]
private var finishOperation: BlockOperation?
init(operations: [Operation]) {
assert(!operations.isEmpty)
self.operations = operations
operationQueue.isSuspended = true
finishOperation = nil
super.init()
let finish = BlockOperation {
self.didFinish()
}
finishOperation = finish
for operation in operations {
finish.addDependency(operation)
}
var initialOperations = operations
initialOperations.append(finish)
operationQueue.addOperations(initialOperations, waitUntilFinished: false)
}
convenience init(operationsBlock: () -> ([Operation])) {
@ -24,18 +41,17 @@ final class FeedlyCompoundOperation: FeedlyOperation {
}
override func main() {
let finishOperation = BlockOperation { [weak self] in
self?.didFinish()
guard !isCancelled else {
didFinish()
return
}
for operation in operations {
finishOperation.addDependency(operation)
}
var operationsWithFinish = operations
operationsWithFinish.append(finishOperation)
operationQueue.addOperations(operationsWithFinish, waitUntilFinished: false)
operationQueue.isSuspended = false
}
func addAnotherOperation(_ operation: Operation) {
guard !isCancelled else { return }
finishOperation?.addDependency(operation)
operationQueue.addOperation(operation)
}
override func cancel() {

2
Frameworks/Account/Feedly/FeedlyOperation.swift
View File

@ -19,11 +19,13 @@ class FeedlyOperation: Operation {
weak var delegate: FeedlyOperationDelegate?
func didFinish() {
assert(Thread.isMainThread)
self.isExecutingOperation = false
self.isFinishedOperation = true
}
func didFinish(_ error: Error) {
assert(Thread.isMainThread)
delegate?.feedlyOperation(self, didFailWith: error)
didFinish()
}

20
Frameworks/Account/Feedly/Refresh/FeedlyGetStreamOperation.swift
View File

@ -15,6 +15,10 @@ protocol FeedlyEntryProviding: class {
var parsedEntries: Set<ParsedItem> { get }
}
protocol FeedlyGetStreamOperationDelegate: class {
func feedlyGetStreamOperation(_ operation: FeedlyGetStreamOperation, didGet stream: FeedlyStream)
}
/// Single responsibility is to get the stream content of a Collection from Feedly.
final class FeedlyGetStreamOperation: FeedlyOperation, FeedlyEntryProviding {
@ -30,7 +34,8 @@ final class FeedlyGetStreamOperation: FeedlyOperation, FeedlyEntryProviding {
var entries: [FeedlyEntry] {
guard let entries = storedStream?.items else {
assertionFailure("Has a prior operation finished too early? Is the operation included in \(self.dependencies)?")
assert(isFinished, "This should only be called when the operation finishes without error.")
assertionFailure("Has this operation been addeded as a dependency on the caller?")
return []
}
return entries
@ -55,16 +60,19 @@ final class FeedlyGetStreamOperation: FeedlyOperation, FeedlyEntryProviding {
private var storedParsedEntries: Set<ParsedItem>?
let account: Account
let caller: FeedlyAPICaller
let unreadOnly: Bool?
let newerThan: Date?
let continuation: String?
init(account: Account, resource: FeedlyResourceId, caller: FeedlyAPICaller, newerThan: Date?, unreadOnly: Bool? = nil) {
weak var streamDelegate: FeedlyGetStreamOperationDelegate?
init(account: Account, resource: FeedlyResourceId, caller: FeedlyAPICaller, continuation: String? = nil, newerThan: Date?, unreadOnly: Bool? = nil) {
self.account = account
self.resourceProvider = ResourceProvider(resource: resource)
self.caller = caller
self.continuation = continuation
self.unreadOnly = unreadOnly
self.newerThan = newerThan
}
@ -79,11 +87,15 @@ final class FeedlyGetStreamOperation: FeedlyOperation, FeedlyEntryProviding {
return
}
caller.getStream(for: resourceProvider.resource, newerThan: newerThan, unreadOnly: unreadOnly) { result in
caller.getStream(for: resourceProvider.resource, continuation: continuation, newerThan: newerThan, unreadOnly: unreadOnly) { result in
switch result {
case .success(let stream):
self.storedStream = stream
self.streamDelegate?.feedlyGetStreamOperation(self, didGet: stream)
self.didFinish()
case .failure(let error):
self.didFinish(error)
}

156
Frameworks/Account/Feedly/Refresh/FeedlySyncStarredArticlesOperation.swift
View File

@ -8,18 +8,86 @@
import Foundation
import os.log
import RSParser
final class FeedlySyncStarredArticlesOperation: FeedlyOperation {
final class FeedlySyncStarredArticlesOperation: FeedlyOperation, FeedlyOperationDelegate, FeedlyGetStreamOperationDelegate {
private let account: Account
private let operationQueue: OperationQueue
private let caller: FeedlyAPICaller
private let log: OSLog
init(account: Account, caller: FeedlyAPICaller, log: OSLog) {
private let setStatuses: FeedlySetStarredArticlesOperation
/// Buffers every starred/saved entry from every page.
private class StarredEntryProvider: FeedlyEntryProviding {
var resource: FeedlyResourceId
private(set) var parsedEntries = Set<ParsedItem>()
private(set) var entries = [FeedlyEntry]()
init(resource: FeedlyResourceId) {
self.resource = resource
}
func addEntries(from provider: FeedlyEntryProviding) {
entries.append(contentsOf: provider.entries)
parsedEntries.formUnion(provider.parsedEntries)
}
}
private let entryProvider: StarredEntryProvider
init(account: Account, credentials: Credentials, caller: FeedlyAPICaller, log: OSLog) {
self.account = account
self.caller = caller
self.operationQueue = OperationQueue()
self.operationQueue.isSuspended = true
self.log = log
let saved = FeedlyTagResourceId.saved(for: credentials.username)
let provider = StarredEntryProvider(resource: saved)
self.entryProvider = provider
self.setStatuses = FeedlySetStarredArticlesOperation(account: account,
allStarredEntriesProvider: provider,
log: log)
super.init()
let getFirstPage = FeedlyGetStreamOperation(account: account,
resource: saved,
caller: caller,
newerThan: nil)
let organiseByFeed = FeedlyOrganiseParsedItemsByFeedOperation(account: account,
entryProvider: provider,
log: log)
let updateAccount = FeedlyUpdateAccountFeedsWithItemsOperation(account: account,
organisedItemsProvider: organiseByFeed,
log: log)
getFirstPage.delegate = self
getFirstPage.streamDelegate = self
setStatuses.addDependency(getFirstPage)
setStatuses.delegate = self
organiseByFeed.addDependency(setStatuses)
organiseByFeed.delegate = self
updateAccount.addDependency(organiseByFeed)
updateAccount.delegate = self
let finishOperation = BlockOperation { [weak self] in
DispatchQueue.main.async {
self?.didFinish()
}
}
finishOperation.addDependency(updateAccount)
let operations = [getFirstPage, setStatuses, organiseByFeed, updateAccount, finishOperation]
operationQueue.addOperations(operations, waitUntilFinished: false)
}
override func cancel() {
@ -33,73 +101,31 @@ final class FeedlySyncStarredArticlesOperation: FeedlyOperation {
return
}
guard let user = caller.credentials?.username else {
didFinish(FeedlyAccountDelegateError.notLoggedIn)
operationQueue.isSuspended = false
}
func feedlyGetStreamOperation(_ operation: FeedlyGetStreamOperation, didGet stream: FeedlyStream) {
entryProvider.addEntries(from: operation)
os_log(.debug, log: log, "Collecting %i items from %@", stream.items.count, stream.id)
guard let continuation = stream.continuation else {
return
}
class Delegate: FeedlyOperationDelegate {
var error: Error?
weak var compoundOperation: FeedlyCompoundOperation?
func feedlyOperation(_ operation: FeedlyOperation, didFailWith error: Error) {
compoundOperation?.cancel()
self.error = error
}
}
let nextPageOperation = FeedlyGetStreamOperation(account: operation.account,
resource: operation.resource,
caller: operation.caller,
continuation: continuation,
newerThan: operation.newerThan)
nextPageOperation.delegate = self
nextPageOperation.streamDelegate = self
let delegate = Delegate()
let syncSaved = FeedlyCompoundOperation {
let saved = FeedlyTagResourceId.saved(for: user)
os_log(.debug, log: log, "Getting starred articles from \"%@\".", saved.id)
let getSavedStream = FeedlyGetStreamOperation(account: account,
resource: saved,
caller: caller,
newerThan: nil)
getSavedStream.delegate = delegate
// set statuses
let setStatuses = FeedlySetStarredArticlesOperation(account: account,
allStarredEntriesProvider: getSavedStream,
log: log)
setStatuses.delegate = delegate
setStatuses.addDependency(getSavedStream)
// ingest articles
let organiseByFeed = FeedlyOrganiseParsedItemsByFeedOperation(account: account,
entryProvider: getSavedStream,
log: log)
organiseByFeed.delegate = delegate
organiseByFeed.addDependency(setStatuses)
let updateAccount = FeedlyUpdateAccountFeedsWithItemsOperation(account: account,
organisedItemsProvider: organiseByFeed,
log: log)
updateAccount.delegate = delegate
updateAccount.addDependency(organiseByFeed)
return [getSavedStream, setStatuses, organiseByFeed, updateAccount]
}
delegate.compoundOperation = syncSaved
let finalOperation = BlockOperation { [weak self] in
guard let self = self else {
return
}
if let error = delegate.error {
self.didFinish(error)
} else {
self.didFinish()
}
os_log(.debug, log: self.log, "Done syncing starred articles.")
}
finalOperation.addDependency(syncSaved)
operationQueue.addOperations([syncSaved, finalOperation], waitUntilFinished: false)
setStatuses.addDependency(nextPageOperation)
operationQueue.addOperation(nextPageOperation)
}
func feedlyOperation(_ operation: FeedlyOperation, didFailWith error: Error) {
operationQueue.cancelAllOperations()
didFinish(error)
}
}

7
Frameworks/Account/Feedly/Refresh/FeedlySyncStrategy.swift
View File

@ -49,6 +49,11 @@ final class FeedlySyncStrategy {
return
}
guard let credentials = caller.credentials else {
completionHandler(.failure(FeedlyAccountDelegateError.notLoggedIn))
return
}
let sendArticleStatuses = FeedlySendArticleStatusesOperation(database: database, caller: caller, log: log)
sendArticleStatuses.delegate = self
@ -85,7 +90,7 @@ final class FeedlySyncStrategy {
getCollectionStreams.queueDelegate = self
getCollectionStreams.addDependency(getCollections)
let syncStarred = FeedlySyncStarredArticlesOperation(account: account, caller: caller, log: log)
let syncStarred = FeedlySyncStarredArticlesOperation(account: account, credentials: credentials, caller: caller, log: log)
syncStarred.addDependency(getCollections)
syncStarred.addDependency(mirrorCollectionsAsFolders)
syncStarred.addDependency(createFeedsOperation)