Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show spinner while loading library components [FC-0062] #1331

Merged

Conversation

pomegranited
Copy link
Contributor

Description

Use query.isLoading (not query.isFetching) to show a spinner when loading Library components.

Prior to this change, the home page for a content library briefly shows "You haven't added any components to this library yet" while the library is loading.

This change affects Course Authors using v2 content libraries.

Supporting information

Bug reported on Slack: comment
Private-ref: FAL-3859

Testing instructions

  1. Create a library with several components.
  2. Force-refresh the library home page
    Note that a spinner is shown while the components are loading, and "You haven't added any components" is never shown.
  3. Force-refresh the library components page.
    Note that a spinner is shown while the components are loading, and "You haven't added any components" is never shown.

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

openedx-webhooks commented Sep 26, 2024

Thanks for the pull request, @pomegranited!

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.

@pomegranited pomegranited force-pushed the jill/FAL-3859-1-library-loading-text branch from b43d902 to c7592ce Compare September 26, 2024 08:34
@pomegranited pomegranited force-pushed the jill/FAL-3859-1-library-loading-text branch from c7592ce to 4a80777 Compare September 27, 2024 09:34
Copy link
Contributor

@rpenido rpenido left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍
Thank you for your work @pomegranited!
This is working great. I added one suggestion to remove isFetching and a fix for the test.

  • I tested this using the instructions from the PR
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

src/search-manager/SearchManager.ts Outdated Show resolved Hide resolved
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Sep 27, 2024
@pomegranited pomegranited marked this pull request as ready for review October 2, 2024 00:32
@pomegranited pomegranited requested a review from a team as a code owner October 2, 2024 00:32
@pomegranited
Copy link
Contributor Author

Test error here is unrelated to this change:

error - 2024-10-02 00:36:20,743 -- Report creating failed: {"message":"Token required because branch is protected"}

@pomegranited
Copy link
Contributor Author

Thanks for addressing the coverage token issue @bradenmacdonald ! I'm still getting a related failure with the coverage check though.. do you know why?

@bradenmacdonald
Copy link
Contributor

@pomegranited Hmm sorry about that. I don't have time to look into it now, but it says No files were found with the provided path: coverage/*.*. No artifacts will be uploaded. during the "archive coverage results" step of this. Perhaps the coverage files are in a different place in this repo compared to the learning MFE? Can you run the tests locally and see where the coverage files get put?

@pomegranited
Copy link
Contributor Author

@bradenmacdonald

No files were found with the provided path: coverage/.. No artifacts will be uploaded. during the "archive coverage results" step of this.

Ahh.. that helped, thank you. I accidentally pushed a change to the Makefile that disabled running the actual tests, so of course there were no coverage files either.

@pomegranited pomegranited force-pushed the jill/FAL-3859-1-library-loading-text branch from 1954570 to d5d7b16 Compare October 3, 2024 07:44
Copy link

codecov bot commented Oct 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.97%. Comparing base (652af9f) to head (a018650).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1331   +/-   ##
=======================================
  Coverage   92.97%   92.97%           
=======================================
  Files        1036     1036           
  Lines       19448    19457    +9     
  Branches     4122     4136   +14     
=======================================
+ Hits        18081    18090    +9     
  Misses       1302     1302           
  Partials       65       65           

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

Copy link
Contributor

@rpenido rpenido left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍
Thank you for your work, @pomegranited!

  • I tested this using the instructions from:
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

I created a small PR to improve the coverage here: open-craft#70

@bradenmacdonald
Copy link
Contributor

Looks like we still have one more line to cover - or just add a comment to ignore coverage for that line.

@bradenmacdonald
Copy link
Contributor

@pomegranited Sorry, looks like there's a conflict with the PR I just merged.

@pomegranited
Copy link
Contributor Author

@bradenmacdonald

Sorry, looks like there's a conflict with the PR I just merged.

No worries! Your merged PR nudged me to clean up the test I added :)

@bradenmacdonald bradenmacdonald merged commit 9c1fd5a into openedx:master Oct 4, 2024
8 checks passed
@bradenmacdonald bradenmacdonald deleted the jill/FAL-3859-1-library-loading-text branch October 4, 2024 04:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants