fix: advanced-settings.api always return exactly what it receives by jignaciopm · Pull Request #1581 · openedx/frontend-app-authoring

jignaciopm · 2025-01-03T04:39:33Z

Description

This PR fixes this bug and this bug.

Testing instructions

Deploy your local environment or go to your preferred remote environment (REDWOOD).
Go to studio > settings > advanced settings.
"Certificate html override" and "other course settings" are showing dictionary keys in camelCase (Review any field whose value is an object with configuration keys).

BEFORE

AFTER

openedx-webhooks · 2025-01-03T04:39:37Z

Thanks for the pull request, @jignaciopm!

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-01-06T21:33:24Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.06%. Comparing base (2e9b5b7) to head (90c69d3).
Report is 2 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1581   +/-   ##
=======================================
  Coverage   94.06%   94.06%           
=======================================
  Files        1164     1164           
  Lines       24445    24466   +21     
  Branches     5316     5297   -19     
=======================================
+ Hits        22994    23015   +21     
  Misses       1374     1374           
  Partials       77       77

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

…ttings to format value cherry-pick from: openedx#1581

peterkulko

Thanks for this fix!

felipemontoya · 2025-01-21T23:02:48Z

Looks like this is blocked waiting for a review from @openedx/2u-tnl. Do you guys think you could take a look?

mphilbrick211 · 2025-02-24T22:18:35Z

Looks like this is blocked waiting for a review from @openedx/2u-tnl. Do you guys think you could take a look?

Bumping this for you, @openedx/2u-tnl

felipemontoya · 2025-04-23T16:48:08Z

@arbrandes @brian-smith-tcril this fix for bug #1243 has been waiting for a reviewer from TNL for several months. If this is not merged by the release cut we will also need to backport it once again as we did for redwood. Can I please ask you to take a look and merge it before the cut?

arbrandes

The fix makes total sense, and sorry it took so long to review, but I would be more comfortable merging this if there were a couple of unit tests to go along with it.

I can help merge the backport if the fix only merges to master after the Teak cut.

magajh · 2025-05-08T00:31:41Z

@jignaciopm could you please help us adding the unit tests so we can have this fix in teak.1?

jignaciopm · 2025-05-11T22:14:42Z

@jignaciopm could you please help us adding the unit tests so we can have this fix in teak.1?

Hi @magajh I've already added the unit tests

jignaciopm · 2025-05-12T14:19:25Z

@arbrandes Can you help me check the unit tests? Please 🙏

jignaciopm · 2025-05-14T15:33:36Z

✅ Fixed the linting issues that were causing the CI to fail.

@mphilbrick211 @arbrandes Could you please re-approve the workflows when you get a chance? Thanks!
CC @magajh

bradenmacdonald · 2025-06-12T17:35:40Z

It's the same approach this PR is already taking, I think and yes I'm fine with it. (i.e. don't change the value fields, but do camelCase the other root keys in the data).

bradenmacdonald · 2025-06-12T17:37:18Z

@arbrandes would you be able to give this a final review and approval/merge?

…ttings to format value

…eives

jignaciopm · 2025-06-13T18:27:08Z

Done @arbrandes let me know your opinion!

arbrandes

Awesome! Thank you for sticking with it! This looks great, now. (Not least of which because I now actually understand what's supposed to happen. 😄 )

…x#1581)

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 #1581 Co-authored-by: Muhammad Faraz Maqsood <faraz.maqsood@A006-01130.local>

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 <faraz.maqsood@A006-01130.local>

…rt) (#2087) * fix: advanced-settings api should not camel-case return value (#1581) * fix: update advanced module list not working (#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 #1581 --------- Co-authored-by: Muhammad Faraz Maqsood <fmaqsood@2u.com>

…rt) (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>

…openedx#1581) * fix: Refactored Chat to be easier to read * chore: Fixed comment typo

* 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>

…rt) (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>

jignaciopm requested a review from a team as a code owner January 3, 2025 04:39

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

This was referenced Jan 3, 2025

Jipm/fix setting snake case eduNEXT/frontend-app-authoring#1

Closed

fix: use modifyObjectKeys and snakeCaseObject on api data advanced settings to format values eduNEXT/frontend-app-course-authoring#6

Merged

jignaciopm force-pushed the jipm/fix-setting-snake-case branch from 42e21ab to 3cb49ce Compare January 3, 2025 19:35

mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jan 3, 2025

mphilbrick211 removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jan 7, 2025

mphilbrick211 requested review from a team and removed request for a team January 7, 2025 14:45

bradenmacdonald mentioned this pull request Jan 10, 2025

[BUG] The advanced settings editor mangles the values passed to "OTHER_COURSE_SETTINGS" #1243

Closed

igobranco pushed a commit to fccn/frontend-app-authoring that referenced this pull request Jan 14, 2025

fix: use modifyObjectKeys and snakeCaseObject on api data advanced se…

c3f9976

…ttings to format value cherry-pick from: openedx#1581

peterkulko approved these changes Jan 21, 2025

View reviewed changes

arslanashraf7 mentioned this pull request Mar 17, 2025

feat: add settings to manage VideoGPT and AI Assistant & pass block sibling IDs mitodl/open-edx-plugins#456

Merged

arbrandes requested changes Apr 24, 2025

View reviewed changes

jignaciopm force-pushed the jipm/fix-setting-snake-case branch 2 times, most recently from 57f22d3 to 8b8f0ec Compare May 11, 2025 22:13

jignaciopm requested a review from arbrandes May 11, 2025 22:13

magajh mentioned this pull request May 12, 2025

Advanced course settings are transformed to Camel Case after saving openedx/wg-build-test-release#474

Closed

mariajgrimaldi linked an issue May 13, 2025 that may be closed by this pull request

Advanced course settings are transformed to Camel Case after saving openedx/wg-build-test-release#474

Closed

jignaciopm force-pushed the jipm/fix-setting-snake-case branch from 78e6015 to 9ec21d1 Compare May 14, 2025 18:28

magajh added the release testing Affects the upcoming release (attention needed) label May 15, 2025

arbrandes requested changes Jun 12, 2025

View reviewed changes

Comment thread src/advanced-settings/data/api.js

arbrandes reviewed Jun 12, 2025

View reviewed changes

Comment thread src/advanced-settings/data/api.test.js Outdated

e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jun 12, 2025

arbrandes reviewed Jun 13, 2025

View reviewed changes

Comment thread src/advanced-settings/data/api.test.js

jignaciopm added 7 commits June 13, 2025 14:09

fix: use modifyObjectKeys and snakeCaseObject on api data advanced se…

7020819

…ttings to format value

fix: improvements from feedback review

b688911

fix: add comments

b440fc4

fix: completly changed the logic to always return exactly what it rec…

1ae3763

…eives

fix: unit test and advanced setting titles in blank

78467d4

fix: remove use convertObjectToSnakeCase

094a210

fix: add more cases to expected

90c69d3

jignaciopm force-pushed the jipm/fix-setting-snake-case branch from 1f17b50 to 90c69d3 Compare June 13, 2025 18:26

jignaciopm requested a review from arbrandes June 13, 2025 18:26

arbrandes approved these changes Jun 13, 2025

View reviewed changes

arbrandes enabled auto-merge (squash) June 13, 2025 23:53

arbrandes merged commit 284e9c7 into openedx:master Jun 13, 2025

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

Faraz32123 mentioned this pull request Jun 18, 2025

fix: update advanced module list not working #2189

Merged

jignaciopm added a commit to eduNEXT/frontend-app-course-authoring that referenced this pull request Jun 18, 2025

fix: advanced-settings api should not camel-case return value (opened…

b5ca921

…x#1581)

Uh oh!

Conversation

jignaciopm commented Jan 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing instructions

Uh oh!

openedx-webhooks commented Jan 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

peterkulko left a comment

Choose a reason for hiding this comment

Uh oh!

felipemontoya commented Jan 21, 2025

Uh oh!

mphilbrick211 commented Feb 24, 2025

Uh oh!

felipemontoya commented Apr 23, 2025

Uh oh!

arbrandes left a comment

Choose a reason for hiding this comment

Uh oh!

magajh commented May 8, 2025

Uh oh!

jignaciopm commented May 11, 2025

Uh oh!

jignaciopm commented May 12, 2025

Uh oh!

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

Uh oh!

Uh oh!

bradenmacdonald commented Jun 12, 2025

Uh oh!

bradenmacdonald commented Jun 12, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jignaciopm commented Jun 13, 2025

Uh oh!

arbrandes left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

jignaciopm commented Jan 3, 2025 •

edited

Loading

openedx-webhooks commented Jan 3, 2025 •

edited

Loading

codecov Bot commented Jan 6, 2025 •

edited

Loading

jignaciopm commented May 14, 2025 •

edited

Loading