feat: Capa problem types submenu [FC-0059] #1207

ChrisChV · 2024-08-07T03:48:06Z

Description

This PR adds a new submenu in the problem filter menu item to filter by Capa Problem Types.

Supporting information

Github Issue: Library Home - Filter by Capa Problem Type #1196
Depends on: feat: Problem types added as filterable attribute [FC-0059] edx-platform#35242

Testing instructions

Use this branch of edx-platform
Create a new library
Enable the library-authoring MFE to edit library components
Go to library-authoring MFE and create problem components for the library. Edit each component and add different problem types.
Disable the library-authoring MFE.
Run tutor dev run cms bash and ./manage.py cms reindex_studio to recreate the index
Go to the library Home and test the new filter by problems

openedx-webhooks · 2024-08-07T03:48:10Z

Thanks for the pull request, @ChrisChV!

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.

navinkarkera

@ChrisChV The filter works nicely except for few cases as mentioned below:

vokoscreenNG-2024-08-15_16-27-11.mp4

navinkarkera · 2024-08-15T10:06:06Z

src/search-manager/FilterByBlockType.tsx

-      return [...currentFilters, e.target.value];
-    });
-  }, [setBlockTypesFilter]);
-
  return (
    <SearchFilterWidget
      appliedFilters={blockTypesFilter.map(blockType => ({ label: <BlockTypeLabel type={blockType} /> }))}


We should also clear problemTypeFilters on Clear Filter click no?
This comment is about line 216 clearFilter={() => setBlockTypesFilter([])}, as it is not part of the diff, I cannot directly comment on it.

Updated: db99d67#diff-6b1219a9801a8748097a4b1c32532d4ea9f975212c769a4426a0aa1fb73306e9R199

navinkarkera · 2024-08-15T11:02:21Z

src/search-manager/data/api.ts

+  // To filter normal block types and problem types as 'OR' query
+  const typeFilters = [[
+    ...blockTypesFilterFormatted,
+    ...problemTypesFilterFormatted,
+  ].flat()];
+


vokoscreenNG-2024-08-15_16-28-28.mp4

Because of the OR condition between block types and problem types, filtering problem types after selecting whole problem block does not work. We can probably remove problem block type if problem types are selected.

Updated: f744344

codecov · 2024-08-21T03:38:47Z

Codecov Report

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

Project coverage is 93.06%. Comparing base (d99a09e) to head (300ecf6).
Report is 1 commits behind head on master.

Files	Patch %	Lines
src/search-manager/data/apiHooks.ts	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1207      +/-   ##
==========================================
+ Coverage   93.02%   93.06%   +0.04%     
==========================================
  Files         756      756              
  Lines       13730    13777      +47     
  Branches     2917     2984      +67     
==========================================
+ Hits        12772    12822      +50     
+ Misses        923      920       -3     
  Partials       35       35

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

navinkarkera

@ChrisChV Nice! Added some suggestions, feel free to ignore them 👍

I tested this by filtering problem blocks in different combinations.
I read through the code
I checked for accessibility issues
Includes documentation

Just one question about the filter behaviour: The filter button doesn't show any data related to problem subtypes:

Is this expected?

src/search-manager/FilterByBlockType.tsx

ChrisChV · 2024-08-22T01:56:34Z

Is this expected?

I asked here: #1196 (comment)

pomegranited

👍 Works perfectly. Great work @ChrisChV !

I tested this using the PR instructions.
I read through the code
I checked for accessibility issues by using my keyboard alone to navigate.
Includes documentation (code comments)
User-facing strings are extracted for translation

bradenmacdonald

Nice!

src/search-manager/FilterByBlockType.tsx

src/search-manager/messages.ts

bradenmacdonald · 2024-08-27T20:11:56Z

Thanks @ChrisChV. Go ahead and merge at your convenience when the build is green.

openedx-webhooks · 2024-08-28T13:16:06Z

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

feat: Capa problem types submenu

8574fc0

ChrisChV requested a review from a team as a code owner August 7, 2024 03:48

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

bradenmacdonald changed the title ~~[FC-0059] feat: Capa problem types submenu~~ feat: Capa problem types submenu [FC-0059] Aug 9, 2024

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Aug 12, 2024

ChrisChV mentioned this pull request Aug 15, 2024

feat: Problem types added as filterable attribute [FC-0059] openedx/edx-platform#35242

Merged

feat: Update filter to make an OR query with blockTypes and problemTypes

f744344

navinkarkera suggested changes Aug 15, 2024

View reviewed changes

ChrisChV added 5 commits August 19, 2024 23:14

fix: Clear Problem block types && multiple cases of the filter

db99d67

chore: Fix merge conflicts

2274d73

test: FilterByBlockType tests

4c23f3b

style: Nits on the code to fix types verification

52c0c85

test: Fix tests on SearchUI

43a787b

navinkarkera approved these changes Aug 21, 2024

View reviewed changes

ChrisChV added 3 commits August 21, 2024 20:17

test: Add more test in LibraryAuthoringPage

bfe82f6

test: fix coverage in FilterByBlockType.tsx

916a37b

style: Nits on the code

5c8e752

ChrisChV mentioned this pull request Aug 22, 2024

Library Home - Filter by Capa Problem Type #1196

Closed

test: fix coverage in tests

c1ae058

pomegranited approved these changes Aug 23, 2024

View reviewed changes

ChrisChV added 2 commits August 26, 2024 18:34

chore: Fix merge conflicts

0b62627

fix: Tests on LibraryAuthoringPage

61f750c

bradenmacdonald approved these changes Aug 27, 2024

View reviewed changes

src/search-manager/FilterByBlockType.tsx Show resolved Hide resolved

src/search-manager/messages.ts Show resolved Hide resolved

ChrisChV added 2 commits August 27, 2024 13:54

refactor: ProblemFilterItem created

f430c32

fix: Add problemFilterTypes to appliedFilters label

300ecf6

ChrisChV merged commit 64ffadd into openedx:master Aug 28, 2024
8 checks passed

ChrisChV deleted the chris/FAL-3781-filter-capa-problem-type branch August 28, 2024 13:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Capa problem types submenu [FC-0059] #1207

feat: Capa problem types submenu [FC-0059] #1207

ChrisChV commented Aug 7, 2024 •

edited

Loading

openedx-webhooks commented Aug 7, 2024

navinkarkera left a comment •

edited

Loading

navinkarkera Aug 15, 2024

ChrisChV Aug 20, 2024

navinkarkera Aug 15, 2024

ChrisChV Aug 20, 2024

codecov bot commented Aug 21, 2024 •

edited

Loading

navinkarkera left a comment

ChrisChV commented Aug 22, 2024

pomegranited left a comment

bradenmacdonald left a comment

bradenmacdonald commented Aug 27, 2024

openedx-webhooks commented Aug 28, 2024

feat: Capa problem types submenu [FC-0059] #1207

feat: Capa problem types submenu [FC-0059] #1207

Conversation

ChrisChV commented Aug 7, 2024 • edited Loading

Description

Supporting information

Testing instructions

openedx-webhooks commented Aug 7, 2024

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?

navinkarkera left a comment • edited Loading

Choose a reason for hiding this comment

navinkarkera Aug 15, 2024

Choose a reason for hiding this comment

ChrisChV Aug 20, 2024

Choose a reason for hiding this comment

navinkarkera Aug 15, 2024

Choose a reason for hiding this comment

ChrisChV Aug 20, 2024

Choose a reason for hiding this comment

codecov bot commented Aug 21, 2024 • edited Loading

Codecov Report

navinkarkera left a comment

Choose a reason for hiding this comment

ChrisChV commented Aug 22, 2024

pomegranited left a comment

Choose a reason for hiding this comment

bradenmacdonald left a comment

Choose a reason for hiding this comment

bradenmacdonald commented Aug 27, 2024

openedx-webhooks commented Aug 28, 2024

ChrisChV commented Aug 7, 2024 •

edited

Loading

navinkarkera left a comment •

edited

Loading

codecov bot commented Aug 21, 2024 •

edited

Loading