Keep filters option when switching repos #226

Arif-Khalid · 2024-01-20T11:11:14Z

Summary:

Fixes #205

Type of change:

✨ New Feature/ Enhancement

Changes Made:

Added checkbox on dialog that opens when selecting a repo
If that checkbox is checked when confirming selection, filter selection for status, type, sort, search bar, selected labels and hidden labels are kept
Checkbox is not mounted when there is no repo currently selected, i.e., no changes to keep

Screenshots:

Before the change

After the change

Proposed Commit Message:

Option to keep filters you have set on repo changes.

No way to keep filters when changing repos.

An option to keep the common filters will be useful for anyone
managing multiple repositories without the hassle of reapplying 
the same filters.

Let's add a checkbox to the change repo dialog allowing 
users to keep their filters.

Checklist:

I have tested my changes thoroughly.
I have created tests for any new code files created in this PR or provided a link to a issue/PR that addresses this.
I have added or modified code comments to improve code readability where necessary.
I have updated the project's documentation as necessary.

gycgabriel

Tested - The filters are shown but they are not applied after switching the repo
Also, the search bar and the label filters are not persisted.

gycgabriel · 2024-01-20T11:49:14Z

src/app/shared/issue-tables/dropdownfilter.ts

+/** This copy of the filter is constantly updated when a change in filter is detected */
+let currentDropdownFilter: DropdownFilter = { ...DEFAULT_DROPDOWN_FILTER };
+
+/** This is the initial dropdown filter applied when first viewing a new repo */
+let initialDropdownFilter: DropdownFilter = { ...DEFAULT_DROPDOWN_FILTER };


Why do we need to store both initial and current Dropdown filters?

Both are unnecessary in hindsight. Initial dropdown filter variable has been removed.

Arif-Khalid · 2024-01-21T15:05:59Z

Tested - The filters are shown but they are not applied after switching the repo Also, the search bar and the label filters are not persisted.

Committed new changes that fixes functionality for status, type and sort filters.
Labels and issue names are likely always different across repos. Should I continue to work on storing search bar and labels?
If so should I ignore labels that don't exist on the new repo?

gycgabriel · 2024-01-21T15:33:04Z

Labels and issue names are likely always different across repos. Should I continue to work on storing search bar and labels?

Actually, for CS2103 projects which is the main use case for WATcher, they will most likely be same or similar. It's up to you if you want to continue working on it or create a separate issue for someone else to pick up.

If so should I ignore labels that don't exist on the new repo?

Yes, drop label selections that don't exist

Arif-Khalid · 2024-01-24T12:33:08Z

Labels and issue names are likely always different across repos. Should I continue to work on storing search bar and labels?

Actually, for CS2103 projects which is the main use case for WATcher, they will most likely be same or similar. It's up to you if you want to continue working on it or create a separate issue for someone else to pick up.

If so should I ignore labels that don't exist on the new repo?

Yes, drop label selections that don't exist

I have refactored the code into its own file called FiltersStore.ts and am using a static class to store the filters as they are edited, initialize new repos with previous filter values and clearing the store if filters are not kept.
Current status is that functionality for search, status, type and sort filters are working; Also fixed an oversight that ascending and descending order of sort was not accounted for.
Before I start work on the labels, I would appreciate some feedback on the direction I have taken and if necessary a suggestion for a better, alternative approach.

Arif-Khalid · 2024-01-24T15:48:21Z

In hindsight, I think a better approach for consistency would be to have my FiltersStore.ts be the central home of the filters such that all components update and retrieve from FiltersStore. This would negate me having to copy filter changes and will be more developer friendly to understand. What do you think?

gycgabriel · 2024-01-25T06:14:54Z

src/app/shared/filter-bar/filter-bar.component.ts

+  dropdownFilter: DropdownFilter = FiltersStore.getInitialDropdownFilter();
+
+  /** The initial search filter value, not updated when search filter is changed */
+  initialSearchFilter: string = FiltersStore.getInitialSearchFilter();



Why name it initial?

It is named initial because this search filter variable is not updated at all when the user types. Instead this variable is simply used to initialize what is seen by the user at the search bar when they first open a new repo.

Arif-Khalid · 2024-01-29T08:40:43Z

I have updated functionality to include the working logic for storing the status, type, sort, search bar, selected labels and hidden labels when the keep filters option is checked when switching repos. I also encountered a small bug where the DEFAULT_DROPDOWN_FILTER milestones property was being added to when switching repos since the array containing the milestones was passed by reference. My most recent push also fixes this issue.

Update branch with latest updates to main

gycgabriel

I'm getting errors for structuredClone, is this necessary

ERROR in src/app/shared/issue-tables/FiltersStore.ts:8:58 - error TS2304: Cannot find name 'structuredClone'.

only available in node 17, we're using node 14

gycgabriel · 2024-02-06T09:01:09Z

I'm not completely convinced that we need both initial and current variables, since by default it will reset, so why do we have to store the initial state? @CATcher-org/2223s2 what do you think?

…cher into 205-keep-filters

Arif-Khalid · 2024-02-19T04:40:04Z

Will close this PR to work on #249 as the fix for #205 will be easy after.

Arif-Khalid added 5 commits January 20, 2024 17:10

Persist common filters across repos

18e4c72

Store filter changes based on a boolean

12db6ab

Checkbox for keeping filters

b3ebf41

Comment and clean up code

03faca9

Update code comments

fa959c2

Arif-Khalid changed the title ~~205 keep filters~~ Keep filters option when switching repos Jan 20, 2024

gycgabriel requested changes Jan 20, 2024

View reviewed changes

Arif-Khalid added 2 commits January 21, 2024 22:51

Fix intial filters not applying to new repo

334199a

Fix import in CardViewComponent

ffec9b1

Arif-Khalid added 4 commits January 24, 2024 19:48

Refactor filters store into a static class

e1a4928

Fix linting issues

2138224

Store search bar filter

372393e

Add comments in FiltersStore

d22d9f6

gycgabriel reviewed Jan 26, 2024

View reviewed changes

Arif-Khalid added 3 commits January 29, 2024 16:04

Store selected and hidden labels

8fdf7c0

Fix linting errors

ef2ecc5

Fix milestones property of default filter being changed

089a9eb

Arif-Khalid requested a review from gycgabriel January 29, 2024 08:43

Arif-Khalid and others added 2 commits February 5, 2024 12:13

Merge pull request #1 from Arif-Khalid/main

0bf2c33

Update branch with latest updates to main

Merge branch 'main' into 205-keep-filters

8d75b16

gycgabriel reviewed Feb 6, 2024

View reviewed changes

gycgabriel requested a review from a team February 6, 2024 13:17

gycgabriel and others added 2 commits February 7, 2024 01:17

Merge branch 'main' into 205-keep-filters

bf6ba3a

Remove unsupported structureClone method

30051f5

Arif-Khalid and others added 3 commits February 8, 2024 16:39

Merge branch '205-keep-filters' of https://github.com/Arif-Khalid/WAT…

a2f8ef8

…cher into 205-keep-filters

Merge branch 'main' into 205-keep-filters

2785012

Merge branch 'main' into 205-keep-filters

0fb4a55

Arif-Khalid mentioned this pull request Feb 8, 2024

Refactor filters into its own service #249

Closed

7 tasks

Arif-Khalid closed this Feb 19, 2024

Arif-Khalid deleted the 205-keep-filters branch March 4, 2024 04:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Keep filters option when switching repos #226

Keep filters option when switching repos #226

Arif-Khalid commented Jan 20, 2024 •

edited

Loading

gycgabriel left a comment

gycgabriel Jan 20, 2024

Arif-Khalid Jan 21, 2024

Arif-Khalid commented Jan 21, 2024

gycgabriel commented Jan 21, 2024

Arif-Khalid commented Jan 24, 2024 •

edited

Loading

Arif-Khalid commented Jan 24, 2024 •

edited

Loading

gycgabriel Jan 25, 2024 •

edited

Loading

Arif-Khalid Jan 29, 2024

Arif-Khalid commented Jan 29, 2024

gycgabriel left a comment •

edited

Loading

gycgabriel commented Feb 6, 2024 •

edited

Loading

Arif-Khalid commented Feb 19, 2024

Keep filters option when switching repos #226

Keep filters option when switching repos #226

Conversation

Arif-Khalid commented Jan 20, 2024 • edited Loading

Summary:

Type of change:

Changes Made:

Screenshots:

Proposed Commit Message:

Checklist:

gycgabriel left a comment

Choose a reason for hiding this comment

gycgabriel Jan 20, 2024

Choose a reason for hiding this comment

Arif-Khalid Jan 21, 2024

Choose a reason for hiding this comment

Arif-Khalid commented Jan 21, 2024

gycgabriel commented Jan 21, 2024

Arif-Khalid commented Jan 24, 2024 • edited Loading

Arif-Khalid commented Jan 24, 2024 • edited Loading

gycgabriel Jan 25, 2024 • edited Loading

Choose a reason for hiding this comment

Arif-Khalid Jan 29, 2024

Choose a reason for hiding this comment

Arif-Khalid commented Jan 29, 2024

gycgabriel left a comment • edited Loading

Choose a reason for hiding this comment

gycgabriel commented Feb 6, 2024 • edited Loading

Arif-Khalid commented Feb 19, 2024

Arif-Khalid commented Jan 20, 2024 •

edited

Loading

Arif-Khalid commented Jan 24, 2024 •

edited

Loading

Arif-Khalid commented Jan 24, 2024 •

edited

Loading

gycgabriel Jan 25, 2024 •

edited

Loading

gycgabriel left a comment •

edited

Loading

gycgabriel commented Feb 6, 2024 •

edited

Loading