fix: change InplaceTextEditor style and add optimistic update by rpenido · Pull Request #1953 · openedx/frontend-app-authoring

rpenido · 2025-05-14T14:12:57Z

Description

This PR adds the following:

Optimistic update for renaming Components, Collections and Containers
Change the InplaceTextEditor to show the new text until the onSave promise resolves
Change the InplaceTextEditor style to: Always show the rename button

Supporting information

Related to Rename component on unit page UX issues #1849

Testing instructions

Check the style and behaviour on the following:

UnitPage > Rename unit title
UnitPage > Rename component title
Sidebar > Rename unit title
Sidebar > Rename collection title
Sidebar > Rename component title

Private ref: FAL-4160

openedx-webhooks · 2025-05-14T14:13:02Z

Thanks for the pull request, @rpenido!

This repository is currently maintained by @bradenmacdonald.

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-14T17:54:59Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.89%. Comparing base (88aa4c1) to head (14804b8).
Report is 3 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1953      +/-   ##
==========================================
- Coverage   93.90%   93.89%   -0.02%     
==========================================
  Files        1153     1153              
  Lines       24053    24062       +9     
  Branches     5198     5091     -107     
==========================================
+ Hits        22586    22592       +6     
- Misses       1399     1402       +3     
  Partials       68       68

☔ 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.

rpenido · 2025-05-14T20:07:35Z

+        setNewText(inputText);
+        try {
+          await onSave(inputText);
+        } catch {
+          // don't propagate the exception
+        } finally {
+          setNewText(undefined);
+        }


Using the optimistic update from react query works for most cases, but sometimes the updated data is too deep in the cache (the title of a block inside a unit is stored on the container children array).
To help with these cases, we are using the newText state here to show the pending new text until the onSave promise resolves.

Could you add a comment here to explain this? Otherwise we might be scratching our heads about it later :)

ChrisChV

Looks good 👍 I left one nit. I have not been able to reproduce the issue N° 3.

I tested this: I followed the testing instructions and verified the bugs are gone. I have not been able to reproduce error 3.
I read through the code and considered the security, stability and performance implications of the changes.
I tested that the UI can be used with a keyboard only (tab order, keyboard controls).
Includes tests for bugfixes and/or features added.
Includes documentation

ChrisChV · 2025-05-14T20:43:58Z

@@ -137,12 +137,12 @@ describe('<LibraryUnitPage />', () => {
  it('show error if renaming unit fails', async () => {


@rpenido I think we should check if the title returns to the previous value.

Great @ChrisChV! Added here on the component tests: 3095249

pomegranited

👍 This is working well, thank you @rpenido !

I tested this on my tutor dev stack by editing collections, components, unit, and unit block titles. Also checked that the [esc] key still reverts any changes made without saving them.
I read through the code
I checked for accessibility issues by using my keyboard to navigate -- and checked the hover/active states are consistent using keyboard as well.
Includes documentation -- I've requested another comment.
User-facing strings are extracted for translation

pomegranited · 2025-05-15T00:24:26Z

+        setNewText(inputText);
+        try {
+          await onSave(inputText);
+        } catch {
+          // don't propagate the exception
+        } finally {
+          setNewText(undefined);
+        }


Could you add a comment here to explain this? Otherwise we might be scratching our heads about it later :)

rpenido · 2025-05-15T14:15:23Z

Done @pomegranited! 14804b8

pomegranited · 2025-05-16T01:05:44Z

Thanks @rpenido , ready for your merge @ChrisChV :)

…x#1953) * Optimistic update for renaming Components, Collections and Containers * Change the InplaceTextEditor to show the new text until the onSave promise resolves * Change the InplaceTextEditor style to: Always show the rename button

…#2014) * Optimistic update for renaming Components, Collections and Containers * Change the InplaceTextEditor to show the new text until the onSave promise resolves * Change the InplaceTextEditor style to: Always show the rename button

…x#1953) (openedx#2014) * Optimistic update for renaming Components, Collections and Containers * Change the InplaceTextEditor to show the new text until the onSave promise resolves * Change the InplaceTextEditor style to: Always show the rename button

* refactor: remove custom order function from course libraries list (openedx#1865) (openedx#1888) (cherry picked from commit bc18fff) * perf: use Library search results to populate container card preview [FC-0083] [TEAK] (openedx#1889) * fix: several library unit page UX bugs (openedx#1868) * fix: rename "Organize" tab to "Manage" * fix: duplicate key warnings * fix: uniform messages while adding to collection * fix: do not allow units be added to a unit (cherry picked from commit 0fdc460) * perf: use Library search results to populate container card preview (openedx#1820) * fix: use Library search results to populate container card preview * feat: show published children when showing only published Unit content * fix: nits (cherry picked from commit 24e4695) --------- Co-authored-by: Rômulo Penido <romulo.penido@gmail.com> * fix: manage access modal on duplicated xblock (openedx#1874) * fix: unit pages ux bugs [FC-0083] (openedx#1884) (openedx#1916) This PR fixes some UX bugs related to the unit pages: * Sort for "recently modified" on unit tab does not update after adding new components to units * Change component delete warning message It's a backport of openedx#1884 * fix: UX issues in unit page (openedx#1913) (openedx#1923) Fixes the following issues: * Selection behavior * Component selection is by header click only * Newly created blocks within a unit should be selected on creation/save, appear selected, and have their sidebar open * Some long text components seem to display at the default height rather than a longer height * Within the full-page unit view, the "add to collection" overflow menu item on components does not seem to work/only opens the sidebar. * Draft status indicator text is not vertically centered with icon * When reordering, dragging a short component past a long component often causes a strange stutter effect. * When dragging to reorder a component, moving quickly or scrolling often causes the drag handle to be lost / causes the block to jump somewhere else * Reordering may not consistently support a keyboard-accessible option to change order, like in course authoring * Tag button on component header opens the old tag side pane (cherry picked from commit 8c3fab3) * fix: invalidate search results when publishing all changes in library (openedx#1925) (openedx#1927) (cherry picked from commit cdb8016) Co-authored-by: Braden MacDonald <braden@opencraft.com> * fix: improve focus/selected style on library authoring (openedx#1918) (openedx#1930) Improves the focus and selected styles from the LibraryPage and UnitPage. * fix: review/sync bugs [FC-0083] (openedx#1905) (openedx#1941) Fixes issues related to component libraries' review/sync flow * Inconsistent sync pane title versions * Library content shown in preview warning only appears in review changes modal when that modal is opened from the review tab * Some new changes only appear within library review tab on scroll at top of list * Vertically misaligned sync icon in review changes message on course outline * Show available updates whenever content is updated, regardless of number of updates available * fix: Issue with read-only units in libraries & published version of units in library units picker (openedx#1940) Fixes the issues from openedx#1633 (comment) * In successfully added units, the "add new component" widget appears sometimes * In the "add existing unit" modal, the preview shows draft versions of units * fix: search modal refresh on typing (openedx#1938) (openedx#1948) * [Teak] backport openedx#1949, openedx#1999 and openedx#2002 (openedx#2006) * feat: select component and show sidebar on edit (openedx#1949) Select component that is being edited in library and show its sidebar. Also fixes issue with children component listing in library unit page (cherry picked from commit 08ac1c0) * fix: search text flickering (openedx#1999) Fix flickering issue in search field. (cherry picked from commit 6f3b7ab) * feat: open collection or unit page on double click only (openedx#2002) Opens collection or unit page only on double click. (cherry picked from commit 503642b) * fix: change InplaceTextEditor style and add optimistic update (openedx#1953) (openedx#2014) * Optimistic update for renaming Components, Collections and Containers * Change the InplaceTextEditor to show the new text until the onSave promise resolves * Change the InplaceTextEditor style to: Always show the rename button * fix: rename library publish button (openedx#2015) * fix: do open editor of new xblock when duplicating (openedx#2017) * feat: display editors as modals (openedx#1838) * fix: do open editor of new xblock when duplicating (openedx#1887) Fixes bug where after duplicating an xblock, the editor modal of the old xblock is being open instead of the new copied xblock. * [Teak] fix: Inconsistent publish status filter menu placement & fix: Remove never published filter from component picker (openedx#2021) * fix: Inconsistent publish status filter menu placement (openedx#1966) * fix: Remove never published filter from component picker (openedx#1947) Removes the never-published filter option from the component picker and unit picker. * fix: refresh xblock inline after accepting/rejecting library sync (openedx#2022) (openedx#2028) Instead of reloading the entire Unit after syncing changes from the library, just reload the xblock that was changed. (cherry picked from commit ac5574d) * fix: set maxHeight on TextEditor TinyMce widget [FC-0090] (openedx#2024) (openedx#2030) Sets a max_height=500px for the TinyMCE editor when editing a Text/Html component. This prevents the autoresize plugin from expanding the editor textarea beyond the bounds of the editor modal. ⚠️ Because the max height can only be a numeric pixel value, we can't use clever settings like vh or %, and so we're forced to limit the height of the editor to a fixed size for all screen sizes in order to address this issue. (cherry picked from commit c5f7d0c) * fix: upstreamInfo is not always provided (openedx#2041) (openedx#2042) (cherry picked from commit 3fc0f27) * fix: selection card wiggle (openedx#2047) * fix: set unit preview readonly on sidebar (openedx#2008) (openedx#2059) Make the unit preview on the sidebar read-only and add `Truncate` to the `InplaceTextEditor` * fix: backport changes for html button in text component markdown editor (openedx#2065) * fix: markdown editor issues in modal (openedx#2076) This PR resolves rendering issues with the Markdown editor inside the modal. The problem began after a PR [1] introduced the use of modals for the editor. The EditorPage [2] component expects a `isMarkdownEditorEnabledForCourse` prop, which was missing in that implementation. [1] openedx#1838 [2] https://github.com/openedx/frontend-app-authoring/pull/1838/files#diff-147218ef88726880178ea895988a5d3feaf2c0c4459086a8de7a4080cbe37de7R226 Backports openedx#2074 * fix: Expand all now expands subsections (openedx#2085) * fix: files & uploads menu was truncated due to overflow-x (openedx#2071) (openedx#2077) * fix: (backport) remove an extra editing xblock modal on unit page (openedx#2111) (openedx#2130) * fix: (backport) enable markdown editor in libraries (openedx#2098) * fix: enable markdown editor for problems in libraries too This fix is also achieved on master via 5991fd3 / openedx#2068 but this is a simpler fix, not a direct backport of that refactor. * fix: remove duplicate markdown_edited save request (openedx#2127) Removes the unnecessary duplicate save request of markdown_edited value to the backend. Part of: openedx#2099 Backports: 62589ae --------- Co-authored-by: Muhammad Anas <88967643+Anas12091101@users.noreply.github.com> * fix: remove icon and empty breadcrumb from libraries (openedx#2129) (openedx#2133) * fix: (backport) text truncate issue in the search modal (openedx#2151) * [Teak] fix: published name in unit sidebar in container picker & Issues on Inplace Editor (openedx#2140) Backport of fix: show unit published name in sidebar on content picker [FC-0090] openedx#2100 Backport of fix: Issue on the Inplace editor [FC-0090] openedx#2101 * feat: add `v2` `CourseAuthoringUnitSidebarSlot` (openedx#2000) * fix: advanced-settings api should not camel-case return value (backport) (openedx#2087) * fix: advanced-settings api should not camel-case return value (openedx#1581) * fix: update advanced module list not working (openedx#2189) Backend was still expecting `{'advanced_modules', {'value': ['poll', 'problem-builder', 'h5pxblock']}}` but without this change, it was receiving `{'advancedModules', ['poll', 'problem-builder', 'h5pxblock']}` Follow up to openedx#1581 --------- Co-authored-by: Muhammad Faraz Maqsood <fmaqsood@2u.com> * fix: clear selection on files & uploads page after deleting (backport) (openedx#2228) * refactor: remove selected rows when deleting or adding elements * refactor: ensure unique asset IDs when adding new ones * refactor: remove unnecessary loading checks in mockStore function * test: add unit tests for TableActions component * fix: loading unit page directly from link after logging in in Teak (openedx#2246) This is a simple version of the fix for Teak; on master it was fixed with openedx#1867 * fix: pages and resources plugins not rendered (openedx#1885) * docs: (backport) adding comprehensive readme documentation for plugin slots (openedx#2340) * fix: publish btn doesn't show after component edit When we edit & save the component, publish button doesn't show up until we refresh the page manualy or open this unit by opening previous unit and coming back to this unit again. In this commit, we are dispatching a storage event whenever we edit the component, it'll refresh the page & show the publish button as expected. --------- Co-authored-by: Navin Karkera <navin@opencraft.com> Co-authored-by: Jillian <jill@opencraft.com> Co-authored-by: Rômulo Penido <romulo.penido@gmail.com> Co-authored-by: Ihor Romaniuk <ihor.romaniuk@raccoongang.com> Co-authored-by: Braden MacDonald <braden@opencraft.com> Co-authored-by: Chris Chávez <xnpiochv@gmail.com> Co-authored-by: Daniel Valenzuela <dsvalenzuela@uc.cl> Co-authored-by: Tony Busa <70979397+tonybusa@users.noreply.github.com> Co-authored-by: Muhammad Anas <88967643+Anas12091101@users.noreply.github.com> Co-authored-by: Victor Navarro <vm.navarro94@gmail.com> Co-authored-by: diana-villalvazo-wgu <diana.villalvazo@wgu.edu> Co-authored-by: bydawen <oleksandr.buhaienko@raccoongang.com> Co-authored-by: Arunmozhi <tecoholic@users.noreply.github.com> Co-authored-by: José Ignacio Palma <jignaciopm13@gmail.com> Co-authored-by: Muhammad Faraz Maqsood <fmaqsood@2u.com> Co-authored-by: Brayan Cerón <86393372+bra-i-am@users.noreply.github.com> Co-authored-by: Jansen Kantor <jkantor@edx.org> Co-authored-by: Jacobo Dominguez <jacobo.dominguez@wgu.edu> Co-authored-by: Muhammad Faraz Maqsood <faraz.maqsood@A006-01130.local>

…x#1953) (openedx#2014) * Optimistic update for renaming Components, Collections and Containers * Change the InplaceTextEditor to show the new text until the onSave promise resolves * Change the InplaceTextEditor style to: Always show the rename button

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

rpenido marked this pull request as draft May 14, 2025 14:13

openedx-webhooks added this to Contributions May 14, 2025

github-project-automation Bot moved this to Needs Triage in Contributions May 14, 2025

rpenido force-pushed the rpenido/fal-4160/inplace-rename-fixes branch 2 times, most recently from 23af9c1 to bff7711 Compare May 14, 2025 17:34

fix: change InplaceTextEditor style and add optimistic upate

b38f24e

rpenido force-pushed the rpenido/fal-4160/inplace-rename-fixes branch from bff7711 to b38f24e Compare May 14, 2025 17:45

rpenido marked this pull request as ready for review May 14, 2025 18:00

rpenido commented May 14, 2025

View reviewed changes

ChrisChV approved these changes May 14, 2025

View reviewed changes

test: add test for pending text and error

3095249

rpenido changed the title ~~fix: change InplaceTextEditor style and add optimistic upate~~ fix: change InplaceTextEditor style and add optimistic update May 14, 2025

pomegranited approved these changes May 15, 2025

View reviewed changes

docs: add comments about the optimistic update

14804b8

mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions May 15, 2025

ChrisChV merged commit 6a3b006 into openedx:master May 19, 2025

github-project-automation Bot moved this from In Eng Review to Done in Contributions May 19, 2025

ChrisChV deleted the rpenido/fal-4160/inplace-rename-fixes branch May 19, 2025 16:46

rpenido mentioned this pull request May 20, 2025

fix: improve focus/selected style on library authoring (#1918) #2009

Closed

rpenido mentioned this pull request May 21, 2025

fix: change InplaceTextEditor style and add optimistic update [teak] #2014

Merged

Navigation Menu

Uh oh!

fix: change InplaceTextEditor style and add optimistic update - #1953

fix: change InplaceTextEditor style and add optimistic update#1953
ChrisChV merged 3 commits into
openedx:masterfrom
open-craft:rpenido/fal-4160/inplace-rename-fixes

rpenido commented May 14, 2025 •

edited

Loading

Uh oh!

openedx-webhooks commented May 14, 2025 •

edited

Loading

Uh oh!

codecov Bot commented May 14, 2025 •

edited

Loading

Uh oh!

rpenido May 14, 2025 •

edited

Loading

Uh oh!

pomegranited May 15, 2025

Uh oh!

ChrisChV left a comment

Uh oh!

ChrisChV May 14, 2025

Uh oh!

rpenido May 14, 2025

Uh oh!

pomegranited left a comment

Uh oh!

pomegranited May 15, 2025

Uh oh!

rpenido commented May 15, 2025

Uh oh!

pomegranited commented May 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		@@ -137,12 +137,12 @@ describe('<LibraryUnitPage />', () => {
		it('show error if renaming unit fails', async () => {

Uh oh!

Conversation

rpenido commented May 14, 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 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

rpenido May 14, 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!

pomegranited May 15, 2025

Choose a reason for hiding this comment

Uh oh!

ChrisChV left a comment

Choose a reason for hiding this comment

Uh oh!

ChrisChV May 14, 2025

Choose a reason for hiding this comment

Uh oh!

rpenido May 14, 2025

Choose a reason for hiding this comment

Uh oh!

pomegranited left a comment

Choose a reason for hiding this comment

Uh oh!

pomegranited May 15, 2025

Choose a reason for hiding this comment

Uh oh!

rpenido commented May 15, 2025

Uh oh!

pomegranited commented May 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

rpenido commented May 14, 2025 •

edited

Loading

openedx-webhooks commented May 14, 2025 •

edited

Loading

codecov Bot commented May 14, 2025 •

edited

Loading

rpenido May 14, 2025 •

edited

Loading