feat: create library form [FC-0059] #1116

rpenido · 2024-06-20T01:57:28Z

Description

This PR adds a Create Library form to course-authoring.

More Info

Closes: Library Home Page - "Bare Bones" #1036
Depends on:
- feat: library home page bare bones [FC-0059] #1076
- feat: Create content in library permission added to API response edx-platform#34934

Testing Instructions

Run your local stack on this branch for course authoring and feat: Create content in library permission added to API response edx-platform#34934 for edx-platform
Make sure you have the studio.library_authoring_mfe waffle flag DISABLED
Go to the Studio Home and go to the "Libraries" tab
Click on the "+ New library" button
You should be redirected to the new library form
Fill the fields trying some invalid data to check validation
Fill the fields correctly and hit "Create".
A new library should be created, and you should be redirected to its Home
Go back to Studio Home and create a new library using the same data (to force a duplicate ID)
You should see an error message after submitting

Private ref: FAL-3768

openedx-webhooks · 2024-06-20T01:57:32Z

Thanks for the pull request, @rpenido! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

supporting documentation
Open edX discussion forum threads
timeline information ("this must be merged by XX date", and why that is)
partner information ("this is a course on edx.org")
any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

codecov · 2024-06-20T02:29:17Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.68%. Comparing base (71fcf9f) to head (d94bbe2).
Report is 672 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1116      +/-   ##
==========================================
- Coverage   92.68%   92.68%   -0.01%     
==========================================
  Files         693      693              
  Lines       12347    12346       -1     
  Branches     2661     2661              
==========================================
- Hits        11444    11443       -1     
  Misses        872      872              
  Partials       31       31

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

src/generic/data/apiHooks.js

src/library-authoring/create-library/data/types.d.ts

src/library-authoring/create-library/data/apiHooks.ts

pomegranited

👍 This looks and works great @rpenido !

Couple of small nits: Will let Braden weigh in on the description field issue (discussion on the open-craft PR), and I've raised a todo for later with the backend error reporting.

I tested this on my tutor dev (nightly) stack using the PR test instructions
I read through the code (using feat: create library form (TEMP) open-craft/frontend-app-authoring#42)
I checked for accessibility issues by using my keyboard only to create a library
Includes documentation -- help text for form fields
User-facing strings are extracted for translation

src/library-authoring/create-library/data/api.ts

pomegranited · 2024-06-24T21:47:27Z

src/library-authoring/create-library/CreateLibrary.tsx

+                setApiError((
+                  <>
+                    {error.message}
+                    <br />
+                    {JSON.stringify(error.response?.data)}
+                  </>
+                ));


I think this is ok for now, but we're going to have to display this error to users better at some stage:

bradenmacdonald · 2024-07-08T14:45:16Z

@rpenido What's the status of this PR - is something blocking the review?

rpenido · 2024-07-08T16:00:57Z

@bradenmacdonald This PR depends on this one:

feat: library home page bare bones [FC-0059] #1076

If you want to do a pass (that would be awesome), it would be better to use the following temp PR for the diff: open-craft#42

bradenmacdonald · 2024-07-09T13:04:24Z

@rpenido Sure, I did a quick pass on the temp PR. It looks good; just had some minor comments about react query.

bradenmacdonald · 2024-07-10T12:40:21Z

@rpenido Please rebase this and get the coverage test passing; I can review whenever you're ready.

rpenido · 2024-07-10T14:54:53Z

Hi @bradenmacdonald! This is ready for your review.

KristinAoki · 2024-07-10T15:07:39Z

@rpenido Is this form for V1 libraries or V2 libraries?

rpenido · 2024-07-10T15:09:26Z

@rpenido Is this form for V1 libraries or V2 libraries?

V2 libraries

bradenmacdonald · 2024-07-11T14:44:21Z

@KristinAoki FYI, You will see this on your devstack because we have it enabled by default for developers, but it's off by default in production, so this new library v2 UX that we're building shouldn't appear on edx.org. There, users should just see the existing "v1" UI which links to the legacy Studio.

bradenmacdonald

Looks great, thanks @rpenido ! Just some minor suggestions before I approve + merge.

👍

I tested this: on my tutor devstack
I read through the code
I checked for accessibility issues
Includes documentation: n/a

src/library-authoring/create-library/CreateLibrary.test.tsx

src/library-authoring/create-library/CreateLibrary.tsx

src/library-authoring/create-library/data/apiHooks.ts

bradenmacdonald · 2024-07-11T15:01:33Z

src/library-authoring/create-library/data/apiHooks.ts

+  return useMutation({
+    mutationFn: createLibraryV2,
+    onSettled: () => {
+      queryClient.invalidateQueries({ queryKey: ['listV2Libraries'] });


We should use a "query key factory" for the query key instead of hard-coding a string here - see this example: https://github.com/openedx/frontend-app-course-authoring/blob/5dee203401c323b89492e3597934377284eb074d/src/taxonomy/data/apiHooks.js#L20-L66

Done: d94bbe2
This included moving some api/apiHook functions to library-authoring

Co-authored-by: Braden MacDonald <[email protected]>

rpenido · 2024-07-12T11:46:12Z

Hi @bradenmacdonald! This is ready for another pass.

openedx-webhooks · 2024-07-12T12:54:40Z

@rpenido 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

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

rpenido force-pushed the rpenido/fal-3768-create-new-library-form branch 3 times, most recently from 1b451bb to a82a7bc Compare June 20, 2024 02:20

rpenido force-pushed the rpenido/fal-3768-create-new-library-form branch from bd7e63f to 8724ac0 Compare June 20, 2024 02:33

rpenido commented Jun 20, 2024

View reviewed changes

src/generic/data/apiHooks.js Show resolved Hide resolved

rpenido force-pushed the rpenido/fal-3768-create-new-library-form branch 5 times, most recently from c6f08df to a008837 Compare June 23, 2024 11:21

bradenmacdonald reviewed Jun 24, 2024

View reviewed changes

src/library-authoring/create-library/data/types.d.ts Outdated Show resolved Hide resolved

src/library-authoring/create-library/data/apiHooks.ts Outdated Show resolved Hide resolved

pomegranited approved these changes Jun 24, 2024

View reviewed changes

rpenido changed the title ~~feat: create library form~~ feat: create library form [FC-0059] Jun 26, 2024

rpenido force-pushed the rpenido/fal-3768-create-new-library-form branch from 4d9da7f to 63e7593 Compare July 9, 2024 14:16

rpenido mentioned this pull request Jul 10, 2024

feat: create library form (TEMP) open-craft/frontend-app-authoring#42

Closed

rpenido force-pushed the rpenido/fal-3768-create-new-library-form branch 3 times, most recently from 8466521 to f07b0bd Compare July 10, 2024 14:53

rpenido marked this pull request as ready for review July 10, 2024 14:54

rpenido requested a review from a team as a code owner July 10, 2024 14:54

rpenido force-pushed the rpenido/fal-3768-create-new-library-form branch 2 times, most recently from c539118 to af3a9d1 Compare July 10, 2024 22:39

feat: add create new library form

8fa7880

rpenido force-pushed the rpenido/fal-3768-create-new-library-form branch from af3a9d1 to 8fa7880 Compare July 10, 2024 23:11

bradenmacdonald reviewed Jul 11, 2024

View reviewed changes

rpenido and others added 4 commits July 12, 2024 11:25

test: remove getByTestId

b60b339

feat: add alert-error component

0e68532

docs: improve docstring

9cb3878

Co-authored-by: Braden MacDonald <[email protected]>

refactor: move api and use queryKey factor

d94bbe2

rpenido force-pushed the rpenido/fal-3768-create-new-library-form branch from 752b094 to d94bbe2 Compare July 12, 2024 11:37

bradenmacdonald approved these changes Jul 12, 2024

View reviewed changes

bradenmacdonald merged commit e087001 into openedx:master Jul 12, 2024
7 checks passed

bradenmacdonald deleted the rpenido/fal-3768-create-new-library-form branch July 12, 2024 12:54

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Sep 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: create library form [FC-0059] #1116

feat: create library form [FC-0059] #1116

rpenido commented Jun 20, 2024 •

edited

Loading

openedx-webhooks commented Jun 20, 2024 •

edited

Loading

codecov bot commented Jun 20, 2024 •

edited

Loading

pomegranited left a comment

pomegranited Jun 24, 2024

bradenmacdonald commented Jul 8, 2024

rpenido commented Jul 8, 2024

bradenmacdonald commented Jul 9, 2024

bradenmacdonald commented Jul 10, 2024

rpenido commented Jul 10, 2024

KristinAoki commented Jul 10, 2024

rpenido commented Jul 10, 2024

bradenmacdonald commented Jul 11, 2024

bradenmacdonald left a comment

bradenmacdonald Jul 11, 2024

rpenido Jul 12, 2024

rpenido commented Jul 12, 2024

openedx-webhooks commented Jul 12, 2024

feat: create library form [FC-0059] #1116

feat: create library form [FC-0059] #1116

Conversation

rpenido commented Jun 20, 2024 • edited Loading

Description

More Info

Testing Instructions

openedx-webhooks commented Jun 20, 2024 • edited Loading

codecov bot commented Jun 20, 2024 • edited Loading

Codecov Report

pomegranited left a comment

Choose a reason for hiding this comment

pomegranited Jun 24, 2024

Choose a reason for hiding this comment

bradenmacdonald commented Jul 8, 2024

rpenido commented Jul 8, 2024

bradenmacdonald commented Jul 9, 2024

bradenmacdonald commented Jul 10, 2024

rpenido commented Jul 10, 2024

KristinAoki commented Jul 10, 2024

rpenido commented Jul 10, 2024

bradenmacdonald commented Jul 11, 2024

bradenmacdonald left a comment

Choose a reason for hiding this comment

bradenmacdonald Jul 11, 2024

Choose a reason for hiding this comment

rpenido Jul 12, 2024

Choose a reason for hiding this comment

rpenido commented Jul 12, 2024

openedx-webhooks commented Jul 12, 2024

rpenido commented Jun 20, 2024 •

edited

Loading

openedx-webhooks commented Jun 20, 2024 •

edited

Loading

codecov bot commented Jun 20, 2024 •

edited

Loading