-
Notifications
You must be signed in to change notification settings - Fork 629
/
IdentityAnalyticsRequestFactory.kt
316 lines (292 loc) · 12.7 KB
/
IdentityAnalyticsRequestFactory.kt
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
package com.stripe.android.identity.analytics
import android.content.Context
import com.stripe.android.core.networking.AnalyticsRequestV2
import com.stripe.android.core.networking.AnalyticsRequestV2Factory
import com.stripe.android.identity.IdentityVerificationSheetContract
import com.stripe.android.identity.networking.models.DocumentUploadParam
import com.stripe.android.identity.states.IdentityScanState
import javax.inject.Inject
/**
* Factory for creating [AnalyticsRequestV2] for Identity.
*/
internal class IdentityAnalyticsRequestFactory @Inject constructor(
context: Context,
private val args: IdentityVerificationSheetContract.Args
) {
private val requestFactory = AnalyticsRequestV2Factory(
context = context,
clientId = CLIENT_ID,
origin = ORIGIN
)
private fun additionalParamWithEventMetadata(vararg pairs: Pair<String, *>) =
mapOf(
PARAM_VERIFICATION_SESSION to args.verificationSessionId,
PARAM_EVENT_META_DATA to mapOf(*pairs)
)
fun sheetPresented() = requestFactory.createRequest(
EVENT_SHEET_PRESENTED,
additionalParams = additionalParamWithEventMetadata()
)
fun sheetClosed(sessionResult: String) = requestFactory.createRequest(
eventName = EVENT_SHEET_CLOSED,
additionalParams = additionalParamWithEventMetadata(
PARAM_SESSION_RESULT to sessionResult
)
)
fun verificationSucceeded(
isFromFallbackUrl: Boolean,
scanType: IdentityScanState.ScanType? = null,
requireSelfie: Boolean? = null,
docFrontRetryTimes: Int? = null,
docBackRetryTimes: Int? = null,
selfieRetryTimes: Int? = null,
docFrontUploadType: DocumentUploadParam.UploadMethod? = null,
docBackUploadType: DocumentUploadParam.UploadMethod? = null,
docFrontModelScore: Float? = null,
docBackModelScore: Float? = null,
selfieModelScore: Float? = null
) = requestFactory.createRequest(
eventName = EVENT_VERIFICATION_SUCCEEDED,
additionalParams = additionalParamWithEventMetadata(
PARAM_FROM_FALLBACK_URL to isFromFallbackUrl,
PARAM_SCAN_TYPE to scanType?.toParam(),
PARAM_REQUIRE_SELFIE to requireSelfie,
PARAM_DOC_FRONT_RETRY_TIMES to docFrontRetryTimes,
PARAM_DOC_BACK_RETRY_TIMES to docBackRetryTimes,
PARAM_SELFIE_RETRY_TIMES to selfieRetryTimes,
PARAM_DOC_FRONT_UPLOAD_TYPE to docFrontUploadType?.name,
PARAM_DOC_BACK_UPLOAD_TYPE to docBackUploadType?.name,
PARAM_DOC_FRONT_MODEL_SCORE to docFrontModelScore,
PARAM_DOC_BACK_MODEL_SCORE to docBackModelScore,
PARAM_SELFIE_MODEL_SCORE to selfieModelScore
)
)
fun verificationCanceled(
isFromFallbackUrl: Boolean,
lastScreenName: String? = null,
scanType: IdentityScanState.ScanType? = null,
requireSelfie: Boolean? = null
) = requestFactory.createRequest(
eventName = EVENT_VERIFICATION_CANCELED,
additionalParams = additionalParamWithEventMetadata(
PARAM_FROM_FALLBACK_URL to isFromFallbackUrl,
PARAM_SCAN_TYPE to scanType?.toParam(),
PARAM_REQUIRE_SELFIE to requireSelfie,
PARAM_LAST_SCREEN_NAME to lastScreenName
)
)
fun verificationFailed(
isFromFallbackUrl: Boolean,
scanType: IdentityScanState.ScanType? = null,
requireSelfie: Boolean? = null,
docFrontUploadType: DocumentUploadParam.UploadMethod? = null,
docBackUploadType: DocumentUploadParam.UploadMethod? = null,
throwable: Throwable
) = requestFactory.createRequest(
eventName = EVENT_VERIFICATION_FAILED,
additionalParams = additionalParamWithEventMetadata(
PARAM_FROM_FALLBACK_URL to isFromFallbackUrl,
PARAM_SCAN_TYPE to scanType?.toParam(),
PARAM_REQUIRE_SELFIE to requireSelfie,
PARAM_DOC_FRONT_UPLOAD_TYPE to docFrontUploadType?.name,
PARAM_DOC_BACK_UPLOAD_TYPE to docBackUploadType?.name,
PARAM_ERROR to mapOf(
PARAM_EXCEPTION to throwable.javaClass.name,
PARAM_STACKTRACE to throwable.stackTrace.toString()
)
)
)
fun screenPresented(
scanType: IdentityScanState.ScanType? = null,
screenName: String
) = requestFactory.createRequest(
eventName = EVENT_SCREEN_PRESENTED,
additionalParams = additionalParamWithEventMetadata(
PARAM_SCAN_TYPE to scanType?.toParam(),
PARAM_SCREEN_NAME to screenName
)
)
fun cameraError(
scanType: IdentityScanState.ScanType,
throwable: Throwable
) = requestFactory.createRequest(
eventName = EVENT_CAMERA_ERROR,
additionalParams = additionalParamWithEventMetadata(
PARAM_SCAN_TYPE to scanType.toParam(),
PARAM_ERROR to mapOf(
PARAM_EXCEPTION to throwable.javaClass.name,
PARAM_STACKTRACE to throwable.stackTrace.toString()
)
)
)
fun cameraPermissionDenied(
scanType: IdentityScanState.ScanType
) = requestFactory.createRequest(
eventName = EVENT_CAMERA_PERMISSION_DENIED,
additionalParams = additionalParamWithEventMetadata(
PARAM_SCAN_TYPE to scanType.toParam()
)
)
fun cameraPermissionGranted(
scanType: IdentityScanState.ScanType
) = requestFactory.createRequest(
eventName = EVENT_CAMERA_PERMISSION_GRANTED,
additionalParams = additionalParamWithEventMetadata(
PARAM_SCAN_TYPE to scanType.toParam()
)
)
fun documentTimeout(
scanType: IdentityScanState.ScanType
) = requestFactory.createRequest(
eventName = EVENT_DOCUMENT_TIMEOUT,
additionalParams = additionalParamWithEventMetadata(
PARAM_SCAN_TYPE to scanType.toParam(),
PARAM_SIDE to scanType.toSide()
)
)
fun selfieTimeout() = requestFactory.createRequest(
eventName = EVENT_SELFIE_TIMEOUT,
additionalParams = additionalParamWithEventMetadata()
)
fun averageFps(type: String, value: Int, frames: Int) = requestFactory.createRequest(
eventName = EVENT_AVERAGE_FPS,
additionalParams = additionalParamWithEventMetadata(
PARAM_TYPE to type,
PARAM_VALUE to value,
PARAM_FRAMES to frames
)
)
fun modelPerformance(mlModel: String, preprocess: Long, inference: Long, frames: Int) =
requestFactory.createRequest(
eventName = EVENT_MODEL_PERFORMANCE,
additionalParams = additionalParamWithEventMetadata(
PARAM_PREPROCESS to preprocess,
PARAM_INFERENCE to inference,
PARAM_ML_MODEL to mlModel,
PARAM_FRAMES to frames
)
)
fun timeToScreen(
value: Long,
networkTime: Long? = null,
fromScreenName: String?,
toScreenName: String
) = requestFactory.createRequest(
eventName = EVENT_TIME_TO_SCREEN,
additionalParams = additionalParamWithEventMetadata(
PARAM_VALUE to value,
PARAM_NETWORK_TIME to networkTime,
PARAM_FROM_SCREEN_NAME to fromScreenName,
PARAM_TO_SCREEN_NAME to toScreenName
)
)
fun imageUpload(
value: Long,
compressionQuality: Float,
scanType: IdentityScanState.ScanType,
id: String?,
fileName: String?,
fileSize: Long
) = requestFactory.createRequest(
eventName = EVENT_IMAGE_UPLOAD,
additionalParams = additionalParamWithEventMetadata(
PARAM_VALUE to value,
PARAM_COMPRESSION_QUALITY to compressionQuality,
PARAM_SCAN_TYPE to scanType.toParam(),
PARAM_ID to id,
PARAM_FILE_NAME to fileName,
PARAM_FILE_SIZE to fileSize
)
)
private fun IdentityScanState.ScanType.toParam(): String =
when (this) {
IdentityScanState.ScanType.ID_FRONT -> ID
IdentityScanState.ScanType.ID_BACK -> ID
IdentityScanState.ScanType.PASSPORT -> PASSPORT
IdentityScanState.ScanType.DL_FRONT -> DRIVER_LICENSE
IdentityScanState.ScanType.DL_BACK -> DRIVER_LICENSE
IdentityScanState.ScanType.SELFIE -> SELFIE
}
private fun IdentityScanState.ScanType.toSide(): String =
when (this) {
IdentityScanState.ScanType.ID_FRONT -> FRONT
IdentityScanState.ScanType.ID_BACK -> BACK
IdentityScanState.ScanType.PASSPORT -> FRONT
IdentityScanState.ScanType.DL_FRONT -> FRONT
IdentityScanState.ScanType.DL_BACK -> BACK
else -> {
throw IllegalArgumentException("Unknown type: $this")
}
}
internal companion object {
const val CLIENT_ID = "mobile-identity-sdk"
const val ORIGIN = "stripe-identity-android"
const val ID = "id"
const val PASSPORT = "passport"
const val DRIVER_LICENSE = "driver_license"
const val SELFIE = "selfie"
const val FRONT = "front"
const val BACK = "back"
const val EVENT_SHEET_PRESENTED = "sheet_presented"
const val EVENT_SHEET_CLOSED = "sheet_closed"
const val EVENT_VERIFICATION_SUCCEEDED = "verification_succeeded"
const val EVENT_VERIFICATION_FAILED = "verification_failed"
const val EVENT_VERIFICATION_CANCELED = "verification_canceled"
const val EVENT_SCREEN_PRESENTED = "screen_presented"
const val EVENT_CAMERA_ERROR = "camera_error"
const val EVENT_CAMERA_PERMISSION_DENIED = "camera_permission_denied"
const val EVENT_CAMERA_PERMISSION_GRANTED = "camera_permission_granted"
const val EVENT_DOCUMENT_TIMEOUT = "document_timeout"
const val EVENT_SELFIE_TIMEOUT = "selfie_timeout"
const val EVENT_AVERAGE_FPS = "average_fps"
const val EVENT_MODEL_PERFORMANCE = "model_performance"
const val EVENT_TIME_TO_SCREEN = "time_to_screen"
const val EVENT_IMAGE_UPLOAD = "image_upload"
const val PARAM_EVENT_META_DATA = "event_metadata"
const val PARAM_FROM_FALLBACK_URL = "from_fallback_url"
const val PARAM_VERIFICATION_SESSION = "verification_session"
const val PARAM_SESSION_RESULT = "session_result"
const val PARAM_SCAN_TYPE = "scan_type"
const val PARAM_REQUIRE_SELFIE = "require_selfie"
const val PARAM_DOC_FRONT_RETRY_TIMES = "doc_front_retry_times"
const val PARAM_DOC_BACK_RETRY_TIMES = "doc_back_retry_times"
const val PARAM_SELFIE_RETRY_TIMES = "selfie_retry_times"
const val PARAM_DOC_FRONT_UPLOAD_TYPE = "doc_front_upload_type"
const val PARAM_DOC_BACK_UPLOAD_TYPE = "doc_back_upload_type"
const val PARAM_DOC_FRONT_MODEL_SCORE = "doc_front_model_score"
const val PARAM_DOC_BACK_MODEL_SCORE = "doc_back_model_score"
const val PARAM_SELFIE_MODEL_SCORE = "selfie_model_score"
const val PARAM_LAST_SCREEN_NAME = "last_screen_name"
const val PARAM_ERROR = "error"
const val PARAM_EXCEPTION = "exception"
const val PARAM_STACKTRACE = "stacktrace"
const val PARAM_SCREEN_NAME = "screen_name"
const val PARAM_SIDE = "side"
const val PARAM_TYPE = "type"
const val PARAM_VALUE = "value"
const val PARAM_PREPROCESS = "preprocess"
const val PARAM_INFERENCE = "inference"
const val PARAM_ML_MODEL = "ml_model"
const val PARAM_FRAMES = "frames"
const val PARAM_NETWORK_TIME = "network_time"
const val PARAM_FROM_SCREEN_NAME = "from_screen_name"
const val PARAM_TO_SCREEN_NAME = "to_screen_name"
const val PARAM_COMPRESSION_QUALITY = "compression_quality"
const val PARAM_ID = "id"
const val PARAM_FILE_NAME = "file_name"
const val PARAM_FILE_SIZE = "file_size"
const val SCREEN_NAME_CONSENT = "consent"
const val SCREEN_NAME_DOC_SELECT = "document_select"
const val SCREEN_NAME_LIVE_CAPTURE_PASSPORT = "live_capture_passport"
const val SCREEN_NAME_LIVE_CAPTURE_ID = "live_capture_id"
const val SCREEN_NAME_LIVE_CAPTURE_DRIVER_LICENSE = "live_capture_driver_license"
const val SCREEN_NAME_FILE_UPLOAD_PASSPORT = "file_upload_passport"
const val SCREEN_NAME_FILE_UPLOAD_ID = "file_upload_id"
const val SCREEN_NAME_FILE_UPLOAD_DRIVER_LICENSE = "file_upload_driver_license"
const val SCREEN_NAME_SELFIE = "selfie"
const val SCREEN_NAME_CONFIRMATION = "confirmation"
const val SCREEN_NAME_ERROR = "error"
const val TYPE_SELFIE = "selfie"
const val TYPE_DOCUMENT = "document"
}
}