i18n Issues Mega Issue part 2 (Controversial part) by jacobo-dominguez-wgu · Pull Request #1922 · openedx/frontend-app-authoring

jacobo-dominguez-wgu · 2025-05-07T21:21:33Z

Description

Part 2 of solving i18n issues containing the controversial section. Link to part 1
Based on a report generated by an AI agent about improvements to untranslated strings according to the i18 guidelines, several files have been modified in order to fix these potential internationalization bugs.
Some of the fixes include:

Untranslated aria-label texts

Supporting information

This PR fixes #1806

Testing instructions

CardHeader
Go to the edit course content.
Hover a module name and click on the pencil icon that shows on hover, the module name turns into an input element
With devtools inspect the input text and look for the aria-label (it is a bit difficult since clicking turns the input into a label, so here is helpful to install the react developer tools and look for the specific component (which is FormControl) on the Components tool)
AnswerWidget/AnswerOption
Select one of the sections of a module and click on the arrow to expand the content.
Click on + New unit.
Select Problem component and then the single select option and click select button.
Scroll down the modal and there must be the Answers section.
Look for the button with an icon of a comment with an exclamation mark and inspect it.
On the devtools look for the aria-label of the parent div.
LicenseWidget/LicenseDetails
Select one of the sections of a module and click on the arrow to expand the content.
Click on + New unit.
On the add new component section select Video option.
Scroll down to the License section and click + Add a license for this video.
On License Type select Creative Commons.
Scroll down to the License Details and inspect the checkboxes for the list options.
With devtools inspect the aria-label for all the checkboxes.
FileInput
TBD.
SortAndFilterModal
Go to the assets page for a course: http://apps.local.openedx.io:2001/authoring/course/{courseId}/assets
Click on the sort and filter button
On the modal, inspect the options on the Sort by section
Inspect the aria-label for each element

…ense details component

openedx-webhooks · 2025-05-07T21:21:37Z

Thanks for the pull request, @jacobo-dominguez-wgu!

This repository is currently maintained by @openedx/2u-tnl.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

codecov · 2025-05-07T21:31:37Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.79%. Comparing base (d717303) to head (e22b1d6).
Report is 17 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff            @@
##           master    #1922    +/-   ##
========================================
  Coverage   93.78%   93.79%            
========================================
  Files        1147     1154     +7     
  Lines       23907    24083   +176     
  Branches     5148     5100    -48     
========================================
+ Hits        22422    22589   +167     
- Misses       1408     1426    +18     
+ Partials       77       68     -9

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

...ainers/VideoEditor/components/VideoSettingsModal/components/LicenseWidget/LicenseDetails.jsx

...s/VideoEditor/components/VideoSettingsModal/components/LicenseWidget/LicenseDetails.test.jsx

src/files-and-videos/generic/messages.js

src/files-and-videos/generic/table-components/sort-and-filter-modal/messages.js

bradenmacdonald · 2025-05-13T00:00:38Z

src/files-and-videos/videos-page/transcript-settings/messages.js

+  noneAriaLabel: {
+    id: 'course-authoring.video-uploads.transcriptSettings.orderTranscripts.none.aria-label',
+    defaultMessage: 'none radio',
+    description: 'Aria label for order transcript None option',


Will translators know the difference between 'Label for order transcript None option' and 'Aria label for order transcript None option'?

It might be helpful to say "Accessible (screen reader) label for 'order transcript: None' option, indicating this is a radio button (mutually exclusive selection)". But just thinking out loud here, it's also fine as is.

Yes I agree, will update all descriptions for aria label.

Hey, I see you requested a re-review but these descriptions aren't updated yet?

Sorry I missed these.

...ainers/VideoEditor/components/VideoSettingsModal/components/LicenseWidget/LicenseDetails.jsx

src/editors/containers/ProblemEditor/components/EditProblemView/AnswerWidget/messages.js

…eded

bradenmacdonald

Thanks, I tested as described and it's working well. Just let me know if you are planning any of the remaining "Aria label..." descriptions before I go ahead and merge it.

bradenmacdonald · 2025-05-13T18:18:28Z

src/files-and-videos/files-page/FilesPage.test.jsx

          axiosMock.onGet(`${getAssetsUrl(courseId)}?display_name=download.png&page_size=1`).reply(200, { assets: [] });
          axiosMock.onPost(getAssetsUrl(courseId)).reply(200, generateNewAssetApiResponse());
-          const addFilesButton = screen.getByLabelText('file-input');
+          const addFilesButton = screen.getByLabelText(messages.fileInputAriaLabel.defaultMessage);


Suggested change

const addFilesButton = screen.getByLabelText(messages.fileInputAriaLabel.defaultMessage);

const addFilesButton = screen.getByLabelText('Upload a file');

Nit: This may seem to go against the usual "DRY" developer maxim, but I generally prefer that strings are hard-coded in test files, because it makes it much more clear when things get changed accidentally. When the test references the code, it's easier to introduce a regression without noticing. In this case it's not a big deal though. Feel free to leave it as is.

I understand your point but lets keep it like this this time since it is not a major thing.

bradenmacdonald · 2025-05-13T18:20:10Z

src/files-and-videos/videos-page/transcript-settings/messages.js

+  noneAriaLabel: {
+    id: 'course-authoring.video-uploads.transcriptSettings.orderTranscripts.none.aria-label',
+    defaultMessage: 'none radio',
+    description: 'Aria label for order transcript None option',


Hey, I see you requested a re-review but these descriptions aren't updated yet?

bradenmacdonald · 2025-05-13T18:22:04Z

...ainers/VideoEditor/components/VideoSettingsModal/components/LicenseWidget/LicenseDetails.jsx

          <FormattedMessage {...messages.detailsSubsectionTitle} />
        </div>
-        {license === LicenseTypes.allRightsReserved ? (
+        {license === LicenseTypes.allRightsReserved && (


Just curious, why are you replacing the ternary operators?

This one was a suggestion from a fellow, so the code looks cleaner and more readable.

jacobo-dominguez-wgu added 4 commits May 7, 2025 15:20

fix: adding messages for i18n issues related to aria labels

342ec62

fix: replacing ternary operator

cd9732a

refactor: injecting intl object to prevent extra modifications on lic…

f85fc33

…ense details component

test: fixing failing snapshot test

9bbb40c

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 7, 2025

openedx-webhooks added this to Contributions May 7, 2025

github-project-automation bot moved this to Needs Triage in Contributions May 7, 2025

jacobo-dominguez-wgu mentioned this pull request May 7, 2025

i18n Issues Mega Issue part 1 (Uncontroversial part) #1921

Merged

jacobo-dominguez-wgu changed the title ~~Fix/issue 1806 i18n controversial~~ i18n Issues Mega Issue part 2 (Controversial part) May 7, 2025

jacobo-dominguez-wgu mentioned this pull request May 7, 2025

fix: untranslated user facing texts for i18n #1901

Closed

jacobo-dominguez-wgu moved this from Needs Triage to Ready for Review in Contributions May 7, 2025

jacobo-dominguez-wgu requested review from brian-smith-tcril, diana-villalvazo-wgu, tonybusa, vmnavarro94 and wgu-jesse-stewart May 8, 2025 17:14

mphilbrick211 requested a review from a team May 9, 2025 17:33

mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label May 12, 2025

jacobo-dominguez-wgu requested a review from bradenmacdonald May 12, 2025 18:02

bradenmacdonald requested changes May 13, 2025

View reviewed changes

chore: best descriptions to aria label and removing aria label not ne…

d51c741

…eded

jacobo-dominguez-wgu force-pushed the fix/issue-1806-i18n-controversial branch from 83f0543 to dab2b1a Compare May 13, 2025 16:07

test: snapshot update and fixing ut

4ab1399

jacobo-dominguez-wgu force-pushed the fix/issue-1806-i18n-controversial branch from dab2b1a to 4ab1399 Compare May 13, 2025 16:27

jacobo-dominguez-wgu requested a review from bradenmacdonald May 13, 2025 16:41

bradenmacdonald approved these changes May 13, 2025

View reviewed changes

chore: best descriptions to aria labels

e22b1d6

bradenmacdonald enabled auto-merge (squash) May 13, 2025 19:06

bradenmacdonald merged commit 88aa4c1 into openedx:master May 13, 2025
7 checks passed

github-project-automation bot moved this from Ready for Review to Done in Contributions May 13, 2025

	const addFilesButton = screen.getByLabelText(messages.fileInputAriaLabel.defaultMessage);
	const addFilesButton = screen.getByLabelText('Upload a file');

Conversation

jacobo-dominguez-wgu commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Uh oh!

openedx-webhooks commented May 7, 2025

Uh oh!

codecov bot commented May 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bradenmacdonald May 13, 2025 • 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!

jacobo-dominguez-wgu May 13, 2025

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald May 13, 2025

Choose a reason for hiding this comment

Uh oh!

jacobo-dominguez-wgu May 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bradenmacdonald left a comment

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald May 13, 2025 • 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!

jacobo-dominguez-wgu May 13, 2025

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald May 13, 2025

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald May 13, 2025

Choose a reason for hiding this comment

Uh oh!

jacobo-dominguez-wgu May 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jacobo-dominguez-wgu commented May 7, 2025 •

edited

Loading

codecov bot commented May 7, 2025 •

edited

Loading

bradenmacdonald May 13, 2025 •

edited

Loading

bradenmacdonald May 13, 2025 •

edited

Loading