[Voice to Content] Support device rotation while recording #20995

zwarm · 2024-06-17T13:38:11Z

Fixes https://github.com/Automattic/wordpress-mobile/issues/77

This PR adds support for device rotation

Add fun isRecording() and fun isPaused() to IAudioRecorder` interface to allow checking if the audio recorder is currently recording or paused.
Update RecordingUseCase to allow access to the values mentioned above
Update VoiceToContentViewModel to receive the flow and add to the UI state for use in the VoiceToContentScreen
Update VoiceToContentScreen and MicToStopIcon to use the isRecording value to drive visual components
Update relevant classes to implement the new methods
Replace log.util with AppLog statements in AudioRecorder
Only endRecordingSession is one is in session

This PR is the companion app for wordpress-mobile/WordPress-FluxC-Android#3035. See merge notes.

This branch build upon issue/v2c-show-elapsed-time

Important

Merge Instructions

Make sure [Voice to Content] Clear recorder resources #20983, [Voice to Content\ Implement elapsed time indicator #20984, and [Voice to Content] Launch edit post with AI content #20992 have been merged to trunk
Make sure [Voice to Content] Fix NPE in jetpack ai query call WordPress-FluxC-Android#3035 has been merged to trunk
Grab the FluxC hash from the CI merge to trunk
Update the fluxC hash in build.gradle & commit
Remove the Not Ready for Merge Label
Merge as normal

Note

The following have not yet been implemented:

Overall polishing of the UI
Unit tests

To Test:

Install and launch the app
Login with an account that has access to AI credits (Any a8c P2 will have this - other free sites have 20 requests)
Navigate to Me > Debug Settings and enable the voice_to_content flag (restart the app)
Navigate to My Site and tap the FAB
Select the Post with Audio option
Start the recording session by tapping on the mic icon
Record a blog post - a few words, maybe include a list, try it out
Rotate the device
✅ Verify the recording view remains on the screen and you are still able to record
Continue recording some audio
Tap the done icon and wait for the Edit Post view
✅ Verify content reflects the audio content from before and after the device rotation
Note: There is a known issue that sometimes all the content shows in the title instead of the body. This is a GB transformation issue that will be addressed separately.

Regression Notes

Potential unintended areas of impact
The app crashes or doesn't pick up recording where it was left off.
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:

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

…rding or is paused.

…gUse methods.

…tude and remaining time.

wpmobilebot · 2024-06-17T13:55:55Z

📲 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	pr20995-b3fba93
	Commit	`b3fba93`
	Direct Download	`jetpack-prototype-build-pr20995-b3fba93.apk`

Note: Google Login is not supported on these builds.

wpmobilebot · 2024-06-17T13:57:46Z

📲 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	pr20995-b3fba93
	Commit	`b3fba93`
	Direct Download	`wordpress-prototype-build-pr20995-b3fba93.apk`

Note: Google Login is not supported on these builds.

codecov · 2024-06-17T14:09:45Z

Codecov Report

Attention: Patch coverage is 6.15385% with 61 lines in your changes missing coverage. Please review.

Project coverage is 40.73%. Comparing base (5a648b3) to head (d665c58).
Report is 45 commits behind head on trunk.

❗ Current head d665c58 differs from pull request most recent head 942b497

Please upload reports for the commit 942b497 to get more accurate results.

Files	Patch %	Lines
.../org/wordpress/android/util/audio/AudioRecorder.kt	0.00%	29 Missing ⚠️
.../android/ui/voicetocontent/VoiceToContentScreen.kt	0.00%	14 Missing ⚠️
...droid/ui/voicetocontent/VoiceToContentViewModel.kt	20.00%	8 Missing ⚠️
...ress/android/ui/voicetocontent/RecordingUseCase.kt	0.00%	4 Missing ⚠️
...rdpress/android/ui/voicetocontent/MicToStopIcon.kt	0.00%	3 Missing ⚠️
...android/ui/voicetocontent/VoiceToContentUseCase.kt	0.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##            trunk   #20995      +/-   ##
==========================================
- Coverage   40.73%   40.73%   -0.01%     
==========================================
  Files        1529     1529              
  Lines       70202    70220      +18     
  Branches    11613    11616       +3     
==========================================
+ Hits        28600    28604       +4     
- Misses      39012    39026      +14     
  Partials     2590     2590

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

notandyvee

Verify content reflects the audio content from before and after the device rotation
Note: There is a known issue that sometimes all the content shows in the title instead of the body. This is a GB transformation issue that will be addressed separately.

I tested and when changing orientation it actually did not save the previous text before the orientation change. Maybe I did something wrong?

notandyvee

I just tried multiple times, and now it works 🤔 . I'll do a quick re-review and make sure I didn't miss anything.

notandyvee

Changes LGTM 👍🏻 . Testing was a bit flaky. But overall the point was to support rotation changes. Which it does. Good work. I won't merge because another PR it depends on hasn't been merged. So you can merge whenever you are ready.

dangermattic · 2024-06-19T14:53:03Z

	1 Warning
⚠️	PR is not assigned to a milestone.

Generated by 🚫 Danger

sonarcloud · 2024-06-19T15:37:07Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

wpmobilebot · 2024-06-19T15:38:57Z

Found 1 violations:

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

-+--- 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:fluxc:{strictly trunk-79f2bc35285748c715e00f2a6648ed6831632178} -> trunk-79f2bc35285748c715e00f2a6648ed6831632178
+|    +--- 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-79f2bc35285748c715e00f2a6648ed6831632178
+|    +--- 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.16.0
-     \--- org.wordpress:fluxc:trunk-ed60798b4d96ec19863c74b0f525e2e20f4525db -> trunk-0fe67fa241426afeaaa66bc3970ba46634efa5c8 (*)
+     \--- org.wordpress:fluxc:trunk-ed60798b4d96ec19863c74b0f525e2e20f4525db -> trunk-79f2bc35285748c715e00f2a6648ed6831632178 (*)

Please review and act accordingly

zwarm added 10 commits June 17, 2024 09:04

Add methods to allow checking if the audio recorder is currently reco…

41f0089

…rding or is paused.

Implement interface method and requests recorder to pause or resume.

2855f5d

Include action handlers for onPause and onResume requests

09fd9d6

Add methods for onPause and onResume requests, and observing recordin…

5ca2c61

…gUse methods.

Update to handle onPause, onResume requests, refactor reporting ampli…

9b22597

…tude and remaining time.

Update to handle onPause, onResume requests during configuration change

408bb1a

Refactor to handle onPause, onResume requests and the icon visibility

5d56725

Refactor to handle onPause and onResume requests

f9fd01a

Replace log lines with AppLog

f63a589

Only end the recording session if one has been started

acfa196

zwarm added [Type] Task [Status] Not Ready for Merge unit-tests-exemption labels Jun 17, 2024

zwarm self-assigned this Jun 17, 2024

zwarm changed the base branch from trunk to issue/v2c-launch-edit-post June 17, 2024 13:38

zwarm requested a review from notandyvee June 17, 2024 13:50

zwarm removed their assignment Jun 18, 2024

zwarm mentioned this pull request Jun 18, 2024

[Voice to Content] Fix NPE in jetpack ai query call wordpress-mobile/WordPress-FluxC-Android#3035

Merged

zwarm added 2 commits June 18, 2024 10:51

Adjust success response to handle nulls in response

464544d

Update FluxC hash

d665c58

notandyvee requested changes Jun 18, 2024

View reviewed changes

notandyvee reviewed Jun 18, 2024

View reviewed changes

notandyvee approved these changes Jun 18, 2024

View reviewed changes

Base automatically changed from issue/v2c-launch-edit-post to trunk June 19, 2024 12:04

zwarm removed the [Status] Not Ready for Merge label Jun 19, 2024

Update FluxC hash

942b497

Merge branch 'trunk' into issue/v2c-workflow-odds-ends

b3fba93

zwarm enabled auto-merge June 19, 2024 15:48

zwarm merged commit f755146 into trunk Jun 19, 2024
20 checks passed

zwarm deleted the issue/v2c-workflow-odds-ends branch June 19, 2024 16:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Voice to Content] Support device rotation while recording #20995

[Voice to Content] Support device rotation while recording #20995

zwarm commented Jun 17, 2024 •

edited

Loading

wpmobilebot commented Jun 17, 2024 •

edited

Loading

wpmobilebot commented Jun 17, 2024 •

edited

Loading

codecov bot commented Jun 17, 2024 •

edited

Loading

notandyvee left a comment

notandyvee left a comment

notandyvee left a comment •

edited

Loading

dangermattic commented Jun 19, 2024

sonarcloud bot commented Jun 19, 2024

wpmobilebot commented Jun 19, 2024

[Voice to Content] Support device rotation while recording #20995

[Voice to Content] Support device rotation while recording #20995

Conversation

zwarm commented Jun 17, 2024 • edited Loading

To Test:

Regression Notes

PR Submission Checklist:

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

wpmobilebot commented Jun 17, 2024 • edited Loading

wpmobilebot commented Jun 17, 2024 • edited Loading

codecov bot commented Jun 17, 2024 • edited Loading

Codecov Report

notandyvee left a comment

Choose a reason for hiding this comment

notandyvee left a comment

Choose a reason for hiding this comment

notandyvee left a comment • edited Loading

Choose a reason for hiding this comment

dangermattic commented Jun 19, 2024

sonarcloud bot commented Jun 19, 2024

Quality Gate passed

wpmobilebot commented Jun 19, 2024

zwarm commented Jun 17, 2024 •

edited

Loading

wpmobilebot commented Jun 17, 2024 •

edited

Loading

wpmobilebot commented Jun 17, 2024 •

edited

Loading

codecov bot commented Jun 17, 2024 •

edited

Loading

notandyvee left a comment •

edited

Loading