-
Notifications
You must be signed in to change notification settings - Fork 22
/
TrackableSuperwallEvent.swift
583 lines (528 loc) · 16.8 KB
/
TrackableSuperwallEvent.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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
//
// File.swift
//
//
// Created by Yusuf Tör on 20/04/2022.
//
// swiftlint:disable type_body_length nesting file_length type_body_length
import Foundation
import StoreKit
protocol TrackableSuperwallEvent: Trackable {
/// The ``SuperwallEvent`` to be tracked by this event.
var superwallEvent: SuperwallEvent { get }
}
extension TrackableSuperwallEvent {
var rawName: String {
return String(describing: superwallEvent)
}
var canImplicitlyTriggerPaywall: Bool {
return superwallEvent.canImplicitlyTriggerPaywall
}
}
/// These are events that tracked internally and sent back to the user via the delegate.
enum InternalSuperwallEvent {
struct AppOpen: TrackableSuperwallEvent {
let superwallEvent: SuperwallEvent = .appOpen
var customParameters: [String: Any] = [:]
func getSuperwallParameters() async -> [String: Any] { [:] }
}
struct AppInstall: TrackableSuperwallEvent {
let superwallEvent: SuperwallEvent = .appInstall
let appInstalledAtString: String
let hasExternalPurchaseController: Bool
var customParameters: [String: Any] = [:]
func getSuperwallParameters() async -> [String: Any] {
return [
"application_installed_at": appInstalledAtString,
"using_purchase_controller": hasExternalPurchaseController
]
}
}
struct TouchesBegan: TrackableSuperwallEvent {
let superwallEvent: SuperwallEvent = .touchesBegan
var customParameters: [String: Any] = [:]
func getSuperwallParameters() async -> [String: Any] { [:] }
}
struct SurveyClose: TrackableSuperwallEvent {
let superwallEvent: SuperwallEvent = .surveyClose
var customParameters: [String: Any] = [:]
func getSuperwallParameters() async -> [String: Any] { [:] }
}
struct SurveyResponse: TrackableSuperwallEvent {
var superwallEvent: SuperwallEvent {
return .surveyResponse(
survey: survey,
selectedOption: selectedOption,
customResponse: customResponse,
paywallInfo: paywallInfo
)
}
var customParameters: [String: Any] {
let output = paywallInfo.customParams()
return output + [
"survey_selected_option_title": selectedOption.title,
"survey_custom_response": customResponse as Any
]
}
let survey: Survey
let selectedOption: SurveyOption
let customResponse: String?
let paywallInfo: PaywallInfo
func getSuperwallParameters() async -> [String: Any] {
let params: [String: Any] = [
"survey_id": survey.id,
"survey_assignment_key": survey.assignmentKey,
"survey_selected_option_id": selectedOption.id
]
return await paywallInfo.eventParams(otherParams: params)
}
}
struct AppLaunch: TrackableSuperwallEvent {
let superwallEvent: SuperwallEvent = .appLaunch
var customParameters: [String: Any] = [:]
func getSuperwallParameters() async -> [String: Any] { [:] }
}
struct Attributes: TrackableSuperwallEvent {
let appInstalledAtString: String
var superwallEvent: SuperwallEvent {
return .userAttributes(customParameters)
}
func getSuperwallParameters() async -> [String: Any] {
return [
"application_installed_at": appInstalledAtString
]
}
var customParameters: [String: Any] = [:]
}
struct DeepLink: TrackableSuperwallEvent {
var superwallEvent: SuperwallEvent {
.deepLink(url: url)
}
let url: URL
func getSuperwallParameters() async -> [String: Any] {
return [
"url": url.absoluteString,
"path": url.path,
"pathExtension": url.pathExtension,
"lastPathComponent": url.lastPathComponent,
"host": url.host ?? "",
"query": url.query ?? "",
"fragment": url.fragment ?? ""
]
}
var customParameters: [String: Any] {
guard let urlComponents = URLComponents(
url: url,
resolvingAgainstBaseURL: false
) else {
return [:]
}
guard let queryItems = urlComponents.queryItems else {
return [:]
}
var queryStrings: [String: Any] = [:]
for queryItem in queryItems {
guard
!queryItem.name.isEmpty,
let value = queryItem.value,
!value.isEmpty
else {
continue
}
let name = queryItem.name
let lowerCaseValue = value.lowercased()
if lowerCaseValue == "true" {
queryStrings[name] = true
} else if lowerCaseValue == "false" {
queryStrings[name] = false
} else if let int = Int(value) {
queryStrings[name] = int
} else if let double = Double(value) {
queryStrings[name] = double
} else {
queryStrings[name] = value
}
}
return queryStrings
}
}
struct FirstSeen: TrackableSuperwallEvent {
let superwallEvent: SuperwallEvent = .firstSeen
var customParameters: [String: Any] = [:]
func getSuperwallParameters() async -> [String: Any] { [:] }
}
struct AppClose: TrackableSuperwallEvent {
let superwallEvent: SuperwallEvent = .appClose
var customParameters: [String: Any] = [:]
func getSuperwallParameters() async -> [String: Any] { [:] }
}
struct SessionStart: TrackableSuperwallEvent {
let superwallEvent: SuperwallEvent = .sessionStart
var customParameters: [String: Any] = [:]
func getSuperwallParameters() async -> [String: Any] { [:] }
}
struct PaywallLoad: TrackableSuperwallEvent {
enum State {
case start
case notFound
case fail
case complete(paywallInfo: PaywallInfo)
}
let state: State
var superwallEvent: SuperwallEvent {
switch state {
case .start:
return .paywallResponseLoadStart(triggeredEventName: eventData?.name)
case .notFound:
return .paywallResponseLoadNotFound(triggeredEventName: eventData?.name)
case .fail:
return .paywallResponseLoadFail(triggeredEventName: eventData?.name)
case .complete(let paywallInfo):
return .paywallResponseLoadComplete(
triggeredEventName: eventData?.name,
paywallInfo: paywallInfo
)
}
}
let eventData: EventData?
var customParameters: [String: Any] {
switch state {
case .complete(paywallInfo: let paywallInfo):
return paywallInfo.customParams()
default:
return [:]
}
}
func getSuperwallParameters() async -> [String: Any] {
let fromEvent = eventData != nil
let params: [String: Any] = [
"is_triggered_from_event": fromEvent
]
switch state {
case .start,
.notFound,
.fail:
return params
case .complete(let paywallInfo):
return await paywallInfo.eventParams(otherParams: params)
}
}
}
struct SubscriptionStatusDidChange: TrackableSuperwallEvent {
let superwallEvent: SuperwallEvent = .subscriptionStatusDidChange
let subscriptionStatus: SubscriptionStatus
var customParameters: [String: Any] = [:]
func getSuperwallParameters() async -> [String: Any] {
return [
"subscription_status": subscriptionStatus.description
]
}
}
struct TriggerFire: TrackableSuperwallEvent {
let triggerResult: InternalTriggerResult
var superwallEvent: SuperwallEvent {
return .triggerFire(
eventName: triggerName,
result: triggerResult.toPublicType()
)
}
let triggerName: String
var customParameters: [String: Any] = [:]
unowned let sessionEventsManager: SessionEventsManager
func getSuperwallParameters() async -> [String: Any] {
var params: [String: Any] = [
"trigger_name": triggerName
]
if let triggerSession = await sessionEventsManager.triggerSession.activeTriggerSession {
params["trigger_session_id"] = triggerSession.id
}
switch triggerResult {
case .noRuleMatch(let unmatchedRules):
params += [
"result": "no_rule_match"
]
for unmatchedRule in unmatchedRules {
params["unmatched_rule_\(unmatchedRule.experimentId)"] = unmatchedRule.source.rawValue
}
return params
case .holdout(let experiment):
return params + [
"variant_id": experiment.variant.id as Any,
"experiment_id": experiment.id as Any,
"result": "holdout"
]
case let .paywall(experiment):
return params + [
"variant_id": experiment.variant.id as Any,
"experiment_id": experiment.id as Any,
"paywall_identifier": experiment.variant.paywallId as Any,
"result": "present"
]
case .eventNotFound:
return params + [
"result": "eventNotFound"
]
case .error:
return params + [
"result": "error"
]
}
}
}
struct PresentationRequest: TrackableSuperwallEvent {
let eventData: EventData?
let type: PresentationRequestType
let status: PaywallPresentationRequestStatus
let statusReason: PaywallPresentationRequestStatusReason?
let factory: RuleAttributesFactory & FeatureFlagsFactory & ComputedPropertyRequestsFactory
var superwallEvent: SuperwallEvent {
return .paywallPresentationRequest(
status: status,
reason: statusReason
)
}
var customParameters: [String: Any] = [:]
func getSuperwallParameters() async -> [String: Any] {
var params = [
"source_event_name": eventData?.name ?? "",
"pipeline_type": type.description,
"status": status.rawValue,
"status_reason": statusReason?.description ?? ""
]
if let featureFlags = factory.makeFeatureFlags(),
featureFlags.enableExpressionParameters {
let computedPropertyRequests = factory.makeComputedPropertyRequests()
let rules = await factory.makeRuleAttributes(
forEvent: eventData,
withComputedProperties: computedPropertyRequests
)
if let rulesDictionary = rules.dictionaryObject,
let jsonData = try? JSONSerialization.data(withJSONObject: rulesDictionary),
let decoded = String(data: jsonData, encoding: .utf8) {
params += [
"expression_params": decoded
]
}
}
return params
}
}
struct PaywallOpen: TrackableSuperwallEvent {
var superwallEvent: SuperwallEvent {
return .paywallOpen(paywallInfo: paywallInfo)
}
let paywallInfo: PaywallInfo
func getSuperwallParameters() async -> [String: Any] {
return await paywallInfo.eventParams()
}
var customParameters: [String: Any] {
return paywallInfo.customParams()
}
}
struct PaywallClose: TrackableSuperwallEvent {
var superwallEvent: SuperwallEvent {
return .paywallClose(paywallInfo: paywallInfo)
}
let paywallInfo: PaywallInfo
let surveyPresentationResult: SurveyPresentationResult
func getSuperwallParameters() async -> [String: Any] {
var params: [String: Any] = [
"survey_attached": paywallInfo.surveys.isEmpty ? false : true
]
if surveyPresentationResult != .noShow {
params["survey_presentation"] = surveyPresentationResult.rawValue
}
let eventParams = await paywallInfo.eventParams()
params += eventParams
return params
}
var customParameters: [String: Any] {
return paywallInfo.customParams()
}
}
struct PaywallDecline: TrackableSuperwallEvent {
var superwallEvent: SuperwallEvent {
return .paywallDecline(paywallInfo: paywallInfo)
}
let paywallInfo: PaywallInfo
func getSuperwallParameters() async -> [String: Any] {
return await paywallInfo.eventParams()
}
var customParameters: [String: Any] {
return paywallInfo.customParams()
}
}
struct Transaction: TrackableSuperwallEvent {
enum State {
case start(StoreProduct)
case fail(TransactionError)
case abandon(StoreProduct)
case complete(StoreProduct, StoreTransaction?)
case restore
case timeout
}
let state: State
var superwallEvent: SuperwallEvent {
switch state {
case .start(let product):
return .transactionStart(
product: product,
paywallInfo: paywallInfo
)
case .fail(let error):
return .transactionFail(
error: error,
paywallInfo: paywallInfo
)
case .abandon(let product):
return .transactionAbandon(
product: product,
paywallInfo: paywallInfo
)
case let .complete(product, model):
return .transactionComplete(
transaction: model,
product: product,
paywallInfo: paywallInfo
)
case .restore:
return .transactionRestore(paywallInfo: paywallInfo)
case .timeout:
return .transactionTimeout(paywallInfo: paywallInfo)
}
}
let paywallInfo: PaywallInfo
let product: StoreProduct?
let model: StoreTransaction?
var customParameters: [String: Any] {
return paywallInfo.customParams()
}
func getSuperwallParameters() async -> [String: Any] {
switch state {
case .start,
.abandon,
.complete,
.restore,
.timeout:
var eventParams = await paywallInfo.eventParams(forProduct: product)
if let transactionDict = model?.dictionary(withSnakeCase: true) {
eventParams += transactionDict
}
return eventParams
case .fail(let error):
switch error {
case .failure(let message, _),
.pending(let message):
return await paywallInfo.eventParams(
forProduct: product,
otherParams: ["message": message]
)
}
}
}
}
struct SubscriptionStart: TrackableSuperwallEvent {
var superwallEvent: SuperwallEvent {
return .subscriptionStart(product: product, paywallInfo: paywallInfo)
}
let paywallInfo: PaywallInfo
let product: StoreProduct
var customParameters: [String: Any] {
return paywallInfo.customParams()
}
func getSuperwallParameters() async -> [String: Any] {
return await paywallInfo.eventParams(forProduct: product)
}
}
struct FreeTrialStart: TrackableSuperwallEvent {
var superwallEvent: SuperwallEvent {
return .freeTrialStart(
product: product,
paywallInfo: paywallInfo
)
}
let paywallInfo: PaywallInfo
let product: StoreProduct
var customParameters: [String: Any] {
return paywallInfo.customParams()
}
func getSuperwallParameters() async -> [String: Any] {
return await paywallInfo.eventParams(forProduct: product)
}
}
struct NonRecurringProductPurchase: TrackableSuperwallEvent {
var superwallEvent: SuperwallEvent {
return .nonRecurringProductPurchase(
product: .init(product: product),
paywallInfo: paywallInfo
)
}
let paywallInfo: PaywallInfo
let product: StoreProduct
var customParameters: [String: Any] {
return paywallInfo.customParams()
}
func getSuperwallParameters() async -> [String: Any] {
return await paywallInfo.eventParams(forProduct: product)
}
}
struct PaywallWebviewLoad: TrackableSuperwallEvent {
enum State {
case start
case fail
case timeout
case complete
}
let state: State
var superwallEvent: SuperwallEvent {
switch state {
case .start:
return .paywallWebviewLoadStart(paywallInfo: paywallInfo)
case .fail:
return .paywallWebviewLoadFail(paywallInfo: paywallInfo)
case .timeout:
return .paywallWebviewLoadTimeout(paywallInfo: paywallInfo)
case .complete:
return .paywallWebviewLoadComplete(paywallInfo: paywallInfo)
}
}
let paywallInfo: PaywallInfo
func getSuperwallParameters() async -> [String: Any] {
return await paywallInfo.eventParams()
}
var customParameters: [String: Any] {
return paywallInfo.customParams()
}
}
struct PaywallProductsLoad: TrackableSuperwallEvent {
enum State {
case start
case fail
case complete
}
let state: State
var customParameters: [String: Any] {
return paywallInfo.customParams()
}
var superwallEvent: SuperwallEvent {
switch state {
case .start:
return .paywallProductsLoadStart(triggeredEventName: eventData?.name, paywallInfo: paywallInfo)
case .fail:
return .paywallProductsLoadFail(triggeredEventName: eventData?.name, paywallInfo: paywallInfo)
case .complete:
return .paywallProductsLoadComplete(triggeredEventName: eventData?.name)
}
}
let paywallInfo: PaywallInfo
let eventData: EventData?
func getSuperwallParameters() async -> [String: Any] {
let fromEvent = eventData != nil
var params: [String: Any] = [
"is_triggered_from_event": fromEvent
]
params += await paywallInfo.eventParams()
return params
}
}
}