feat: whole course translations #1330

leangseu-edx · 2024-03-20T17:38:55Z

What changed:

implementation of whole course translation
use frontend plugin framework's pattern
NOTE: most of the existing code in src/ doesn't get much changed. The reason there were a lot of files was because I tried to fix the warning message during tests. It used to print way too many error and warning messages. It was too tedious to debug/write more tests. This doesn't remove all of the warning but it should take care of the common and unnecessary one.

codecov · 2024-03-20T18:12:42Z

Codecov Report

Attention: Patch coverage is 68.88889% with 14 lines in your changes are missing coverage. Please review.

Project coverage is 88.23%. Comparing base (3917262) to head (77fa47d).

❗ Current head 77fa47d differs from pull request most recent head c1879ea. Consider uploading reports for the commit c1879ea to get more accurate results

Files	Patch %	Lines
src/generic/plugin-store/hooks.js	0.00%	7 Missing and 1 partial ⚠️
src/generic/plugin-store/slice.js	42.85%	3 Missing and 1 partial ⚠️
src/courseware/course/sequence/Sequence.jsx	95.65%	1 Missing ⚠️
src/index.jsx	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1330      +/-   ##
==========================================
- Coverage   88.42%   88.23%   -0.20%     
==========================================
  Files         291      293       +2     
  Lines        4969     4988      +19     
  Branches     1263     1266       +3     
==========================================
+ Hits         4394     4401       +7     
- Misses        561      571      +10     
- Partials       14       16       +2

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

BrandonHBodine

Left a couple questions. Since it's top of mind for me; I noticed there's a conflict between paragon versions @edx/paragon and @openedx/paragon.

env.config.jsx

package.json

jsnwesson · 2024-03-20T20:08:46Z

Solely inputting on the Plugin framework implementation: this looks good! The implementation looks good, including the env.config.jsx example (assuming that the actual file was intended to be .gitignored). If the limitation for gitignoring it is because the default content is living in env.config, would I be able to recommend that you try the @openedx/frontend-plugin-framework package?

The main change you'd see is that defaultContents wouldn't be defined in env.config.jsx, but instead you can leave the default component inside the PluginSlot wrapper (see README for setup).

What ends up taking the place of defaultContents is a boolean keepDefault that you can use to determine if you'd want to use the default component in your deploy.

Note: there is an intention to make the default content more easily customizable when several components are involved (as was the intended feature with defining the content in env.config) but that implementation shouldn't require a drastic change in the setup you have now.

leangseu-edx · 2024-03-21T13:56:14Z

Solely inputting on the Plugin framework implementation: this looks good! The implementation looks good, including the env.config.jsx example (assuming that the actual file was intended to be .gitignored). If the limitation for gitignoring it is because the default content is living in env.config, would I be able to recommend that you try the @openedx/frontend-plugin-framework package?

The main change you'd see is that defaultContents wouldn't be defined in env.config.jsx, but instead you can leave the default component inside the PluginSlot wrapper (see README for setup).

What ends up taking the place of defaultContents is a boolean keepDefault that you can use to determine if you'd want to use the default component in your deploy.

Note: there is an intention to make the default content more easily customizable when several components are involved (as was the intended feature with defining the content in env.config) but that implementation shouldn't require a drastic change in the setup you have now.

So I added a pr to make the package build correctly openedx/frontend-plugin-framework#48. However, I still run into issue of unavailable context. When I used the transpiled code, the react component that replaced the slot lost the application context. I can't access application data.

src/courseware/course/sequence/Unit/index.jsx

Rodra

Just one question, but apart from that this looks AWESOME

chore: update tests so we have less error message test: update test * test: update tests * chore: remove duplicate translation * chore: lint for console * chore: remove comments * chore: make sure the affect url frame refresh after the language selection change

…1305)

Add unit tests Fix snapshot Clean Sequence component logEvent calls Clean unit test Put feedback widget behind whole course translation flag Fix useFeedbackWidget test

chore: update plugin instruction

Connect FeedbackWidget with backend services Move feedback widget to unit translation plugin

chore: rewrite and test the api request chore: rebase chore: update translation feedback chore: test chore: add more tests

…ssistant

* fix: feedback widget render error after submit feedback * fix: widget logic

arbrandes

Can't thank you enough for adopting FPF and using it for AI translations, @leangseu-edx. Otherwise, beyond it being unfortunate that there are a lot of unrelated changes in this PR (I'd've preferred them in a separate one), there is a big stickler here: we can't have the plugin live in the repository itself. It'll have to be removed from master this week so that it doesn't land in Redwood.

There's also a specifc place (sequence-container) that will need to be converted to a slot. See comment.

arbrandes · 2024-04-08T15:57:32Z

src/courseware/course/sequence/Sequence.jsx

      </div>
-      {enableNewSidebar === 'true' ? <NewSidebar /> : <Sidebar />}
-    </div>
+      <div id="whole-course-translation-feedback-widget" />


We will likely have to convert sequence-container to a plugin slot so you can insert this div as part of the plugin. Thoughts?

I was thinking of doing that as well. It require an extra fetch to the server for the same response. If that is a prefer way, I don't mind.

If a plugin needs to make extra requests, that is not only fine, but expected. I would avoid introducing extra requests to the default experience, though.

To be clear, all I mean to suggest is for sequence-container to either be wrapped in a <PluginSlot /> or contain one or more of them, not that it should become a plugin itself. In other words, what exists today should at most be "default content".

arbrandes · 2024-04-08T17:38:03Z

plugins/UnitTranslationPlugin/index.jsx

+  unitId: PropTypes.string.isRequired,
+};
+
+export default UnitTranslationPlugin;


We're going to have to move this plugin out of this repository in the next couple of weeks, before redwood.master is created.

Should I start the process for make a monorepo or do we have one already?

@leangseu-edx, this plugin can live anywhere at 2U's discretion, with one exception: it can't be in the openedx org. Otherwise, it's up to you folks whether it is even public.

arbrandes · 2024-04-08T17:39:49Z

example.env.config.jsx

@@ -0,0 +1,24 @@
+import UnitTranslationPlugin from '@plugins/UnitTranslationPlugin';


It's great for documentation to have an example plugin defined, but it's unfortunate that we won't be able to leave it pointing to this particular plugin.

I thought we would leave this as an example.

Sure, but let's at least make it clearly fictitious. Or even better, maybe make a skeleton sample plugin that lives in plugins, and point to that.

This is not the most urgent bit, though.

arbrandes · 2024-04-08T17:41:13Z

.env

@@ -4,6 +4,7 @@
 NODE_ENV='production'

 ACCESS_TOKEN_COOKIE_NAME=''
+AI_TRANSLATIONS_URL=''


We won't be able to leave this in master for much longer. See other comments.

This can be move to env.config.js

To 2U's own version of it, yes, but preferably not the example one that lives in this repository.

leangseu-edx force-pushed the feat/whole-course-translations branch from 0c48319 to 981c958 Compare March 20, 2024 18:04

leangseu-edx requested review from ihor-romaniuk, arbrandes, jansenk, BrandonHBodine, Rodra, nsprenkle, hajorg and jsnwesson March 20, 2024 18:06

leangseu-edx force-pushed the feat/whole-course-translations branch 2 times, most recently from 3ad314c to 77fa47d Compare March 20, 2024 18:29

BrandonHBodine reviewed Mar 20, 2024

View reviewed changes

env.config.jsx Outdated Show resolved Hide resolved

package.json Outdated Show resolved Hide resolved

Rodra reviewed Mar 21, 2024

View reviewed changes

src/courseware/course/sequence/Unit/index.jsx Outdated Show resolved Hide resolved

Rodra approved these changes Mar 21, 2024

View reviewed changes

leangseu-edx force-pushed the feat/whole-course-translations branch from d2d1744 to fe6b041 Compare March 25, 2024 14:12

Rodra force-pushed the feat/whole-course-translations branch from fe6b041 to 4feff37 Compare March 25, 2024 14:19

Rodra approved these changes Mar 27, 2024

View reviewed changes

leangseu-edx and others added 10 commits March 27, 2024 13:27

chore: add whole_course_translation and language to courseware meta (#…

dab0f39

…1305)

feat: Add feedback widget UI mock

6b62cab

Add unit tests Fix snapshot Clean Sequence component logEvent calls Clean unit test Put feedback widget behind whole course translation flag Fix useFeedbackWidget test

chore: add src and dest translation

7a46c5e

feat: first iteration of plugin translation

cc39e9d

chore: update plugin instruction

feat: Connect FeedbackWidget with backend services (#1325)

a1d9682

Connect FeedbackWidget with backend services Move feedback widget to unit translation plugin

feat: Add authentication to WCT feedback endpoints (#1329)

9bed3d4

chore: add fetch config and move feedback widget for the plugin

bb01fa0

chore: rewrite and test the api request chore: rebase chore: update translation feedback chore: test chore: add more tests

chore: rebase

775911e

chore: update requested change

30591dc

leangseu-edx and others added 7 commits March 27, 2024 13:28

chore: update package

d07595d

chore: upgrade frontend-lib-special-exams and frontend-lib-learning-a…

1a1922a

…ssistant

chore: update tests

e8e1f70

chore: remove unneeded package

e4522a5

chore: update example config

5c9ccc8

chore: add source-map-loader

b7f2612

fix: feedback widget render error after submit feedback (#1335)

c1879ea

* fix: feedback widget render error after submit feedback * fix: widget logic

leangseu-edx force-pushed the feat/whole-course-translations branch from 69aef75 to c1879ea Compare March 27, 2024 17:32

leangseu-edx changed the title ~~Feat/whole course translations~~ feat: whole course translations Mar 27, 2024

leangseu-edx merged commit 36b3c36 into master Mar 27, 2024
5 checks passed

leangseu-edx deleted the feat/whole-course-translations branch March 27, 2024 17:39

arbrandes reviewed Apr 8, 2024

View reviewed changes

Zacharis278 mentioned this pull request Apr 9, 2024

Pluggable Upgrade Messaging openedx/platform-roadmap#332

Open

leangseu-edx mentioned this pull request Apr 18, 2024

chore: remove UnitTranslationPlugin #1352

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: whole course translations #1330

feat: whole course translations #1330

leangseu-edx commented Mar 20, 2024 •

edited

Loading

codecov bot commented Mar 20, 2024 •

edited

Loading

BrandonHBodine left a comment

jsnwesson commented Mar 20, 2024

leangseu-edx commented Mar 21, 2024

Rodra left a comment

arbrandes left a comment

arbrandes Apr 8, 2024

leangseu-edx Apr 9, 2024

arbrandes Apr 9, 2024 •

edited

Loading

arbrandes Apr 8, 2024

leangseu-edx Apr 9, 2024

arbrandes Apr 9, 2024

arbrandes Apr 8, 2024

leangseu-edx Apr 9, 2024

arbrandes Apr 9, 2024

arbrandes Apr 8, 2024

leangseu-edx Apr 9, 2024

arbrandes Apr 9, 2024

		@@ -0,0 +1,24 @@
		import UnitTranslationPlugin from '@plugins/UnitTranslationPlugin';

feat: whole course translations #1330

feat: whole course translations #1330

Conversation

leangseu-edx commented Mar 20, 2024 • edited Loading

codecov bot commented Mar 20, 2024 • edited Loading

Codecov Report

BrandonHBodine left a comment

Choose a reason for hiding this comment

jsnwesson commented Mar 20, 2024

leangseu-edx commented Mar 21, 2024

Rodra left a comment

Choose a reason for hiding this comment

arbrandes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arbrandes Apr 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leangseu-edx commented Mar 20, 2024 •

edited

Loading

codecov bot commented Mar 20, 2024 •

edited

Loading

arbrandes Apr 9, 2024 •

edited

Loading