Enable capa problem editor for components in libraries [FC-0062] #1290

bradenmacdonald · 2024-09-17T02:18:20Z

Description

Implements #1086

Builds on #1280 and can't merge until after that one is merged.

Private ref: FAL-382

Testing instructions

Use the problem editor in a course, both to edit an existing problem and create a new problem.
Use the problem editor in a v2 library, both to edit an existing problem and create a new problem.

TODO

~~Solve the problem that components in search results aren't updated synchronously after changes are saved.~~ done separate in edx-platform PR
Remember to change the target branch to master before merging.

openedx-webhooks · 2024-09-17T02:18:23Z

Thanks for the pull request, @bradenmacdonald!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/2u-tnl. Tag them in a comment and let them know that your changes are ready for review.

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.

bradenmacdonald · 2024-09-17T02:20:48Z

src/editors/data/services/cms/api.ts

+interface AssetResponse {
+  assets: Record<string, string>[]; // In the raw response here, these are NOT camel-cased yet.
+}
+


Most of the functions below are unchanged other than adding types - I just had to move them higher up in the file.

bradenmacdonald · 2024-09-17T02:21:43Z

src/editors/data/services/cms/api.ts

-};
-
-export default Object.keys(apiMethods).reduce(
-  (obj, key) => ({ ...obj, [key]: checkMockApi(key) }),


This mock API was for the preview server that existed in frontend-lib-content-components. Last time I tried it, it wasn't working at all, and now that we've moved the code to frontend-app-authoring, it doesn't even exist. So I deleted the unused mockApi code.

bradenmacdonald · 2024-09-17T02:22:32Z

src/editors/data/services/cms/types.ts


 export default {
-  videoDataProps,
-  problemDataProps,


These weren't used anymore (?), but they look like they'll be useful if/when we add more types to these APIs / to the redux state, so I kept the info here, just commented out.

codecov · 2024-09-17T20:47:08Z

Codecov Report

Attention: Patch coverage is 99.14530% with 1 line in your changes missing coverage. Please review.

Project coverage is 92.47%. Comparing base (b010909) to head (d7e185b).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
src/library-authoring/LibraryLayout.tsx	83.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1290      +/-   ##
==========================================
+ Coverage   92.38%   92.47%   +0.08%     
==========================================
  Files        1023     1025       +2     
  Lines       18930    18977      +47     
  Branches     3967     4036      +69     
==========================================
+ Hits        17489    17549      +60     
+ Misses       1376     1363      -13     
  Partials       65       65

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

pomegranited

👍 Working perfectly @bradenmacdonald .

There's some code comments in the tests that need updating, and I have one suggestion around parsing opaque keys, but it shouldn't block merging.

I tested this using the PR test instructions.
I read through the code
I checked for accessibility issues by using my keyboard only to navigate the screens.
Includes documentation -- code comments mark out TODOs and odd behaviours.
~~User-facing strings are extracted for translation~~ N/A

pomegranited · 2024-09-18T00:06:45Z

src/editors/data/redux/thunkActions/problem.ts

+    // Though first we need to fake the request or else the problem type selection UI won't display:
+    dispatch(actions.requests.completeRequest({ requestKey: RequestKeys.fetchAdvancedSettings, response: {} }));


src/editors/data/services/cms/api.ts

src/library-authoring/add-content/AddContentWorkflow.test.tsx

src/library-authoring/components/utils.test.ts

ChrisChV

@bradenmacdonald Looks good 👍

…brary

bradenmacdonald requested a review from a team as a code owner September 17, 2024 02:18

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 17, 2024

bradenmacdonald added the FC Relates to an Axim Funded Contribution project label Sep 17, 2024

bradenmacdonald commented Sep 17, 2024

View reviewed changes

bradenmacdonald marked this pull request as draft September 17, 2024 02:23

bradenmacdonald force-pushed the braden/edit-problems-in-library branch 3 times, most recently from 3b6947e to 4e6f3bd Compare September 17, 2024 20:35

bradenmacdonald marked this pull request as ready for review September 17, 2024 20:36

bradenmacdonald requested review from pomegranited and removed request for a team September 17, 2024 20:36

pomegranited mentioned this pull request Sep 17, 2024

When editing a v2 library xblock, update search index synchronously [FC-0062] openedx/edx-platform#35495

Merged

pomegranited approved these changes Sep 18, 2024

View reviewed changes

ChrisChV approved these changes Sep 18, 2024

View reviewed changes

bradenmacdonald changed the base branch from braden/problem-editor-warnings to master September 18, 2024 17:09

bradenmacdonald added 10 commits September 18, 2024 10:35

feat: enable the problem editor for library components

13eb21a

fix: don't try to load "advanced settings" when editing problem in li…

1098139

…brary

fix: don't fetch images when editing problem in library

2dd5850

docs: add a note about plans for the editor modal

4227c58

fix: choosing a problem type then cancelling resulted in an error

3a7015d

chore: remove unused mockApi, clean up problematic 'module' self import

45d37c2

test: update workflow test to test problem editor

508db8a

feat: show capa content summary on cards in library search results

a81bc4e

docs: fix comment typos found in code review

27b3d49

refactor: add 'key-utils' to consolidate opaque key logic

d7e185b

bradenmacdonald force-pushed the braden/edit-problems-in-library branch from dfbf0af to d7e185b Compare September 18, 2024 17:36

bradenmacdonald enabled auto-merge (squash) September 18, 2024 17:39

bradenmacdonald merged commit 314dfa6 into openedx:master Sep 18, 2024
5 checks passed

bradenmacdonald deleted the braden/edit-problems-in-library branch September 18, 2024 18:10

pomegranited mentioned this pull request Sep 19, 2024

feat: collections page [FC-0062] #1281

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable capa problem editor for components in libraries [FC-0062] #1290

Enable capa problem editor for components in libraries [FC-0062] #1290

bradenmacdonald commented Sep 17, 2024 •

edited

Loading

openedx-webhooks commented Sep 17, 2024 •

edited

Loading

bradenmacdonald Sep 17, 2024

bradenmacdonald Sep 17, 2024

bradenmacdonald Sep 17, 2024

codecov bot commented Sep 17, 2024 •

edited

Loading

pomegranited left a comment

pomegranited Sep 18, 2024

ChrisChV left a comment

		// Though first we need to fake the request or else the problem type selection UI won't display:
		dispatch(actions.requests.completeRequest({ requestKey: RequestKeys.fetchAdvancedSettings, response: {} }));

Enable capa problem editor for components in libraries [FC-0062] #1290

Enable capa problem editor for components in libraries [FC-0062] #1290

Conversation

bradenmacdonald commented Sep 17, 2024 • edited Loading

Description

Testing instructions

TODO

openedx-webhooks commented Sep 17, 2024 • edited Loading

What's next?

🔘 Get product approval

🔘 Provide context

🔘 Get a green build

🔘 Let us know that your PR is ready for review:

Who will review my changes?

Where can I find more information?

When can I expect my changes to be merged?

bradenmacdonald Sep 17, 2024

Choose a reason for hiding this comment

bradenmacdonald Sep 17, 2024

Choose a reason for hiding this comment

bradenmacdonald Sep 17, 2024

Choose a reason for hiding this comment

codecov bot commented Sep 17, 2024 • edited Loading

Codecov Report

pomegranited left a comment

Choose a reason for hiding this comment

pomegranited Sep 18, 2024

Choose a reason for hiding this comment

ChrisChV left a comment

Choose a reason for hiding this comment

bradenmacdonald commented Sep 17, 2024 •

edited

Loading

openedx-webhooks commented Sep 17, 2024 •

edited

Loading

codecov bot commented Sep 17, 2024 •

edited

Loading