[Voice to Content] Error logging, tracking, and error state #20979

zwarm · 2024-06-13T16:22:57Z

Addresses

This PR implements the following Voice To Content

Adds a helper class for logging and tracking throughout the flow
Creates specific Failure results for PrepareVoiceToContentUseCase and VoiceToContentUseCase
Log error results from API calls and audio recording
Track events
Launch upgrade URL in external browser when out of credits

Note

The following have not yet been implemented
waveform
recording timer
orientation changes
landscape view
Overall polishing of the UI
Launch Edit Post

To Test:

The testing will focus on tracking

Install the JP from the device
Login and select a site that does not have AI credits
Navigate to Me > App Settings > Privacy settings > Enable collect information
Navigate to Me > Debug Settings
Enable the voice-to-content feature flag and restart the app (option is in the more menu of the debug settings view)
Navigate to My Site for the site with no AI credits
Tap the FAB and select the Post from audio option to launch the Post From Audio bottom sheet
✅ Validate the log contains the following entries:
🔵 Tracked: my_site_create_sheet_action_tapped, Properties: {"action":"create_new_post_from_audio"}
🔵 Tracked: voice_to_content_sheet_shown
🔵 Tracked: voice_to_content_button_recording_limit_reached
Tap the upgrade link to launch the upgrade in an external browser
Navigate back to the app
✅ Validate the log contains 🔵 Tracked: voice_to_content_button_upgrade_tapped
Tap the close button
✅ Validate the log contains 🔵 Tracked: voice_to_content_button_close_tapped
Navigate to a site that has AI credits
Tap the FAB and select the Post from audio option to launch the Post From Audio bottom sheet
✅ Validate the log contains the following entries:
🔵 Tracked: my_site_create_sheet_action_tapped, Properties: {"action":"create_new_post_from_audio"}
🔵 Tracked: voice_to_content_sheet_shown
Tap the microphone icon and record some audio
Tap the done icon when finished (note - the bottom sheet will close - the edit post will not launch yet)
✅ Validate the log contains the following entries:
🔵 Tracked: voice_to_content_button_start_recording_tapped
🔵 Tracked: voice_to_content_button_done_tapped

Regression Notes

Potential unintended areas of impact
The track events are not tracked
What I did to test those areas of impact (or what existing automated tests I relied on)
Manual tested
What automated tests I added (or what prevented me from doing so)
N/A

PR Submission Checklist:

I have completed the Regression Notes.
I have considered adding accessibility improvements for my changes.
I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

Testing Checklist (strike-out the not-applying and unnecessary ones): N/A

…errors from audio

dangermattic · 2024-06-13T16:25:44Z

	5 Warnings
⚠️	`strings.xml` files should only be updated on release branches, when the translations are downloaded by our automation.
⚠️	Class `Failure` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `VoiceToContentResult` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `Success` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	PR is not assigned to a milestone.

Generated by 🚫 Danger

sonarcloud · 2024-06-13T16:27:16Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

wpmobilebot · 2024-06-13T16:39:22Z

📲 You can test the changes from this Pull Request in Jetpack by scanning the QR code below to install the corresponding build.

	App Name	Jetpack
	Flavor	Jalapeno
	Build Type	Debug
	Version	pr20979-028cb1e
	Commit	`028cb1e`
	Direct Download	`jetpack-prototype-build-pr20979-028cb1e.apk`

Note: Google Login is not supported on these builds.

wpmobilebot · 2024-06-13T16:53:18Z

📲 You can test the changes from this Pull Request in WordPress by scanning the QR code below to install the corresponding build.

	App Name	WordPress
	Flavor	Jalapeno
	Build Type	Debug
	Version	pr20979-028cb1e
	Commit	`028cb1e`
	Direct Download	`wordpress-prototype-build-pr20979-028cb1e.apk`

Note: Google Login is not supported on these builds.

codecov · 2024-06-13T17:52:00Z

Codecov Report

Attention: Patch coverage is 8.25688% with 100 lines in your changes missing coverage. Please review.

Project coverage is 40.75%. Comparing base (756cbd8) to head (028cb1e).
Report is 7 commits behind head on trunk.

Files	Patch %	Lines
...droid/ui/voicetocontent/VoiceToContentViewModel.kt	11.86%	52 Missing ⚠️
...android/ui/voicetocontent/VoiceToContentUseCase.kt	0.00%	22 Missing ⚠️
.../ui/voicetocontent/PrepareVoiceToContentUseCase.kt	0.00%	11 Missing ⚠️
...droid/ui/voicetocontent/VoiceToContentTelemetry.kt	0.00%	6 Missing ⚠️
.../android/ui/voicetocontent/VoiceToContentScreen.kt	0.00%	4 Missing ⚠️
...android/ui/voicetocontent/VoiceToContentUiState.kt	33.33%	4 Missing ⚠️
...java/org/wordpress/android/ui/ActivityNavigator.kt	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##            trunk   #20979      +/-   ##
==========================================
- Coverage   40.79%   40.75%   -0.04%     
==========================================
  Files        1527     1528       +1     
  Lines       70079    70158      +79     
  Branches    11588    11603      +15     
==========================================
+ Hits        28589    28596       +7     
- Misses      38900    38972      +72     
  Partials     2590     2590

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

kean · 2024-06-13T18:26:57Z

Verified the changes according to the instructions. Looks good, but two comments:

voice-to-content FF was already enabled when I opened "Debug Settings" I logged in with my personal account (not P2/A8C)
The layout on the "Upgrade needed" screen looks a bit off

"error+retry" view is also not center.

kean · 2024-06-13T18:31:52Z

WordPress/src/main/java/org/wordpress/android/ui/voicetocontent/VoiceToContentUseCase.kt

@@ -25,6 +30,10 @@ class VoiceToContentUseCase @Inject constructor(
        file: File
    ): VoiceToContentResult =
        withContext(Dispatchers.IO) {
+            if (!networkUtilsWrapper.isNetworkAvailable()) {


Is it common on Android to stop the request without sending it in case the app thinks network is unavailable. On iOS, it's considered a bad practice because the respective API usually lags behind the real status a bit and is not always accurate.

@kean - yes, this is the way it's done on Android. Something perhaps for the future app team to align?

zwarm · 2024-06-13T18:50:03Z

Verified the changes according to the instructions. Looks good, but two comments:

voice-to-content FF was already enabled when I opened "Debug Settings" I logged in with my personal account (not P2/A8C)

That's odd indeed. Postman returns false for anything under 25.2. I'll see if it's set internally somewhere.

The layout on the "Upgrade needed" screen looks a bit off

The entire layout needs to be polished. 😜

Thanks for the feedback!

zwarm added 13 commits June 13, 2024 11:03

Add helper for logging and tracking

a2b5915

Add error resources

eaf6b08

Add error ui model-state

558ba02

Capture and log errors; return result failure

225a3f0

Add transitionToError for result failures, support ErrorUiModel, Log …

6b3988c

…errors from audio

Update error view with message and retry icon

d94a609

Add function for launching the browser to update plan for AI credits

bb4f0b3

Add voice-to-content tracker values to the enum

df56977

Rename to reflect this class does both logging and tracking

0cfeb4f

Update to reflect name change of logger

788d6f6

Add track events and hook in the upgrade link tapped

a1a1063

Observe onIneligibleForVoiceToContent events and launch upgrade link

e1c3b3a

Update new parameter

028cb1e

zwarm added [Type] Task Voice to Content labels Jun 13, 2024

zwarm requested a review from kean June 13, 2024 16:22

zwarm self-assigned this Jun 13, 2024

zwarm added the unit-tests-exemption label Jun 13, 2024

kean reviewed Jun 13, 2024

View reviewed changes

kean self-requested a review June 13, 2024 18:35

kean approved these changes Jun 13, 2024

View reviewed changes

zwarm merged commit 10b3bb3 into trunk Jun 13, 2024
22 checks passed

zwarm deleted the issue/v2c-error-logging-tracking branch June 13, 2024 18:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Voice to Content] Error logging, tracking, and error state #20979

[Voice to Content] Error logging, tracking, and error state #20979

zwarm commented Jun 13, 2024

dangermattic commented Jun 13, 2024 •

edited

Loading

sonarcloud bot commented Jun 13, 2024

wpmobilebot commented Jun 13, 2024

wpmobilebot commented Jun 13, 2024

codecov bot commented Jun 13, 2024

kean commented Jun 13, 2024 •

edited

Loading

kean Jun 13, 2024

zwarm Jun 13, 2024

zwarm commented Jun 13, 2024 •

edited

Loading

[Voice to Content] Error logging, tracking, and error state #20979

[Voice to Content] Error logging, tracking, and error state #20979

Conversation

zwarm commented Jun 13, 2024

To Test:

Regression Notes

PR Submission Checklist:

Testing Checklist (strike-out the not-applying and unnecessary ones): N/A

dangermattic commented Jun 13, 2024 • edited Loading

sonarcloud bot commented Jun 13, 2024

Quality Gate passed

wpmobilebot commented Jun 13, 2024

wpmobilebot commented Jun 13, 2024

codecov bot commented Jun 13, 2024

Codecov Report

kean commented Jun 13, 2024 • edited Loading

kean Jun 13, 2024

Choose a reason for hiding this comment

zwarm Jun 13, 2024

Choose a reason for hiding this comment

zwarm commented Jun 13, 2024 • edited Loading

dangermattic commented Jun 13, 2024 •

edited

Loading

kean commented Jun 13, 2024 •

edited

Loading

zwarm commented Jun 13, 2024 •

edited

Loading