feat: automatic screen tracking #52

Shahroz16 · 2021-12-14T11:44:50Z

No description provided.

… screen-tracking-auto

levibostian · 2021-12-14T15:41:44Z

sdk/src/main/java/io/customer/sdk/CustomerIO.kt

@@ -56,6 +64,11 @@ class CustomerIO internal constructor(
            return this
        }

+        fun shouldAutoRecordScreenViews(shouldRecordScreenViews: Boolean): Builder {


If you want to keep things consistent, in the iOS SDK we autoTrackScreenViews as the function name for configuration.

levibostian · 2021-12-14T15:43:59Z

sdk/src/main/java/io/customer/sdk/CustomerIO.kt

+        val packageManager = activity.packageManager
+        return try {
+            val info = packageManager.getActivityInfo(
+                activity.componentName, PackageManager.GET_META_DATA
+            )
+            val activityLabel = info.loadLabel(packageManager)
+            screen(activityLabel.toString(), attributes)
+        } catch (e: PackageManager.NameNotFoundException) {
+            ActionUtils.getErrorAction(ErrorResult(error = ErrorDetail(message = "Activity Not Found: $e")))
+        } catch (e: Exception) {
+            ActionUtils.getErrorAction(ErrorResult(error = ErrorDetail(message = "Unable to track, $activity")))
+        }
+    }


Instead of this code, are we able to instead get the class name from the given Activity parameter? If an Activity class is named LoginActivity then we can use that class name?

The benefit of having this is, instead of getting class name which doesn't necessarily depict a screen, we fetch the label given to that activity in the Manifest.
A couple of clients we talked to wanted this approach as its quite standard.

levibostian · 2021-12-14T15:46:02Z

buildSrc/src/main/kotlin/io.customer/android/Dependencies.kt

@@ -29,6 +29,7 @@ object Dependencies {
    const val junit4 = "junit:junit:${Versions.JUNIT4}"
    const val kluent = "org.amshove.kluent:kluent:${Versions.KLUENT}"
    const val kotlinGradlePlugin = "org.jetbrains.kotlin:kotlin-gradle-plugin:${Versions.KOTLIN}"
+    const val lifecycleCommon = "androidx.lifecycle:lifecycle-common:${Versions.LIFECYCLE_COMMON}"


Do we need this dependency? Can we use this instead?

DefaultLifecycleObserver needs this, but it's focused more on the latest API. We can ignore for now.

# [1.0.0-alpha.8](1.0.0-alpha.7...1.0.0-alpha.8) (2021-12-15) ### Features * automatic screen tracking ([#52](#52)) ([8f95ebb](8f95ebb))

ami-ci · 2021-12-15T16:04:23Z

🎉 This PR is included in version 1.0.0-alpha.8 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

# 1.0.0-beta.1 (2021-12-16) ### Bug Fixes * pro-guarding removal of enums ([#39](#39)) ([dd27d35](dd27d35)) * timestamp conversion issue ([#37](#37)) ([d986f54](d986f54)) * user agent ([#42](#42)) ([37af83e](37af83e)) ### Features * automatic screen tracking ([#52](#52)) ([8f95ebb](8f95ebb)) * event tracking, identify customer ([#29](#29)) ([5181268](5181268)) * manual screen tracking ([#51](#51)) ([213a278](213a278)) * Push notification ([#31](#31)) ([c639802](c639802)) * Rich push support ([#34](#34)) ([2480127](2480127))

ami-ci · 2021-12-16T21:59:05Z

🎉 This PR is included in version 1.0.0-beta.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

# 1.0.0 (2022-01-19) ### Bug Fixes * pro-guarding removal of enums ([#39](#39)) ([dd27d35](dd27d35)) * timestamp conversion issue ([#37](#37)) ([d986f54](d986f54)) * updated host endpoints ([#53](#53)) ([efe2b9e](efe2b9e)) * user agent ([#42](#42)) ([37af83e](37af83e)) ### Features * automatic screen tracking ([#52](#52)) ([8f95ebb](8f95ebb)) * event tracking, identify customer ([#29](#29)) ([5181268](5181268)) * manual screen tracking ([#51](#51)) ([213a278](213a278)) * Push notification ([#31](#31)) ([c639802](c639802)) * Rich push support ([#34](#34)) ([2480127](2480127))

ami-ci · 2022-01-19T18:18:21Z

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

## 1.0.0 (2023-02-10) ### ⚠ BREAKING CHANGES * android 12 deep link fix * get current FCM token on SDK startup * register device attributes when set * create background queue to make API synchronous ### Features * add device and profile attribute setters ([789f09f](789f09f)) * add device_manufacturer device attribute ([6a60f39](6a60f39)) * add setting a in-app event listener ([customerio#147](https://github.com/nunofgs/customerio-android/issues/147)) ([5fd9559](5fd9559)) * added option to customize push notification from app ([68010f8](68010f8)) * added shared instance for independent components ([70fa8cd](70fa8cd)) * added support for custom track url ([b61a64b](b61a64b)) * added support for device attributes ([customerio#71](https://github.com/nunofgs/customerio-android/issues/71)) ([5fedf26](5fedf26)) * added support to modify notification small icon ([b93c2dc](b93c2dc)) * automatic screen tracking ([customerio#52](https://github.com/nunofgs/customerio-android/issues/52)) ([8f95ebb](8f95ebb)) * changes for react native package ([2f20ac3](2f20ac3)) * create background queue to make API synchronous ([2524460](2524460)) * delete expired background queue tasks ([8dca8b7](8dca8b7)) * event tracking, identify customer ([customerio#29](https://github.com/nunofgs/customerio-android/issues/29)) ([5181268](5181268)) * get current FCM token on SDK startup ([dda443d](dda443d)) * in app sdk ([1036c80](1036c80)) * in-app feature no longer requires orgId ([customerio#163](https://github.com/nunofgs/customerio-android/issues/163)) ([fc2a08e](fc2a08e)) * manual screen tracking ([customerio#51](https://github.com/nunofgs/customerio-android/issues/51)) ([213a278](213a278)) * Push notification ([customerio#31](https://github.com/nunofgs/customerio-android/issues/31)) ([c639802](c639802)) * register device attributes when set ([0f5159e](0f5159e)) * Rich push support ([customerio#34](https://github.com/nunofgs/customerio-android/issues/34)) ([2480127](2480127)) * sdk initialization re-architecture ([9e21960](9e21960)) * set log level via SDK config ([81eea4e](81eea4e)) * support for custom device attributes and config ([customerio#77](https://github.com/nunofgs/customerio-android/issues/77)) ([a7dbaba](a7dbaba)) * updated client to support react native user agent ([7588526](7588526)) ### Bug Fixes * added alternative route to fetch screen name for automatic tracking ([customerio#92](https://github.com/nunofgs/customerio-android/issues/92)) ([37a20b5](37a20b5)) * added java compatibility in public constructors and methods ([2bb73be](2bb73be)) * added java compatibility in public constructors and methods ([acdec46](acdec46)) * added support for big decimal ([customerio#56](https://github.com/nunofgs/customerio-android/issues/56)) ([58c791b](58c791b)) * allow http requests in host app ([customerio#74](https://github.com/nunofgs/customerio-android/issues/74)) ([1035648](1035648)) * android 12 deep link fix ([fd7ae28](fd7ae28)) * cio sdk version attribute using client value ([bb90f35](bb90f35)) * code cleanup ([c651ee6](c651ee6)) * crash using invalid characters in HTTP header ([customerio#75](https://github.com/nunofgs/customerio-android/issues/75)) ([81a065e](81a065e)) * delete device token when clear identify ([72f9753](72f9753)) * deploy code script commands ([customerio#124](https://github.com/nunofgs/customerio-android/issues/124)) ([fe817d1](fe817d1)) * events are tracked to identified customer ([71634ed](71634ed)) * in-app messages instant delivery ([customerio#150](https://github.com/nunofgs/customerio-android/issues/150)) ([a6dcf3c](a6dcf3c)) * in-app messages stop delivering ([4027502](4027502)) * in-app system link causes app reopen ([6349081](6349081)) * moved shared wrapper code ([customerio#158](https://github.com/nunofgs/customerio-android/issues/158)) ([51af98f](51af98f)) * number parsing coverts to double ([customerio#57](https://github.com/nunofgs/customerio-android/issues/57)) ([72a80fe](72a80fe)) * parsing exception for expired tasks ([440bb13](440bb13)) * pro-guarding removal of enums ([customerio#39](https://github.com/nunofgs/customerio-android/issues/39)) ([dd27d35](dd27d35)) * queue attempts to run all tasks on each run ([e180dea](e180dea)) * register device tokens http request ([b1c6872](b1c6872)) * remove currentRoute parameter in in-app event listener ([customerio#159](https://github.com/nunofgs/customerio-android/issues/159)) ([688e4a5](688e4a5)) * rename in app listener keys ([customerio#164](https://github.com/nunofgs/customerio-android/issues/164)) ([f540eaf](f540eaf)) * set gist user token incase identifier exists ([customerio#162](https://github.com/nunofgs/customerio-android/issues/162)) ([44cc4d1](44cc4d1)) * timestamp conversion issue ([customerio#37](https://github.com/nunofgs/customerio-android/issues/37)) ([d986f54](d986f54)) * track opens fcm notification payload ([ab3cd18](ab3cd18)) * updated host endpoints ([customerio#53](https://github.com/nunofgs/customerio-android/issues/53)) ([efe2b9e](efe2b9e)) * updated json adapter usage to safe parsing ([f72280b](f72280b)) * upgrade dependencies ([customerio#146](https://github.com/nunofgs/customerio-android/issues/146)) ([6da8b8d](6da8b8d)) * user agent ([customerio#42](https://github.com/nunofgs/customerio-android/issues/42)) ([37af83e](37af83e)) * user agent client support in preferences repo ([454a18e](454a18e)) * version bump for gist sdk to resolve messaging not showing bug ([05dad42](05dad42))

## 1.0.0 (2023-02-13) ### ⚠ BREAKING CHANGES * android 12 deep link fix * get current FCM token on SDK startup * register device attributes when set * create background queue to make API synchronous ### Features * add device and profile attribute setters ([789f09f](789f09f)) * add device_manufacturer device attribute ([6a60f39](6a60f39)) * add setting a in-app event listener ([customerio#147](https://github.com/nunofgs/customerio-android/issues/147)) ([5fd9559](5fd9559)) * added option to customize push notification from app ([68010f8](68010f8)) * added shared instance for independent components ([70fa8cd](70fa8cd)) * added support for custom track url ([b61a64b](b61a64b)) * added support for device attributes ([customerio#71](https://github.com/nunofgs/customerio-android/issues/71)) ([5fedf26](5fedf26)) * added support to modify notification small icon ([b93c2dc](b93c2dc)) * automatic screen tracking ([customerio#52](https://github.com/nunofgs/customerio-android/issues/52)) ([8f95ebb](8f95ebb)) * changes for react native package ([2f20ac3](2f20ac3)) * create background queue to make API synchronous ([2524460](2524460)) * delete expired background queue tasks ([8dca8b7](8dca8b7)) * event tracking, identify customer ([customerio#29](https://github.com/nunofgs/customerio-android/issues/29)) ([5181268](5181268)) * get current FCM token on SDK startup ([dda443d](dda443d)) * in app sdk ([1036c80](1036c80)) * in-app feature no longer requires orgId ([customerio#163](https://github.com/nunofgs/customerio-android/issues/163)) ([fc2a08e](fc2a08e)) * manual screen tracking ([customerio#51](https://github.com/nunofgs/customerio-android/issues/51)) ([213a278](213a278)) * Push notification ([customerio#31](https://github.com/nunofgs/customerio-android/issues/31)) ([c639802](c639802)) * register device attributes when set ([0f5159e](0f5159e)) * Rich push support ([customerio#34](https://github.com/nunofgs/customerio-android/issues/34)) ([2480127](2480127)) * sdk initialization re-architecture ([9e21960](9e21960)) * set log level via SDK config ([81eea4e](81eea4e)) * support for custom device attributes and config ([customerio#77](https://github.com/nunofgs/customerio-android/issues/77)) ([a7dbaba](a7dbaba)) * updated client to support react native user agent ([7588526](7588526)) ### Bug Fixes * added alternative route to fetch screen name for automatic tracking ([customerio#92](https://github.com/nunofgs/customerio-android/issues/92)) ([37a20b5](37a20b5)) * added java compatibility in public constructors and methods ([2bb73be](2bb73be)) * added java compatibility in public constructors and methods ([acdec46](acdec46)) * added support for big decimal ([customerio#56](https://github.com/nunofgs/customerio-android/issues/56)) ([58c791b](58c791b)) * allow http requests in host app ([customerio#74](https://github.com/nunofgs/customerio-android/issues/74)) ([1035648](1035648)) * android 12 deep link fix ([fd7ae28](fd7ae28)) * cio sdk version attribute using client value ([bb90f35](bb90f35)) * code cleanup ([c651ee6](c651ee6)) * crash using invalid characters in HTTP header ([customerio#75](https://github.com/nunofgs/customerio-android/issues/75)) ([81a065e](81a065e)) * delete device token when clear identify ([72f9753](72f9753)) * deploy code script commands ([customerio#124](https://github.com/nunofgs/customerio-android/issues/124)) ([fe817d1](fe817d1)) * events are tracked to identified customer ([71634ed](71634ed)) * in-app messages instant delivery ([customerio#150](https://github.com/nunofgs/customerio-android/issues/150)) ([a6dcf3c](a6dcf3c)) * in-app messages stop delivering ([4027502](4027502)) * in-app system link causes app reopen ([6349081](6349081)) * moved shared wrapper code ([customerio#158](https://github.com/nunofgs/customerio-android/issues/158)) ([51af98f](51af98f)) * number parsing coverts to double ([customerio#57](https://github.com/nunofgs/customerio-android/issues/57)) ([72a80fe](72a80fe)) * parsing exception for expired tasks ([440bb13](440bb13)) * pro-guarding removal of enums ([customerio#39](https://github.com/nunofgs/customerio-android/issues/39)) ([dd27d35](dd27d35)) * queue attempts to run all tasks on each run ([e180dea](e180dea)) * register device tokens http request ([b1c6872](b1c6872)) * remove currentRoute parameter in in-app event listener ([customerio#159](https://github.com/nunofgs/customerio-android/issues/159)) ([688e4a5](688e4a5)) * rename in app listener keys ([customerio#164](https://github.com/nunofgs/customerio-android/issues/164)) ([f540eaf](f540eaf)) * set gist user token incase identifier exists ([customerio#162](https://github.com/nunofgs/customerio-android/issues/162)) ([44cc4d1](44cc4d1)) * timestamp conversion issue ([customerio#37](https://github.com/nunofgs/customerio-android/issues/37)) ([d986f54](d986f54)) * track opens fcm notification payload ([ab3cd18](ab3cd18)) * updated host endpoints ([customerio#53](https://github.com/nunofgs/customerio-android/issues/53)) ([efe2b9e](efe2b9e)) * updated json adapter usage to safe parsing ([f72280b](f72280b)) * upgrade dependencies ([customerio#146](https://github.com/nunofgs/customerio-android/issues/146)) ([6da8b8d](6da8b8d)) * user agent ([customerio#42](https://github.com/nunofgs/customerio-android/issues/42)) ([37af83e](37af83e)) * user agent client support in preferences repo ([454a18e](454a18e)) * version bump for gist sdk to resolve messaging not showing bug ([05dad42](05dad42))

Shahroz16 added 6 commits December 9, 2021 20:39

added manual screen tracking

8dbf0d7

Added tests for manual screen tracking

06e1416

updated handling of retrofit wrapper

2a10a56

Added automatic tracking via activity lifecycle callback

9ed8df5

Merge branch 'alpha' of github.com:customerio/customerio-android into…

67848f2

… screen-tracking-auto

updated tests

95ba308

Shahroz16 requested a review from levibostian December 14, 2021 11:53

levibostian reviewed Dec 14, 2021

View reviewed changes

PR suggestions

b599ab1

levibostian approved these changes Dec 15, 2021

View reviewed changes

Shahroz16 merged commit 8f95ebb into alpha Dec 15, 2021

Shahroz16 deleted the screen-tracking-auto branch December 15, 2021 15:39

github-actions bot pushed a commit that referenced this pull request Dec 15, 2021

chore(release): 1.0.0-alpha.8 [skip ci]

336204a

# [1.0.0-alpha.8](1.0.0-alpha.7...1.0.0-alpha.8) (2021-12-15) ### Features * automatic screen tracking ([#52](#52)) ([8f95ebb](8f95ebb))

ami-ci added the released on @alpha label Dec 15, 2021

ami-ci added the released on @beta label Dec 16, 2021

ami-ci added the released label Jan 19, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: automatic screen tracking #52

feat: automatic screen tracking #52

Shahroz16 commented Dec 14, 2021

levibostian Dec 14, 2021

levibostian Dec 14, 2021

Shahroz16 Dec 15, 2021

levibostian Dec 14, 2021

Shahroz16 Dec 15, 2021

ami-ci commented Dec 15, 2021

ami-ci commented Dec 16, 2021

ami-ci commented Jan 19, 2022

feat: automatic screen tracking #52

feat: automatic screen tracking #52

Conversation

Shahroz16 commented Dec 14, 2021

levibostian Dec 14, 2021

Choose a reason for hiding this comment

levibostian Dec 14, 2021

Choose a reason for hiding this comment

Shahroz16 Dec 15, 2021

Choose a reason for hiding this comment

levibostian Dec 14, 2021

Choose a reason for hiding this comment

Shahroz16 Dec 15, 2021

Choose a reason for hiding this comment

ami-ci commented Dec 15, 2021

ami-ci commented Dec 16, 2021

ami-ci commented Jan 19, 2022