Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add scroll and swipe autocapture #201

Merged
merged 33 commits into from
Jun 13, 2024
Merged

feat: add scroll and swipe autocapture #201

merged 33 commits into from
Jun 13, 2024

Conversation

PouriaAmini
Copy link
Contributor

Summary

This PR adds support for scroll and swipe autocapture. The functionality is enabled by default when userInteractions is set to true in DefaultTrackingOptions.

@OptIn(ExperimentalAmplitudeFeature::class)
Amplitude(
    Configuration(
        apiKey = AMPLITUDE_API_KEY,
        context = applicationContext,
        defaultTracking = DefaultTrackingOptions(
            userInteractions = true
        )
    )
)

New automatically captured event

[Amplitude] Element Scrolled: Emitted when a user scrolls on a scrollable element in the legacy Android View system or a tagged scrollable @Composable functions in Compose.

[Amplitude] Element Swiped: Emitted when a user flings on a UI element that was previously scrolled/moved.

Note: To capture the event in Compose, the scrollable @Composable functions must include a Modifier.testTag, otherwise the event will not be captured. Scrollable @Composable functions have an ScrollBy lambda or a Modifier.scrollable modifier (for Jetpack Compose > 1.5).

New automatically captured properties

[Amplitude] Direction: (Android Views and Compose) The direction of the scroll or swipe (Up, Right, Down, Left).

Optimizations around Autocapture implementations

  1. Resource name has a fallback now in case a resourceEntryName does not exist.
  2. Reflection is done lazily for Compose internals.

Checklist

  • Does your PR title have the correct title format?
  • Does your PR have a breaking change?: no

PouriaAmini and others added 30 commits June 3, 2024 14:29
@PouriaAmini
Implement Autocapture for the Kotlin SDK
7ccff28
@PouriaAmini
Support Android API levels down to 16 for autocapture
1f6b98d
@PouriaAmini
Revert linter changes
228554a
@PouriaAmini
Upgrade minSDK to 19 with targetSDK set to 34
b5ffb53
@PouriaAmini
Add unit tests for Autocapture
1cf48e0
@PouriaAmini
Revert linter changes and fix typo
386e1ec
@PouriaAmini
Add tracking start and stop for user interactions
5c8cd0e
@PouriaAmini
Find ViewTarget even if Resource.NotFoundException is thrown
c8e4e3b
@PouriaAmini
Change event name to [Amplitude] Element Tapped
c2e7827
@PouriaAmini
Add checks for Compose
b0ca2c7
@PouriaAmini
Fix failing tests for autocapture
b6329b3
@PouriaAmini
Fix typo
fd6972f
@PouriaAmini
Add scroll and swap for autocapture
7fab60c
@PouriaAmini
Make class loading lazy
5feb699
@PouriaAmini
Change element clicked event name
87593f1
@PouriaAmini
Merge branch 'AMP-99736_autocapture' into AMP-100454_autocapture
dbd50f8 
# Conflicts:
#	android/src/main/java/com/amplitude/android/internal/gestures/AutocaptureGestureListener.kt
#	android/src/main/java/com/amplitude/android/utilities/DefaultEventUtils.kt
#	android/src/test/java/com/amplitude/android/internal/gestures/AutocaptureGestureListenerClickTest.kt
@PouriaAmini
Change direction property values
fce6329
@PouriaAmini
Move compose to the android module
ffa1aa1
@PouriaAmini
Merge branch 'AMP-99736_autocapture' into AMP-100454_autocapture
8be8c85 
# Conflicts:
#	android/src/main/java/com/amplitude/android/internal/gestures/AutocaptureGestureListener.kt
#	android/src/main/java/com/amplitude/android/internal/locators/AndroidViewTargetLocator.kt
@PouriaAmini
Fix import mix-ups
112b071
@PouriaAmini
Change build JDK version to 17
57c8786
@PouriaAmini
Update gradle version
56799f5
@PouriaAmini
Add Java 11 to the CI flow
467c510
@PouriaAmini
Cleanup the CI workflow
d7f2488
@PouriaAmini
Add name for workflow jobs
5e12fab
@PouriaAmini
Merge branch 'amplitude:main' into main
13a7b7b
@PouriaAmini
Merge branch 'amplitude:main' into main
1b9b2a1
@PouriaAmini
Merge branch 'main' into AMP-100454_autocapture
9879bf6 
# Conflicts:
#	android/build.gradle
#	android/src/main/java/com/amplitude/android/DefaultTrackingOptions.kt
#	android/src/main/java/com/amplitude/android/internal/ViewHierarchyScanner.kt
#	android/src/main/java/com/amplitude/android/internal/ViewTarget.kt
#	android/src/main/java/com/amplitude/android/internal/gestures/AutocaptureGestureListener.kt
#	android/src/main/java/com/amplitude/android/internal/gestures/AutocaptureWindowCallback.kt
#	android/src/main/java/com/amplitude/android/internal/locators/AndroidViewTargetLocator.kt
#	android/src/main/java/com/amplitude/android/internal/locators/ComposeLayoutNodeBoundsHelper.java
#	android/src/main/java/com/amplitude/android/internal/locators/ComposeViewTargetLocator.java
#	android/src/main/java/com/amplitude/android/internal/locators/ViewTargetLocator.kt
#	android/src/main/java/com/amplitude/android/internal/locators/ViewTargetLocators.kt
#	android/src/main/java/com/amplitude/android/utilities/DefaultEventUtils.kt
#	android/src/test/java/com/amplitude/android/internal/gestures/AutocaptureGestureListenerClickTest.kt
#	android/src/test/java/com/amplitude/android/internal/gestures/AutocaptureWindowCallbackTest.kt
@PouriaAmini
Remove Jetbrains Compose Gradle plugin
7960a07
@PouriaAmini
Change severity of error logs
38d68a5
@PouriaAmini PouriaAmini requested a review from a team June 12, 2024 17:49
@PouriaAmini PouriaAmini self-assigned this Jun 12, 2024
justin-fiedler
justin-fiedler approved these changes Jun 13, 2024
View reviewed changes
Copy link
Contributor

@justin-fiedler justin-fiedler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @PouriaAmini. LGTM. See nits.

android/src/main/java/com/amplitude/android/internal/gestures/AutocaptureGestureListener.kt Outdated Show resolved Hide resolved
...src/test/java/com/amplitude/android/internal/gestures/AutocaptureGestureListenerClickTest.kt Show resolved Hide resolved
@PouriaAmini PouriaAmini merged commit 1a5a392 into amplitude:main Jun 13, 2024
4 checks passed
github-actions bot pushed a commit that referenced this pull request Aug 8, 2024
@amplitude-sdk-bot
chore(release): 1.17.0 [skip ci]
d20a072 
# [1.17.0](v1.16.8...v1.17.0) (2024-08-08)

### Bug Fixes

* extract ComposeUtils to share with plugins ([#202](#202)) ([c239bba](c239bba))
* fix release pipeline ([#211](#211)) ([816599f](816599f))
* revert autocapture scroll and swipe ([#206](#206)) ([4b834bd](4b834bd))

### Features

* add autocapture for element clicks ([#199](#199)) ([7f0a500](7f0a500))
* add autocapture in configs ([#207](#207)) ([dcb9393](dcb9393))
* add screen name to elementInteractions properties for autocapture ([#209](#209)) ([8044122](8044122))
* add scroll and swipe autocapture ([#201](#201)) ([1a5a392](1a5a392))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@justin-fiedler justin-fiedler justin-fiedler approved these changes

Assignees

@PouriaAmini PouriaAmini

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@PouriaAmini @justin-fiedler