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 #1995 from kielgillard/ios-release 

Feedly: renew access token once a day
This commit is contained in:
Maurice Parker 2020-04-18 17:59:22 -05:00 committed by GitHub
parent a4c672bb46 5ab13ae705
commit 059582c625
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 65 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Frameworks/Account/AccountMetadata.swift
View File

@ -23,6 +23,7 @@ final class AccountMetadata: Codable {
case lastArticleFetchStartTime = "lastArticleFetch" case lastArticleFetchStartTime = "lastArticleFetch"
case lastArticleFetchEndTime case lastArticleFetchEndTime
case endpointURL case endpointURL
case lastCredentialRenewTime = "lastCredentialRenewTime"
} }
var name: String? { var name: String? {
@ -81,6 +82,16 @@ final class AccountMetadata: Codable {
} }
} }
/// The last moment an account successfully renewed its credentials, or `nil` if no such moment exists.
/// An account delegate can use this value to decide when to next ask the service provider to renew credentials.
var lastCredentialRenewTime: Date? {
didSet {
if lastCredentialRenewTime != oldValue {
valueDidChange(.lastCredentialRenewTime)
}
}
}
weak var delegate: AccountMetadataDelegate? weak var delegate: AccountMetadataDelegate?
func valueDidChange(_ key: CodingKeys) { func valueDidChange(_ key: CodingKeys) {

26
Frameworks/Account/Feedly/FeedlyAccountDelegate.swift
View File

@ -111,11 +111,20 @@ final class FeedlyAccountDelegate: AccountDelegate {
} }
let log = self.log let log = self.log
let operation = FeedlySyncAllOperation(account: account, credentials: credentials, caller: caller, database: database, lastSuccessfulFetchStartDate: accountMetadata?.lastArticleFetchStartTime, downloadProgress: refreshProgress, log: log)
operation.downloadProgress = refreshProgress let refreshAccessToken = FeedlyRefreshAccessTokenOperation(account: account, service: self, oauthClient: oauthAuthorizationClient, refreshDate: Date(), log: log)
refreshAccessToken.downloadProgress = refreshProgress
operationQueue.add(refreshAccessToken)
let syncAllOperation = FeedlySyncAllOperation(account: account, feedlyUserId: credentials.username, caller: caller, database: database, lastSuccessfulFetchStartDate: accountMetadata?.lastArticleFetchStartTime, downloadProgress: refreshProgress, log: log)
syncAllOperation.downloadProgress = refreshProgress
// Ensure the sync uses the latest credential.
syncAllOperation.addDependency(refreshAccessToken)
let date = Date() let date = Date()
operation.syncCompletionHandler = { [weak self] result in syncAllOperation.syncCompletionHandler = { [weak self] result in
if case .success = result { if case .success = result {
self?.accountMetadata?.lastArticleFetchStartTime = date self?.accountMetadata?.lastArticleFetchStartTime = date
self?.accountMetadata?.lastArticleFetchEndTime = Date() self?.accountMetadata?.lastArticleFetchEndTime = Date()
@ -125,9 +134,9 @@ final class FeedlyAccountDelegate: AccountDelegate {
completion(result) completion(result)
} }
currentSyncAllOperation = operation currentSyncAllOperation = syncAllOperation
operationQueue.add(operation) operationQueue.add(syncAllOperation)
} }
func sendArticleStatus(for account: Account, completion: @escaping ((Result<Void, Error>) -> Void)) { func sendArticleStatus(for account: Account, completion: @escaping ((Result<Void, Error>) -> Void)) {
@ -155,7 +164,7 @@ final class FeedlyAccountDelegate: AccountDelegate {
let group = DispatchGroup() let group = DispatchGroup()
let ingestUnread = FeedlyIngestUnreadArticleIdsOperation(account: account, credentials: credentials, service: caller, database: database, newerThan: nil, log: log) let ingestUnread = FeedlyIngestUnreadArticleIdsOperation(account: account, userId: credentials.username, service: caller, database: database, newerThan: nil, log: log)
group.enter() group.enter()
ingestUnread.completionBlock = { _ in ingestUnread.completionBlock = { _ in
@ -163,7 +172,7 @@ final class FeedlyAccountDelegate: AccountDelegate {
} }
let ingestStarred = FeedlyIngestStarredArticleIdsOperation(account: account, credentials: credentials, service: caller, database: database, newerThan: nil, log: log) let ingestStarred = FeedlyIngestStarredArticleIdsOperation(account: account, userId: credentials.username, service: caller, database: database, newerThan: nil, log: log)
group.enter() group.enter()
ingestStarred.completionBlock = { _ in ingestStarred.completionBlock = { _ in
@ -492,9 +501,6 @@ final class FeedlyAccountDelegate: AccountDelegate {
func accountDidInitialize(_ account: Account) { func accountDidInitialize(_ account: Account) {
credentials = try? account.retrieveCredentials(type: .oauthAccessToken) credentials = try? account.retrieveCredentials(type: .oauthAccessToken)
let refreshAccessToken = FeedlyRefreshAccessTokenOperation(account: account, service: self, oauthClient: oauthAuthorizationClient, log: log)
operationQueue.add(refreshAccessToken)
} }
func accountWillBeDeleted(_ account: Account) { func accountWillBeDeleted(_ account: Account) {

2
Frameworks/Account/Feedly/Operations/FeedlyAddNewFeedOperation.swift
View File

@ -89,7 +89,7 @@ class FeedlyAddNewFeedOperation: FeedlyOperation, FeedlyOperationDelegate, Feedl
createFeeds.downloadProgress = downloadProgress createFeeds.downloadProgress = downloadProgress
operationQueue.add(createFeeds) operationQueue.add(createFeeds)
let syncUnread = FeedlyIngestUnreadArticleIdsOperation(account: account, credentials: credentials, service: syncUnreadIdsService, database: database, newerThan: nil, log: log) let syncUnread = FeedlyIngestUnreadArticleIdsOperation(account: account, userId: credentials.username, service: syncUnreadIdsService, database: database, newerThan: nil, log: log)
syncUnread.addDependency(createFeeds) syncUnread.addDependency(createFeeds)
syncUnread.downloadProgress = downloadProgress syncUnread.downloadProgress = downloadProgress
syncUnread.delegate = self syncUnread.delegate = self

4
Frameworks/Account/Feedly/Operations/FeedlyGetUpdatedArticleIdsOperation.swift
View File

@ -29,8 +29,8 @@ class FeedlyGetUpdatedArticleIdsOperation: FeedlyOperation, FeedlyEntryIdentifie
self.log = log self.log = log
} }
convenience init(account: Account, credentials: Credentials, service: FeedlyGetStreamIdsService, newerThan: Date?, log: OSLog) { convenience init(account: Account, userId: String, service: FeedlyGetStreamIdsService, newerThan: Date?, log: OSLog) {
let all = FeedlyCategoryResourceId.Global.all(for: credentials.username) let all = FeedlyCategoryResourceId.Global.all(for: userId)
self.init(account: account, resource: all, service: service, newerThan: newerThan, log: log) self.init(account: account, resource: all, service: service, newerThan: newerThan, log: log)
} }

4
Frameworks/Account/Feedly/Operations/FeedlyIngestStarredArticleIdsOperation.swift
View File

@ -25,8 +25,8 @@ final class FeedlyIngestStarredArticleIdsOperation: FeedlyOperation {
private var remoteEntryIds = Set<String>() private var remoteEntryIds = Set<String>()
private let log: OSLog private let log: OSLog
convenience init(account: Account, credentials: Credentials, service: FeedlyGetStreamIdsService, database: SyncDatabase, newerThan: Date?, log: OSLog) { convenience init(account: Account, userId: String, service: FeedlyGetStreamIdsService, database: SyncDatabase, newerThan: Date?, log: OSLog) {
let resource = FeedlyTagResourceId.Global.saved(for: credentials.username) let resource = FeedlyTagResourceId.Global.saved(for: userId)
self.init(account: account, resource: resource, service: service, database: database, newerThan: newerThan, log: log) self.init(account: account, resource: resource, service: service, database: database, newerThan: newerThan, log: log)
} }

4
Frameworks/Account/Feedly/Operations/FeedlyIngestStreamArticleIdsOperation.swift
View File

@ -28,8 +28,8 @@ class FeedlyIngestStreamArticleIdsOperation: FeedlyOperation {
self.log = log self.log = log
} }
convenience init(account: Account, credentials: Credentials, service: FeedlyGetStreamIdsService, log: OSLog) { convenience init(account: Account, userId: String, service: FeedlyGetStreamIdsService, log: OSLog) {
let all = FeedlyCategoryResourceId.Global.all(for: credentials.username) let all = FeedlyCategoryResourceId.Global.all(for: userId)
self.init(account: account, resource: all, service: service, log: log) self.init(account: account, resource: all, service: service, log: log)
} }

4
Frameworks/Account/Feedly/Operations/FeedlyIngestUnreadArticleIdsOperation.swift
View File

@ -26,8 +26,8 @@ final class FeedlyIngestUnreadArticleIdsOperation: FeedlyOperation {
private var remoteEntryIds = Set<String>() private var remoteEntryIds = Set<String>()
private let log: OSLog private let log: OSLog
convenience init(account: Account, credentials: Credentials, service: FeedlyGetStreamIdsService, database: SyncDatabase, newerThan: Date?, log: OSLog) { convenience init(account: Account, userId: String, service: FeedlyGetStreamIdsService, database: SyncDatabase, newerThan: Date?, log: OSLog) {
let resource = FeedlyCategoryResourceId.Global.all(for: credentials.username) let resource = FeedlyCategoryResourceId.Global.all(for: userId)
self.init(account: account, resource: resource, service: service, database: database, newerThan: newerThan, log: log) self.init(account: account, resource: resource, service: service, database: database, newerThan: newerThan, log: log)
} }

22
Frameworks/Account/Feedly/Operations/FeedlyRefreshAccessTokenOperation.swift
View File

@ -17,14 +17,32 @@ final class FeedlyRefreshAccessTokenOperation: FeedlyOperation {
let account: Account let account: Account
let log: OSLog let log: OSLog
init(account: Account, service: OAuthAccessTokenRefreshing, oauthClient: OAuthAuthorizationClient, log: OSLog) { /// The moment the refresh is being requested. The token will refresh only if the account's `lastCredentialRenewTime` is not on the same day as this moment. When nil, the operation will always refresh the token.
let refreshDate: Date?
init(account: Account, service: OAuthAccessTokenRefreshing, oauthClient: OAuthAuthorizationClient, refreshDate: Date?, log: OSLog) {
self.oauthClient = oauthClient self.oauthClient = oauthClient
self.service = service self.service = service
self.account = account self.account = account
self.refreshDate = refreshDate
self.log = log self.log = log
} }
override func run() { override func run() {
// Only refresh the token if these dates are not on the same day.
let shouldRefresh: Bool = {
guard let date = refreshDate, let lastRenewDate = account.metadata.lastCredentialRenewTime else {
return true
}
return !Calendar.current.isDate(lastRenewDate, equalTo: date, toGranularity: .day)
}()
guard shouldRefresh else {
os_log(.debug, log: log, "Skipping access token renewal.")
didFinish()
return
}
let refreshToken: Credentials let refreshToken: Credentials
do { do {
@ -64,6 +82,8 @@ final class FeedlyRefreshAccessTokenOperation: FeedlyOperation {
// Now store the access token because we want the account delegate to use it. // Now store the access token because we want the account delegate to use it.
try account.storeCredentials(grant.accessToken) try account.storeCredentials(grant.accessToken)
account.metadata.lastCredentialRenewTime = Date()
didFinish() didFinish()
} catch { } catch {
didFinish(with: error) didFinish(with: error)

14
Frameworks/Account/Feedly/Operations/FeedlySyncAllOperation.swift
View File

@ -33,7 +33,7 @@ final class FeedlySyncAllOperation: FeedlyOperation {
/// ///
/// Download articles for statuses at the union of those statuses without its corresponding article and those included in 3 (changed since last successful sync). /// Download articles for statuses at the union of those statuses without its corresponding article and those included in 3 (changed since last successful sync).
/// ///
init(account: Account, credentials: Credentials, lastSuccessfulFetchStartDate: Date?, markArticlesService: FeedlyMarkArticlesService, getUnreadService: FeedlyGetStreamIdsService, getCollectionsService: FeedlyGetCollectionsService, getStreamContentsService: FeedlyGetStreamContentsService, getStarredService: FeedlyGetStreamIdsService, getStreamIdsService: FeedlyGetStreamIdsService, getEntriesService: FeedlyGetEntriesService, database: SyncDatabase, downloadProgress: DownloadProgress, log: OSLog) { init(account: Account, feedlyUserId: String, lastSuccessfulFetchStartDate: Date?, markArticlesService: FeedlyMarkArticlesService, getUnreadService: FeedlyGetStreamIdsService, getCollectionsService: FeedlyGetCollectionsService, getStreamContentsService: FeedlyGetStreamContentsService, getStarredService: FeedlyGetStreamIdsService, getStreamIdsService: FeedlyGetStreamIdsService, getEntriesService: FeedlyGetEntriesService, database: SyncDatabase, downloadProgress: DownloadProgress, log: OSLog) {
self.syncUUID = UUID() self.syncUUID = UUID()
self.log = log self.log = log
self.operationQueue.suspend() self.operationQueue.suspend()
@ -67,14 +67,14 @@ final class FeedlySyncAllOperation: FeedlyOperation {
createFeedsOperation.addDependency(mirrorCollectionsAsFolders) createFeedsOperation.addDependency(mirrorCollectionsAsFolders)
self.operationQueue.add(createFeedsOperation) self.operationQueue.add(createFeedsOperation)
let getAllArticleIds = FeedlyIngestStreamArticleIdsOperation(account: account, credentials: credentials, service: getStreamIdsService, log: log) let getAllArticleIds = FeedlyIngestStreamArticleIdsOperation(account: account, userId: feedlyUserId, service: getStreamIdsService, log: log)
getAllArticleIds.delegate = self getAllArticleIds.delegate = self
getAllArticleIds.downloadProgress = downloadProgress getAllArticleIds.downloadProgress = downloadProgress
getAllArticleIds.addDependency(createFeedsOperation) getAllArticleIds.addDependency(createFeedsOperation)
self.operationQueue.add(getAllArticleIds) self.operationQueue.add(getAllArticleIds)
// Get each page of unread article ids in the global.all stream for the last 31 days (nil = Feedly API default). // Get each page of unread article ids in the global.all stream for the last 31 days (nil = Feedly API default).
let getUnread = FeedlyIngestUnreadArticleIdsOperation(account: account, credentials: credentials, service: getUnreadService, database: database, newerThan: nil, log: log) let getUnread = FeedlyIngestUnreadArticleIdsOperation(account: account, userId: feedlyUserId, service: getUnreadService, database: database, newerThan: nil, log: log)
getUnread.delegate = self getUnread.delegate = self
getUnread.addDependency(getAllArticleIds) getUnread.addDependency(getAllArticleIds)
getUnread.downloadProgress = downloadProgress getUnread.downloadProgress = downloadProgress
@ -82,14 +82,14 @@ final class FeedlySyncAllOperation: FeedlyOperation {
// Get each page of the article ids which have been update since the last successful fetch start date. // Get each page of the article ids which have been update since the last successful fetch start date.
// If the date is nil, this operation provides an empty set (everything is new, nothing is updated). // If the date is nil, this operation provides an empty set (everything is new, nothing is updated).
let getUpdated = FeedlyGetUpdatedArticleIdsOperation(account: account, credentials: credentials, service: getStreamIdsService, newerThan: lastSuccessfulFetchStartDate, log: log) let getUpdated = FeedlyGetUpdatedArticleIdsOperation(account: account, userId: feedlyUserId, service: getStreamIdsService, newerThan: lastSuccessfulFetchStartDate, log: log)
getUpdated.delegate = self getUpdated.delegate = self
getUpdated.downloadProgress = downloadProgress getUpdated.downloadProgress = downloadProgress
getUpdated.addDependency(createFeedsOperation) getUpdated.addDependency(createFeedsOperation)
self.operationQueue.add(getUpdated) self.operationQueue.add(getUpdated)
// Get each page of the article ids for starred articles. // Get each page of the article ids for starred articles.
let getStarred = FeedlyIngestStarredArticleIdsOperation(account: account, credentials: credentials, service: getStarredService, database: database, newerThan: nil, log: log) let getStarred = FeedlyIngestStarredArticleIdsOperation(account: account, userId: feedlyUserId, service: getStarredService, database: database, newerThan: nil, log: log)
getStarred.delegate = self getStarred.delegate = self
getStarred.downloadProgress = downloadProgress getStarred.downloadProgress = downloadProgress
getStarred.addDependency(createFeedsOperation) getStarred.addDependency(createFeedsOperation)
@ -125,8 +125,8 @@ final class FeedlySyncAllOperation: FeedlyOperation {
self.operationQueue.add(finishOperation) self.operationQueue.add(finishOperation)
} }
convenience init(account: Account, credentials: Credentials, caller: FeedlyAPICaller, database: SyncDatabase, lastSuccessfulFetchStartDate: Date?, downloadProgress: DownloadProgress, log: OSLog) { convenience init(account: Account, feedlyUserId: String, caller: FeedlyAPICaller, database: SyncDatabase, lastSuccessfulFetchStartDate: Date?, downloadProgress: DownloadProgress, log: OSLog) {
self.init(account: account, credentials: credentials, lastSuccessfulFetchStartDate: lastSuccessfulFetchStartDate, markArticlesService: caller, getUnreadService: caller, getCollectionsService: caller, getStreamContentsService: caller, getStarredService: caller, getStreamIdsService: caller, getEntriesService: caller, database: database, downloadProgress: downloadProgress, log: log) self.init(account: account, feedlyUserId: feedlyUserId, lastSuccessfulFetchStartDate: lastSuccessfulFetchStartDate, markArticlesService: caller, getUnreadService: caller, getCollectionsService: caller, getStreamContentsService: caller, getStarredService: caller, getStreamIdsService: caller, getEntriesService: caller, database: database, downloadProgress: downloadProgress, log: log)
} }
override func run() { override func run() {