Fix #4848 Content Description Generation for Content and SelectionInteractionContent ViewModels #5704

manas-yu · 2025-02-15T16:42:08Z

Explanation

Fix #4848
This PR addresses post-PR review issues from #5614 by refining content description generation. The key updates include:

The getContentDescription function is now utilized in ContentViewModel and SelectionInteractionContentViewModel, ensuring accurate content descriptions with the necessary customTagHandlers
1. ContentViewModel: Handles CUSTOM_LIST_LI_TAG, CUSTOM_LIST_OL_TAG, CUSTOM_LIST_UL_TAG, CUSTOM_IMG_TAG, CUSTOM_CONCEPT_CARD_TAG, and CUSTOM_MATH_TAG
2. SelectionInteractionContentViewModel: Handles CUSTOM_IMG_TAG
Improved handling of tags where content resides in attributes, such as anchor tags: <a href="https://example.com">Click here</a>, ensuring proper extraction of meaningful descriptions
Handled edge cases in CustomHtmlContentHandler to improve getContentDescription logic, addressing inconsistencies and included comments for better understanding.

Essential Checklist

The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of #bugnum: ...".)
Any changes to scripts/assets files have their rationale included in the PR explanation.
The PR follows the style guide.
The PR does not contain any unnecessary code changes from Android Studio (reference).
The PR is made from a branch that's not called "develop" and is up-to-date with "develop".
The PR is assigned to the appropriate reviewers (reference).

…content-description-update

manas-yu · 2025-02-15T19:25:01Z

Hi @adhiamboperes, PTAL.

I have integrated the getContentDescription logic into both ContentViewModel and SelectionInteractionContentViewModel. However, I need a clarification regarding this comment:

ensure descriptions are generated for answers, link cases, including anchors, or any case when text can appear between tags.

Previously, when processing certain tags (e.g., <a>), the content description only included the inner text but missed important attribute information. For example:

<a href="https://example.com">Click here</a>

Previously, the generated content description was:
"Click here"

While the inner text was correctly appended, the hyperlink (href attribute) was omitted.
For such cases where attribute values are also important, a workaround similar to this approach could be considered to ensure relevant attributes are included in the content description. Two other approaches to be considered could be:

Implementing a custom tag handler for each such case.
Handling attribute data in endElement after caching the tag's related data in startElement.

I would like clarification on the final approach for handling tags where attribute values are important. Additionally, if there are any other tags (besides <a>) that should need consideration.

Thanks!

@manas-yu, AFAIK, the tag is the only one with attributes that are meaningful for talkback. I think that your approach in the PR is sufficient to handle this case.

github-actions · 2025-02-15T21:53:20Z

Coverage Report

Results

Number of files assessed: 7
Overall Coverage: 87.84%
Coverage Analysis: PASS ✅

Passing coverage

Files with passing code coverage

File	Coverage	Lines Hit	Status	Min Required
CustomHtmlContentHandler.kt utility/src/main/java/org/oppia/android/util/parser/html/CustomHtmlContentHandler.kt	84.92%	107 / 126	✅	70%
LiTagHandler.kt utility/src/main/java/org/oppia/android/util/parser/html/LiTagHandler.kt	90.70%	117 / 129	✅	70%

Exempted coverage

Files exempted from coverage

File	Exemption Reason
StateFragment.kt app/src/main/java/org/oppia/android/app/player/state/StateFragment.kt	This file is incompatible with code coverage tooling; skipping coverage check.
StatePlayerRecyclerViewAssembler.kt app/src/main/java/org/oppia/android/app/player/state/StatePlayerRecyclerViewAssembler.kt	This file is exempted from having a test file; skipping coverage check.
SelectionInteractionContentViewModel.kt app/src/main/java/org/oppia/android/app/player/state/itemviewmodel/SelectionInteractionContentViewModel.kt	This file is exempted from having a test file; skipping coverage check.
SelectionInteractionViewModel.kt app/src/main/java/org/oppia/android/app/player/state/itemviewmodel/SelectionInteractionViewModel.kt	This file is exempted from having a test file; skipping coverage check.
ContentViewModel.kt app/src/main/java/org/oppia/android/app/player/state/itemviewmodel/ContentViewModel.kt	This file is exempted from having a test file; skipping coverage check.

Refer test_file_exemptions.textproto for the comprehensive list of file exemptions and their required coverage percentages.

To learn more, visit the Oppia Android Code Coverage wiki page

github-actions · 2025-02-16T04:11:04Z

APK & AAB differences analysis

Note that this is a summarized snapshot. See the CI artifacts for detailed differences.

Dev

Expand to see flavor specifics

Universal APK

APK file size: 19 MiB (old), 19 MiB (new), 564 bytes (Added)

APK download size (estimated): 17 MiB (old), 17 MiB (new), 866 bytes (Added)

Method count: 260321 (old), 260323 (new), 2 (Added)

Features: 2 (old), 2 (new), 0 (No change)

Permissions: 6 (old), 6 (new), 0 (No change)

Resources: 6830 (old), 6830 (new), 0 (No change)

Anim: 43 (old), 43 (new), 0 (No change)
Animator: 26 (old), 26 (new), 0 (No change)
Array: 15 (old), 15 (new), 0 (No change)
Attr: 922 (old), 922 (new), 0 (No change)
Bool: 9 (old), 9 (new), 0 (No change)
Color: 967 (old), 967 (new), 0 (No change)
Dimen: 1048 (old), 1048 (new), 0 (No change)
Drawable: 380 (old), 380 (new), 0 (No change)
Id: 1285 (old), 1285 (new), 0 (No change)
Integer: 37 (old), 37 (new), 0 (No change)
Interpolator: 11 (old), 11 (new), 0 (No change)
Layout: 380 (old), 380 (new), 0 (No change)
Menu: 3 (old), 3 (new), 0 (No change)
Mipmap: 1 (old), 1 (new), 0 (No change)
Plurals: 10 (old), 10 (new), 0 (No change)
Raw: 2 (old), 2 (new), 0 (No change)
String: 853 (old), 853 (new), 0 (No change)
Style: 832 (old), 832 (new), 0 (No change)
Xml: 6 (old), 6 (new), 0 (No change)

Lesson assets: 111 (old), 111 (new), 0 (No change)

AAB differences

Expand to see AAB specifics

Supported configurations:

hdpi (same)
ldpi (same)
mdpi (same)
tvdpi (same)
xhdpi (same)
xxhdpi (same)
xxxhdpi (same)

Base APK

APK file size: 18 MiB (old), 18 MiB (new), 568 bytes (Added)
APK download size (estimated): 17 MiB (old), 17 MiB (new), 1777 bytes (Added)
Method count: 260321 (old), 260323 (new), 2 (Added)

Configuration hdpi

APK file size: 50 KiB (old), 50 KiB (new), 0 bytes (No change)
APK download size (estimated): 18 KiB (old), 18 KiB (new), 0 bytes (No change)

Configuration ldpi

APK file size: 49 KiB (old), 49 KiB (new), 0 bytes (No change)
APK download size (estimated): 14 KiB (old), 14 KiB (new), 0 bytes (No change)

Configuration mdpi

APK file size: 45 KiB (old), 45 KiB (new), 0 bytes (No change)
APK download size (estimated): 14 KiB (old), 14 KiB (new), 0 bytes (No change)

Configuration tvdpi

APK file size: 86 KiB (old), 86 KiB (new), 0 bytes (No change)
APK download size (estimated): 29 KiB (old), 29 KiB (new), 0 bytes (No change)

Configuration xhdpi

APK file size: 57 KiB (old), 57 KiB (new), 0 bytes (No change)
APK download size (estimated): 21 KiB (old), 21 KiB (new), 0 bytes (No change)

Configuration xxhdpi

APK file size: 63 KiB (old), 63 KiB (new), 0 bytes (No change)
APK download size (estimated): 29 KiB (old), 29 KiB (new), 0 bytes (No change)

Configuration xxxhdpi

APK file size: 63 KiB (old), 63 KiB (new), 0 bytes (No change)
APK download size (estimated): 28 KiB (old), 28 KiB (new), 0 bytes (No change)

Alpha

Expand to see flavor specifics

Universal APK

APK file size: 11 MiB (old), 11 MiB (new), 660 bytes (Added)

APK download size (estimated): 10 MiB (old), 10 MiB (new), 50 bytes (Removed)

Method count: 115840 (old), 115834 (new), 6 (Removed)

Features: 2 (old), 2 (new), 0 (No change)

Permissions: 6 (old), 6 (new), 0 (No change)

Resources: 5798 (old), 5798 (new), 0 (No change)

Anim: 33 (old), 33 (new), 0 (No change)
Animator: 24 (old), 24 (new), 0 (No change)
Array: 14 (old), 14 (new), 0 (No change)
Attr: 888 (old), 888 (new), 0 (No change)
Bool: 8 (old), 8 (new), 0 (No change)
Color: 820 (old), 820 (new), 0 (No change)
Dimen: 780 (old), 780 (new), 0 (No change)
Drawable: 342 (old), 342 (new), 0 (No change)
Id: 1231 (old), 1231 (new), 0 (No change)
Integer: 32 (old), 32 (new), 0 (No change)
Interpolator: 11 (old), 11 (new), 0 (No change)
Layout: 343 (old), 343 (new), 0 (No change)
Menu: 1 (old), 1 (new), 0 (No change)
Mipmap: 1 (old), 1 (new), 0 (No change)
Plurals: 10 (old), 10 (new), 0 (No change)
String: 786 (old), 786 (new), 0 (No change)
Style: 473 (old), 473 (new), 0 (No change)
Xml: 1 (old), 1 (new), 0 (No change)

Lesson assets: 111 (old), 111 (new), 0 (No change)

AAB differences

Expand to see AAB specifics

Supported configurations:

hdpi (same)
ldpi (same)
mdpi (same)
tvdpi (same)
xhdpi (same)
xxhdpi (same)
xxxhdpi (same)

Base APK

APK file size: 11 MiB (old), 11 MiB (new), 660 bytes (Added)
APK download size (estimated): 10 MiB (old), 10 MiB (new), 20 bytes (Added)
Method count: 115840 (old), 115834 (new), 6 (Removed)

Configuration hdpi

APK file size: 43 KiB (old), 43 KiB (new), 0 bytes (No change)
APK download size (estimated): 17 KiB (old), 17 KiB (new), 0 bytes (No change)

Configuration ldpi

APK file size: 44 KiB (old), 44 KiB (new), 0 bytes (No change)
APK download size (estimated): 13 KiB (old), 13 KiB (new), 0 bytes (No change)

Configuration mdpi

APK file size: 38 KiB (old), 38 KiB (new), 0 bytes (No change)
APK download size (estimated): 13 KiB (old), 13 KiB (new), 0 bytes (No change)

Configuration tvdpi

APK file size: 73 KiB (old), 73 KiB (new), 0 bytes (No change)
APK download size (estimated): 27 KiB (old), 27 KiB (new), 0 bytes (No change)

Configuration xhdpi

APK file size: 50 KiB (old), 50 KiB (new), 0 bytes (No change)
APK download size (estimated): 20 KiB (old), 20 KiB (new), 0 bytes (No change)

Configuration xxhdpi

APK file size: 55 KiB (old), 55 KiB (new), 0 bytes (No change)
APK download size (estimated): 28 KiB (old), 28 KiB (new), 0 bytes (No change)

Configuration xxxhdpi

APK file size: 55 KiB (old), 55 KiB (new), 0 bytes (No change)
APK download size (estimated): 27 KiB (old), 27 KiB (new), 0 bytes (No change)

Beta

Expand to see flavor specifics

Universal APK

APK file size: 11 MiB (old), 11 MiB (new), 440 bytes (Added)

APK download size (estimated): 10 MiB (old), 10 MiB (new), 257 bytes (Removed)

Method count: 115846 (old), 115840 (new), 6 (Removed)

Features: 2 (old), 2 (new), 0 (No change)

Permissions: 6 (old), 6 (new), 0 (No change)

Resources: 5798 (old), 5798 (new), 0 (No change)

Anim: 33 (old), 33 (new), 0 (No change)
Animator: 24 (old), 24 (new), 0 (No change)
Array: 14 (old), 14 (new), 0 (No change)
Attr: 888 (old), 888 (new), 0 (No change)
Bool: 8 (old), 8 (new), 0 (No change)
Color: 820 (old), 820 (new), 0 (No change)
Dimen: 780 (old), 780 (new), 0 (No change)
Drawable: 342 (old), 342 (new), 0 (No change)
Id: 1231 (old), 1231 (new), 0 (No change)
Integer: 32 (old), 32 (new), 0 (No change)
Interpolator: 11 (old), 11 (new), 0 (No change)
Layout: 343 (old), 343 (new), 0 (No change)
Menu: 1 (old), 1 (new), 0 (No change)
Mipmap: 1 (old), 1 (new), 0 (No change)
Plurals: 10 (old), 10 (new), 0 (No change)
String: 786 (old), 786 (new), 0 (No change)
Style: 473 (old), 473 (new), 0 (No change)
Xml: 1 (old), 1 (new), 0 (No change)

Lesson assets: 111 (old), 111 (new), 0 (No change)

AAB differences

Expand to see AAB specifics

Supported configurations:

hdpi (same)
ldpi (same)
mdpi (same)
tvdpi (same)
xhdpi (same)
xxhdpi (same)
xxxhdpi (same)

Base APK

APK file size: 10 MiB (old), 10 MiB (new), 440 bytes (Added)
APK download size (estimated): 9 MiB (old), 9 MiB (new), 938 bytes (Removed)
Method count: 115846 (old), 115840 (new), 6 (Removed)

Configuration hdpi

APK file size: 43 KiB (old), 43 KiB (new), 0 bytes (No change)
APK download size (estimated): 17 KiB (old), 17 KiB (new), 0 bytes (No change)

Configuration ldpi

APK file size: 44 KiB (old), 44 KiB (new), 0 bytes (No change)
APK download size (estimated): 13 KiB (old), 13 KiB (new), 0 bytes (No change)

Configuration mdpi

APK file size: 38 KiB (old), 38 KiB (new), 0 bytes (No change)
APK download size (estimated): 13 KiB (old), 13 KiB (new), 0 bytes (No change)

Configuration tvdpi

APK file size: 73 KiB (old), 73 KiB (new), 0 bytes (No change)
APK download size (estimated): 27 KiB (old), 27 KiB (new), 0 bytes (No change)

Configuration xhdpi

APK file size: 50 KiB (old), 50 KiB (new), 0 bytes (No change)
APK download size (estimated): 20 KiB (old), 20 KiB (new), 0 bytes (No change)

Configuration xxhdpi

APK file size: 55 KiB (old), 55 KiB (new), 0 bytes (No change)
APK download size (estimated): 28 KiB (old), 28 KiB (new), 0 bytes (No change)

Configuration xxxhdpi

APK file size: 55 KiB (old), 55 KiB (new), 0 bytes (No change)
APK download size (estimated): 27 KiB (old), 27 KiB (new), 0 bytes (No change)

Ga

Expand to see flavor specifics

Universal APK

APK file size: 11 MiB (old), 11 MiB (new), 364 bytes (Added)

APK download size (estimated): 10 MiB (old), 10 MiB (new), 243 bytes (Removed)

Method count: 115846 (old), 115840 (new), 6 (Removed)

Features: 2 (old), 2 (new), 0 (No change)

Permissions: 6 (old), 6 (new), 0 (No change)

Resources: 5798 (old), 5798 (new), 0 (No change)

Anim: 33 (old), 33 (new), 0 (No change)
Animator: 24 (old), 24 (new), 0 (No change)
Array: 14 (old), 14 (new), 0 (No change)
Attr: 888 (old), 888 (new), 0 (No change)
Bool: 8 (old), 8 (new), 0 (No change)
Color: 820 (old), 820 (new), 0 (No change)
Dimen: 780 (old), 780 (new), 0 (No change)
Drawable: 342 (old), 342 (new), 0 (No change)
Id: 1231 (old), 1231 (new), 0 (No change)
Integer: 32 (old), 32 (new), 0 (No change)
Interpolator: 11 (old), 11 (new), 0 (No change)
Layout: 343 (old), 343 (new), 0 (No change)
Menu: 1 (old), 1 (new), 0 (No change)
Mipmap: 1 (old), 1 (new), 0 (No change)
Plurals: 10 (old), 10 (new), 0 (No change)
String: 786 (old), 786 (new), 0 (No change)
Style: 473 (old), 473 (new), 0 (No change)
Xml: 1 (old), 1 (new), 0 (No change)

Lesson assets: 111 (old), 111 (new), 0 (No change)

AAB differences

Expand to see AAB specifics

Supported configurations:

hdpi (same)
ldpi (same)
mdpi (same)
tvdpi (same)
xhdpi (same)
xxhdpi (same)
xxxhdpi (same)

Base APK

APK file size: 10 MiB (old), 10 MiB (new), 364 bytes (Added)
APK download size (estimated): 9 MiB (old), 9 MiB (new), 200 bytes (Removed)
Method count: 115846 (old), 115840 (new), 6 (Removed)

Configuration hdpi

APK file size: 43 KiB (old), 43 KiB (new), 0 bytes (No change)
APK download size (estimated): 17 KiB (old), 17 KiB (new), 0 bytes (No change)

Configuration ldpi

APK file size: 44 KiB (old), 44 KiB (new), 0 bytes (No change)
APK download size (estimated): 13 KiB (old), 13 KiB (new), 0 bytes (No change)

Configuration mdpi

APK file size: 38 KiB (old), 38 KiB (new), 0 bytes (No change)
APK download size (estimated): 13 KiB (old), 13 KiB (new), 0 bytes (No change)

Configuration tvdpi

APK file size: 73 KiB (old), 73 KiB (new), 0 bytes (No change)
APK download size (estimated): 27 KiB (old), 27 KiB (new), 0 bytes (No change)

Configuration xhdpi

APK file size: 50 KiB (old), 50 KiB (new), 0 bytes (No change)
APK download size (estimated): 20 KiB (old), 20 KiB (new), 0 bytes (No change)

Configuration xxhdpi

APK file size: 55 KiB (old), 55 KiB (new), 0 bytes (No change)
APK download size (estimated): 28 KiB (old), 28 KiB (new), 0 bytes (No change)

Configuration xxxhdpi

APK file size: 55 KiB (old), 55 KiB (new), 0 bytes (No change)
APK download size (estimated): 27 KiB (old), 27 KiB (new), 0 bytes (No change)

adhiamboperes

Thanks @manas-yu! Nice cleanup. I just have one minor comment.

app/src/main/java/org/oppia/android/app/player/state/StatePlayerRecyclerViewAssembler.kt

app/src/main/java/org/oppia/android/app/player/state/itemviewmodel/ContentViewModel.kt

…oppia-android into get-content-description-update

manas-yu · 2025-02-17T06:20:45Z

Thanks @adhiamboperes PTAL.

adhiamboperes

LGTM, Thanks @manas-yu.

manas-yu added 11 commits February 10, 2025 20:03

li-taghandler

bd12794

tagName

255200f

ktlint

38eac95

comments

462a340

Merge branch 'develop' of github.com:manas-yu/oppia-android into get-…

c269caf

…content-description-update

content-view-model

d5a5a7a

ktlint

24b3173

revert replaceRegexWithBlank

bb2eea9

content view model finalised

358088e

kdoc

91542ba

SelectionInteractionContentViewModel

56a4717

manas-yu requested a review from a team as a code owner February 15, 2025 16:42

manas-yu requested a review from adhiamboperes February 15, 2025 16:42

anchor

d18a741

manas-yu assigned adhiamboperes Feb 15, 2025

manas-yu added 2 commits February 16, 2025 01:03

update

265bf1f

ktlint

991c88b

adhiamboperes reviewed Feb 17, 2025

View reviewed changes

app/src/main/java/org/oppia/android/app/player/state/StatePlayerRecyclerViewAssembler.kt Outdated Show resolved Hide resolved

app/src/main/java/org/oppia/android/app/player/state/itemviewmodel/ContentViewModel.kt Show resolved Hide resolved

adhiamboperes assigned manas-yu and unassigned adhiamboperes Feb 17, 2025

manas-yu and others added 4 commits February 17, 2025 11:47

customTagHandlers

e185eb6

Merge branch 'develop' into get-content-description-update

c256843

Merge branch 'get-content-description-update' of github.com:manas-yu/…

81fa8a3

…oppia-android into get-content-description-update

ktlint

9e729e6

manas-yu assigned adhiamboperes and unassigned manas-yu Feb 17, 2025

adhiamboperes approved these changes Feb 17, 2025

View reviewed changes

adhiamboperes merged commit 2c6f8a8 into oppia:develop Feb 17, 2025
34 checks passed

manas-yu deleted the get-content-description-update branch February 17, 2025 12:59

Fix #4848 Content Description Generation for Content and SelectionInteractionContent ViewModels #5704

Fix #4848 Content Description Generation for Content and SelectionInteractionContent ViewModels #5704

Conversation

manas-yu commented Feb 15, 2025 • edited Loading

Explanation

Essential Checklist

manas-yu commented Feb 15, 2025 • edited by adhiamboperes Loading

github-actions bot commented Feb 15, 2025

Coverage Report

Results

Passing coverage

Exempted coverage

github-actions bot commented Feb 16, 2025

APK & AAB differences analysis

Dev

Universal APK

AAB differences

Base APK

Configuration hdpi

Configuration ldpi

Configuration mdpi

Configuration tvdpi

Configuration xhdpi

Configuration xxhdpi

Configuration xxxhdpi

Alpha

Universal APK

AAB differences

Base APK

Configuration hdpi

Configuration ldpi

Configuration mdpi

Configuration tvdpi

Configuration xhdpi

Configuration xxhdpi

Configuration xxxhdpi

Beta

Universal APK

AAB differences

Base APK

Configuration hdpi

Configuration ldpi

Configuration mdpi

Configuration tvdpi

Configuration xhdpi

Configuration xxhdpi

Configuration xxxhdpi

Ga

Universal APK

AAB differences

Base APK

Configuration hdpi

Configuration ldpi

Configuration mdpi

Configuration tvdpi

Configuration xhdpi

Configuration xxhdpi

Configuration xxxhdpi

adhiamboperes left a comment

Choose a reason for hiding this comment

manas-yu commented Feb 17, 2025

adhiamboperes left a comment

Choose a reason for hiding this comment

manas-yu commented Feb 15, 2025 •

edited

Loading

manas-yu commented Feb 15, 2025 •

edited by adhiamboperes

Loading