Debug view: Initial UI + Usage in MagicWeatherCompose by tonidero · Pull Request #1075 · RevenueCat/purchases-android

tonidero · 2023-06-19T12:59:28Z

Description

Same as was added in iOS in RevenueCat/purchases-ios#2567. Includes the changes in #1180

This PR adds a debug view in the Android SDK and uses it in the MagicWeatherCompose sample app. This debug view is meant to be a Jetpack compose function, even though later we might add convenience accessors for people not using jetpack compose. It's extracted to a different module so it can be published separately from the main SDK. It also attempts to keep all the code in the debug source set, to try to include as few code in the release variants.

The provided API is currently 2 composable functions:

DebugRevenueCatDebugScreen: This is the actual UI that is part of the debug screen. In case devs want to use it in a custom UI.
DebugRevenueCatBottomSheet: This will display the debug screen as a bottom sheet. This is what's used in the MagicWeatherCompose sample app.

TODO

Allow visualizing offerings in debug menu
Support non-composable apps by wrapping it into a fragment, with utility launch methods.
Split library for debug and release
Add UI tests
Support publishing the new module as different libraries for debug and release.
Remove module local substitution once debugview library has been published

Screen_recording_20230728_115505.mp4

tonidero · 2023-06-19T13:00:31Z

Had to update kotlin to 1.8 in this module, it didn't work even with 1.7.20 unless I downgraded compose a lot. Considering this is meant to be a new library, we can require Kotlin 1.8 I think.

tonidero · 2023-06-19T13:01:14Z

The release version of this composable does nothing.

codecov · 2023-07-28T08:38:18Z

Codecov Report

Merging #1075 (819508f) into main (b428869) will not change coverage.
The diff coverage is n/a.

❗ Current head 819508f differs from pull request most recent head 5ec4c4f. Consider uploading reports for the commit 5ec4c4f to get more accurate results

@@           Coverage Diff           @@
##             main    #1075   +/-   ##
=======================================
  Coverage   85.92%   85.92%           
=======================================
  Files         181      181           
  Lines        6216     6216           
  Branches      899      899           
=======================================
  Hits         5341     5341           
  Misses        533      533           
  Partials      342      342

tonidero · 2023-07-28T09:24:46Z

This is so it doesn't warn us about compose preview functions being unused.

tonidero · 2023-07-28T09:35:53Z

Will need to leave this until the debug view has been deployed at least once

tonidero · 2023-07-28T09:43:24Z

The compiler version needs to match the kotlin version https://developer.android.com/jetpack/androidx/releases/compose-kotlin. And for 1.7.21, it needs to be 1.4.0-alpha02. It won't work with 1.4.0. The alternative here would be to downgrade to 1.7.20, which would match with compiler version 1.3.2... As for upgrading to kotlin 1.8, it would cause breaking changes, since it seems apps using kotlin 1.6 aren't really compatible due to some dependencies. Open to suggestions here... For now, I haven't had issues using the alpha version

tonidero · 2023-07-28T09:46:19Z

I'm commenting this out for now until I completely finish the debug view and is ready to be published as a separate package.

tonidero · 2023-07-28T09:47:00Z

Open to thoughts about the dependency name. I'm thinking something like this for the "debug" library and something like com.revenuecat.purchases:debugview-noop for the release version

I think this is fine. I thought about only debug but that might imply other stuff like debug logs or something like that

tonidero · 2023-07-28T10:49:29Z

The bottom sheet APIs I'm using are marked as experimental, so I'm forced to opt in. This means there might be breaking changes at any point :(.

I thought about using Material instead of Material3 to do this, but the paradigm is quite different... In Material's version, you need to pass the UI below the bottom sheet as the content of the composable. IMO, that's not ideal, so I understand the new architecture they are using in Material3. In the end, I decided to go with Material3's version since it provides a much easier to use API and more modern UI as well.

This is a debug thing so I think it's fine to do this.

tonidero · 2023-07-28T10:51:27Z

Still need to make offerings visible. My idea is to display them as alerts in a future PR. Navigation within bottom sheets requires additional experimental libraries on Google's side, so I wanted to avoid that for now.

NachoSoto

Exciting 😍

NachoSoto · 2023-07-28T12:25:32Z

Haha this is basically just like @ViewBuilder.

Yup it's super similar to SwiftUI :P

NachoSoto · 2023-07-28T12:25:45Z

Should this be com.revenuecat.purchases.ui maybe? Are you thinking of having a separate one for "future" UI? 👀

Hmm maybe... I was thinking that for other ui projects, those would belong to other modules/dependencies, but maybe we could scope all those under ui. So maybe rename to com.revenuecat.purchases.ui.debugview. Wdyt?

ui.debugview sounds good to me

I will do this rename in a followup PR to avoid conflicts

NachoSoto · 2023-07-28T12:26:35Z

This is a debug thing so I think it's fine to do this.

vegaro · 2023-07-31T16:37:36Z

vegaro

This looks very good! Good job!

vegaro · 2023-08-02T12:46:17Z

ui.debugview sounds good to me

vegaro · 2023-08-02T13:22:32Z

do you think this function should be toSettingGroupStates()?

vegaro · 2023-08-02T14:08:43Z

Should this be part of a viewModel or is it fine here? I am not that familiar

I thought about it, unfortunately we don't have a view model for the MainScreen right now, so it was easier to move it here... But yeah, this is something that could be moved to a view model.

vegaro · 2023-08-02T14:09:24Z

I think this is fine. I thought about only debug but that might imply other stuff like debug logs or something like that

…1180) ### Description This reverts the changes in #1169, and additionally makes some changes so we only apply the maven publish plugin when using the `defaults` flavor in non-purchases modules. This should avoid having to have extra flavors in those modules and having them support the `customEntitlementComputation` flavor. This was becoming a bit of a problem as I was working in the debug view #1075. Since some of the functions I'm using aren't in the `customEntitlementComputation` flavor. I could have split the debug view library by flavor to make it compatible, but that seems like unnecessary work.

@vegaro

**This is an automatic release.** ### Bugfixes * Fix NoSuchElementException by using poll when accessing serviceRequests (#1190) via Cesar de la Vega (@vegaro) ### Other Changes * Debug view: rename package (#1191) via Toni Rico (@tonidero) * Debugview: Add snapshot tests for debug view using Paparazzi (#1187) via Toni Rico (@tonidero) * Debug view: Add offerings section and purchasing capabilities (#1186) via Toni Rico (@tonidero) * Debug view: Initial UI + Usage in MagicWeatherCompose (#1075) via Toni Rico (@tonidero) * Remove customEntitlementComputation flavor for non-purchases modules (#1180) via Toni Rico (@tonidero) Co-authored-by: revenuecat-ops <ops@revenuecat.com>

tonidero added the test label Jun 19, 2023

tonidero commented Jun 19, 2023

View reviewed changes

Comment thread ...g/kotlin/com/revenuecat/purchases/debugview/models/InternalDebugRevenueCatScreenViewModel.kt Outdated

tonidero force-pushed the debug-view branch from 397c09e to ff6711b Compare June 19, 2023 13:53

tonidero force-pushed the debug-view branch from ff6711b to 9ee7d6b Compare July 27, 2023 11:32

tonidero mentioned this pull request Jul 27, 2023

Remove customEntitlementComputation flavor for non-purchases modules #1180

Merged

tonidero force-pushed the debug-view branch from c403bfa to db66d4a Compare July 27, 2023 16:12

tonidero force-pushed the debug-view branch from 0f0e81f to c40c09b Compare July 28, 2023 09:25

tonidero commented Jul 28, 2023

View reviewed changes

tonidero changed the title ~~[WIP] Debug view~~ Debug view: Initial UI + Usage in MagicWeatherCompose Jul 28, 2023

tonidero marked this pull request as ready for review July 28, 2023 12:15

tonidero requested a review from a team July 28, 2023 12:15

NachoSoto reviewed Jul 28, 2023

View reviewed changes

tonidero force-pushed the debug-view branch from c9698fd to 67b586f Compare July 31, 2023 12:31

vegaro reviewed Jul 31, 2023

View reviewed changes

tonidero requested a review from vegaro August 1, 2023 09:12

vegaro approved these changes Aug 2, 2023

View reviewed changes

tonidero added 9 commits August 3, 2023 11:40

Create module

8979f51

Add debug view basic composables

1cfb96f

Move some files and fix after rebase

8fcc762

Testing: Use debugview library in magic weather compose for testing

65addba

Add some customer info to debug view

e484816

Move to use gradle catalogs

5bdd46a

Support scrolling

81c47c8

Improve UI

beb8f0c

Add new sections to customer info section

eb43f3e

tonidero added 17 commits August 3, 2023 11:40

Use viewModel and coroutines

34e9338

Remove unnecessary loading states and simplify things

93ee362

Fix screen preview

c72d2b9

Fix after rebase

07598f0

update magic weather compose to kotlin 1.7.21

cba31d2

Only apply maven publish plugin if defaults variant

d79898b

Add header to menu

2ca4245

Add bottom sheet

4d8e189

Fix tests

ac9034d

Handle exceptions during SDK operations

da8d63a

Improve API and logic to display debug menu

fbcd63a

Some cleanup

f058670

Disable publishing debugview for now

723b854

Add api tests

1c18c51

Add new line

be8bcc4

Move kotlin bom to toml file

f49aabc

Rename function

5ec4c4f

tonidero force-pushed the debug-view branch from 819508f to 5ec4c4f Compare August 3, 2023 09:44

tonidero enabled auto-merge (squash) August 3, 2023 09:44

tonidero merged commit 1c5f6e9 into main Aug 3, 2023

tonidero deleted the debug-view branch August 3, 2023 09:58

RCGitBot mentioned this pull request Aug 9, 2023

[AUTOMATIC] Release/6.9.1 #1196

Merged

Conversation

tonidero commented Jun 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

TODO

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov Bot commented Jul 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tonidero Jul 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tonidero Jul 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NachoSoto left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vegaro left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

tonidero commented Jun 19, 2023 •

edited

Loading

codecov Bot commented Jul 28, 2023 •

edited

Loading

tonidero Jul 28, 2023 •

edited

Loading

tonidero Jul 28, 2023 •

edited

Loading