This repository was archived by the owner on Feb 24, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 16
/
Copy pathUnifiedFeedbackFormViewModel.swift
330 lines (291 loc) · 12.1 KB
/
UnifiedFeedbackFormViewModel.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
//
// UnifiedFeedbackFormViewModel.swift
//
// Copyright © 2023 DuckDuckGo. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
import Foundation
import Combine
import SwiftUI
import PixelKit
import Networking
import Subscription
protocol UnifiedFeedbackFormViewModelDelegate: AnyObject {
func feedbackViewModelDismissedView(_ viewModel: UnifiedFeedbackFormViewModel)
}
final class UnifiedFeedbackFormViewModel: ObservableObject {
private static let feedbackEndpoint = URL(string: "https://subscriptions.duckduckgo.com/api/feedback")!
private static let platform = "macos"
enum ViewState {
case feedbackPending
case feedbackSending
case feedbackSendingFailed
case feedbackSent
var canSubmit: Bool {
switch self {
case .feedbackPending: return true
case .feedbackSending: return false
case .feedbackSendingFailed: return true
case .feedbackSent: return false
}
}
}
enum Error: String, Swift.Error {
case missingAccessToken
case invalidResponse
}
enum ViewAction {
case cancel
case submit
case faqClick
case reportShow
case reportSubmitShow
case reportFAQClick
}
struct Payload: Codable {
let userEmail: String
let feedbackSource: String
let platform: String
let problemCategory: String
let feedbackText: String
let problemSubCategory: String
let customMetadata: String
func toData() -> Data? {
try? JSONEncoder().encode(self)
}
}
struct Response: Codable {
let message: String?
let error: String?
}
@Published var viewState: ViewState {
didSet {
updateSubmitButtonStatus()
}
}
@Published var feedbackFormText: String = "" {
didSet {
updateSubmitButtonStatus()
}
}
@Published private(set) var submitButtonEnabled: Bool = false
@Published var selectedReportType: String = UnifiedFeedbackReportType.prompt.rawValue {
didSet {
let defaultCategory: UnifiedFeedbackCategory
switch source {
case .ppro: defaultCategory = .subscription
case .vpn: defaultCategory = .vpn
case .pir: defaultCategory = .pir
case .itr: defaultCategory = .itr
default: defaultCategory = .prompt
}
selectedCategory = defaultCategory.rawValue
updateSubmitShowStatus()
}
}
@Published var selectedCategory: String = UnifiedFeedbackCategory.prompt.rawValue {
didSet {
selectedSubcategory = selectedSubcategoryPrompt
updateSubmitShowStatus()
}
}
@Published var selectedSubcategory = "" {
didSet {
updateSubmitShowStatus()
}
}
@Published var userEmail = "" {
didSet {
updateSubmitButtonStatus()
}
}
private var selectedSubcategoryPrompt: String {
switch UnifiedFeedbackCategory(rawValue: selectedCategory) {
case .selectFeature, nil: return ""
case .subscription: return PrivacyProFeedbackSubcategory.prompt.rawValue
case .vpn: return VPNFeedbackSubcategory.prompt.rawValue
case .pir: return PIRFeedbackSubcategory.prompt.rawValue
case .itr: return ITRFeedbackSubcategory.prompt.rawValue
}
}
@Published var needsSubmitShowReport = false
var usesCompactForm: Bool {
switch UnifiedFeedbackReportType(rawValue: selectedReportType) {
case .reportIssue:
return false
default:
return true
}
}
weak var delegate: UnifiedFeedbackFormViewModelDelegate?
private let accountManager: any AccountManager
private let apiService: any Networking.APIService
private let vpnMetadataCollector: any UnifiedMetadataCollector
private let defaultMetadataCollector: any UnifiedMetadataCollector
private let feedbackSender: any UnifiedFeedbackSender
let source: UnifiedFeedbackSource
private(set) var availableCategories: [UnifiedFeedbackCategory] = [.selectFeature, .subscription]
init(subscriptionManager: any SubscriptionManager,
apiService: any Networking.APIService,
vpnMetadataCollector: any UnifiedMetadataCollector,
defaultMetadataCollector: any UnifiedMetadataCollector = EmptyMetadataCollector(),
feedbackSender: any UnifiedFeedbackSender = DefaultFeedbackSender(),
source: UnifiedFeedbackSource = .default) {
self.viewState = .feedbackPending
self.accountManager = subscriptionManager.accountManager
self.apiService = apiService
self.vpnMetadataCollector = vpnMetadataCollector
self.defaultMetadataCollector = defaultMetadataCollector
self.feedbackSender = feedbackSender
self.source = source
Task {
let features = await subscriptionManager.currentSubscriptionFeatures()
if features.contains(.networkProtection) {
availableCategories.append(.vpn)
}
if features.contains(.dataBrokerProtection) {
availableCategories.append(.pir)
}
if features.contains(.identityTheftRestoration) || features.contains(.identityTheftRestorationGlobal) {
availableCategories.append(.itr)
}
}
}
@MainActor
func process(action: ViewAction) async {
switch action {
case .cancel:
delegate?.feedbackViewModelDismissedView(self)
case .submit:
self.viewState = .feedbackSending
do {
try await sendFeedback()
self.viewState = .feedbackSent
} catch {
self.viewState = .feedbackSendingFailed
}
case .faqClick:
await openFAQ()
case .reportShow:
feedbackSender.sendFormShowPixel()
case .reportSubmitShow:
feedbackSender.sendSubmitScreenShowPixel(source: source,
reportType: selectedReportType,
category: selectedCategory,
subcategory: selectedSubcategory)
needsSubmitShowReport = false
case .reportFAQClick:
feedbackSender.sendSubmitScreenFAQClickPixel(source: source,
reportType: selectedReportType,
category: selectedCategory,
subcategory: selectedSubcategory)
}
}
private func openFAQ() async {
guard !selectedReportType.isEmpty, UnifiedFeedbackReportType(rawValue: selectedReportType) == .reportIssue,
!selectedCategory.isEmpty, let category = UnifiedFeedbackCategory(rawValue: selectedCategory),
!selectedSubcategory.isEmpty else {
return
}
let url: URL? = {
switch category {
case .selectFeature: return nil
case .subscription: return PrivacyProFeedbackSubcategory(rawValue: selectedSubcategory)?.url
case .vpn: return VPNFeedbackSubcategory(rawValue: selectedSubcategory)?.url
case .pir: return PIRFeedbackSubcategory(rawValue: selectedSubcategory)?.url
case .itr: return ITRFeedbackSubcategory(rawValue: selectedSubcategory)?.url
}
}()
if let url {
NSWorkspace.shared.open(url)
}
}
private func sendFeedback() async throws {
switch UnifiedFeedbackReportType(rawValue: selectedReportType) {
case .selectReportType, nil:
return
case .requestFeature:
try await feedbackSender.sendFeatureRequestPixel(description: feedbackFormText,
source: source)
case .general:
try await feedbackSender.sendGeneralFeedbackPixel(description: feedbackFormText,
source: source)
case .reportIssue:
try await reportProblem()
}
}
private func reportProblem() async throws {
switch UnifiedFeedbackCategory(rawValue: selectedCategory) {
case .vpn:
let metadata = await vpnMetadataCollector.collectMetadata()
try await submitIssue(metadata: metadata)
try await feedbackSender.sendReportIssuePixel(source: source,
category: selectedCategory,
subcategory: selectedSubcategory,
description: feedbackFormText,
metadata: metadata as? VPNMetadata)
default:
let metadata = await defaultMetadataCollector.collectMetadata()
try await submitIssue(metadata: metadata)
try await feedbackSender.sendReportIssuePixel(source: source,
category: selectedCategory,
subcategory: selectedSubcategory,
description: feedbackFormText,
metadata: metadata as? EmptyFeedbackMetadata)
}
}
private func submitIssue(metadata: UnifiedFeedbackMetadata?) async throws {
guard !userEmail.isEmpty else { return }
guard let accessToken = accountManager.accessToken else {
throw Error.missingAccessToken
}
let payload = Payload(userEmail: userEmail,
feedbackSource: source.rawValue,
platform: Self.platform,
problemCategory: selectedCategory,
feedbackText: feedbackFormText,
problemSubCategory: selectedSubcategory,
customMetadata: metadata?.toString() ?? "")
let headers = APIRequestV2.HeadersV2(additionalHeaders: [HTTPHeaderKey.authorization: "Bearer \(accessToken)"])
guard let request = APIRequestV2(url: Self.feedbackEndpoint, method: .post, headers: headers, body: payload.toData()) else {
assertionFailure("Invalid request")
return
}
let response: Response = try await apiService.fetch(request: request).decodeBody()
if let error = response.error, !error.isEmpty {
throw Error.invalidResponse
}
}
private func updateSubmitButtonStatus() {
self.submitButtonEnabled = viewState.canSubmit && !feedbackFormText.isEmpty && (userEmail.isEmpty || userEmail.isValidEmail)
}
private func updateSubmitShowStatus() {
needsSubmitShowReport = {
switch UnifiedFeedbackReportType(rawValue: selectedReportType) {
case .selectReportType, nil:
return false
case .requestFeature, .general:
return true
case .reportIssue:
return selectedCategory != UnifiedFeedbackCategory.prompt.rawValue && selectedSubcategory != selectedSubcategoryPrompt
}
}()
}
}
private extension String {
var isValidEmail: Bool {
guard let regex = try? NSRegularExpression(pattern: #"[^\s]+@[^\s]+\.[^\s]+"#) else { return false }
return matches(regex)
}
}