refactor: remove references of ENABLE_HOME_PAGE_COURSE_API_V2 #1611

bra-i-am · 2025-01-27T16:27:44Z

Description

This PR primarily aims to eliminate references to ENABLE_HOME_PAGE_COURSE_API_V2: it intends to use that API, enabling the pagination and the course filters by default without needing the flag. Moreover, it also solves some issues related to the requests to the API that make the UI blink or request more times than required.

Supporting information

https://github.com/eduNEXT/consulting-issues-mapping/issues/118

Side effects

The Archived Courses Tab has been removed as it is no longer necessary because it relied on the previously used attribute archived_courses, which is no longer in use. With the implementation of the courses API v2, courses are marked as archived when the isActive attribute of the retrieved courses is true, as reviewed through the new filters.

Testing instructions

Mount this MFE on this specific branch in a Sumac/Nightly environment
Be sure you count with many courses (11 makes to appear the pagination component)
You should watch by default the search bar and filters without adding any env variable
Open the inspect and go to the Network tab, every time you change the search bar input or change any filter, you should see only one endpoint call is made

openedx-webhooks · 2025-01-27T16:27:48Z

Thanks for the pull request, @bra-i-am!

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.

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-30T15:48:41Z

Codecov Report

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

Project coverage is 93.68%. Comparing base (ac127e2) to head (1d6f8ad).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
src/studio-home/tabs-section/courses-tab/index.tsx	83.33%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1611   +/-   ##
=======================================
  Coverage   93.68%   93.68%           
=======================================
  Files        1142     1141    -1     
  Lines       23456    23423   -33     
  Branches     5046     5024   -22     
=======================================
- Hits        21974    21944   -30     
- Misses       1406     1411    +5     
+ Partials       76       68    -8

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

mariajgrimaldi · 2025-02-21T10:26:33Z

@bradenmacdonald: Can you help us review this PR which is part of the openedx/public-engineering#287 deprecation effort? Thank you!

bradenmacdonald · 2025-02-25T18:50:58Z

The Archived Courses Tab has been removed as it is no longer necessary because it relied on the previously used attribute archived_courses, which is no longer in use. With the implementation of the courses API v2, courses are marked as archived when the isActive attribute of the retrieved courses is true, as reviewed through the new filters.

Taking into account the conditional from courses-tab, should only be displayed when isEnablePagination is false. Since it cannot currently function this way, I assume this feature should be dropped. I wasn't able to make this work without hardcoding (I’m not sure if I'm doing something wrong or if the feature is not functioning). However, based on my review of the code, when a course is executed for re-run, it should transition to a in_process state, which I believe represents a background task, and this is indicated on the front end through the ProcessingCourses component. I’m unclear whether the element should be rendered or not with the new features (I didn't quite understand it), but currently, when the re-run is initiated, the user is redirected to a new route with its own loader button indicating the action being processed. Do you happen to know if this feature should be skipped or how I can get this to work for testing? Should we work this on another PR?

Hmm, I don't think I'll be able to answer these questions. Maybe @jristau1984 or @KristinAoki can answer?

KristinAoki · 2025-02-28T16:07:25Z

I think the ProcessingCourses component work should be moved to another PR. I have only seen it one time when a course creation job was hung. I am unable to say if it should be skipped or not. If you want to see the feature, you can manually force a course be in-progress by hard-coding the status.

bra-i-am · 2025-03-05T20:23:03Z

I think the ProcessingCourses component work should be moved to another PR.

@KristinAoki, taking this into account, I removed the ProcessingCourses related changes from this merge request and left only the related with dropping ENABLE_HOME_PAGE_COURSE_API_V2

saadyousafarbi · 2025-03-24T12:25:03Z

@bra-i-am checking in on this PR. What is the current status of this PR?

I am working on removing the v1 API from edx-platform in this PR, and was wondering when we would be able to merge that PR!
Thanks!

cc: @mariajgrimaldi

* fix: infinite requests when clearing filters * fix: some requests were being duplicated when changing filters

mphilbrick211 · 2025-05-27T20:12:07Z

Hi @saadyousafarbi and @bra-i-am! Is this still in progress?

bra-i-am · 2025-05-27T20:21:48Z

@saadyousafarbi, I'm really really sorry... I didn't see your comment before 🙏

answering you and @mphilbrick211, I already made the required changes, and I think this PR is ready

I am waiting for review

bradenmacdonald

A couple minor requests. Also can you please rebase this? It seems a bit old at this point. Then I'll test and approve, and we can get it merge. Thanks!

bradenmacdonald · 2025-05-28T19:30:46Z

src/studio-home/card-item/CardItem.test.tsx

@@ -29,15 +29,17 @@ describe('<CardItem />', () => {
    render(<CardItem {...props} />);
    const courseTitleLink = screen.getByText(props.displayName);
    expect(courseTitleLink).toHaveAttribute('href', `${getConfig().STUDIO_BASE_URL}${props.url}`);
+    const dropDownMenu = screen.getByTestId('toggle-dropdown');


Please try to avoid getByTestId. In fact, I can see there's an accessibility issue with this button - it doesn't have a name for non-visual users

Please add an aria-label to the button then change this to something like screen.getByRole('button', {name: /Course Actions/i})

bradenmacdonald · 2025-05-28T19:37:52Z

src/studio-home/card-item/index.tsx

+            as={IconButton}
+            iconAs={MoreHoriz}
+            variant="primary"
+            data-testid="toggle-dropdown"


As mentioned above, I think this needs an aria-label:

Suggested change

data-testid="toggle-dropdown"

aria-label={intl.formatMessage(messages. ... )}

See also openedx/paragon#3616

bradenmacdonald · 2025-05-28T19:40:23Z

src/studio-home/tabs-section/courses-tab/index.test.tsx

+    const props = { isLoading: false, coursesDataItems: [] };
+    const customStoreData = { studioHomeCoursesRequestParams: { isFiltered: true } };
+    const { store } = renderComponent(props, customStoreData);
+    const cleanFiltersButton = screen.queryByTestId('clean-filters');


Suggested change

const cleanFiltersButton = screen.queryByTestId('clean-filters');

const cleanFiltersButton = screen.queryByRole('button', {name: /Clear filters/i});

bradenmacdonald · 2025-05-28T19:40:38Z

src/studio-home/tabs-section/courses-tab/index.tsx

@@ -199,7 +184,7 @@ const CoursesTab: React.FC<Props> = ({
            <p data-testid="courses-not-found-alert">
              {intl.formatMessage(messages.coursesTabCourseNotFoundAlertMessage)}
            </p>
-            <Button variant="primary" onClick={handleCleanFilters}>
+            <Button data-testid="clean-filters" variant="primary" onClick={handleCleanFilters}>


Suggested change

<Button data-testid="clean-filters" variant="primary" onClick={handleCleanFilters}>

<Button variant="primary" onClick={handleCleanFilters}>

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

bra-i-am changed the title ~~refactor: remove references of ENABLE_HOME_PAGE_COURSE_API_V2~~ [WIP] refactor: remove references of ENABLE_HOME_PAGE_COURSE_API_V2 Jan 27, 2025

BryanttV mentioned this pull request Jan 28, 2025

[DEPR]: Remove HomePageCourses API v1 openedx/public-engineering#287

Open

4 tasks

bra-i-am force-pushed the bc/rm-course-api-v2-and-fixes branch 2 times, most recently from 994e1b6 to eb6203a Compare January 30, 2025 15:37

bra-i-am force-pushed the bc/rm-course-api-v2-and-fixes branch from 95ebf9d to dfabaab Compare February 3, 2025 13:28

bra-i-am marked this pull request as ready for review February 3, 2025 14:13

bra-i-am force-pushed the bc/rm-course-api-v2-and-fixes branch from 82b976e to c6b6c64 Compare February 18, 2025 14:32

bra-i-am changed the title ~~[WIP] refactor: remove references of ENABLE_HOME_PAGE_COURSE_API_V2~~ refactor: remove references of ENABLE_HOME_PAGE_COURSE_API_V2 Feb 18, 2025

bra-i-am force-pushed the bc/rm-course-api-v2-and-fixes branch from 6456ccc to 65b4d0f Compare March 5, 2025 20:05

bra-i-am added 6 commits April 21, 2025 16:41

refactor: remove references of ENABLE_HOME_PAGE_COURSE_API_V2

b7f8c4b

* fix: infinite requests when clearing filters * fix: some requests were being duplicated when changing filters

test: adapt tests to the latest changes

3672bbd

test: improve test coverage

aa7087c

refactor: drop tab for archived courses

d582792

test: filter reset functionality in CoursesTab component

edefa55

refactor: revert deletion of isShowProcessing

72892ca

bra-i-am force-pushed the bc/rm-course-api-v2-and-fixes branch from 65b4d0f to 72892ca Compare April 21, 2025 21:47

test: update visibility check for pagination text in TabsSection tests

1d6f8ad

bradenmacdonald reviewed May 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor: remove references of ENABLE_HOME_PAGE_COURSE_API_V2 #1611

refactor: remove references of ENABLE_HOME_PAGE_COURSE_API_V2 #1611

bra-i-am commented Jan 27, 2025 •

edited

Loading

Uh oh!

openedx-webhooks commented Jan 27, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jan 30, 2025 •

edited

Loading

Uh oh!

mariajgrimaldi commented Feb 21, 2025

Uh oh!

bradenmacdonald commented Feb 25, 2025

Uh oh!

KristinAoki commented Feb 28, 2025

Uh oh!

bra-i-am commented Mar 5, 2025

Uh oh!

saadyousafarbi commented Mar 24, 2025

Uh oh!

mphilbrick211 commented May 27, 2025

Uh oh!

bra-i-am commented May 27, 2025

Uh oh!

bradenmacdonald left a comment

Uh oh!

bradenmacdonald May 28, 2025

Uh oh!

bradenmacdonald May 28, 2025

Uh oh!

bradenmacdonald May 28, 2025

Uh oh!

bradenmacdonald May 28, 2025

Uh oh!

Uh oh!

	data-testid="toggle-dropdown"
	aria-label={intl.formatMessage(messages. ... )}

	const cleanFiltersButton = screen.queryByTestId('clean-filters');
	const cleanFiltersButton = screen.queryByRole('button', {name: /Clear filters/i});

	<Button data-testid="clean-filters" variant="primary" onClick={handleCleanFilters}>
	<Button variant="primary" onClick={handleCleanFilters}>

refactor: remove references of ENABLE_HOME_PAGE_COURSE_API_V2 #1611

Are you sure you want to change the base?

refactor: remove references of ENABLE_HOME_PAGE_COURSE_API_V2 #1611

Conversation

bra-i-am commented Jan 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Side effects

Testing instructions

Uh oh!

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

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

mariajgrimaldi commented Feb 21, 2025

Uh oh!

bradenmacdonald commented Feb 25, 2025

Uh oh!

KristinAoki commented Feb 28, 2025

Uh oh!

bra-i-am commented Mar 5, 2025

Uh oh!

saadyousafarbi commented Mar 24, 2025

Uh oh!

mphilbrick211 commented May 27, 2025

Uh oh!

bra-i-am commented May 27, 2025

Uh oh!

bradenmacdonald left a comment

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald May 28, 2025

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald May 28, 2025

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald May 28, 2025

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald May 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bra-i-am commented Jan 27, 2025 •

edited

Loading

openedx-webhooks commented Jan 27, 2025 •

edited

Loading

codecov bot commented Jan 30, 2025 •

edited

Loading