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.

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

feat: Track IMPRESSION and SURVER_OPTION_CHOSEN for CustomerCenter #2124

Merged
merged 10 commits into from
Feb 11, 2025

Conversation

facumenzella
Copy link
Contributor

@facumenzella facumenzella commented Feb 7, 2025

Motivation

Introduce event tracking for CustomerCenter

Description

This PR starts tracking IMPRESSION and SURVER_OPTION_CHOSEN for CustomerCenter.

Things to have in mind:

  • I've removed serialization from CustomerCenter events because it was not used.
  • I've removed isSandbox because we can't track that here
  • I've moved appSessionID to events manager (similar to what's being done in iOS)

Doubts

  • I've added the locale, colorScheme and darkMode refresh methods BUT I wasn't sure if state needs to be updated. It does not seem to be used. Let me know if it should.

Comment on lines 515 to 517
if (shouldRefresh) {
_state.update { it }
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wanted to trigger a refresh, assuming this is how darkMode refresh works.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm I believe this updates the state with itself, so it wouldn't actually do any change. We would need to add some property to the state that actually needs to be updated I think? (which might come in a separate PR). Otherwise this is not needed I believe.

@facumenzella facumenzella changed the title feat: Track IMPRESSION for CustomerCenter feat: Track IMPRESSION and SURVER_OPTION_CHOSEN for CustomerCenter Feb 7, 2025
Copy link
Contributor

@tonidero tonidero left a comment

Choose a reason for hiding this comment

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

Looking good! Just some more comments

@@ -27,6 +30,7 @@ import kotlinx.serialization.modules.polymorphic
* @property postEvents Function for sending events to the backend.
*/
internal class EventsManager(
private val appSessionID: UUID = UUID.randomUUID(),
Copy link
Contributor

Choose a reason for hiding this comment

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

This may potentially be recreated if someone reconfigures the SDK. It's rare, but possible... Maybe it's ok to do it like this anyway since that's a pretty rare case. The alternative being storing this into a static variable.

Comment on lines 515 to 517
if (shouldRefresh) {
_state.update { it }
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm I believe this updates the state with itself, so it wouldn't actually do any change. We would need to add some property to the state that actually needs to be updated I think? (which might come in a separate PR). Otherwise this is not needed I believe.

Copy link

codecov bot commented Feb 10, 2025

Codecov Report

Attention: Patch coverage is 93.58974% with 5 lines in your changes missing coverage. Please review.

Project coverage is 80.82%. Comparing base (eee45a0) to head (ff6889f).
Report is 16 commits behind head on main.

Files with missing lines Patch % Lines
.../com/revenuecat/purchases/PurchasesOrchestrator.kt 50.00% 0 Missing and 2 partials ⚠️
...revenuecat/purchases/common/events/BackendEvent.kt 66.66% 2 Missing ⚠️
...evenuecat/purchases/common/events/EventsManager.kt 90.90% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2124      +/-   ##
==========================================
+ Coverage   80.43%   80.82%   +0.39%     
==========================================
  Files         274      275       +1     
  Lines        9194     9258      +64     
  Branches     1294     1294              
==========================================
+ Hits         7395     7483      +88     
+ Misses       1252     1229      -23     
+ Partials      547      546       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@facumenzella
Copy link
Contributor Author

Had a quick chat with @tonidero. I'll address the multiple json encoders / decoders in another PR, so we fix it once and for all.

@facumenzella facumenzella enabled auto-merge (squash) February 11, 2025 09:23
*
* @receiver The `PaywallEvent` to be converted.
* @param appUserID The user ID associated with the event.
* @return A `BackendStoredEvent.Paywalls` containing a `BackendEvent.Paywalls`.
Copy link
Contributor

Choose a reason for hiding this comment

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

let's update this docs and the ones of the above function

*/
@ExperimentalPreviewRevenueCatPurchasesAPI
@Poko
class CustomerCenterSurverOptionChosenEvent(
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
class CustomerCenterSurverOptionChosenEvent(
class CustomerCenterSurveyOptionChosenEvent(

@facumenzella facumenzella merged commit fc0ebe4 into main Feb 11, 2025
12 checks passed
@facumenzella facumenzella deleted the feat/track-impression-cc branch February 11, 2025 10:34
facumenzella added a commit that referenced this pull request Feb 11, 2025
### Motivation
This is a follow-up of
#2124

### Description
- Address typo
- Address wrong documentation
This was referenced Feb 12, 2025
tonidero added a commit that referenced this pull request Feb 14, 2025
**This is an automatic release.**

## RevenueCat SDK
### 🐞 Bugfixes
* fix: Add prepaid as a period type (#2141) via Greenie (@greenietea)

## RevenueCatUI SDK
### Paywalls v2
#### ✨ New Features
* [Paywalls V2] Adds support for Paywalls V2! (#2127) via JayShortway
(@JayShortway)
### Customer Center
#### ✨ New Features
* Adds support for `CustomerCenter` (#2156) via Cesar de la Vega
(@vegaro)

### 🔄 Other Changes
* [Paywalls V2] Deprecate PaywallFooter in favor of
OriginalTemplatePaywallFooter (#2111) via Toni Rico (@tonidero)
* feat: Filter CANCEL from help path if lifetime (#2140) via Facundo
Menzella (@facumenzella)
* fix: Localize Restore Purchases Dialog (#2139) via Facundo Menzella
(@facumenzella)
* fix: Hide contact support if there's no email (#2135) via Facundo
Menzella (@facumenzella)
* feat: Track IMPRESSION and SURVER_OPTION_CHOSEN for CustomerCenter
(#2124) via Facundo Menzella (@facumenzella)
* fix: Use TextButton instead of outline for Promotionals (#2138) via
Facundo Menzella (@facumenzella)
* Rename carousel slide to page (#2144) via Josh Holtz (@joshdholtz)
* [Paywalls V2] Make border draw on top of the image overlay (#2165) via
Toni Rico (@tonidero)
* [Paywalls V2] Gradients Reloaded: Makes linear gradients match CSS
even more closely (#2166) via JayShortway (@JayShortway)
* [Paywalls V2] Fix wrong spacers in Stack when some children are Fill
(#2164) via Toni Rico (@tonidero)
* chore: Unify Json encoding with JsonHelper (#2160) via Facundo
Menzella (@facumenzella)
* [Paywalls V2] Fixes the top system bar padding being applied to all
children in a vertical container (#2162) via JayShortway (@JayShortway)
* [Paywalls V2] Refactor to use a single ImageLoader singleton in
RevenueCatUI (#2161) via Toni Rico (@tonidero)
* [Paywalls V2] Apply stack margins to overlay badges (#2158) via Toni
Rico (@tonidero)
* [Paywalls V2] Disables the click handler for the selected package
(#2159) via JayShortway (@JayShortway)
* [Paywalls V2] Change stack distribution system to use spacers instead
of custom arrangements (#2154) via Toni Rico (@tonidero)
* [Paywalls V2] Fixes empty stacks not showing up. (#2157) via
JayShortway (@JayShortway)
* Explicitly sets the `defaults` flavor as the default. (#2155) via
JayShortway (@JayShortway)
* Updates on no active purchases screen (#2150) via Cesar de la Vega
(@vegaro)
* [Paywalls V2] Fix issue with sizing of stacks with nested badges
(#2152) via Toni Rico (@tonidero)
* [Paywalls V2] Fix issue with shadows overlapping long edgeToEdge
badges (#2149) via Toni Rico (@tonidero)
* [Paywalls V2] Adjusts the convex/concave offset to 10% of the image
height (#2151) via JayShortway (@JayShortway)
* [Paywalls V2] Fixes variables for multi month periods (#2148) via
JayShortway (@JayShortway)
* [Paywalls V2] Correctly handles variables for lifetime products
(#2145) via JayShortway (@JayShortway)
* [Paywalls V2] Add shadows to badge previews (#2147) via Toni Rico
(@tonidero)
* [Paywalls V2] Predownload paywall low res images (#2143) via Toni Rico
(@tonidero)
* [Paywalls V2] Makes linear gradients consistent with CSS (#2142) via
JayShortway (@JayShortway)
* [Paywalls V2] Adds edge-to-edge support (#2137) via JayShortway
(@JayShortway)
* [Paywalls V2] Make root stack component use all the available space by
default (#2136) via Toni Rico (@tonidero)
* [Paywalls V2] Avoids a crash if a package is missing (#2130) via
JayShortway (@JayShortway)
* [Paywalls V2] Fix stack clipping issues (#2126) via Toni Rico
(@tonidero)
* fix: Address typo and wrong doc for CustomerCenter events (#2133) via
Facundo Menzella (@facumenzella)
* [Paywalls V2] Fix merge conflict (#2134) via Toni Rico (@tonidero)
* [Paywalls V2] Actually ignores the font provider for V2. (#2129) via
JayShortway (@JayShortway)
* Rename `PromotionalOfferView` to `PromotionalOfferScreen` (#2132) via
Cesar de la Vega (@vegaro)
* [Paywalls V2] Support background images in StackComponent,
CarouselComponent, TabsComponent (#2131) via Toni Rico (@tonidero)
* [Paywalls V2] Support scroll orientation in StackComponent (#2108) via
Toni Rico (@tonidero)
* [Paywalls V2] Correctly selects packages on tabs (#2122) via
JayShortway (@JayShortway)
* Revamp UI in Customer Center (#2123) via Cesar de la Vega (@vegaro)
* [Paywalls V2] Remove cursive as a generic font (#2118) via Josh Holtz
(@joshdholtz)
* Publishes PaywallsTester to Internal testing track on every commit to
`main` (#2100) via JayShortway (@JayShortway)
* Fixes `X` in promo offer not dismissing the promo (#2110) via Cesar de
la Vega (@vegaro)
* [Paywalls V2] Published version of PaywallTester now uses the Paywalls
V2 Alpha RC project (#2093) via JayShortway (@JayShortway)
* [Paywalls V2] New overrides structure (#2120) via Toni Rico
(@tonidero)
* [Paywalls V2] Adds `TabsComponent` samples and tests (#2115) via
JayShortway (@JayShortway)
* Ignores `RestorePurchasesDialog` previews using `IgnoreEmergeSnapshot`
(#2116) via Cesar de la Vega (@vegaro)
* [Paywalls V2] Adds `TabsComponentView` (#2114) via JayShortway
(@JayShortway)
* Fixes "View field header collides with a variable" data binding error
in PurchaseTester (#2119) via JayShortway (@JayShortway)
* feat: Add support for tracking customer center events (#2117) via
Facundo Menzella (@facumenzella)
* [Paywalls V2] Adds `TabsComponentStyle` (#2113) via JayShortway
(@JayShortway)
* [Paywalls V2] Adds deserialization of `TabsComponent` (#2101) via
JayShortway (@JayShortway)
* [Paywalls V2] Implements Variables V2 (#2099) via JayShortway
(@JayShortway)
* refactor: Introduce EventsManager to track events for different
features (#2096) via Facundo Menzella (@facumenzella)
* Rename to Web Billing (#2094) via Antonio Borrero Granell (@antoniobg)
* [Paywalls V2] Fixes shadows drawing behind transparent components
(#2112) via JayShortway (@JayShortway)
* Fix title not being reset after closing Feedback Survey (#2109) via
Cesar de la Vega (@vegaro)
* Support for opening custom urls in Customer Center (#2107) via Cesar
de la Vega (@vegaro)
* Prices in accept promotional offer button (#2104) via Cesar de la Vega
(@vegaro)
* Customer Center use remote appearance config (#2102) via Cesar de la
Vega (@vegaro)
* [Paywalls V2] Use original paywall fallback when trying to use Footer
modes in a Components paywall (#2106) via Toni Rico (@tonidero)
* [Paywalls V2] Add more `ImageComponentView` preview tests (#2103) via
Toni Rico (@tonidero)
* [Paywalls V2] Add CarouselComponent page indicator animation (#2105)
via Toni Rico (@tonidero)
* [Paywalls V2] Add `CarouselComponentView` (#2095) via Toni Rico
(@tonidero)
* [Paywalls V2] Add `CarouselComponent` infrastructure (#2092) via Toni
Rico (@tonidero)
* [Paywalls V2] Adds new price calculations needed for Variables V2
(#2098) via JayShortway (@JayShortway)
* [Paywalls V2] Preparation for Variables V2 (#2097) via JayShortway
(@JayShortway)
* Promotional offers (#2011) via Cesar de la Vega (@vegaro)
* [Paywalls V2] No longer provides the entire `UiConfig` to
`StyleFactory` (#2091) via JayShortway (@JayShortway)
* [Paywalls V2] Adds support for custom fonts (#2090) via JayShortway
(@JayShortway)
* feat: Add basic customer center events (#2075) via Facundo Menzella
(@facumenzella)
* Add support to manage non-Google purchases in Customer Center (#2067)
via Cesar de la Vega (@vegaro)
* [Paywalls V2] Add `TimelineComponentView` (#2083) via Toni Rico
(@tonidero)
* [Paywalls V2] Process `TimelineComponent` overrides and state (#2082)
via Toni Rico (@tonidero)
* [Paywalls V2] Cleans up after implementing color aliases (#2087) via
JayShortway (@JayShortway)
* [Paywalls V2] Implements color aliases for backgrounds (#2086) via
JayShortway (@JayShortway)
* `PaywallTesterApp` is no longer wrapped in a `Surface` (#2089) via
JayShortway (@JayShortway)
* [Paywalls V2] Implements color aliases for shadows (#2085) via
JayShortway (@JayShortway)
* [Paywalls V2] Implements color aliases for borders (#2084) via
JayShortway (@JayShortway)
* [Paywalls V2] Implements color aliases for `TextComponent` (#2080) via
JayShortway (@JayShortway)
* [Paywalls V2] Add `TimelineComponent` network parsing (#2047) via Toni
Rico (@tonidero)
* [Paywalls V2] Implements color aliases for `ImageComponent` (#2079)
via JayShortway (@JayShortway)
* [Paywalls V2] Implements color aliases for `IconComponent` (#2078) via
JayShortway (@JayShortway)
* Build `SubscriptionDetailsView` using `CustomerInfo` (#2057) via Cesar
de la Vega (@vegaro)
* Some Material 3 updates to the `ManageSubscriptionsView` (#2072) via
JayShortway (@JayShortway)
* [Paywalls V2] Implements color aliases for `StackComponent` (#2076)
via JayShortway (@JayShortway)
* Fixes compilation of `IconComponentView`. (#2073) via JayShortway
(@JayShortway)
* [Paywalls V2] Make `edgeToEdge` top/bottom badge extend to entire
stack background (#2070) via Toni Rico (@tonidero)
* [Paywalls V2] Parses `UiConfig` (#2068) via JayShortway (@JayShortway)
* [Paywalls V2] Add `IconComponent` (#2071) via Toni Rico (@tonidero)
* [Paywalls V2] Badge: Handle main stack border width correctly in
overlay and nested badge styles (#2069) via Toni Rico (@tonidero)
* [Paywalls V2] Add `edgeToEdge` badge trailing/leading style layout
(#2054) via Toni Rico (@tonidero)
* [Paywalls V2] Adds support for fallback components (#2064) via
JayShortway (@JayShortway)

---------

Co-authored-by: revenuecat-ops <ops@revenuecat.com>
Co-authored-by: Toni Rico <toni.rico.diez@revenuecat.com>
Co-authored-by: Toni Rico <antonio.rico.diez@revenuecat.com>
Co-authored-by: Cesar de la Vega <cesarvegaro@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants