#234: Fix bug with include filters on ICAT backend

ral-facilities · May 21, 2021 · 58056db · 58056db
1 parent 205f155
commit 58056db
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/.flake8 b/.flake8
@@ -11,4 +11,5 @@ per-file-ignores =
   util/icat_db_generator.py: S311
   datagateway_api/wsgi.py:E402,F401
   datagateway_api/common/database/models.py: N815,A003
+  datagateway_api/common/icat/filters.py: C901
 enable-extensions=G
diff --git a/datagateway_api/common/icat/filters.py b/datagateway_api/common/icat/filters.py
@@ -241,8 +241,29 @@ def _extract_filter_fields(self, field):
                     self._extract_filter_fields(".".join((key, value)))
                 elif isinstance(value, list):
                     for element in value:
-                        # Will end up as: key.element1, key.element2, key.element3 etc.
-                        self._extract_filter_fields(".".join((key, element)))
+                        if isinstance(element, str):
+                            # Will end up as: key.element1, key.element2 etc.
+                            self._extract_filter_fields(".".join((key, element)))
+                        elif isinstance(element, list):
+                            for sub_element in element:
+                                self._extract_filter_fields(".".join(key, sub_element))
+                        elif isinstance(element, dict):
+                            for (
+                                inner_element_key,
+                                inner_element_value,
+                            ) in element.items():
+                                if not isinstance(inner_element_key, str):
+                                    raise FilterError(
+                                        "Include Filter: Dictionary key should only be"
+                                        " a string, not any other type",
+                                    )
+                                self._extract_filter_fields(
+                                    {
+                                        ".".join(
+                                            (key, inner_element_key),
+                                        ): inner_element_value,
+                                    },
+                                )
                 elif isinstance(value, dict):
                     for inner_key, inner_value in value.items():
                         if not isinstance(inner_key, str):