[Voice to Content] Initial UI #20961

zwarm · 2024-06-09T21:39:39Z

Part of:
https://github.com/Automattic/wordpress-mobile/issues/81
https://github.com/Automattic/wordpress-mobile/issues/83

This PR include the Base UI work for the Voice To Content Flow

Identifies VoiceToContentUiState and associated types
Flushes out strings
Compose screens and elements
Content styles
Basic waveform (needs a bunch of work)
Bottom sheet height set to 60% of the screen

Important

This PR does not include

A polished UI
A working waveform
Elapsed time viewer
Launch the Edit Post view
Proper error handling
Network connectivity checks
Unit tests for the VM and UseCase - these will follow post error handling

Testing instructions:

There is no official testing for this PR; however you can test the success flow by

Installing, launching, and logging into the app using your a8c account or an account that has AI requests available for a site
Select a site in which you have available AI requests
Navigate to Me > Debug Settings
Enable voice_to_content and restart the app
Navigate to My Site > Tap the FAB
Select "Post from Audio"
Tap the mic icon to begin recording
Say something :)
Tap the stop icon
✅ Verify the processing view is shown
The bottom sheet should close and look for "***=> result is " in the logs

Regression Notes

Potential unintended areas of impact
The voice to content flow is not working as expected
What I did to test those areas of impact (or what existing automated tests I relied on)
Manual testing
What automated tests I added (or what prevented me from doing so)
N/A

PR Submission Checklist: N/A

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

…ermission checks to the viewmodel, observe viewmodel

…eToContentUseCase and transitionTo methods. Reorged methods

dangermattic · 2024-06-09T21:41:58Z

	4 Warnings
⚠️	`strings.xml` files should only be updated on release branches, when the translations are downloaded by our automation.
⚠️	This PR is larger than 300 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.
⚠️	Class `PrepareVoiceToContentResult` is missing tests, but `unit-tests-exemption` label was set to ignore this.
⚠️	Class `HeaderUIModel` is missing tests, but `unit-tests-exemption` label was set to ignore this.

Generated by 🚫 Danger

wpmobilebot · 2024-06-09T21:59:09Z

📲 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	pr20961-82bf5ed
	Commit	`82bf5ed`
	Direct Download	`jetpack-prototype-build-pr20961-82bf5ed.apk`

Note: Google Login is not supported on these builds.

wpmobilebot · 2024-06-09T21:59:20Z

📲 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	pr20961-82bf5ed
	Commit	`82bf5ed`
	Direct Download	`wordpress-prototype-build-pr20961-82bf5ed.apk`

Note: Google Login is not supported on these builds.

…upgrade

# Conflicts: # build.gradle

wpmobilebot · 2024-06-11T10:02:44Z

Found 1 violations:

The PR caused some dependency changes (expand to see details)

-+--- org.wordpress:fluxc:{strictly trunk-b5d95fda4257bd1b3c94b33088f5e2a3f48ff1c2} -> trunk-b5d95fda4257bd1b3c94b33088f5e2a3f48ff1c2
-|    +--- org.wordpress:wellsql:2.0.0
-|    |    +--- androidx.annotation:annotation:1.2.0 -> 1.6.0 (*)
-|    |    \--- org.wordpress.wellsql:wellsql-annotations:2.0.0
-|    +--- org.wordpress.fluxc:fluxc-annotations:trunk-b5d95fda4257bd1b3c94b33088f5e2a3f48ff1c2
-|    +--- org.greenrobot:eventbus:3.3.1
-|    |    \--- org.greenrobot:eventbus-java:3.3.1
-|    +--- com.squareup.okhttp3:okhttp:4.9.0 -> 4.12.0 (*)
-|    +--- com.android.volley:volley:1.1.1 -> 1.2.1
-|    +--- androidx.paging:paging-runtime:2.1.2
-|    |    +--- androidx.paging:paging-common:2.1.2
-|    |    |    +--- androidx.annotation:annotation:1.0.0 -> 1.6.0 (*)
-|    |    |    \--- androidx.arch.core:core-common:2.0.0 -> 2.2.0 (*)
-|    |    +--- androidx.arch.core:core-runtime:2.0.0 -> 2.2.0 (*)
-|    |    +--- androidx.lifecycle:lifecycle-runtime:2.0.0 -> 2.6.2 (*)
-|    |    +--- androidx.lifecycle:lifecycle-livedata:2.0.0 -> 2.6.2 (*)
-|    |    \--- androidx.recyclerview:recyclerview:1.0.0 -> 1.3.0 (*)
-|    +--- com.goterl:lazysodium-android:5.0.2
-|    +--- net.java.dev.jna:jna:5.5.0
-|    +--- org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.20 -> 1.9.10 (*)
-|    +--- org.jetbrains.kotlin:kotlin-android-extensions-runtime:1.6.20 -> 1.9.22 (*)
-|    +--- androidx.appcompat:appcompat:1.0.2 -> 1.6.1 (*)
-|    +--- androidx.recyclerview:recyclerview:1.0.0 -> 1.3.0 (*)
-|    +--- androidx.exifinterface:exifinterface:1.0.0 -> 1.3.6 (*)
-|    +--- androidx.security:security-crypto:1.0.0
-|    |    +--- androidx.annotation:annotation:1.1.0 -> 1.6.0 (*)
-|    |    \--- com.google.crypto.tink:tink-android:1.5.0
-|    +--- com.squareup.okhttp3:okhttp-urlconnection:4.9.0 -> 4.9.2 (*)
-|    +--- com.google.code.gson:gson:2.8.5 -> 2.10.1
-|    +--- org.apache.commons:commons-text:1.10.0
-|    |    \--- org.apache.commons:commons-lang3:3.12.0
-|    +--- androidx.room:room-runtime:2.4.2 -> 2.5.0
-|    |    +--- androidx.annotation:annotation-experimental:1.1.0 -> 1.3.1 (*)
-|    |    +--- androidx.arch.core:core-runtime:2.0.1 -> 2.2.0 (*)
-|    |    +--- androidx.room:room-common:2.5.0
-|    |    |    +--- androidx.annotation:annotation:1.3.0 -> 1.6.0 (*)
-|    |    |    \--- org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.7.20 -> 1.9.10 (*)
-|    |    +--- androidx.sqlite:sqlite:2.3.0
-|    |    |    +--- androidx.annotation:annotation:1.0.0 -> 1.6.0 (*)
-|    |    |    \--- org.jetbrains.kotlin:kotlin-stdlib:1.7.20 -> 1.9.22 (*)
-|    |    \--- androidx.sqlite:sqlite-framework:2.3.0
-|    |         +--- androidx.annotation:annotation:1.2.0 -> 1.6.0 (*)
-|    |         +--- androidx.sqlite:sqlite:2.3.0 (*)
-|    |         \--- org.jetbrains.kotlin:kotlin-stdlib:1.7.20 -> 1.9.22 (*)
-|    +--- androidx.room:room-ktx:2.4.2 -> 2.5.0
-|    |    +--- androidx.room:room-common:2.5.0 (*)
-|    |    +--- androidx.room:room-runtime:2.5.0 (*)
-|    |    +--- org.jetbrains.kotlin:kotlin-stdlib:1.7.20 -> 1.9.22 (*)
-|    |    \--- org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4 -> 1.7.3 (*)
-|    +--- com.google.dagger:dagger:2.42 -> 2.50
-|    |    \--- javax.inject:javax.inject:1
-|    +--- org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.9 -> 1.7.3 (*)
-|    \--- org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9 -> 1.7.3 (*)
++--- org.wordpress:fluxc:{strictly trunk-0fe67fa241426afeaaa66bc3970ba46634efa5c8} -> trunk-0fe67fa241426afeaaa66bc3970ba46634efa5c8
+|    +--- org.wordpress:wellsql:2.0.0
+|    |    +--- androidx.annotation:annotation:1.2.0 -> 1.6.0 (*)
+|    |    \--- org.wordpress.wellsql:wellsql-annotations:2.0.0
+|    +--- org.wordpress.fluxc:fluxc-annotations:trunk-0fe67fa241426afeaaa66bc3970ba46634efa5c8
+|    +--- org.greenrobot:eventbus:3.3.1
+|    |    \--- org.greenrobot:eventbus-java:3.3.1
+|    +--- com.squareup.okhttp3:okhttp:4.9.0 -> 4.12.0 (*)
+|    +--- com.android.volley:volley:1.1.1 -> 1.2.1
+|    +--- androidx.paging:paging-runtime:2.1.2
+|    |    +--- androidx.paging:paging-common:2.1.2
+|    |    |    +--- androidx.annotation:annotation:1.0.0 -> 1.6.0 (*)
+|    |    |    \--- androidx.arch.core:core-common:2.0.0 -> 2.2.0 (*)
+|    |    +--- androidx.arch.core:core-runtime:2.0.0 -> 2.2.0 (*)
+|    |    +--- androidx.lifecycle:lifecycle-runtime:2.0.0 -> 2.6.2 (*)
+|    |    +--- androidx.lifecycle:lifecycle-livedata:2.0.0 -> 2.6.2 (*)
+|    |    \--- androidx.recyclerview:recyclerview:1.0.0 -> 1.3.0 (*)
+|    +--- com.goterl:lazysodium-android:5.0.2
+|    +--- net.java.dev.jna:jna:5.5.0
+|    +--- org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.20 -> 1.9.10 (*)
+|    +--- org.jetbrains.kotlin:kotlin-android-extensions-runtime:1.6.20 -> 1.9.22 (*)
+|    +--- androidx.appcompat:appcompat:1.0.2 -> 1.6.1 (*)
+|    +--- androidx.recyclerview:recyclerview:1.0.0 -> 1.3.0 (*)
+|    +--- androidx.exifinterface:exifinterface:1.0.0 -> 1.3.6 (*)
+|    +--- androidx.security:security-crypto:1.0.0
+|    |    +--- androidx.annotation:annotation:1.1.0 -> 1.6.0 (*)
+|    |    \--- com.google.crypto.tink:tink-android:1.5.0
+|    +--- com.squareup.okhttp3:okhttp-urlconnection:4.9.0 -> 4.9.2 (*)
+|    +--- com.google.code.gson:gson:2.8.5 -> 2.10.1
+|    +--- org.apache.commons:commons-text:1.10.0
+|    |    \--- org.apache.commons:commons-lang3:3.12.0
+|    +--- androidx.room:room-runtime:2.4.2 -> 2.5.0
+|    |    +--- androidx.annotation:annotation-experimental:1.1.0 -> 1.3.1 (*)
+|    |    +--- androidx.arch.core:core-runtime:2.0.1 -> 2.2.0 (*)
+|    |    +--- androidx.room:room-common:2.5.0
+|    |    |    +--- androidx.annotation:annotation:1.3.0 -> 1.6.0 (*)
+|    |    |    \--- org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.7.20 -> 1.9.10 (*)
+|    |    +--- androidx.sqlite:sqlite:2.3.0
+|    |    |    +--- androidx.annotation:annotation:1.0.0 -> 1.6.0 (*)
+|    |    |    \--- org.jetbrains.kotlin:kotlin-stdlib:1.7.20 -> 1.9.22 (*)
+|    |    \--- androidx.sqlite:sqlite-framework:2.3.0
+|    |         +--- androidx.annotation:annotation:1.2.0 -> 1.6.0 (*)
+|    |         +--- androidx.sqlite:sqlite:2.3.0 (*)
+|    |         \--- org.jetbrains.kotlin:kotlin-stdlib:1.7.20 -> 1.9.22 (*)
+|    +--- androidx.room:room-ktx:2.4.2 -> 2.5.0
+|    |    +--- androidx.room:room-common:2.5.0 (*)
+|    |    +--- androidx.room:room-runtime:2.5.0 (*)
+|    |    +--- org.jetbrains.kotlin:kotlin-stdlib:1.7.20 -> 1.9.22 (*)
+|    |    \--- org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4 -> 1.7.3 (*)
+|    +--- com.google.dagger:dagger:2.42 -> 2.50
+|    |    \--- javax.inject:javax.inject:1
+|    +--- org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.9 -> 1.7.3 (*)
+|    \--- org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9 -> 1.7.3 (*)
 \--- org.wordpress:login:1.15.0
-     \--- org.wordpress:fluxc:trunk-ed60798b4d96ec19863c74b0f525e2e20f4525db -> trunk-b5d95fda4257bd1b3c94b33088f5e2a3f48ff1c2 (*)
+     \--- org.wordpress:fluxc:trunk-ed60798b4d96ec19863c74b0f525e2e20f4525db -> trunk-0fe67fa241426afeaaa66bc3970ba46634efa5c8 (*)

Please review and act accordingly

pantstamp

LGTM!

sonarcloud · 2024-06-11T17:08:23Z

Quality Gate passed

Issues
7 New issues
0 Accepted issues

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

See analysis details on SonarCloud

codecov · 2024-06-11T17:28:50Z

Codecov Report

Attention: Patch coverage is 13.26316% with 412 lines in your changes missing coverage. Please review.

Project coverage is 40.79%. Comparing base (71b4b52) to head (82bf5ed).
Report is 3 commits behind head on trunk.

Files	Patch %	Lines
.../android/ui/voicetocontent/VoiceToContentScreen.kt	0.00%	242 Missing ⚠️
...rdpress/android/ui/voicetocontent/MicToStopIcon.kt	0.00%	67 Missing ⚠️
...droid/ui/voicetocontent/VoiceToContentViewModel.kt	28.57%	64 Missing and 1 partial ⚠️
...ss/android/ui/voicetocontent/WaveformVisualizer.kt	0.00%	25 Missing ⚠️
.../ui/voicetocontent/PrepareVoiceToContentUseCase.kt	0.00%	10 Missing and 1 partial ⚠️
.../org/wordpress/android/util/audio/AudioRecorder.kt	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##            trunk   #20961      +/-   ##
==========================================
- Coverage   40.98%   40.79%   -0.20%     
==========================================
  Files        1522     1527       +5     
  Lines       69628    70079     +451     
  Branches    11489    11588      +99     
==========================================
+ Hits        28540    28589      +49     
- Misses      38499    38900     +401     
- Partials     2589     2590       +1

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

zwarm added 18 commits May 30, 2024 17:04

Add UiState for voice to content

302ef26

Move VoiceToContent screen into it's own class with initial UI pass

0540358

Refactor: Move VoiceToContent screen into it's own class, move some p…

1fc33fa

…ermission checks to the viewmodel, observe viewmodel

Add string placeholders for voiceToContent

426528b

Add placeholder methods for uiState.

4ba9d75

Merge branch 'trunk' into issue/v2c-initial-UI

70d29cf

Move the call to jetpack ai assistant into its own use case

78b11f3

Update string placeholders

4ebfe65

Add ErrorView, FinishedView, and update existing

4f3032f

Add ErrorView and FinishedView to support the UI building

aebf427

Observe dismiss action, refactor method names, and call vm.start

129a892

Refactor: remove uiState and aiAssistantFeatureState. Add prepareVoic…

ff013f9

…eToContentUseCase and transitionTo methods. Reorged methods

A bunch of POC commits that I will come back to later

78ad550

Merge branch 'trunk' into issue/v2c-initial-UI

d8f6f5f

Add amplitudes to RecordingUpdate to be passed back to caller

9b97d8b

Initial shot as waveform

fd307b7

Refactor: uiState, models, and views

79a46fb

Address detekt issues

a8b7aaf

zwarm added [Status] Not Ready for Review [Type] Task [Status] Not Ready for Merge Voice to Content labels Jun 9, 2024

zwarm added this to the 25.2 milestone Jun 9, 2024

zwarm requested review from pantstamp and AjeshRPai June 9, 2024 21:39

AjeshRPai added 2 commits June 10, 2024 12:49

+ Adds: text styles for all fonts

7266580

→ Moves: styles to top of the previews

ab59085

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

zwarm added 7 commits June 10, 2024 14:56

Rename properties for messages related to ineligibility and upgrade

ee5cf02

Support renamed properties for messages related to ineligibility and …

eaccd7e

…upgrade

Remove delay and incorrect check

35a9994

Refactor: clean up unused strings

57de539

Apply correct strings

e98ada2

Update FluxC hash

50221d9

Merge branch 'trunk' into issue/v2c-initial-UI

e1f3ed3

zwarm marked this pull request as ready for review June 10, 2024 19:29

zwarm removed [Status] Not Ready for Review [Status] Not Ready for Merge labels Jun 10, 2024

zwarm and others added 3 commits June 10, 2024 16:15

Fix references to broken strings

fac2e05

Merge branch 'trunk' into issue/v2c-initial-UI

2ddd71f

# Conflicts: # build.gradle

Updates FluxC hash

c415bc5

pantstamp approved these changes Jun 11, 2024

View reviewed changes

pantstamp and others added 10 commits June 11, 2024 13:41

Fix unit tests

784aa42

Fix unit tests

c435cbe

Add microphone vector asset

27f8afd

Update to use ic mic

c315755

Revert back to normal after accidently commit

8c76a46

Add start test for the view model

5af902d

Fix checkstyle

bf16b77

Remove unused resource

7859334

Address failing test

fbc2040

Address detekt issues

82bf5ed

zwarm merged commit 82a794b into trunk Jun 11, 2024
20 checks passed

zwarm deleted the issue/v2c-initial-UI branch June 11, 2024 17:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Voice to Content] Initial UI #20961

[Voice to Content] Initial UI #20961

zwarm commented Jun 9, 2024 •

edited

dangermattic commented Jun 9, 2024 •

edited

wpmobilebot commented Jun 9, 2024 •

edited

wpmobilebot commented Jun 9, 2024 •

edited

wpmobilebot commented Jun 11, 2024

pantstamp left a comment

sonarcloud bot commented Jun 11, 2024

codecov bot commented Jun 11, 2024

[Voice to Content] Initial UI #20961

[Voice to Content] Initial UI #20961

Conversation

zwarm commented Jun 9, 2024 • edited

Testing instructions:

Regression Notes

PR Submission Checklist: N/A

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

dangermattic commented Jun 9, 2024 • edited

wpmobilebot commented Jun 9, 2024 • edited

wpmobilebot commented Jun 9, 2024 • edited

wpmobilebot commented Jun 11, 2024

pantstamp left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Jun 11, 2024

Quality Gate passed

codecov bot commented Jun 11, 2024

Codecov Report

zwarm commented Jun 9, 2024 •

edited

dangermattic commented Jun 9, 2024 •

edited

wpmobilebot commented Jun 9, 2024 •

edited

wpmobilebot commented Jun 9, 2024 •

edited