Make some views use URL query parameters instead of distinct paths #650
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## dev #650 +/- ##
=======================================
Coverage 87.72% 87.72%
=======================================
Files 148 148
Lines 5937 5937
=======================================
Hits 5208 5208
Misses 729 729 |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| {{ ticket.timeplace.start_time.date }} | ||
| </a> | ||
| {% else %} | ||
| <a href="{% url 'admin_event_ticket_list' ticket.event.pk %}" target="_blank"> |
Check warning
Code scanning / CodeQL
Potentially unsafe external link
| {% for ticket in user.tickets %} | ||
| <li class="{% if not ticket.active %}canceled{% endif %}"> | ||
| {% if ticket.timeplace %} | ||
| <a href="{% url 'admin_time_place_ticket_list' ticket.timeplace.event.pk ticket.timeplace.pk %}" |
Check warning
Code scanning / CodeQL
Potentially unsafe external link
ddabble
added a commit
that referenced
this pull request
May 5, 2023
Also replaced the required `make_queue.add_printer3dcourse` permission with `users.view_user`, which all active members currently have.
ddabble
added a commit
that referenced
this pull request
May 6, 2023
ddabble
force-pushed
the
cleanup/url-query-parameters-instead-of-distinct-paths
branch
from
9608bda to
a9a1b1f
Compare
ddabble
added a commit
that referenced
this pull request
May 7, 2023
ddabble
force-pushed
the
cleanup/url-query-parameters-instead-of-distinct-paths
branch
from
a9a1b1f to
1b80ab4
Compare
This can make it easier for views to use forms for validating and cleaning URL query parameters.
...instead of a distinct path, for listing the quotas of a specific user. This should make it easier to potentially extend the code in the future.
Also removed its inheritance of `CustomFieldsetFormMixin`, as that mixin class isn't suited for `GET` forms, and because `AdminEventParticipantsSearchView` previously needed heavy customization of `CustomFieldsetFormMixin`'s default fields anyway. Also, there wasn't much code needed to be added to `admin_event_participants_search.html`.
They both performed the same basic task (listing reservations using the same template), so this reduces code duplication and makes it easier to potentially extend the code in the future.
...instead of having the year and week as part of the path. This should make it easier to potentially extend the code in the future.
Also added the search query to the page title in the template.
...instead of having the excluded reservation PK as part of the path. This should make it easier to potentially extend the code in the future.
The tests now use the more standard approach of comparing the context data of responses from test clients, instead of using mock requests. Also made the previously named `test_inherited_permissions()` properly test which inherited permissions are listed, as the tests previously didn't add any permissions to any of the groups (i.e. `dev.inherited_permissions` was empty). Also removed some comments from `test_models.py` that were accidentally added in 144e4ef from another, unfinished commit.
ddabble
force-pushed
the
cleanup/url-query-parameters-instead-of-distinct-paths
branch
from
1b80ab4 to
f70538e
Compare
|
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. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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>(4fcb275)POSTform data withsearch_stringfield to/admin/news/events/participants/search/→GETto/admin/news/events/participants/search/?search_string=<search_string>(cf2063d)/reservation/me/→/reservation/reservations/?owner=me(c729089)/reservation/admin/→/reservation/reservations/?owner=MAKE(c729089)/reservation/<int:year>/<int:week>/<int:pk>/→/reservation/machines/<int:pk>/?calendar_year=<int:year>&calendar_week=<int:week>(0ca0e06)/reservation/json/<int:pk>/<int:reservation_pk>/→/reservation/json/<int:pk>/?exclude_reservation=<int:reservation_pk>(ccded76)Also refactored the following views to use the newly added
QueryParameterFormMixin(bca8946):DocumentationPageSearchView[/search/?query=<query>&page=<page>] (727aadc)APIReservationListView[/reservation/calendar/<int:pk>/reservations/?start_date=<start_date>&end_date=<end_date>] (23d2acd)startDatequery param tostart_date, andendDatetoend_dateAlso made all
JsonResponses use UTF8 as encoding instead of ASCII (28f86df).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)