Editor: Add a date range search filter #1030

tkohr · 2024-10-25T17:23:21Z

Description

This PR allows setting a date range filter via the calendar.

Open to-dos are:

design/css
further tests
~~add a filter reset button while waiting for filter summary?~~ => wait for Editor: Add a search filters summary component #1037 before merging this one

Displaying available dates in the calendar via the aggregation values will be part of a separate PR.

Quality Assurance Checklist

Commit history is devoid of any merge commits and readable to facilitate reviews
If new logic ⚙️ is introduced: unit tests were added
If new user stories 🤏 are introduced: E2E tests were added
If new UI components 🕹️ are introduced: corresponding stories in Storybook were created
If breaking changes 🪚 are introduced: add the breaking change label
If bugs 🐞 are fixed: add the backport <release branch> label
The documentation website 📚 has received the love it deserves

github-actions · 2024-10-25T17:24:33Z

Affected libs: api-repository, feature-catalog, feature-record, feature-router, feature-search, feature-map, feature-editor, feature-auth, common-domain, api-metadata-converter, ui-search, feature-dataviz, common-fixtures, ui-elements, feature-notifications, ui-catalog, util-shared, ui-widgets, ui-inputs, ui-layout, ui-map, ui-dataviz,
Affected apps: metadata-editor, datahub, demo, webcomponents, map-viewer, search, datafeeder, metadata-converter, data-platform,

🚀 Build and deploy storybook and demo on GitHub Pages
📦 Build and push affected docker images

github-actions · 2024-10-25T17:31:29Z

📷 Screenshots are here!

coveralls · 2024-11-06T11:03:08Z

coverage: 83.97% (+0.6%) from 83.419%
when pulling 3d963c2 on me-date-filter
into a731fc6 on main.

Angi-Kinas

Nice work 🎉
Thank you @tkohr for this nice date range filter!

While testing the component I was also feeling a need for a "clear filter" button as you already mentioned. But maybe this will be part of future implementation.

Apart from this I only have some minor comments. Let me know if something is not clear.

apps/metadata-editor-e2e/src/e2e/dashboard.cy.ts

libs/api/repository/src/lib/gn4/elasticsearch/elasticsearch.service.spec.ts

libs/feature/router/src/lib/default/state/query-params.utils.ts

libs/ui/inputs/src/lib/date-range-dropdown/date-range-dropdown.component.css

libs/common/domain/src/lib/model/search/filter.model.ts

to make them work with other filters

todo: methods should only accept DateRange or string, not both

Co-authored-by: Olivia Guyot <[email protected]>

…rray

…range even without the date input, this is used in the calendar display

…s-summary-item

…s present

…omponent

…ar all

…method to simplify template and align badges

move one common formatUserInfo() to utils at the same time

…f no summary label defined

and use fieldname 'user' in component

treat dates in local timezone in app and without time in URL

…lters summary fix waiting for this.searchFacade.searchFilters$ via ngOnInit at the same time both is needed for use in myRecords.component

CLAassistant · 2024-12-08T03:41:27Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

…LIST also when clearing filters

Editor: Add a search filters summary component

Angi-Kinas

Thanks @tkohr for implementing a date range search filter!

I tested this together with this PR #1037 and it works fine 👍 🚀

tkohr · 2024-12-11T17:09:07Z

Nice, thanks for all the reviewing and testing @Angi-Kinas !

tkohr force-pushed the me-date-filter branch from 3713c5d to ad65635 Compare October 29, 2024 15:52

tkohr force-pushed the me-date-filter branch from 8b8d1d2 to 873cbff Compare November 6, 2024 10:49

tkohr marked this pull request as ready for review November 6, 2024 10:50

Angi-Kinas reviewed Nov 11, 2024

View reviewed changes

jahow added this to the 2.4.0 milestone Nov 14, 2024

tkohr force-pushed the me-date-filter branch from 2693db5 to f95e16d Compare November 26, 2024 08:28

tkohr and others added 21 commits December 5, 2024 13:57

feat(filters): first draft to filter results by date range

0b5ba02

fix(fields): return one value instead of array for date range filter

d4722db

fix(fields): handle stringified range filters

c4c898f

to make them work with other filters

refactor(es): check on filter type dateRange instead of name changeDate

7cb12dc

refactor(es): add types for FilterQuery

0cef9b7

refactor(es): move utility functions

bd48cb1

refactor(fields): clarify curently used types for date range

fc9d05b

todo: methods should only accept DateRange or string, not both

feat(router): add utilitis to serialize DateRange objects in URL

a36690c

Co-authored-by: Olivia Guyot <[email protected]>

feat(router): use and adapt query-params.utils for serialization

eb1e459

refactor(date-range): keep one isDateRange() function

adce683

refactor(fields): clean getFiltersForValues() and pass DateRange as a…

1dfeaed

…rray

feat(filter-dropdown): display date in date picker input

1849410

fix(filter-dropdown): ignore timezones to set exact dates

ac463c0

feat(all-records): remove filter publicationYear

8cc8b61

feat(date-range): add a date-range-dropdown.component to follow mockups

006f639

test(filters): add e2e tests for date range search filter

b22225e

test(filters): add unit tests and fix code

56ae253

fix(date-range): define and export type once

32b7c5c

review(search filters): address comments

1a3f86a

feat(date-range): synchronize date-range-dropdown with selected date …

bf9cae0

…range even without the date input, this is used in the calendar display

chore(router): clean commented type

e4db9ea

tkohr added 19 commits December 5, 2024 14:11

feat(search-filters): add search-filters-summary

b966143

refactor(search-filters): refactor summary component

57d9dea

refactor(search-filters-summary): rename component into search-filter…

33b2788

…s-summary-item

feat(search-filters): display summary and filter labels only if value…

a3757ea

…s present

feat(search-filters): introduce intermediate search-filters-summary.c…

e80aa11

…omponent

feat(search-filter-summary): allow to remove one filter value and cle…

b8a9090

…ar all

feat(search-filters-summary): adapt UI

4a4a20a

refactor(search-filters-summary-item): implement a getReadableValues …

527c253

…method to simplify template and align badges

refactor(search-filter-summary): move components for feature-search lib

4ee157c

fix(search-filters-summary): fix error when used in myRecords

a46f4e5

feat(search-filter-summary): format userInfo in summary badges

d3ef2ad

move one common formatUserInfo() to utils at the same time

feat(search-filter-summary): provide filter label as fallback label i…

11a2ed3

…f no summary label defined

refactor(fields): remove FieldType 'userInfo'

66f26a5

and use fieldname 'user' in component

test(search-filter-summary): add unit tests

85353ee

rebase(search-filters): clean after rebase

df492b9

test(search-filter-summary): add e2e tests

e3e2f71

fix(dateRange/e2e): handle different timezones

ebe1355

treat dates in local timezone in app and without time in URL

feat(search-filters-summary): allow providing filters to ignore in fi…

8302b76

…lters summary fix waiting for this.searchFacade.searchFilters$ via ngOnInit at the same time both is needed for use in myRecords.component

fix(fields): ignore empty values in getFiltersForValues

508983b

tkohr force-pushed the me-date-filter branch from f95e16d to e4db9ea Compare December 5, 2024 13:20

chore(date-range-dropdown): replace left over mat-icon with ng-icon

5ee6f32

tkohr added 2 commits December 10, 2024 16:16

fix(search-filters-summary): ignore filters in FILTER_SUMMARY_IGNORE_…

75ca16b

…LIST also when clearing filters

Merge pull request #1037 from geonetwork/me-search-filters-summary

3d963c2

Editor: Add a search filters summary component

Angi-Kinas approved these changes Dec 11, 2024

View reviewed changes

tkohr merged commit bef577f into main Dec 11, 2024
13 checks passed

tkohr deleted the me-date-filter branch December 11, 2024 17:09

tkohr mentioned this pull request Dec 13, 2024

Editor: Ignore search value in filter reset button #1065

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Editor: Add a date range search filter #1030

Editor: Add a date range search filter #1030

tkohr commented Oct 25, 2024 •

edited

Loading

github-actions bot commented Oct 25, 2024 •

edited

Loading

github-actions bot commented Oct 25, 2024 •

edited

Loading

coveralls commented Nov 6, 2024 •

edited

Loading

Angi-Kinas left a comment

CLAassistant commented Dec 8, 2024

Angi-Kinas left a comment

tkohr commented Dec 11, 2024

Editor: Add a date range search filter #1030

Editor: Add a date range search filter #1030

Conversation

tkohr commented Oct 25, 2024 • edited Loading

Description

Quality Assurance Checklist

github-actions bot commented Oct 25, 2024 • edited Loading

github-actions bot commented Oct 25, 2024 • edited Loading

coveralls commented Nov 6, 2024 • edited Loading

Angi-Kinas left a comment

Choose a reason for hiding this comment

CLAassistant commented Dec 8, 2024

Angi-Kinas left a comment

Choose a reason for hiding this comment

tkohr commented Dec 11, 2024

tkohr commented Oct 25, 2024 •

edited

Loading

github-actions bot commented Oct 25, 2024 •

edited

Loading

github-actions bot commented Oct 25, 2024 •

edited

Loading

coveralls commented Nov 6, 2024 •

edited

Loading