loans: date range search (#783)

* loans: date range search

- adds filter `loans_from_date` and `loans_to_date` to filter loans
- adds UI datepickers to choose dates
- upgrades `react-searchkit` and `axios`
- closes #168

.gitignore

@@ -4,6 +4,7 @@ __pycache__/
 
 # Idea software family
 .idea/
+.vscode/
 
 # C extensions
 *.so

invenio_app_ils/config.py

@@ -53,8 +53,9 @@
 from .documents.api import DOCUMENT_PID_FETCHER, DOCUMENT_PID_MINTER, \
     DOCUMENT_PID_TYPE, Document
 from .documents.search import DocumentSearch
-from .facets import default_value_when_missing_filter, keyed_range_filter, \
-    not_empty_object_or_list_filter, overdue_agg, overdue_loans_filter
+from .facets import date_range_filter, default_value_when_missing_filter, \
+    keyed_range_filter, not_empty_object_or_list_filter, overdue_agg, \
+    overdue_loans_filter
 from .records.views import UserInfoResource
 
 from invenio_circulation.config import _LOANID_CONVERTER  # isort:skip
@@ -1140,10 +1141,10 @@ def _(x):
             ),
         ),
         filters=dict(
-            circulation=default_value_when_missing_filter("circulation.state",
-                                                          "NOT_ON_LOAN"),
         ),
         post_filters=dict(
+            circulation=default_value_when_missing_filter(
+                "circulation.state", "NOT_ON_LOAN"),
             status=terms_filter("status"),
             medium=terms_filter("medium"),
             restrictions=terms_filter("circulation_restriction"),
@@ -1186,17 +1187,17 @@ def _(x):
                 )
             ),
         ),
-        filters={
-            "returns.end_date": overdue_loans_filter("end_date"),
-        },
-        post_filters=dict(
-            state=terms_filter("state"),
-            delivery=terms_filter("delivery.method"),
-            availability=keyed_range_filter(
+        post_filters={
+            "state": terms_filter("state"),
+            "delivery": terms_filter("delivery.method"),
+            "availability": keyed_range_filter(
                 "document.circulation.has_items_for_loan",
                 {"Available for loan": {"gt": 0}},
             ),
-        ),
+            "returns.end_date": overdue_loans_filter("end_date"),
+            "loans_from_date": date_range_filter("start_date", "gte"),
+            "loans_to_date": date_range_filter("start_date", "lte"),
+        },
     ),
     acq_orders=dict(  # OrderSearch.Meta.index
         aggs=dict(

invenio_app_ils/facets.py

@@ -6,7 +6,6 @@
 # it under the terms of the MIT License; see LICENSE file for more details.
 
 """Facets and factories for result filtering and aggregation."""
-from datetime import timedelta
 
 import arrow
 from elasticsearch_dsl.query import Bool, Q, Range
@@ -113,3 +112,18 @@ def overdue_agg():
             )
         )
     )
+
+
+def date_range_filter(field, comparator):
+    """Create a range filter.
+
+    :param field: Field name.
+    :param comparator: Comparison we want with the supplied date.
+    """
+    def inner(values):
+        try:
+            input_date = str(arrow.get(values[0]).date())
+        except arrow.parser.ParserError as e:
+            raise ValueError("Input should be a date")
+        return Range(**{field: {comparator: input_date}})
+    return inner

tests/api/test_facets.py

@@ -12,11 +12,13 @@
 from datetime import timedelta
 
 import arrow
+import pytest
 from elasticsearch_dsl.query import Bool, Q, Range, Terms
 from flask import current_app
 
-from invenio_app_ils.facets import default_value_when_missing_filter, \
-    keyed_range_filter, overdue_loans_filter
+from invenio_app_ils.facets import date_range_filter, \
+    default_value_when_missing_filter, keyed_range_filter, \
+    overdue_loans_filter
 
 
 def test_keyed_range_filter():
@@ -34,7 +36,6 @@ def test_keyed_range_filter():
 
 def test_current_ranged_loans_filter(app):
     """Test ranged current loans filter."""
-
     with app.app_context():
         rfilter = overdue_loans_filter("field")
 
@@ -57,3 +58,18 @@ def test_default_value_when_missing_filter(app):
         assert rfilter("test") == Terms(field="test")
         assert rfilter("missing val") == Bool(
             **{'must_not': {'exists': {'field': "field"}}})
+
+
+@pytest.mark.parametrize("input_date", ["",  "a string", "2020-02-02"])
+def test_date_range_filter(app, input_date):
+    """Test date range filter date validation and query."""
+    from_filter = date_range_filter("field", "gte")
+    to_filter = date_range_filter("field", "lte")
+
+    try:
+        assert from_filter([input_date]) == Range(field={"gte": input_date})
+        assert to_filter([input_date]) == Range(field={"lte": input_date})
+    except:
+        with pytest.raises(ValueError) as err:
+            from_filter([input_date])
+            to_filter([input_date])

ui/package.json

@@ -11,7 +11,7 @@
     "format": "prettier --config ./.prettierrc --ignore-path ./.prettierignore --write \"**/*.js\""
   },
   "dependencies": {
-    "axios": "^0.19.0",
+    "axios": "^0.19.2",
     "extract-text-webpack-plugin": "^3.0.2",
     "formik": "^2.0.6",
     "less": "^3.10.3",
@@ -30,7 +30,7 @@
     "react-router-dom": "^5.1.2",
     "react-scripts": "^3.4.0",
     "react-scroll": "^1.7.16",
-    "react-searchkit": "^0.16.0",
+    "react-searchkit": "^0.18.0",
     "react-show-more": "^2.0.0",
     "react-tagcloud": "^2.0.0",
     "redux": "^4.0.4",

ui/src/components/SearchControls/__tests__/SearchControls.test.js

@@ -30,8 +30,10 @@ beforeEach(() => {
 });
 
 const searchApi = new InvenioSearchApi({
-  url: documentApi.searchBaseURL,
-  withCredentials: true,
+  axios: {
+    url: documentApi.searchBaseURL,
+    withCredentials: true,
+  },
 });
 
 describe('SearchControls tests', () => {

ui/src/components/SearchControls/__tests__/__snapshots__/SearchControls.test.js.snap

@@ -101,16 +101,23 @@ exports[`SearchControls tests should mount SearchControls component 1`] = `
   }
 >
   <ReactSearchKit
+    appName="RSK"
     defaultSortByOnEmptyQuery={null}
-    history={null}
+    eventListenerEnabled={false}
     searchApi={
       InvenioSearchApi {
+        "axiosConfig": Object {
+          "url": "https://localhost:5000/api/documents/",
+          "withCredentials": true,
+        },
         "http": [Function],
+        "requestInterceptor": undefined,
         "requestSerializer": InvenioRequestSerializer {
           "_addFilter": [Function],
           "_addFilters": [Function],
           "serialize": [Function],
         },
+        "responseInterceptor": undefined,
         "responseSerializer": InvenioResponseSerializer {
           "serialize": [Function],
         },
@@ -139,15 +146,17 @@ exports[`SearchControls tests should mount SearchControls component 1`] = `
       }
     >
       <Connect(Bootstrap)
-        historyListen={null}
+        appName="RSK"
+        eventListenerEnabled={false}
         searchOnInit={true}
       >
         <Bootstrap
-          historyListen={null}
+          appName="RSK"
+          eventListenerEnabled={false}
           onAppInitialized={[Function]}
-          onBrowserHistoryExternallyChanged={[Function]}
           searchOnInit={true}
           searchOnUrlQueryStringChanged={[Function]}
+          updateQueryState={[Function]}
         >
           <SearchControls
             layoutToggle={

ui/src/pages/backoffice/Acquisition/Order/OrderSearch/OrderSearch.js

@@ -42,11 +42,13 @@ class OrderResponseSerializer {
 
 export class OrderSearch extends Component {
   searchApi = new InvenioSearchApi({
+    axios: {
+      url: orderApi.searchBaseURL,
+      withCredentials: true,
+    },
     invenio: {
       responseSerializer: OrderResponseSerializer,
     },
-    url: orderApi.searchBaseURL,
-    withCredentials: true,
   });
 
   renderSearchBar = (_, queryString, onInputChange, executeSearch) => {

ui/src/pages/backoffice/Acquisition/Vendor/VendorSearch/VendorSearch.js

@@ -29,8 +29,10 @@ import history from '@history';
 
 export class VendorSearch extends Component {
   searchApi = new InvenioSearchApi({
-    url: vendorApi.searchBaseURL,
-    withCredentials: true,
+    axios: {
+      url: vendorApi.searchBaseURL,
+      withCredentials: true,
+    },
   });
   searchConfig = getSearchConfig('vendors');
 

ui/src/pages/backoffice/Document/DocumentSearch/DocumentSearch.js

@@ -30,8 +30,10 @@ import history from '@history';
 
 export class DocumentSearch extends Component {
   searchApi = new InvenioSearchApi({
-    url: documentApi.searchBaseURL,
-    withCredentials: true,
+    axios: {
+      url: documentApi.searchBaseURL,
+      withCredentials: true,
+    },
   });
   searchConfig = getSearchConfig('documents');
 

ui/src/pages/backoffice/DocumentRequest/DocumentRequestSearch/DocumentRequestSearch.js

@@ -29,8 +29,10 @@ import { responseRejectInterceptor } from '@api/base';
 
 export class DocumentRequestSearch extends Component {
   searchApi = new InvenioSearchApi({
-    url: documentRequestApi.searchBaseURL,
-    withCredentials: true,
+    axios: {
+      url: documentRequestApi.searchBaseURL,
+      withCredentials: true,
+    },
     interceptors: {
       response: { reject: responseRejectInterceptor },
     },

ui/src/pages/backoffice/EItem/EItemSearch/EItemSearch.js

@@ -28,8 +28,10 @@ import history from '@history';
 
 export class EItemSearch extends Component {
   searchApi = new InvenioSearchApi({
-    url: eitemApi.searchBaseURL,
-    withCredentials: true,
+    axios: {
+      url: eitemApi.searchBaseURL,
+      withCredentials: true,
+    },
     interceptors: {
       response: { reject: responseRejectInterceptor },
     },

ui/src/pages/backoffice/ILL/BorrowingRequestSearch/BorrowingRequestSearch.js

@@ -29,8 +29,10 @@ import { BorrowingRequestListEntry } from './components';
 
 export class BorrowingRequestSearch extends Component {
   searchApi = new InvenioSearchApi({
-    url: borrowingRequestApi.searchBaseURL,
-    withCredentials: true,
+    axios: {
+      url: borrowingRequestApi.searchBaseURL,
+      withCredentials: true,
+    },
   });
 
   renderSearchBar = (_, queryString, onInputChange, executeSearch) => {

ui/src/pages/backoffice/ILL/LibrarySearch/LibrarySearch.js

@@ -27,8 +27,10 @@ import { LibraryListEntry } from './components/LibraryListEntry';
 
 export class LibrarySearch extends Component {
   searchApi = new InvenioSearchApi({
-    url: libraryApi.searchBaseURL,
-    withCredentials: true,
+    axios: {
+      url: libraryApi.searchBaseURL,
+      withCredentials: true,
+    },
   });
   searchConfig = getSearchConfig('libraries');
 

ui/src/pages/backoffice/Item/ItemSearch/ItemSearch.js

@@ -25,8 +25,10 @@ import {
 
 export class ItemSearch extends Component {
   searchApi = new InvenioSearchApi({
-    url: itemApi.searchBaseURL,
-    withCredentials: true,
+    axios: {
+      url: itemApi.searchBaseURL,
+      withCredentials: true,
+    },
     interceptors: {
       response: { reject: responseRejectInterceptor },
     },

ui/src/pages/backoffice/Loan/LoanSearch/LoanSearch.js

@@ -23,10 +23,11 @@ import {
   SearchAggregationsCards,
 } from '@components/SearchControls';
 
+import { SearchDateRange } from './SearchDateRange';
+
 export class LoanSearch extends Component {
   searchApi = new InvenioSearchApi({
-    url: loanApi.searchBaseURL,
-    withCredentials: true,
+    axios: { url: loanApi.searchBaseURL, withCredentials: true },
     interceptors: {
       response: { reject: responseRejectInterceptor },
     },
@@ -87,6 +88,7 @@ export class LoanSearch extends Component {
                 <Grid.Column width={3} className={'search-aggregations'}>
                   <Header content={'Filter by'} />
                   <SearchAggregationsCards modelName={'loans'} />
+                  <SearchDateRange />
                 </Grid.Column>
                 <Grid.Column width={13}>
                   <SearchEmptyResults extras={this.renderEmptyResultsExtra} />