Release 5.4.0 #1642
Merged
Release 5.4.0 #1642
This pull request is big! We’re only showing the most recent 250 commits.
Commits on May 1, 2024
-
-
Merge pull request #1595 from Adyen/renovate/detekt_version
Update detekt_version to v1.23.6
-
-
Merge pull request #1596 from Adyen/renovate/hilt_version
Update hilt_version to v2.51.1
-
This will create a build cache that can be used by other branches. COAND-851
-
Merge pull request #1561 from Adyen/setup-ui-testing
Setup UI testing
-
Use full qualified name to store action configurations in CheckoutCon…
…figuration This solves a crash where configurations would get the same name when they are obfuscated. COAND-902
-
Merge pull request #1592 from Adyen/fix/config-obfuscation
Fix crash caused by obfuscation of action configurations
-
-
Merge pull request #1597 from Adyen/renovate/detekt_gradle_plugin_ver…
…sion Update plugin io.gitlab.arturbosch.detekt to v1.23.6
-
Merge pull request #1602 from Adyen/renovate/mockito_kotlin_version
Update dependency org.mockito.kotlin:mockito-kotlin to v5.3.1
-
Merge pull request #1607 from Adyen/renovate/jamesives-github-pages-d…
…eploy-action-4.x Update JamesIves/github-pages-deploy-action action to v4.6.0
-
-
Merge pull request #1606 from Adyen/renovate/retrofit2_version
Update retrofit2_version to v2.11.0
-
Commits on May 2, 2024
-
Merge pull request #1608 from Adyen/renovate/kotlin
Update dependency composeOptions to v1.5.12
-
-
Merge pull request #1598 from Adyen/renovate/dokka_version
Update plugin org.jetbrains.dokka to v1.9.20
-
Merge pull request #1609 from Adyen/renovate/compose_activity_version
Update dependency androidx.activity:activity-compose to v1.9.0
-
Merge pull request #1600 from Adyen/renovate/compose_bom_version
Update dependency androidx.compose:compose-bom to v2024.04.01
-
-
Merge pull request #1603 from Adyen/renovate/barista_version
Update dependency com.adevinta.android:barista to v4.3.0
-
-
Merge pull request #1604 from Adyen/renovate/robolectric_version
Update dependency org.robolectric:robolectric to v4.12.1
-
-
-
Merge pull request #1593 from Adyen/renovate/android_gradle_plugin_ve…
…rsion Update android_gradle_plugin_version to v8.3.2
-
Merge pull request #1611 from Adyen/refactor/improve-client-key-valid…
…ation Improve client key validation
-
Commits on May 3, 2024
-
Merge pull request #1599 from Adyen/renovate/browser_version
Update dependency androidx.browser:browser to v1.8.0
-
-
Merge pull request #1601 from Adyen/renovate/gradle-8.x
Update dependency gradle to v8.7
-
Disable recompilation by the sonar command
Sonar currently doesn't pick this up from the gradle configuration, thus has to be passed in the command. https://community.sonarsource.com/t/sonar-gradle-skipcompile-is-not-working/102710
-
Remove no-daemon flag for CI builds
Gradle doesn't recommend this anymore.
-
-
-
Merge pull request #1605 from Adyen/fix/sonar-build-time
Speed up sonar
-
-
-
Merge pull request #1614 from Adyen/refactor/non-transitive-r
Migrate to non-transitive R classes
Commits on May 6, 2024
-
-
Merge pull request #1621 from Adyen/revert-1601-renovate/gradle-8.x
Revert gradle to v8.6
Commits on May 7, 2024
Commits on May 8, 2024
-
Merge pull request #1612 from Adyen/fix/submit-button
Display pay button in components if created by drop in
Commits on May 13, 2024
-
-
-
Merge pull request #1625 from Adyen/renovate/adyen3ds2_version
Update dependency com.adyen.threeds:adyen-3ds2 to v2.2.18
Commits on May 14, 2024
-
Use existing ActionComponentDialogFragment instance to handle consecu…
…tive actions This is only applicable for 3DS2 with API v66 and before, where the payments call return one action (fingerprint) then the details call returns another action (challenge) both of which need to be handled with the same component COAND-906
-
Merge pull request #1629 from Adyen/fix/old-3ds2-flow-drop-in
Fix drop-in unable to handle 3DS2 on API v66 and below
Commits on May 15, 2024
-
Merge pull request #1628 from Adyen/feature/custom-tabs-styling
Support changing the custom tabs toolbar and navigation colors
Commits on May 16, 2024
-
Don't save action in DefaultGenericActionDelegate
The specific action delegates should do this since they share a SavedStateHandle and are also responsible for removing it. COAND-857
-
Split restoring qr and redirect action state restoration for DefaultQ…
…rCodeDelegate COAND-857
-
Make naming consistent between action delegates
Not for 3ds2 and WeChat though, because they are too specific. COAND-857
-
Merge pull request #1489 from Adyen/fix/restore-action-handling-state
Restore action handling state
Commits on May 21, 2024
-
Make sure 3DS2s ChallengeStatusHandler survives process death
This makes sure the final result from the 3DS2 SDK will be correctly delivered to the newly created delegate. COAND-857
Commits on May 22, 2024
-
Don't save authorization token anymore
The action is saved now, which holds the authorization token. COAND-857
-
Merge pull request #1632 from Adyen/fix/restore-3ds2-state
Restore 3DS2 state after process death
Commits on May 23, 2024
-
-
This makes sure sonar runs after the other tasks are completed
-
Publish Twint SDK as a standalone dependency
It is not possible to publish nested AAR files, so we have to publish the Twint AAR as a standalone dependency. COAND-806
-
This makes it possible for us to handle the activity result stuff and makes the implementation for a merchant significantly easier. COAND-806
-
Update ActionHandlingMethod explanation
COAND-806 Co-authored-by: Ararat Mnatsakanyan <[email protected]>
Commits on May 24, 2024
-
Merge pull request #1630 from Adyen/feature/twint_sdk
Integrate with Twint SDK
Commits on May 28, 2024
-
Merge pull request #1633 from Adyen/fix/country-drop-down
Change phone number country code picker
-
Use getBooleanOrNull instead of optBoolean for enableStoreDetails and…
… showRemovePaymentMethodButton COAND-913
-
Merge pull request #1637 from Adyen/fix/stored_payment_methods_remova…
…l_old_integration_fix Fix storedPaymentMethod removal for older integrations
-
-
Implement analytics setup call
COAND-844 diff --git a/checkout-core/src/main/java/com/adyen/checkout/core/internal/analytics/AdyenAnalytics.kt b/checkout-core/src/main/java/com/adyen/checkout/core/internal/analytics/AdyenAnalytics.kt deleted file mode 100644 index 4106710ea..000000000 --- a/checkout-core/src/main/java/com/adyen/checkout/core/internal/analytics/AdyenAnalytics.kt +++ /dev/null @@ -1,24 +0,0 @@ -/* - * Copyright (c) 2024 Adyen N.V. - * - * This file is open source and available under the MIT license. See the LICENSE file for more info. - * - * Created by oscars on 6/2/2024. - */ - -package com.adyen.checkout.core.internal.analytics - -import androidx.annotation.RestrictTo - -@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) -class AdyenAnalytics { - - fun setup() { - // See DefaultAnalyticsRepository.setupAnalytics - } - - fun track(event: AnalyticsEvent) { - // Queue the event - // Send it - } -} diff --git a/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AdyenAnalytics.kt b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AdyenAnalytics.kt new file mode 100644 index 000000000..d012b5721 --- /dev/null +++ b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AdyenAnalytics.kt @@ -0,0 +1,92 @@ +/* + * Copyright (c) 2024 Adyen N.V. + * + * This file is open source and available under the MIT license. See the LICENSE file for more info. + * + * Created by oscars on 12/2/2024. + */ + +package com.adyen.checkout.components.core.internal.analytics + +import androidx.annotation.RestrictTo +import androidx.annotation.VisibleForTesting +import com.adyen.checkout.components.core.internal.data.api.AnalyticsService +import com.adyen.checkout.components.core.internal.ui.model.AnalyticsParams +import com.adyen.checkout.components.core.internal.ui.model.AnalyticsParamsLevel +import com.adyen.checkout.core.AdyenLogLevel +import com.adyen.checkout.core.internal.util.adyenLog +import com.adyen.checkout.core.internal.util.runSuspendCatching +import kotlinx.coroutines.CoroutineDispatcher +import kotlinx.coroutines.CoroutineScope +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.SupervisorJob +import kotlinx.coroutines.launch + +@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) +class AdyenAnalytics( + private val analyticsProvider: AnalyticsProvider, + private val analyticsParams: AnalyticsParams, + private val analyticsService: AnalyticsService, + coroutineDispatcher: CoroutineDispatcher = Dispatchers.Default, +) { + + // TODO: Check if Job or SupervisorJob is better for us + private val coroutineScope = CoroutineScope(coroutineDispatcher + SupervisorJob()) + + @volatile + var checkoutAttemptId: String? = null + private set + + @volatile + private var state: State = State.Uninitialized + + fun setup() { + if (cannotSendEvent()) { + checkoutAttemptId = CHECKOUT_ATTEMPT_ID_FOR_DISABLED_ANALYTICS + return + } + + if (state != State.Uninitialized) return + state = State.InProgress + adyenLog(AdyenLogLevel.VERBOSE) { "Setting up analytics" } + + coroutineScope.launch { + runSuspendCatching { + val analyticsSetupRequest = analyticsProvider.provide() + val response = analyticsService.setupAnalytics(analyticsSetupRequest, analyticsParams.clientKey) + checkoutAttemptId = response.checkoutAttemptId + state = State.Ready + adyenLog(AdyenLogLevel.VERBOSE) { "Analytics setup call successful" } + }.onFailure { e -> + state = State.Failed + adyenLog(AdyenLogLevel.ERROR) { + "Failed to send analytics setup call - ${e::class.simpleName}: ${e.message}" + } + } + } + } + + fun track(event: AnalyticsEvent) { + // TODO: Check if we can send events anyway, because attempt id is anonymous already + if (cannotSendEvent()) return + + // Queue the event + // Send it + } + + private fun cannotSendEvent(): Boolean { + return analyticsParams.level.priority <= AnalyticsParamsLevel.NONE.priority + } + + companion object { + private const val CHECKOUT_ATTEMPT_ID_FOR_DISABLED_ANALYTICS = "do-not-track" + } + + @VisibleForTesting + internal sealed class State { + data object Uninitialized : State() + data object InProgress : State() + data object Ready : State() + data object Failed : State() + } +} diff --git a/checkout-core/src/main/java/com/adyen/checkout/core/internal/analytics/AnalyticsEventApi.kt b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsEventApi.kt similarity index 78% rename from checkout-core/src/main/java/com/adyen/checkout/core/internal/analytics/AnalyticsEventApi.kt rename to components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsEventApi.kt index 8a98d58f6..d3775c469 100644 --- a/checkout-core/src/main/java/com/adyen/checkout/core/internal/analytics/AnalyticsEventApi.kt +++ b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsEventApi.kt @@ -3,10 +3,10 @@ * * This file is open source and available under the MIT license. See the LICENSE file for more info. * - * Created by oscars on 7/2/2024. + * Created by oscars on 12/2/2024. */ -package com.adyen.checkout.core.internal.analytics +package com.adyen.checkout.components.core.internal.analytics import androidx.annotation.RestrictTo diff --git a/checkout-core/src/main/java/com/adyen/checkout/core/internal/analytics/AnalyticsEvents.kt b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsEvents.kt similarity index 96% rename from checkout-core/src/main/java/com/adyen/checkout/core/internal/analytics/AnalyticsEvents.kt rename to components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsEvents.kt index 28027debc..d90089e3e 100644 --- a/checkout-core/src/main/java/com/adyen/checkout/core/internal/analytics/AnalyticsEvents.kt +++ b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsEvents.kt @@ -6,7 +6,7 @@ * Created by oscars on 7/2/2024. */ -package com.adyen.checkout.core.internal.analytics +package com.adyen.checkout.components.core.internal.analytics import androidx.annotation.RestrictTo import java.util.Date diff --git a/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsProvider.kt b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsProvider.kt index fd6f27593..70a792048 100644 --- a/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsProvider.kt +++ b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsProvider.kt @@ -21,7 +21,6 @@ import com.adyen.checkout.components.core.internal.ui.model.ComponentParams class AnalyticsProvider( val application: Application, val componentParams: ComponentParams, - // drop-in or txVariant val source: AnalyticsSource, val sessionId: String?, ) { diff --git a/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsSource.kt b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsSource.kt index 4b4c58185..7938e93c7 100644 --- a/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsSource.kt +++ b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsSource.kt @@ -12,11 +12,12 @@ import androidx.annotation.RestrictTo @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) sealed class AnalyticsSource { - data class DropIn(val paymentMethods: List<String>) : AnalyticsSource() + data class DropIn(val paymentMethodList: List<String>) : AnalyticsSource() data class PaymentComponent(val paymentMethodType: String) : AnalyticsSource() + // TODO: Check if we can rename paymentMethodList and not make it clash with this function fun getPaymentMethods(): List<String> = when(this) { - is DropIn -> paymentMethods + is DropIn -> paymentMethodList is PaymentComponent -> listOf(paymentMethodType) } } diff --git a/checkout-core/src/main/java/com/adyen/checkout/core/internal/analytics/GenericEvents.kt b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/GenericEvents.kt similarity index 80% rename from checkout-core/src/main/java/com/adyen/checkout/core/internal/analytics/GenericEvents.kt rename to components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/GenericEvents.kt index f9e46dd02..b99a56ce0 100644 --- a/checkout-core/src/main/java/com/adyen/checkout/core/internal/analytics/GenericEvents.kt +++ b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/GenericEvents.kt @@ -3,10 +3,10 @@ * * This file is open source and available under the MIT license. See the LICENSE file for more info. * - * Created by oscars on 7/2/2024. + * Created by oscars on 12/2/2024. */ -package com.adyen.checkout.core.internal.analytics +package com.adyen.checkout.components.core.internal.analytics import androidx.annotation.RestrictTo @@ -22,7 +22,7 @@ object GenericEvents { brand: String? = null, ) = AnalyticsEvent.Info( component = component, - type = InfoEventType.RENDERED, + type = AnalyticsEvent.Info.Type.RENDERED, isStoredPaymentMethod = isStoredPaymentMethod, brand = brand, ) @@ -32,7 +32,7 @@ object GenericEvents { target: String, ) = AnalyticsEvent.Info( component = component, - type = InfoEventType.DISPLAYED, + type = AnalyticsEvent.Info.Type.DISPLAYED, target = target, ) @@ -42,7 +42,7 @@ object GenericEvents { issuer: String, ) = AnalyticsEvent.Info( component = component, - type = InfoEventType.SELECTED, + type = AnalyticsEvent.Info.Type.SELECTED, target = target, issuer = issuer, ) @@ -52,7 +52,7 @@ object GenericEvents { target: String, ) = AnalyticsEvent.Info( component = component, - type = InfoEventType.INPUT, + type = AnalyticsEvent.Info.Type.INPUT, target = target, ) @@ -63,7 +63,7 @@ object GenericEvents { target: String, ) = AnalyticsEvent.Info( component = component, - type = InfoEventType.FOCUS, + type = AnalyticsEvent.Info.Type.FOCUS, target = target, ) @@ -72,7 +72,7 @@ object GenericEvents { target: String, ) = AnalyticsEvent.Info( component = component, - type = InfoEventType.UNFOCUS, + type = AnalyticsEvent.Info.Type.UNFOCUS, target = target, ) @@ -81,7 +81,7 @@ object GenericEvents { target: String, ) = AnalyticsEvent.Info( component = component, - type = InfoEventType.DOWNLOAD, + type = AnalyticsEvent.Info.Type.DOWNLOAD, target = target, ) @@ -92,7 +92,7 @@ object GenericEvents { validationErrorMessage: String?, ) = AnalyticsEvent.Info( component = component, - type = InfoEventType.VALIDATION_ERROR, + type = AnalyticsEvent.Info.Type.VALIDATION_ERROR, target = target, validationErrorCode = validationErrorCode, validationErrorMessage = validationErrorMessage, @@ -103,7 +103,7 @@ object GenericEvents { component: String, ) = AnalyticsEvent.Log( component = component, - type = LogEventType.SUBMIT, + type = AnalyticsEvent.Log.Type.SUBMIT, ) fun threeDS2( @@ -111,7 +111,7 @@ object GenericEvents { message: String, ) = AnalyticsEvent.Log( component = component, - type = LogEventType.THREEDS2, + type = AnalyticsEvent.Log.Type.THREEDS2, message = message, ) @@ -121,7 +121,7 @@ object GenericEvents { message: String, ) = AnalyticsEvent.Log( component = component, - type = LogEventType.ACTION, + type = AnalyticsEvent.Log.Type.ACTION, subType = subType, message = message, ) diff --git a/components-core/src/main/java/com/adyen/checkout/components/core/internal/data/api/AnalyticsRepositoryData.kt b/components-core/src/main/java/com/adyen/checkout/components/core/internal/data/api/AnalyticsRepositoryData.kt index 5d215f7ea..f5fea4d92 100644 --- a/components-core/src/main/java/com/adyen/checkout/components/core/internal/data/api/AnalyticsRepositoryData.kt +++ b/components-core/src/main/java/com/adyen/checkout/components/core/internal/data/api/AnalyticsRepositoryData.kt @@ -40,7 +40,7 @@ data class AnalyticsRepositoryData( ) : this( application = application, componentParams = componentParams, - source = AnalyticsSource.PaymentComponent(componentParams.isCreatedByDropIn, paymentMethod), + source = AnalyticsSource.PaymentComponent(paymentMethod.type.orEmpty()), paymentMethodType = paymentMethod.type, sessionId = sessionId, ) @@ -53,7 +53,7 @@ data class AnalyticsRepositoryData( ) : this( application = application, componentParams = componentParams, - source = AnalyticsSource.PaymentComponent(componentParams.isCreatedByDropIn, storedPaymentMethod), + source = AnalyticsSource.PaymentComponent(storedPaymentMethod.type.orEmpty()), paymentMethodType = storedPaymentMethod.type, sessionId = sessionId, ) diff --git a/components-core/src/main/java/com/adyen/checkout/components/core/internal/data/api/DefaultAnalyticsRepository.kt b/components-core/src/main/java/com/adyen/checkout/components/core/internal/data/api/DefaultAnalyticsRepository.kt index b9557b82a..fbd5e7918 100644 --- a/components-core/src/main/java/com/adyen/checkout/components/core/internal/data/api/DefaultAnalyticsRepository.kt +++ b/components-core/src/main/java/com/adyen/checkout/components/core/internal/data/api/DefaultAnalyticsRepository.kt @@ -40,33 +40,33 @@ class DefaultAnalyticsRepository( state = State.InProgress adyenLog(AdyenLogLevel.VERBOSE) { "Setting up analytics" } - runSuspendCatching { - val analyticsSetupRequest = with(analyticsRepositoryData) { - analyticsMapper.getAnalyticsSetupRequest( - packageName = packageName, - locale = locale, - source = source, - amount = amount, - screenWidth = screenWidth.toLong(), - paymentMethods = paymentMethods, - sessionId = sessionId, - ) - } - val response = analyticsService.setupAnalytics(analyticsSetupRequest, analyticsRepositoryData.clientKey) - checkoutAttemptId = response.checkoutAttemptId - state = State.Ready - adyenLog(AdyenLogLevel.VERBOSE) { "Analytics setup call successful" } - }.onFailure { e -> - state = State.Failed - adyenLog(AdyenLogLevel.ERROR) { - "Failed to send analytics setup call - ${e::class.simpleName}: ${e.message}" - } - } +// runSuspendCatching { +// val analyticsSetupRequest = with(analyticsRepositoryData) { +// analyticsMapper.getAnalyticsSetupRequest( +// packageName = packageName, +// locale = locale, +// source = source, +// amount = amount, +// screenWidth = screenWidth.toLong(), +// paymentMethods = paymentMethods, +// sessionId = sessionId, +// ) +// } +// val response = analyticsService.setupAnalytics(analyticsSetupRequest, analyticsRepositoryData.clientKey) +// checkoutAttemptId = response.checkoutAttemptId +// state = State.Ready +// adyenLog(AdyenLogLevel.VERBOSE) { "Analytics setup call successful" } +// }.onFailure { e -> +// state = State.Failed +// adyenLog(AdyenLogLevel.ERROR) { +// "Failed to send analytics setup call - ${e::class.simpleName}: ${e.message}" +// } +// } } private fun canSendAnalytics(requiredLevel: AnalyticsParamsLevel): Boolean { require(requiredLevel != NONE) { "Analytics are not allowed with level NONE" } - return !analyticsRepositoryData.level.hasHigherPriorityThan(requiredLevel) + return true } companion object { diff --git a/components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/AnalyticsParams.kt b/components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/AnalyticsParams.kt index c95ed163f..8214b77f5 100644 --- a/components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/AnalyticsParams.kt +++ b/components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/AnalyticsParams.kt @@ -15,20 +15,19 @@ import com.adyen.checkout.components.core.AnalyticsLevel @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) data class AnalyticsParams( val level: AnalyticsParamsLevel, + val clientKey: String, ) { - constructor(analyticsConfiguration: AnalyticsConfiguration?) : - this(level = getLevel(analyticsConfiguration)) + constructor( + analyticsConfiguration: AnalyticsConfiguration?, + clientKey: String, + ) : this(level = getLevel(analyticsConfiguration), clientKey = clientKey) } @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) -enum class AnalyticsParamsLevel(private val priority: Int) { - ALL(1), - NONE(2); - - internal fun hasHigherPriorityThan(level: AnalyticsParamsLevel): Boolean { - return priority > level.priority - } +enum class AnalyticsParamsLevel(val priority: Int) { + NONE(1), + ALL(2), } private fun getLevel(analyticsConfiguration: AnalyticsConfiguration?): AnalyticsParamsLevel { diff --git a/drop-in/src/main/java/com/adyen/checkout/dropin/internal/ui/DropInViewModelFactory.kt b/drop-in/src/main/java/com/adyen/checkout/dropin/internal/ui/DropInViewModelFactory.kt index f65293023..fd98091ce 100644 --- a/drop-in/src/main/java/com/adyen/checkout/dropin/internal/ui/DropInViewModelFactory.kt +++ b/drop-in/src/main/java/com/adyen/checkout/dropin/internal/ui/DropInViewModelFactory.kt @@ -13,6 +13,7 @@ import androidx.lifecycle.AbstractSavedStateViewModelFactory import androidx.lifecycle.SavedStateHandle import androidx.lifecycle.ViewModel import com.adyen.checkout.components.core.CheckoutConfiguration +import com.adyen.checkout.components.core.internal.analytics.AnalyticsSource import com.adyen.checkout.components.core.internal.data.api.AnalyticsMapper import com.adyen.checkout.components.core.internal.data.api.AnalyticsRepositoryData import com.adyen.checkout.components.core.internal.data.api.AnalyticsService -
Implement AdyenAnalytics in MBWay
COAND-844
-
Map events and send them to backend
COAND-844
-
Implement fetch checkoutAttemptId flow
COAND-844
-
Implement timer and send logic
COAND-844
-
Create analytics manager factory and use it for MBWay component
COAND-844 diff --git a/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsManager.kt b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsManager.kt index 0249034da..40fdf0839 100644 --- a/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsManager.kt +++ b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsManager.kt @@ -8,8 +8,8 @@ package com.adyen.checkout.components.core.internal.analytics +import androidx.annotation.RestrictTo import com.adyen.checkout.components.core.internal.analytics.data.AnalyticsRepository -import com.adyen.checkout.components.core.internal.analytics.data.remote.AnalyticsSetupProvider import com.adyen.checkout.components.core.internal.ui.model.AnalyticsParams import com.adyen.checkout.components.core.internal.ui.model.AnalyticsParamsLevel import com.adyen.checkout.core.AdyenLogLevel @@ -24,9 +24,9 @@ import kotlinx.coroutines.isActive import kotlinx.coroutines.launch import kotlin.time.Duration.Companion.seconds +@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) class AnalyticsManager internal constructor( private val analyticsRepository: AnalyticsRepository, - private val analyticsSetupProvider: AnalyticsSetupProvider, private val analyticsParams: AnalyticsParams, private val coroutineDispatcher: CoroutineDispatcher = Dispatchers.IO, ) { @@ -54,7 +54,7 @@ class AnalyticsManager internal constructor( coroutineScope.launch(coroutineDispatcher) { runSuspendCatching { - analyticsRepository.fetchCheckoutAttemptId(analyticsSetupProvider) + analyticsRepository.fetchCheckoutAttemptId() }.fold( onSuccess = { attemptId -> checkoutAttemptId = attemptId?.also { startTimer() } diff --git a/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsManagerFactory.kt b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsManagerFactory.kt new file mode 100644 index 000000000..e02614591 --- /dev/null +++ b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/AnalyticsManagerFactory.kt @@ -0,0 +1,57 @@ +/* + * Copyright (c) 2024 Adyen N.V. + * + * This file is open source and available under the MIT license. See the LICENSE file for more info. + * + * Created by ararat on 5/3/2024. + */ + +package com.adyen.checkout.components.core.internal.analytics + +import android.app.Application +import androidx.annotation.RestrictTo +import com.adyen.checkout.components.core.internal.analytics.data.DefaultAnalyticsRepository +import com.adyen.checkout.components.core.internal.analytics.data.local.InfoAnalyticsLocalDataStore +import com.adyen.checkout.components.core.internal.analytics.data.local.LogAnalyticsLocalDataStore +import com.adyen.checkout.components.core.internal.analytics.data.remote.AnalyticsService +import com.adyen.checkout.components.core.internal.analytics.data.remote.AnalyticsTrackRequestProvider +import com.adyen.checkout.components.core.internal.analytics.data.remote.DefaultAnalyticsRemoteDataStore +import com.adyen.checkout.components.core.internal.analytics.data.remote.DefaultAnalyticsSetupProvider +import com.adyen.checkout.components.core.internal.ui.model.ComponentParams +import com.adyen.checkout.core.internal.data.api.HttpClientFactory + +@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) +class AnalyticsManagerFactory { + fun provide( + componentParams: ComponentParams, + application: Application, + source: AnalyticsSource, + sessionId: String? + ) = AnalyticsManager( + analyticsRepository = DefaultAnalyticsRepository( + localInfoDataStore = InfoAnalyticsLocalDataStore(), + localLogDataStore = LogAnalyticsLocalDataStore(), + remoteDataStore = DefaultAnalyticsRemoteDataStore( + analyticsService = AnalyticsService( + HttpClientFactory.getAnalyticsHttpClient(componentParams.environment), + ), + clientKey = componentParams.clientKey, + infoSize = INFO_SIZE, + logSize = LOG_SIZE, + ), + analyticsSetupProvider = DefaultAnalyticsSetupProvider( + application = application, + componentParams = componentParams, + source = source, + sessionId = sessionId, + ), + analyticsTrackRequestProvider = AnalyticsTrackRequestProvider(), + ), + analyticsParams = componentParams.analyticsParams, + ) + + companion object { + private const val INFO_SIZE = 50 + private const val LOG_SIZE = 5 + } +} diff --git a/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/data/AnalyticsRepository.kt b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/data/AnalyticsRepository.kt index eb15dd775..e4fd2e09e 100644 --- a/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/data/AnalyticsRepository.kt +++ b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/data/AnalyticsRepository.kt @@ -9,11 +9,10 @@ package com.adyen.checkout.components.core.internal.analytics.data import com.adyen.checkout.components.core.internal.analytics.AnalyticsEvent -import com.adyen.checkout.components.core.internal.analytics.data.remote.AnalyticsSetupProvider internal interface AnalyticsRepository { - suspend fun fetchCheckoutAttemptId(analyticsSetupProvider: AnalyticsSetupProvider): String? + suspend fun fetchCheckoutAttemptId(): String? suspend fun storeEvent(event: AnalyticsEvent) diff --git a/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/data/DefaultAnalyticsRepository.kt b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/data/DefaultAnalyticsRepository.kt index 6222b3899..1a372c3d4 100644 --- a/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/data/DefaultAnalyticsRepository.kt +++ b/components-core/src/main/java/com/adyen/checkout/components/core/internal/analytics/data/DefaultAnalyticsRepository.kt @@ -18,10 +18,11 @@ internal class DefaultAnalyticsRepository( private val localInfoDataStore: AnalyticsLocalDataStore<AnalyticsEvent.Info>, private val localLogDataStore: AnalyticsLocalDataStore<AnalyticsEvent.Log>, private val remoteDataStore: AnalyticsRemoteDataStore, + private val analyticsSetupProvider: AnalyticsSetupProvider, private val analyticsTrackRequestProvider: AnalyticsTrackRequestProvider, ) : AnalyticsRepository { - override suspend fun fetchCheckoutAttemptId(analyticsSetupProvider: AnalyticsSetupProvider): String? { + override suspend fun fetchCheckoutAttemptId(): String? { val request = analyticsSetupProvider.provide() return remoteDataStore.fetchCheckoutAttemptId(request).checkoutAttemptId } diff --git a/mbway/src/main/java/com/adyen/checkout/mbway/internal/provider/MBWayComponentProvider.kt b/mbway/src/main/java/com/adyen/checkout/mbway/internal/provider/MBWayComponentProvider.kt index bd8b0eb37..74688703c 100644 --- a/mbway/src/main/java/com/adyen/checkout/mbway/internal/provider/MBWayComponentProvider.kt +++ b/mbway/src/main/java/com/adyen/checkout/mbway/internal/provider/MBWayComponentProvider.kt @@ -22,10 +22,9 @@ import com.adyen.checkout.components.core.Order import com.adyen.checkout.components.core.PaymentMethod import com.adyen.checkout.components.core.internal.DefaultComponentEventHandler import com.adyen.checkout.components.core.internal.PaymentObserverRepository -import com.adyen.checkout.components.core.internal.analytics.AnalyticsProvider +import com.adyen.checkout.components.core.internal.analytics.AnalyticsManager +import com.adyen.checkout.components.core.internal.analytics.AnalyticsManagerFactory import com.adyen.checkout.components.core.internal.analytics.AnalyticsSource -import com.adyen.checkout.components.core.internal.data.api.OldAnalyticsRepository -import com.adyen.checkout.components.core.internal.analytics.data.remote.AnalyticsService import com.adyen.checkout.components.core.internal.provider.PaymentComponentProvider import com.adyen.checkout.components.core.internal.ui.model.ButtonComponentParamsMapper import com.adyen.checkout.components.core.internal.ui.model.CommonComponentParamsMapper @@ -56,7 +55,7 @@ class MBWayComponentProvider @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) constructor( private val dropInOverrideParams: DropInOverrideParams? = null, - private val analyticsRepository: OldAnalyticsRepository? = null, + private val analyticsManager: AnalyticsManager? = null, private val localeProvider: LocaleProvider = LocaleProvider(), ) : PaymentComponentProvider< @@ -99,18 +98,11 @@ constructor( paymentMethod = paymentMethod, order = order, componentParams = componentParams, - // TODO: Find out how to use analytics source with drop-in - adyenAnalytics = AdyenAnalytics( - analyticsProvider = AnalyticsProvider( - application, - componentParams, - AnalyticsSource.PaymentComponent(paymentMethod.type.orEmpty()), - null, - ), - analyticsParams = componentParams.analyticsParams, - analyticsService = AnalyticsService( - HttpClientFactory.getAnalyticsHttpClient(componentParams.environment), - ), + analyticsManager = analyticsManager ?: AnalyticsManagerFactory().provide( + componentParams = componentParams, + application = application, + source = AnalyticsSource.PaymentComponent(paymentMethod.type.orEmpty()), + sessionId = null, ), submitHandler = SubmitHandler(savedStateHandle), ) @@ -191,18 +183,11 @@ constructor( paymentMethod = paymentMethod, order = checkoutSession.order, componentParams = componentParams, - // TODO: Find out how to use analytics source with drop-in - adyenAnalytics = AdyenAnalytics( - analyticsProvider = AnalyticsProvider( - application, - componentParams, - AnalyticsSource.PaymentComponent(paymentMethod.type.orEmpty()), - checkoutSession.sessionSetupResponse.id, - ), - analyticsParams = componentParams.analyticsParams, - analyticsService = AnalyticsService( - HttpClientFactory.getAnalyticsHttpClient(componentParams.environment), - ), + analyticsManager = analyticsManager ?: AnalyticsManagerFactory().provide( + componentParams = componentParams, + application = application, + source = AnalyticsSource.PaymentComponent(paymentMethod.type.orEmpty()), + sessionId = checkoutSession.sessionSetupResponse.id, ), submitHandler = SubmitHandler(savedStateHandle), ) diff --git a/mbway/src/main/java/com/adyen/checkout/mbway/internal/ui/DefaultMBWayDelegate.kt b/mbway/src/main/java/com/adyen/checkout/mbway/internal/ui/DefaultMBWayDelegate.kt index cb9cc361e..fec5297ed 100644 --- a/mbway/src/main/java/com/adyen/checkout/mbway/internal/ui/DefaultMBWayDelegate.kt +++ b/mbway/src/main/java/com/adyen/checkout/mbway/internal/ui/DefaultMBWayDelegate.kt @@ -16,6 +16,7 @@ import com.adyen.checkout.components.core.PaymentMethod import com.adyen.checkout.components.core.PaymentMethodTypes import com.adyen.checkout.components.core.internal.PaymentComponentEvent import com.adyen.checkout.components.core.internal.PaymentObserverRepository +import com.adyen.checkout.components.core.internal.analytics.AnalyticsManager import com.adyen.checkout.components.core.internal.ui.model.ButtonComponentParams import com.adyen.checkout.components.core.internal.util.CountryInfo import com.adyen.checkout.components.core.internal.util.CountryUtils @@ -40,7 +41,7 @@ internal class DefaultMBWayDelegate( private val paymentMethod: PaymentMethod, private val order: OrderRequest?, override val componentParams: ButtonComponentParams, - private val adyenAnalytics: AdyenAnalytics, + private val analyticsManager: AnalyticsManager, private val submitHandler: SubmitHandler<MBWayComponentState>, ) : MBWayDelegate { @@ -69,12 +70,12 @@ internal class DefaultMBWayDelegate( override fun initialize(coroutineScope: CoroutineScope) { submitHandler.initialize(coroutineScope, componentStateFlow) - setupAnalytics() + initializeAnalytics(coroutineScope) } - private fun setupAnalytics() { - adyenLog(AdyenLogLevel.VERBOSE) { "setupAnalytics" } - adyenAnalytics.setup() + private fun initializeAnalytics(coroutineScope: CoroutineScope) { + adyenLog(AdyenLogLevel.VERBOSE) { "initializeAnalytics" } + analyticsManager.initialize(coroutineScope) } override fun observe( @@ -132,7 +133,7 @@ internal class DefaultMBWayDelegate( ): MBWayComponentState { val paymentMethod = MBWayPaymentMethod( type = MBWayPaymentMethod.PAYMENT_METHOD_TYPE, - checkoutAttemptId = adyenAnalytics.checkoutAttemptId, + checkoutAttemptId = analyticsManager.getCheckoutAttemptId(), telephoneNumber = outputData.mobilePhoneNumberFieldState.value, ) diff --git a/mbway/src/test/java/com/adyen/checkout/mbway/internal/ui/DefaultMBWayDelegateTest.kt b/mbway/src/test/java/com/adyen/checkout/mbway/internal/ui/DefaultMBWayDelegateTest.kt index 6055c03f0..5303293f3 100644 --- a/mbway/src/test/java/com/adyen/checkout/mbway/internal/ui/DefaultMBWayDelegateTest.kt +++ b/mbway/src/test/java/com/adyen/checkout/mbway/internal/ui/DefaultMBWayDelegateTest.kt @@ -14,7 +14,7 @@ import com.adyen.checkout.components.core.CheckoutConfiguration import com.adyen.checkout.components.core.OrderRequest import com.adyen.checkout.components.core.PaymentMethod import com.adyen.checkout.components.core.internal.PaymentObserverRepository -import com.adyen.checkout.components.core.internal.data.api.OldAnalyticsRepository +import com.adyen.checkout.components.core.internal.analytics.AnalyticsManager import com.adyen.checkout.components.core.internal.ui.model.ButtonComponentParamsMapper import com.adyen.checkout.components.core.internal.ui.model.CommonComponentParamsMapper import com.adyen.checkout.core.Environment @@ -41,6 +41,7 @@ import org.junit.jupiter.params.provider.Arguments.arguments import org.junit.jupiter.params.provider.MethodSource import org.mockito.Mock import org.mockito.junit.jupiter.MockitoExtension +import org.mockito.kotlin.any import org.mockito.kotlin.doReturn import org.mockito.kotlin.verify import org.mockito.kotlin.whenever @@ -49,7 +50,7 @@ import java.util.Locale @OptIn(ExperimentalCoroutinesApi::class) @ExtendWith(MockitoExtension::class) internal class DefaultMBWayDelegateTest( - @mock private val analyticsRepository: OldAnalyticsRepository, + @mock private val analyticsManager: AnalyticsManager, @mock private val submitHandler: SubmitHandler<MBWayComponentState>, ) { @@ -198,9 +199,9 @@ internal class DefaultMBWayDelegateTest( } @test - fun `when delegate is initialized then analytics event is sent`() = runTest { + fun `when delegate is initialized then analytics manager is initialized`() = runTest { delegate.initialize(CoroutineScope(UnconfinedTestDispatcher())) - verify(analyticsRepository).setupAnalytics() + verify(analyticsManager).initialize(any()) } @nested @@ -261,7 +262,7 @@ internal class DefaultMBWayDelegateTest( @test fun `when component state is valid then PaymentMethodDetails should contain checkoutAttemptId`() = runTest { - whenever(analyticsRepository.getCheckoutAttemptId()) doReturn TEST_CHECKOUT_ATTEMPT_ID + whenever(analyticsManager.getCheckoutAttemptId()) doReturn TEST_CHECKOUT_ATTEMPT_ID delegate.initialize(CoroutineScope(UnconfinedTestDispatcher())) @@ -289,7 +290,7 @@ internal class DefaultMBWayDelegateTest( componentSessionParams = null, componentConfiguration = configuration.getMBWayConfiguration(), ), - analyticsRepository = analyticsRepository, + analyticsManager = analyticsManager, submitHandler = submitHandler, ) -
Rename old classes back to previous and prefix new classes
This is only for review purposes and should be reverted later. COAND-844
-
Fix unit tests and lint errors
COAND-844
-
Move AnalyticsService to it's original place
This is for review purposes and should be reverted later. COAND-844
-
Generate id for analytics events
COAND-844
-
Don't send events if there are none
COAND-844
-
Create an interface for AnalyticsManager
This will help with testing later. COAND-844
-
Log when exiting a function early
COAND-844
-
Improve empty response handling
COAND-844
-
Change analytics implementation for StoredACHDirectDebitDelegate and …
…DefaultACHDirectDebitDelegate COAND-844
-
Change analytics implementation for DefaultCardDelegate and StoredCar…
…dDelegate COAND-844
-
Change analytics implementation for DefaultBlikDelegate and StoredBli…
…kDelegate COAND-844
-
Change analytics implementation for DefaultCashAppPayDelegate and Sto…
…redCashAppPayDelegate COAND-844
-
Add tests for AnalyticsPlatformParams
COAND-844
-
COAND-844
-
Add tests for AnalyticsSetupRequest
COAND-844
-
Add tests for AnalyticsSetupResponse
COAND-844
-
Add tests for AnalyticsTrackRequest
COAND-844
-
Add tests for AnalyticsTrackInfo
COAND-844
-
Add tests for AnalyticsTrackLog
COAND-844
-
Add tests for DefaultAnalyticsManager
COAND-844
-
Add tests for DefaultAnalyticsRepository
COAND-844
-
Implement MBWay analytics events
COAND-845
-
Add rendered and submit events for DefaultCardDelegate and StoredCard…
…Delegate COAND-845
-
Pass analytics manager to GenericActionComponentProvider from payment…
… method component providers COAND-845
-
Track download event when qr code is downloaded
COAND-845 diff --git a/qr-code/src/main/java/com/adyen/checkout/qrcode/internal/ui/DefaultQRCodeDelegate.kt b/qr-code/src/main/java/com/adyen/checkout/qrcode/internal/ui/DefaultQRCodeDelegate.kt index d1efa7cbf..c58ab3a1b 100644 --- a/qr-code/src/main/java/com/adyen/checkout/qrcode/internal/ui/DefaultQRCodeDelegate.kt +++ b/qr-code/src/main/java/com/adyen/checkout/qrcode/internal/ui/DefaultQRCodeDelegate.kt @@ -310,6 +310,12 @@ internal class DefaultQRCodeDelegate( val timestamp = DateUtils.formatDateToString(Calendar.getInstance()) val imageName = String.format(IMAGE_NAME_FORMAT, paymentMethodType, timestamp) + val event = GenericEvents.download( + component = paymentMethodType, + target = "qr_download_button" + ) + analyticsManager?.trackEvent(event) + coroutineScope.launch { imageSaver.saveImageFromUrl( context = context, diff --git a/qr-code/src/test/java/com/adyen/checkout/qrcode/internal/ui/DefaultQRCodeDelegateTest.kt b/qr-code/src/test/java/com/adyen/checkout/qrcode/internal/ui/DefaultQRCodeDelegateTest.kt index ba3c19c97..aad9455b9 100644 --- a/qr-code/src/test/java/com/adyen/checkout/qrcode/internal/ui/DefaultQRCodeDelegateTest.kt +++ b/qr-code/src/test/java/com/adyen/checkout/qrcode/internal/ui/DefaultQRCodeDelegateTest.kt @@ -612,6 +612,27 @@ internal class DefaultQRCodeDelegateTest( ) analyticsManager.assertLastEventEquals(expectedEvent) } + + @test + fun `when downloadQRImage is called, then download event is tracked`() { + delegate.initialize(CoroutineScope(UnconfinedTestDispatcher())) + delegate.handleAction( + QrCodeAction( + paymentMethodType = TEST_PAYMENT_METHOD_TYPE, + qrCodeData = TEST_QR_CODE_DATA, + paymentData = TEST_PAYMENT_DATA, + ), + mock(), + ) + + delegate.downloadQRImage(context) + + val expectedEvent = GenericEvents.download( + component = TEST_PAYMENT_METHOD_TYPE, + target = "qr_download_button", + ) + analyticsManager.assertLastEventEquals(expectedEvent) + } } private fun createTestAction( @@ -650,5 +671,6 @@ internal class DefaultQRCodeDelegateTest( private const val TEST_PAYMENT_METHOD_TYPE = "TEST_PAYMENT_METHOD_TYPE" private const val TEST_ACTION_TYPE = "TEST_PAYMENT_METHOD_TYPE" private const val TEST_PAYMENT_DATA = "TEST_PAYMENT_DATA" + private const val TEST_QR_CODE_DATA = "TEST_QR_CODE_DATA" } } -
Add assertHasEventEquals method in TestAnalyticsManager to test payme…
…nt methods, which track more than one event when initializing. COAND-845
-
Track events before calling onSubmit for delegates which already trac…
…k submit event. COAND-845
-
Add generic events for StoredCashAppPayDelegate and DefaultCashAppPay…
…Delegate COAND-845
-
Add generic events for StoredACHDirectDebitDelegate and DefaultACHDir…
…ectDebitDelegate COAND-845
-
Clean up unused code and TODOs
COAND-845
-
Move log line for successfully sending events
The line was logged even when no events were actually sent. Now it should only log when events are actually successfully sent. COAND-845
-
Only remove events that were successfully sent
This will prevent an edge case where we would accidentally clear events that were not sent yet. COAND-845
-
Make sure action event is tracked when handleAction is called
initState can be called from other places, so it's not the right place to send the event. COAND-845
Commits on May 29, 2024
-
Merge pull request #1639 from Adyen/fix/redirect-state-restoration
Correctly restore state of redirect
-
Merge pull request #1640 from Adyen/fix/wechatpay-state-restoration
Correctly restore state of WeChatPay
-
Remove storedEventCount counter, since it was not reliable due to con…
…current operations COAND-845
-
Merge pull request #1641 from Adyen/feature/analytics_remove_non_reli…
…able_counter Analytics - Remove stored event counter
-
-
-
Merge pull request #1638 from Adyen/release/5.4.0
Prepare release 5.4.0
-
-
Merge pull request #1643 from Adyen/release-note-deps
Add dependency updates to release notes
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.