summaryrefslogtreecommitdiffhomepage
path: root/ios/MullvadVPN/AddressCache/AddressCacheTracker.swift
blob: 70397032caa4b2212cd6343fc090ae505772fa55 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
//
//  AddressCacheTracker.swift
//  MullvadVPN
//
//  Created by pronebird on 08/12/2021.
//  Copyright © 2021 Mullvad VPN AB. All rights reserved.
//

import UIKit
import Logging

extension AddressCache {

    class Tracker {
        /// Shared instance.
        static let shared: AddressCache.Tracker = {
            return AddressCache.Tracker(
                apiProxy: REST.ProxyFactory.shared.createAPIProxy(),
                store: AddressCache.Store.shared
            )
        }()

        /// Update interval (in seconds).
        private static let updateInterval: TimeInterval = 60 * 60 * 24

        /// Retry interval (in seconds).
        private static let retryInterval: TimeInterval = 60 * 15

        /// Logger.
        private let logger = Logger(label: "AddressCache.Tracker")

        /// REST API proxy.
        private let apiProxy: REST.APIProxy

        /// Store.
        private let store: AddressCache.Store

        /// A flag that indicates whether periodic updates are running
        private var isPeriodicUpdatesEnabled = false

        /// The date of last failed attempt.
        private var lastFailureAttemptDate: Date?

        /// Timer used for scheduling periodic updates.
        private var timer: DispatchSourceTimer?

        /// Operation queue.
        private let operationQueue: AsyncOperationQueue = {
            let operationQueue = AsyncOperationQueue()
            operationQueue.maxConcurrentOperationCount = 1
            return operationQueue
        }()

        /// Lock used for synchronizing member access.
        private let nslock = NSLock()

        /// Designated initializer
        private init(apiProxy: REST.APIProxy, store: AddressCache.Store) {
            self.apiProxy = apiProxy
            self.store = store
        }

        func startPeriodicUpdates() {
            nslock.lock()
            defer { nslock.unlock() }

            guard !isPeriodicUpdatesEnabled else {
                return
            }

            logger.debug("Start periodic address cache updates.")

            isPeriodicUpdatesEnabled = true

            let scheduleDate = _nextScheduleDate()

            logger.debug("Schedule address cache update at \(scheduleDate.logFormatDate()).")

            scheduleEndpointsUpdate(startTime: .now() + scheduleDate.timeIntervalSinceNow)
        }

        func stopPeriodicUpdates() {
            nslock.lock()
            defer { nslock.unlock() }

            guard isPeriodicUpdatesEnabled else { return }

            logger.debug("Stop periodic address cache updates.")

            isPeriodicUpdatesEnabled = false

            timer?.cancel()
            timer = nil
        }

        func updateEndpoints(
            completionHandler: ((OperationCompletion<Bool, Error>) -> Void)? = nil
        ) -> Cancellable
        {
            let operation = ResultBlockOperation<Bool, Error> { operation in
                guard self.nextScheduleDate() <= Date() else {
                    operation.finish(completion: .success(false))
                    return
                }

                let task = self.apiProxy.getAddressList(retryStrategy: .default) { completion in
                    operation.finish(
                        completion: self.handleResponse(completion: completion)
                    )
                }

                operation.addCancellationBlock {
                    task.cancel()
                }
            }

            operation.completionQueue = .main
            operation.completionHandler = completionHandler

            operation.addObserver(
                BackgroundObserver(name: "Update endpoints", cancelUponExpiration: true)
            )

            operationQueue.addOperation(operation)

            return operation
        }

        func nextScheduleDate() -> Date {
            nslock.lock()
            defer { nslock.unlock() }

            return _nextScheduleDate()
        }

        private func handleResponse(
            completion: OperationCompletion<[AnyIPEndpoint], REST.Error>
        ) -> OperationCompletion<Bool, Error>
        {
            let mappedCompletion = completion
                .flatMapError { error -> OperationCompletion<[AnyIPEndpoint], REST.Error> in
                    if case URLError.cancelled = error {
                        return .cancelled
                    } else {
                        return .failure(error)
                    }
                }
                .tryMap { endpoints -> Bool in
                    try store.setEndpoints(endpoints)

                    return true
                }

            nslock.lock()
            lastFailureAttemptDate = mappedCompletion.isSuccess ? nil : Date()
            nslock.unlock()

            if let error = mappedCompletion.error {
                logger.error(
                    chainedError: AnyChainedError(error),
                    message: "Failed to update address cache."
                )
            }

            return mappedCompletion
        }

        private func scheduleEndpointsUpdate(startTime: DispatchWallTime) {
            let newTimer = DispatchSource.makeTimerSource()
            newTimer.setEventHandler { [weak self] in
                self?.handleTimer()
            }

            newTimer.schedule(wallDeadline: startTime)
            newTimer.activate()

            timer?.cancel()
            timer = newTimer
        }

        private func handleTimer() {
            _ = updateEndpoints { _ in
                self.nslock.lock()
                defer { self.nslock.unlock() }

                guard self.isPeriodicUpdatesEnabled else { return }

                let scheduleDate = self._nextScheduleDate()

                self.logger.debug("Schedule next address cache update at \(scheduleDate.logFormatDate()).")

                self.scheduleEndpointsUpdate(startTime: .now() + scheduleDate.timeIntervalSinceNow)
            }
        }

        private func _nextScheduleDate() -> Date {
            let nextDate = lastFailureAttemptDate.map { date in
                return Date(
                    timeInterval: Self.retryInterval,
                    since: date
                )
            } ?? Date(
                timeInterval: Self.updateInterval,
                since: store.getLastUpdateDate()
            )

            return max(nextDate, Date())
        }

    }
}