Make some views use URL query parameters instead of distinct paths

ddabble commented 1 year ago

Proposed changes

Changed multiple pages' URLs to use query parameters, instead of having multiple distinct paths for practically the same page.

Here's an exhaustive list of all affected URLs:

/reservation/quota/<int:pk>/ → /reservation/quota/?user=<int:pk> (4fcb275a8bdb46ccddc28ba23f19cfb4fd3cdf3d)
POST form data with search_string field to /admin/news/events/participants/search/ → GET to /admin/news/events/participants/search/?search_string=<search_string> (cf2063d3a51e72244696a8ef098af8d1dd1f14e7)
- Resolves #631
/reservation/me/ → /reservation/reservations/?owner=me (c7290892c1b4211588fd05e844584e522e44d677)
/reservation/admin/ → /reservation/reservations/?owner=MAKE (c7290892c1b4211588fd05e844584e522e44d677)
/reservation/<int:year>/<int:week>/<int:pk>/ → /reservation/machines/<int:pk>/?calendar_year=<int:year>&calendar_week=<int:week> (0ca0e06cc81d654726645be96de9352295ddbfce)
/reservation/json/<int:pk>/<int:reservation_pk>/ → /reservation/json/<int:pk>/?exclude_reservation=<int:reservation_pk> (ccded76ef08e57e5107f9edf3b57b73d75f613ba)

Also refactored the following views to use the newly added QueryParameterFormMixin (bca894670afa2381e942162854911da0ec31cd16):

DocumentationPageSearchView [/search/?query=<query>&page=<page>] (727aadc08acea5549806f62abbab1d0b18da7e1b)
APIReservationListView [/reservation/calendar/<int:pk>/reservations/?start_date=<start_date>&end_date=<end_date>] (23d2acdd08ebfb67d09ab8ce5148484e1cf4486b)
- Also renamed the startDate query param to start_date, and endDate to end_date

Also made all JsonResponses use UTF8 as encoding instead of ASCII (28f86df49c9df3e5c40ff75431090a749c1edac8).

Areas to review closely

That all the changed views still work as intended, and that changing the encoding of JsonResponses to UTF8 doesn't cause any unforeseen bugs.

Checklist

(If any of the points are not relevant, mark them as checked)

[x] Created tests that fail without the changes, if relevant/possible
[x] Made sure that your code conforms to the code style guides and that any common code smells have been addressed
- (It's not intended that you read through this whole document, but that you get yourself an overview over its contents, and that you keep it in mind while taking a second look at your code before opening a pull request)
[x] Added sufficient documentation - e.g. as docstrings or in the README, if suitable
[x] Added your changes to the "Unreleased" section of the changelog - mainly the changes that are of particular interest to users and/or developers, if any
[x] Added a "Deployment notes" section above, if anything out of the ordinary should be done when deploying these changes to the server

codecov[bot] commented 1 year ago

Codecov Report

Merging #650 (82631fa) into dev (82631fa) will not change coverage. The diff coverage is n/a.

:exclamation: Current head 82631fa differs from pull request most recent head f70538e. Consider uploading reports for the commit f70538e to get more accurate results

@@           Coverage Diff           @@
##              dev     #650   +/-   ##
=======================================
  Coverage   87.72%   87.72%           
=======================================
  Files         148      148           
  Lines        5937     5937           
=======================================
  Hits         5208     5208           
  Misses        729      729

ddabble commented 1 year ago

Merging without explicit approval from another member, as the Dev committee previously agreed to merge these changes and assume they're relatively bug-free, simply to get things done quicker.

MAKENTNU / web