Fmd 452 add feature switch - remove sort (#515)

* add waffle to settings

* add switch `search-sort-radio-buttons` to search template

* add command to create radio button switch

* add section for feature switches to README

* update poetry with django-waffle

* do not need sort selenium tests

* switches info

Author: LavMatt

Dockerfile

@@ -46,6 +46,9 @@ COPY --from=builder ${VIRTUAL_ENV} ${VIRTUAL_ENV}
 RUN python manage.py collectstatic --noinput
 RUN python manage.py migrate
 
+# create switch with default setting
+RUN ./manage.py waffle_switch search-sort-radio-buttons off --create
+
 # Use a non-root user
 RUN addgroup --gid 31337 --system appuser \
   && adduser --uid 31337 --system appuser --ingroup appuser

README.md

@@ -73,3 +73,15 @@ and run `npm install -g chromedriver chromedriver@latest` to install the latest
 
 If making changes to the scss, to ensure your changes are reflected in local deployments, run:
 `npm run dependencies` to update the css files. If you have `DEBUG=False` you will then need to rerun `poetry run python manage.py collectstatic`.
+
+## Feature Switches
+
+We have enabled feature switches in `find-moj-data`. These have been enabled using a package called [django-waffle](https://github.com/jazzband/django-waffle).
+
+Switches can be managed via the [cli](https://waffle.readthedocs.io/en/stable/usage/cli.html#usage-cli) or via the [django admin page](https://docs.djangoproject.com/en/dev/ref/contrib/admin/).
+
+Our switches are created via the cli; the commands can be seen in the Dockerfile.
+
+Current swicthes and default settings:
+
+- `search-sort-radio-buttons` off - switches on/off radio selection buttons for sort order of search results.

core/settings.py

@@ -42,6 +42,7 @@
     "home.apps.HomeConfig",
     "django_prometheus",
     "users",
+    "waffle",
 ]
 
 MIDDLEWARE = [
@@ -55,6 +56,7 @@
     "django.contrib.messages.middleware.MessageMiddleware",
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
     "core.middleware.CustomErrorMiddleware",
+    "waffle.middleware.WaffleMiddleware",
     # Prometheus needs to be the last middleware in the list.
     # Avoid appending to this list and rather insert into -1.
     "django_prometheus.middleware.PrometheusAfterMiddleware",

poetry.lock

@@ -19,6 +19,7 @@ nltk = "^3.8.1"
 sentry-sdk = { extras = ["django"], version = "^2.5.1" }
 ministryofjustice-data-platform-catalogue = { path = "lib/datahub-client", develop = true }
 django-azure-auth = "^2.0.0"
+django-waffle = "^4.1.0"
 
 [tool.poetry.group.dev.dependencies]
 black = "^24.4.0"

pyproject.toml

@@ -2,6 +2,7 @@
 {% load static %}
 {% load markdown %}
 {% load humanize %}
+{% load waffle_tags %}
 
 {% block content %}
   <div class="govuk-grid-row">
@@ -47,7 +48,9 @@ <h2 class="govuk-heading-l govuk-!-display-inline-block" id="result-count">{{tot
       {% else %}
         {% include "partial/no_results.html" %}
       {% endif %}
-      {% include "partial/sort.html" %}
+      {% switch 'search-sort-radio-buttons' %}
+        {% include "partial/sort.html" %}
+      {% endswitch %}
       {% include "partial/search_result.html" %}
       {% include "partial/pagination.html" %}
     </div>

templates/search.html

@@ -63,6 +63,7 @@ def test_pagination(self):
         self.click_previous_page()
         self.verify_page("1")
 
+    @pytest.mark.skip(reason="search sort is currently switched off")
     def test_sorting(self):
         """
         Interact with the sort control. Note: without javascript, this requires
@@ -78,6 +79,7 @@ def test_sorting(self):
         self.verify_i_have_results()
         self.verify_sort_selected("Ascending")
 
+    @pytest.mark.skip(reason="search sort is currently switched off")
     def test_filters_query_and_sort_persist(self):
         """
         Search settings persist as the user continues to