Signal-iOS/SignalMessaging/utils/RefreshEvent.swift
Jordan Rose 4f06a6d8a5 Fix incorrect uses of NotificationCenter block-based API
The block-based API returns a token that needs to be explicitly
unregistered, *and* the block should not capture 'self' strongly.
The fixes in this PR come in three flavors:

1. Switch to the selector-based API, sometimes taking advantage of
   the fact that extra arguments to an Objective-C method can be
   safely discarded (because they are passed at +0).

2. Save the observer token and unregister in deinit.

3. Comment why it's safe to leave the observer registered forever
   in this particular case.
2022-08-02 17:43:52 -07:00

113 lines
2.9 KiB
Swift

//
// Copyright (c) 2022 Open Whisper Systems. All rights reserved.
//
import Foundation
// This class can be used to coordinate the refresh of a
// value obtained from the network.
@objc
public class RefreshEvent: NSObject {
public typealias Block = () -> Void
private let block: Block
private let refreshInterval: TimeInterval
private var refreshTimer: Timer?
// The block will be performed with a rough frequency of refreshInterval.
//
// It will not be performed if the app isn't ready, the user isn't registered,
// if the app isn't the main app, if the app isn't active.
//
// It will also be performed immediately if any of the conditions change.
public required init(refreshInterval: TimeInterval,
block: @escaping Block) {
self.refreshInterval = refreshInterval
self.block = block
super.init()
AppReadiness.runNowOrWhenAppDidBecomeReadyAsync { [weak self] in
self?.ensureRefreshTimer()
}
NotificationCenter.default.addObserver(
self,
selector: #selector(didEnterBackground),
name: .OWSApplicationDidEnterBackground,
object: nil
)
NotificationCenter.default.addObserver(
self,
selector: #selector(didBecomeActive),
name: .OWSApplicationDidBecomeActive,
object: nil
)
NotificationCenter.default.addObserver(
self,
selector: #selector(fireEvent),
name: SSKReachability.owsReachabilityDidChange,
object: nil)
}
private var canFire: Bool {
guard AppReadiness.isAppReady,
CurrentAppContext().isMainAppAndActive,
tsAccountManager.isRegisteredAndReady else {
return false
}
return true
}
@objc
private func fireEvent() {
guard canFire else {
return
}
block()
}
@objc
private func didEnterBackground() {
AssertIsOnMainThread()
ensureRefreshTimer()
}
@objc
private func didBecomeActive() {
AssertIsOnMainThread()
ensureRefreshTimer()
}
private func ensureRefreshTimer() {
guard canFire else {
stopRefreshTimer()
return
}
startRefreshTimer()
}
private func stopRefreshTimer() {
refreshTimer?.invalidate()
refreshTimer = nil
}
private func startRefreshTimer() {
guard refreshTimer == nil else {
return
}
refreshTimer = WeakTimer.scheduledTimer(timeInterval: refreshInterval,
target: self,
userInfo: nil,
repeats: true) { [weak self] _ in
self?.fireEvent()
}
fireEvent()
}
}