Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

params: validate param option against all available options #526

Merged
merged 1 commit into from
Oct 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion invenio_records_resources/services/base/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,14 @@ def customize(cls, opts):
attrs = {}
if opts.facets:
attrs["facets"] = opts.facets
# these are the selected sort options
if opts.sort_options:
attrs["sort_options"] = opts.sort_options
attrs["sort_default"] = opts.sort_default
attrs["sort_default_no_query"] = opts.sort_default_no_query
# store all available sort options
if opts.available_sort_options:
attrs["available_sort_options"] = opts.available_sort_options
if opts.query_parser_cls:
attrs["query_parser_cls"] = opts.query_parser_cls
return _make_cls(cls, attrs) if attrs else cls
Expand Down Expand Up @@ -128,20 +132,30 @@ def __init__(self, available_options, selected_options):
# Ensure all selected options are availabe.
for o in selected_options:
assert o in available_options, f"Selected option '{o}' is undefined."
self.iterate_all_options = False

self.available_options = available_options
self.selected_options = selected_options

def __iter__(self):
"""Iterate over options to produce RSK options."""
for o in self.selected_options:
for o in (
self.selected_options
if not self.iterate_all_options
else self.available_options
):
yield self.map_option(o, self.available_options[o])

def map_option(self, key, option):
"""Map an option."""
# This interface is used in Invenio-App-RDM.
return (key, option)

def __call__(self):
"""Control if we iterate through all or selected sort options."""
self.iterate_all_options = True
return self


class SortOptionsSelector(OptionsSelector):
"""Sort options for the search configuration."""
Expand Down Expand Up @@ -194,6 +208,11 @@ def sort_options(self):
"""Get sort options for search."""
return {k: v for (k, v) in self._sort}

@property
def available_sort_options(self):
"""Get sort options for search."""
return {k: v for (k, v) in self._sort()}

@property
def sort_default(self):
"""Get default sort method for search."""
Expand Down
11 changes: 10 additions & 1 deletion invenio_records_resources/services/records/params/sort.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,16 @@ def apply(self, identity, search, params):

def _compute_sort_fields(self, params):
"""Compute sort fields."""
options = deepcopy(self.config.sort_options)
# validate sort options in the following order
# 1. search all available options if set in the search config. This will be
# added automatically if `SearchOptionsMixin` is used.
# 2. selected sort options otherwise. These are also the sort options that the
# UI displays.
options = deepcopy(
self.config.available_sort_options
if hasattr(self.config, "available_sort_options")
else self.config.sort_options
)
if "sort" not in params:
params["sort"] = self._default_sort(params, options)

Expand Down
Loading