-
-
Notifications
You must be signed in to change notification settings - Fork 756
/
WMFAltTextDataController.swift
370 lines (294 loc) · 12.8 KB
/
WMFAltTextDataController.swift
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
import Foundation
import UIKit
public final class WMFAltTextDataController {
struct OnboardingStatus: Codable {
var hasPresentedOnboardingModal: Bool
var hasPresentedOnboardingTooltips: Bool
static var `default`: OnboardingStatus {
return OnboardingStatus(hasPresentedOnboardingModal: false, hasPresentedOnboardingTooltips: false)
}
}
public static let shared = WMFAltTextDataController()
public lazy var experimentStopDate: Date? = {
var dateComponents = DateComponents()
dateComponents.year = 2024
dateComponents.month = 11
dateComponents.day = 5
return Calendar.current.date(from: dateComponents)
}()
public enum WMFAltTextDataControllerError: Error {
case notPermanent
case invalidProject
case invalidDeviceOrOS
case invalidDate
case unexpectedBucketValue
case alreadyAssignedThisExperiment
case alreadyAssignedOtherExperiment
}
private let experimentsDataController: WMFExperimentsDataController
private let developerSettingsDataController: WMFDeveloperSettingsDataController
private let userDefaultsStore: WMFKeyValueStore
private var experimentPercentage: Int {
developerSettingsDataController.alwaysShowAltTextEntryPoint ? 100 : 50
}
// MARK: - Public
public init?(experimentStore: WMFKeyValueStore? = WMFDataEnvironment.current.sharedCacheStore, userDefaultsStore: WMFKeyValueStore? = WMFDataEnvironment.current.userDefaultsStore) {
guard let experimentStore,
let userDefaultsStore else {
return nil
}
self.experimentsDataController = WMFExperimentsDataController(store: experimentStore)
self.developerSettingsDataController = WMFDeveloperSettingsDataController.shared
self.userDefaultsStore = userDefaultsStore
}
public func assignImageRecsExperiment(isPermanent: Bool, project: WMFProject) throws {
guard isPermanent else {
throw WMFAltTextDataControllerError.notPermanent
}
guard project.qualifiesForAltTextExperiments(developerSettingsDataController: developerSettingsDataController) else {
throw WMFAltTextDataControllerError.invalidProject
}
guard isValidDeviceAndOS else {
throw WMFAltTextDataControllerError.invalidDeviceOrOS
}
guard isBeforeEndDate else {
throw WMFAltTextDataControllerError.invalidDate
}
if !developerSettingsDataController.alwaysShowAltTextEntryPoint {
if experimentsDataController.bucketForExperiment(.altTextImageRecommendations) != nil {
throw WMFAltTextDataControllerError.alreadyAssignedThisExperiment
}
}
if !developerSettingsDataController.alwaysShowAltTextEntryPoint {
if let articleEditorExperimentBucket = experimentsDataController.bucketForExperiment(.altTextArticleEditor) {
switch articleEditorExperimentBucket {
case .altTextArticleEditorTest:
throw WMFAltTextDataControllerError.alreadyAssignedOtherExperiment
case .altTextArticleEditorControl:
break
default:
throw WMFAltTextDataControllerError.unexpectedBucketValue
}
}
}
try experimentsDataController.determineBucketForExperiment(.altTextImageRecommendations, withPercentage: experimentPercentage)
}
public func assignArticleEditorExperiment(isPermanent: Bool, project: WMFProject) throws {
guard isPermanent else {
throw WMFAltTextDataControllerError.notPermanent
}
guard project.qualifiesForAltTextExperiments(developerSettingsDataController: developerSettingsDataController) else {
throw WMFAltTextDataControllerError.invalidProject
}
guard isValidDeviceAndOS else {
throw WMFAltTextDataControllerError.invalidDeviceOrOS
}
guard isBeforeEndDate else {
throw WMFAltTextDataControllerError.invalidDate
}
if !developerSettingsDataController.alwaysShowAltTextEntryPoint {
if experimentsDataController.bucketForExperiment(.altTextArticleEditor) != nil {
throw WMFAltTextDataControllerError.alreadyAssignedThisExperiment
}
}
if !developerSettingsDataController.alwaysShowAltTextEntryPoint {
if let imageRecommendationsExperimentBucket = experimentsDataController.bucketForExperiment(.altTextImageRecommendations) {
switch imageRecommendationsExperimentBucket {
case .altTextImageRecommendationsTest:
throw WMFAltTextDataControllerError.alreadyAssignedOtherExperiment
case .altTextImageRecommendationsControl:
break
default:
throw WMFAltTextDataControllerError.unexpectedBucketValue
}
}
}
try experimentsDataController.determineBucketForExperiment(.altTextArticleEditor, withPercentage: experimentPercentage)
}
public func markSawAltTextImageRecommendationsPrompt() {
self.sawAltTextImageRecommendationsPrompt = true
}
public func shouldEnterAltTextImageRecommendationsFlow(isPermanent: Bool, project: WMFProject) -> Bool {
if !developerSettingsDataController.alwaysShowAltTextEntryPoint {
guard sawAltTextImageRecommendationsPrompt == false && sawAltTextArticleEditorPrompt == false else {
return false
}
}
guard isPermanent else {
return false
}
guard project.qualifiesForAltTextExperiments(developerSettingsDataController: developerSettingsDataController) else {
return false
}
guard isValidDeviceAndOS else {
return false
}
guard isBeforeEndDate else {
return false
}
guard let imageRecommendationsExperimentBucket = experimentsDataController.bucketForExperiment(.altTextImageRecommendations) else {
return false
}
switch imageRecommendationsExperimentBucket {
case .altTextImageRecommendationsTest:
return true
default:
return false
}
}
public func markSawAltTextArticleEditorPrompt() {
self.sawAltTextArticleEditorPrompt = true
}
public func shouldFetchFullArticleWikitextFromArticleEditor(isPermanent: Bool, project: WMFProject) -> Bool {
// haven't already seen the prompt elsewhere
if !developerSettingsDataController.alwaysShowAltTextEntryPoint {
guard sawAltTextImageRecommendationsPrompt == false && sawAltTextArticleEditorPrompt == false else {
return false
}
}
// is permanent
guard isPermanent else {
return false
}
// is looking at the target experiment wikis
guard project.qualifiesForAltTextExperiments(developerSettingsDataController: developerSettingsDataController) else {
return false
}
// iPhone, iOS 16+
guard isValidDeviceAndOS else {
return false
}
// Before Oct 10
guard isBeforeEndDate else {
return false
}
// Hasn't already been assigned the alt text editor experiment
if !developerSettingsDataController.alwaysShowAltTextEntryPoint {
guard experimentsDataController.bucketForExperiment(.altTextArticleEditor) == nil else {
return false
}
}
return true
}
public func shouldEnterAltTextArticleEditorFlow(isPermanent: Bool, project: WMFProject) -> Bool {
if !developerSettingsDataController.alwaysShowAltTextEntryPoint {
guard sawAltTextImageRecommendationsPrompt == false && sawAltTextArticleEditorPrompt == false else {
return false
}
}
guard isPermanent else {
return false
}
guard project.qualifiesForAltTextExperiments(developerSettingsDataController: developerSettingsDataController) else {
return false
}
guard isValidDeviceAndOS else {
return false
}
guard isBeforeEndDate else {
return false
}
guard let articleEditorExperimentBucket = experimentsDataController.bucketForExperiment(.altTextArticleEditor) else {
return false
}
switch articleEditorExperimentBucket {
case .altTextArticleEditorTest:
return true
default:
return false
}
}
public func assignedAltTextImageRecommendationsGroupForLogging() -> String? {
if let imageRecommendationsExperimentBucket = experimentsDataController.bucketForExperiment(.altTextImageRecommendations) {
switch imageRecommendationsExperimentBucket {
case .altTextImageRecommendationsTest:
return "B"
case .altTextImageRecommendationsControl:
return "A"
default:
break
}
}
return nil
}
public func assignedAltTextArticleEditorGroupForLogging() -> String? {
if let articleEditorExperimentBucket = experimentsDataController.bucketForExperiment(.altTextArticleEditor) {
switch articleEditorExperimentBucket {
case .altTextArticleEditorTest:
return "C"
case .altTextArticleEditorControl:
return "D"
default:
break
}
}
return nil
}
// MARK: - Onboarding
private var onboardingStatus: OnboardingStatus {
return (try? userDefaultsStore.load(key: WMFUserDefaultsKey.altTextExperimentOnboarding.rawValue)) ?? OnboardingStatus.default
}
public var hasPresentedOnboardingModal: Bool {
get {
return onboardingStatus.hasPresentedOnboardingModal
} set {
var currentOnboardingStatus = onboardingStatus
currentOnboardingStatus.hasPresentedOnboardingModal = newValue
try? userDefaultsStore.save(key: WMFUserDefaultsKey.altTextExperimentOnboarding.rawValue, value: currentOnboardingStatus)
}
}
public var hasPresentedOnboardingTooltips: Bool {
get {
return onboardingStatus.hasPresentedOnboardingTooltips
} set {
var currentOnboardingStatus = onboardingStatus
currentOnboardingStatus.hasPresentedOnboardingTooltips = newValue
try? userDefaultsStore.save(key: WMFUserDefaultsKey.altTextExperimentOnboarding.rawValue, value: currentOnboardingStatus)
}
}
// MARK: - Private
private var isValidDeviceAndOS: Bool {
if #available(iOS 16, *) {
return UIDevice.current.userInterfaceIdiom == UIUserInterfaceIdiom.phone
} else {
return false
}
}
private var isBeforeEndDate: Bool {
guard let experimentStopDate else {
return false
}
return experimentStopDate >= Date()
}
private var sawAltTextImageRecommendationsPrompt: Bool {
get {
return (try? userDefaultsStore.load(key: WMFUserDefaultsKey.sawAltTextImageRecommendationsPrompt.rawValue)) ?? false
} set {
try? userDefaultsStore.save(key: WMFUserDefaultsKey.sawAltTextImageRecommendationsPrompt.rawValue, value: newValue)
}
}
private var sawAltTextArticleEditorPrompt: Bool {
get {
return (try? userDefaultsStore.load(key: WMFUserDefaultsKey.sawAltTextArticleEditorPrompt.rawValue)) ?? false
} set {
try? userDefaultsStore.save(key: WMFUserDefaultsKey.sawAltTextArticleEditorPrompt.rawValue, value: newValue)
}
}
}
private extension WMFProject {
func qualifiesForAltTextExperiments(developerSettingsDataController: WMFDeveloperSettingsDataController) -> Bool {
switch self {
case .wikipedia(let language):
switch language.languageCode {
case "es", "fr", "pt", "zh", "test":
return true
case "en":
return developerSettingsDataController.enableAltTextExperimentForEN
default:
return false
}
default:
return false
}
}
}