Persist filter parameters in URL

[nmcharlton]

User Story

As an Admin Panel user I want to be able to bookmark (in my browser) or link directly to pre-filtered views on each of the Admin Panel tools that support filtering so that I don't have to set my preferred filters each time I open the tool, and can share direct links to other users.

Feature Description

We need to encode the current filter selection in the URL as a query string and have it update each time the user changes the filters. When navigating to a valid filter URL, the filter should be applied automatically and the values should populate the filter dialog.

This should be applied as uniformly as possible across all tools with filters:

• Verify
• Captures
• Capture Matching
• Earnings
• Payments
• Growers
• Stakeholders

The mechanism should be built in a way that does not require additional maintenance when new filter parameters are added to any existing filter.

[SuspenseFallback]

Can I be assigned to this?

[nmcharlton]

Note that there is currently no requirement for a filter bookmark feature within the Admin Panel. Instead, filters in the URL would allow users to bookmark a filter using their browser.

[SuspenseFallback]

So the user has to manually bookmark the page? Or does the filter get bookmarked via something like localStorage?

[nmcharlton]

Manual bookmarking is fine for now. The main aim of this issue is the mechanism that enables persistable filters.

Sorry for the misleading user story.

[SuspenseFallback]

Are the active and approved parameters also supposed to persist?

[nmcharlton]

Are the active and approved parameters also supposed to persist?

The verification status needs to persist in Verify.
The active and approved parameters will soon be removed from Captures, so are less important.

[SuspenseFallback]

What is the verification status?

[nmcharlton]

What is the verification status?

It's the first filter in Verify. It maps to status in the /${QUERY_API}/raw-captures query.

[nmcharlton]

Apologies, I didn't realise we were still using active and approved booleans as a proxy for status. We can remove those and use a direct mapping in the filter and everywhere we display the verification status.

[nmcharlton]

@gwynndp Can you make sure we remove active and approved from the filter models as part of the Captures migration?

[SuspenseFallback]

Sorry, I have not been able to work on this issue for a while due to school!

[nmcharlton]

Hi @SuspenseFallback. Have you been able to make any more progress on this issue?
Could you create a draft PR to help us move it forward?

[SuspenseFallback]

OK, thanks.