feat: restrict information_system from facets for unauthenticated #416
Conversation
|
TIEDONOHJAUS-API branch is deployed to platta: https://tiedonohjaus-pr416.api.dev.hel.ninja 🚀🚀🚀 |
| @@ -28,13 +28,23 @@ class FacetedAttributeBackend(BaseFilterBackend, FilterBackendMixin): | |||
| faceted_search_param = "facet_attribute" | |||
|
|
|||
| @staticmethod | |||
| def get_attributes(documents: List[Type[Document]] = None) -> list: | |||
| def get_attributes( | |||
| documents: List[Type[Document]] = None, authenticated=True | |||
There was a problem hiding this comment.
List and Type have been deprecated since 3.9:
https://docs.python.org/3.9/library/typing.html#typing.Type
https://docs.python.org/3.9/library/typing.html#typing.List
| documents: List[Type[Document]] = None, authenticated=True | |
| documents: list[type[Document]] = None, authenticated=True |
There are also information system information in search facets which are to be restricted from the unauthenticated users. Removes InformationSystem attributes from facets data for unauthenticated users. Refs TIED-171
nicobav
force-pushed
the
TIED-171/infsysinfacets
branch
from
d1335d6 to
03bf689
Compare
|
|
| @@ -28,13 +26,23 @@ class FacetedAttributeBackend(BaseFilterBackend, FilterBackendMixin): | |||
| faceted_search_param = "facet_attribute" | |||
|
|
|||
| @staticmethod | |||
| def get_attributes(documents: List[Type[Document]] = None) -> list: | |||
| def get_attributes( | |||
| documents: list[type[Document]] = None, authenticated=True | |||
There was a problem hiding this comment.
authenticated=True
- defaulting optional flag related to authentication to true is a bit meh
- "authenticated" does not tell the caller what it does, compared for example to something like "include_information_system"
There was a problem hiding this comment.
While you're at it, this is a boolean trap. Use def get_attributes(documents: ..., *, authenticated=True) instead (or whatever name/value you settle on)
There was a problem hiding this comment.
Valid argument. I'd go with include_information_system
| self.attributes = FacetedAttributeBackend.get_attributes( | ||
| authenticated=False | ||
| ) |
There was a problem hiding this comment.
If it doesn't cause any issues, would be nice to have if/else branch here for both authenticated and unauthenticated. I got a bit paranoid about this somehow ending up overwriting the class attribute BaseSearchDocumentViewSet.attributes, but yeah that shouldn't happen of course because the instance copies the class attributes as instance attributes.
|
TIEDONOHJAUS-API branch is deployed to platta: https://tiedonohjaus-pr416.api.dev.hel.ninja 🚀🚀🚀 |
There are also information system information in search facets which are to be restricted from the unauthenticated users.
Removes InformationSystem attributes from facets data for unauthenticated users.
Refs TIED-171