feat: support for custom device attributes and config #77

Shahroz16 · 2022-03-22T13:58:45Z

Complete each step to get your pull request merged in. Learn more about the workflow this project uses.

Assign members of your team to review the pull request.
Wait for pull request status checks to complete. If there are problems, fix them until you see that all status checks are passing.
Wait until the pull request has been reviewed and approved by a teammate
After pull request is approved, and you determine it's ready add the label "Ready to merge" to the pull request and it will automatically be merged.

ami-oss-ci · 2022-03-22T13:59:01Z

Pull request title looks good 👍. If this pull request gets merged, it will cause a new release of the software.

Example: If this project's latest release version is 1.0.0. If this pull request gets merged in, the next release of this project will be 1.1.0.

To merge this pull request, add the label Ready to merge to this pull request and I'll merge it for you.

app/src/main/java/io/customer/example/MainActivity.kt

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

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

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

levibostian · 2022-03-23T17:13:43Z

sdk/src/test/java/io/customer/sdk/CustomerIOTest.kt

+
+        val expectedToken = "token"
+
+        val expectedAttributes = customerIO.deviceAttributes + deviceStore.buildDeviceAttributes()


I have an idea to improve the quality of this test.

For the expected value, have as little logic involved in generating the expected value is a good idea. What I mean by logic is:

// logic is involved to create the expected value val expected = 2 + 2 // <-- if this had a bug in it, the test could give a false positive // compared to no logic val expected = 4 // <-- no logic == less chance of encountering a false positive.

In my past experience, I have encountered times where my test functions gave false positives because what I truly expected to be the expected value was incorrect. That was because it had too much logic involved where the logic actually had a bug in it.

So, I would suggest that this line of code instead says:

// instead of having logic generate the expected value, hard-code the expected value in. val expectedAttributes = mapOf("test" to "value, "push_enabled" to "true)

yes, this would require modifying the returned value from deviceStore.buildDeviceAttriutes() to something hard-coded/predictable but stubs should give the ability to modify returned values so it shouldn't be a problem.

sdk/src/test/java/io/customer/sdk/CustomerIOTest.kt

sdk/src/test/java/io/customer/sdk/MockCustomerIOBuilder.kt

sdk/src/test/java/io/customer/sdk/CustomerIOTest.kt

levibostian

There are 3 unresolved conversations in the PR. I am unsure how you plan to address those? Make a change now, make a ticket to change later, we decide to disagree with the suggestion and we don't make a change ever.

However, they are minor conversations so I am OK with moving this PR forward and into alpha!

levibostian · 2022-03-24T21:03:23Z

sdk/src/main/java/io/customer/sdk/data/store/BuildStore.kt

@@ -17,7 +17,7 @@ interface BuildStore {
    // Android SDK Version: 21
    val deviceOSVersion: Int

-    // Device locale: en
+    // Device locale: en-US


From conversations with LJ, I believe the backend is looking for en_US (notice underscore).

## [1.1.0-alpha.1](1.0.3...1.1.0-alpha.1) (2022-03-24) ### Features * added support for device attributes ([#71](#71)) ([5fedf26](5fedf26)) * support for custom device attributes and config ([#77](#77)) ([a7dbaba](a7dbaba)) ### Bug Fixes * added java compatibility in public constructors and methods ([acdec46](acdec46)) * added support for big decimal ([#56](#56)) ([58c791b](58c791b))

## [1.1.0-alpha.1](1.0.4...1.1.0-alpha.1) (2022-03-24) ### Features * added support for device attributes ([#71](#71)) ([5fedf26](5fedf26)) * support for custom device attributes and config ([#77](#77)) ([a7dbaba](a7dbaba)) ### Bug Fixes * added java compatibility in public constructors and methods ([acdec46](acdec46)) * added support for big decimal ([#56](#56)) ([58c791b](58c791b))

## [1.1.0-alpha.2](1.1.0-alpha.1...1.1.0-alpha.2) (2022-03-25) ### Features * support for custom device attributes and config ([#77](#77)) ([a7dbaba](a7dbaba)) ### Bug Fixes * added java compatibility in public constructors and methods ([2bb73be](2bb73be)) * allow http requests in host app ([#74](#74)) ([1035648](1035648)) * code cleanup ([c651ee6](c651ee6)) * crash using invalid characters in HTTP header ([#75](#75)) ([81a065e](81a065e))

ami-ci · 2022-03-25T12:30:45Z

🎉 This PR is included in version 1.1.0-alpha.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

## [2.0.0-beta.1](1.0.5...2.0.0-beta.1) (2022-05-13) ### ⚠ BREAKING CHANGES * 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)) * added support for custom track url ([b61a64b](b61a64b)) * added support for device attributes ([#71](#71)) ([5fedf26](5fedf26)) * create background queue to make API synchronous ([2524460](2524460)) * get current FCM token on SDK startup ([dda443d](dda443d)) * register device attributes when set ([0f5159e](0f5159e)) * set log level via SDK config ([81eea4e](81eea4e)) * support for custom device attributes and config ([#77](#77)) ([a7dbaba](a7dbaba)) ### Bug Fixes * added java compatibility in public constructors and methods ([acdec46](acdec46)) * added support for big decimal ([#56](#56)) ([58c791b](58c791b)) * code cleanup ([c651ee6](c651ee6)) * delete device token when clear identify ([72f9753](72f9753)) * events are tracked to identified customer ([71634ed](71634ed)) * queue attempts to run all tasks on each run ([e180dea](e180dea)) * register device tokens http request ([b1c6872](b1c6872))

ami-ci · 2022-05-13T20:41:20Z

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

The release is available on GitHub release

Your semantic-release bot 📦🚀

## [2.0.0](1.0.5...2.0.0) (2022-06-01) ### ⚠ BREAKING CHANGES * 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)) * added support for custom track url ([b61a64b](b61a64b)) * added support for device attributes ([#71](#71)) ([5fedf26](5fedf26)) * create background queue to make API synchronous ([2524460](2524460)) * get current FCM token on SDK startup ([dda443d](dda443d)) * register device attributes when set ([0f5159e](0f5159e)) * set log level via SDK config ([81eea4e](81eea4e)) * support for custom device attributes and config ([#77](#77)) ([a7dbaba](a7dbaba)) ### Bug Fixes * added java compatibility in public constructors and methods ([acdec46](acdec46)) * added support for big decimal ([#56](#56)) ([58c791b](58c791b)) * code cleanup ([c651ee6](c651ee6)) * delete device token when clear identify ([72f9753](72f9753)) * events are tracked to identified customer ([71634ed](71634ed)) * queue attempts to run all tasks on each run ([e180dea](e180dea)) * register device tokens http request ([b1c6872](b1c6872))

ami-ci · 2022-06-01T16:22:04Z

🎉 This PR is included in version 2.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))

support for custom device attributes and config

d768b54

Shahroz16 requested a review from levibostian March 22, 2022 13:58

levibostian reviewed Mar 22, 2022

View reviewed changes

attributes tests added and moved out of builder

6350b16

Shahroz16 requested a review from levibostian March 22, 2022 23:17

levibostian reviewed Mar 23, 2022

View reviewed changes

tests updated

78a011c

Shahroz16 requested a review from levibostian March 24, 2022 15:03

levibostian approved these changes Mar 24, 2022

View reviewed changes

updated local to show both language and country

a7fdc70

Shahroz16 merged commit a7dbaba into develop Mar 24, 2022

Shahroz16 deleted the shahroz/custom-device-attributes branch March 24, 2022 21:03

levibostian reviewed Mar 24, 2022

View reviewed changes

ami-ci added the released on @alpha label Mar 25, 2022

ami-ci added the released on @beta label May 13, 2022

ami-ci added the released label Jun 1, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support for custom device attributes and config #77

feat: support for custom device attributes and config #77

Shahroz16 commented Mar 22, 2022

ami-oss-ci commented Mar 22, 2022 •

edited

levibostian Mar 23, 2022

levibostian left a comment

levibostian Mar 24, 2022

ami-ci commented Mar 25, 2022

ami-ci commented May 13, 2022

ami-ci commented Jun 1, 2022


		val expectedToken = "token"

		val expectedAttributes = customerIO.deviceAttributes + deviceStore.buildDeviceAttributes()

feat: support for custom device attributes and config #77

feat: support for custom device attributes and config #77

Conversation

Shahroz16 commented Mar 22, 2022

ami-oss-ci commented Mar 22, 2022 • edited

levibostian Mar 23, 2022

Choose a reason for hiding this comment

levibostian left a comment

Choose a reason for hiding this comment

levibostian Mar 24, 2022

Choose a reason for hiding this comment

ami-ci commented Mar 25, 2022

ami-ci commented May 13, 2022

ami-ci commented Jun 1, 2022

ami-oss-ci commented Mar 22, 2022 •

edited