Add boundary views and serializers #113

mstone121 · 2022-10-07T15:32:22Z

Overview

This PR adds serializers for submissions and a few related objects and views for submissions.

Closes #107

Notes

I added a venv folder to the .gitignore so I could install requirements locally.

TODO: Create activity log

Testing Instructions

scripts/manage resetdb in order to test the validator user, if desired
Log in as c1@azavea.com
Go to http://localhost:8181/api/boundaries/
See list of submissions
- There should be one for each stage in the submission process
Pick one of the submissions, go to the details page (i.e. http://localhost:8181/api/boundaries/1)
- Check that all the relevant details are returned (reviews/annotations/submissions)

Checklist

fixup! commits have been squashed
CHANGELOG.md updated with summary of features or fixes, following Keep a Changelog guidelines
README.md updated if necessary to reflect the changes
CI passes after rebase

rajadain

Left some comments.

My tendency has been to used function-based views in the past rather than class-based ones. ViewSets add standardization and offer good built-in support, but can make custom / non-standard work a little difficult. DRF has a brief write-up on this: https://www.django-rest-framework.org/tutorial/6-viewsets-and-routers/#trade-offs-between-views-vs-viewsets

For now, I think ViewSets are fine. If we need to refactor to function-based views down the line, we can do it then.

.gitignore

src/django/api/serializers/submission.py

src/django/api/views/submission.py

src/django/api/filters/submission.py

jacobtylerwalls

Sorry for the piecemeal review. Other things I noticed while working on the ReferenceImage serializer.

src/django/api/filters/submission.py

jacobtylerwalls

I know this is still WIP, but was hoping this would still be helpful.

src/django/api/models/user.py

src/django/api/models/boundary.py

src/django/api/views/boundary.py

src/django/api/management/commands/resetdb.py

jacobtylerwalls · 2022-10-11T15:15:13Z

src/django/api/views/boundary.py

+                if not request.user.has_access_to_utility(
+                    Utility.objects.get(pk=utility_id)
+                ):
+                    raise APIException('Cannot access this utility', 401)


This could merit updating the ADR, but if we just raise PermissionDenied, DRF will convert this into a 403, which I think is more accurate than 401 given that this is an insufficient permission issue rather than incorrect creds issue.

Sample response from what I was just working on in 97ef19b (and 61615c9, updated to use the DRF import of PermissionDenied to get the accurate detail message):

GET /api/boundaries/1/reference-images/ HTTP 403 Forbidden Allow: GET, POST, HEAD, OPTIONS Content-Type: application/json Vary: Accept { "detail": "Validators cannot view image details." }

I'm okay with that. Looping in @rajadain

src/django/api/views/boundary.py

src/django/api/management/commands/resetdb.py

src/django/api/views/boundary.py

jacobtylerwalls

Looks great. We can also finalize the 403 vs. 401 thing later on.

rajadain · 2022-10-12T15:22:18Z

Taking a look now

rajadain · 2022-10-12T15:24:10Z

This needs the migrations to be updated:

Running migrations:
  No migrations to apply.
  Your models in app(s): 'api' have changes that are not yet reflected in a migration, and so won't be applied.
  Run 'manage.py makemigrations' to make new migrations, and then re-run 'manage.py migrate' to apply them.

rajadain

This looks great!

Minor comments on utility filtering, but overall this looks great. We should defer the Activity Log to a later card.

rajadain · 2022-10-12T15:34:56Z

src/django/api/models/boundary.py

+
+        return BOUNDARY_STATUS.SUBMITTED
+
+    @cached_property


Nice work caching this 👍

rajadain · 2022-10-12T15:36:04Z

src/django/api/models/submission.py

+
+    @property
+    def resolved(self):
+        return self.resolved_at is not None


Nice shortcut

src/django/api/views/boundary.py

rajadain

+1 great job! Nice, clean implementation. Sets up a solid foundation for us to build upon. This looks good to merge!

The endpoint is /boundaries/ as of #113, so the RTK query is updated accordingly.

This allows developers to create a virtual env for this project. One might want to do this so the IDE will know about required packages.

This allows for testing each submission in the same submission list.

The additional boundaries will allow for testing each stage of the submission process.

The endpoint is /boundaries/ as of #113, so the RTK query is updated accordingly.

rajadain reviewed Oct 7, 2022

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

src/django/api/serializers/submission.py Outdated Show resolved Hide resolved

src/django/api/views/submission.py Outdated Show resolved Hide resolved

src/django/api/views/submission.py Outdated Show resolved Hide resolved

jacobtylerwalls reviewed Oct 7, 2022

View reviewed changes

src/django/api/filters/submission.py Outdated Show resolved Hide resolved

jacobtylerwalls reviewed Oct 7, 2022

View reviewed changes

src/django/api/filters/submission.py Outdated Show resolved Hide resolved

src/django/api/filters/submission.py Outdated Show resolved Hide resolved

src/django/api/filters/submission.py Outdated Show resolved Hide resolved

jacobtylerwalls mentioned this pull request Oct 7, 2022

Create ReferenceImage serializers and views #114

Merged

4 tasks

mstone121 force-pushed the ms/add-submission-serializers-views branch 6 times, most recently from 4407843 to 41173e9 Compare October 10, 2022 22:14

mstone121 changed the title ~~Add submission views and serializers~~ Add boundary views and serializers Oct 10, 2022

jacobtylerwalls reviewed Oct 11, 2022

View reviewed changes

mstone121 marked this pull request as ready for review October 11, 2022 15:39

jacobtylerwalls reviewed Oct 11, 2022

View reviewed changes

src/django/api/views/boundary.py Outdated Show resolved Hide resolved

src/django/api/management/commands/resetdb.py Show resolved Hide resolved

src/django/api/views/boundary.py Outdated Show resolved Hide resolved

jacobtylerwalls approved these changes Oct 11, 2022

View reviewed changes

rajadain requested changes Oct 12, 2022

View reviewed changes

rajadain approved these changes Oct 13, 2022

View reviewed changes

rajadain added a commit that referenced this pull request Oct 13, 2022

Replace submissions with boundaries RTK query

f03f2dc

The endpoint is /boundaries/ as of #113, so the RTK query is updated accordingly.

rajadain mentioned this pull request Oct 13, 2022

Wire up Boundary List Page #122

Merged

6 tasks

Matt Stone added 2 commits October 13, 2022 09:01

Add venv folder to .gitignore

96cb0a0

This allows developers to create a virtual env for this project. One might want to do this so the IDE will know about required packages.

Split test submissions into multiple boundaries

c2af9b4

This allows for testing each submission in the same submission list.

mstone121 force-pushed the ms/add-submission-serializers-views branch from 8ce625e to 5ccc0be Compare October 13, 2022 14:07

Matt Stone added 4 commits October 13, 2022 09:14

Add boundary list view and serializer

eee032b

Add more boundaries to test data

02af746

The additional boundaries will allow for testing each stage of the submission process.

Add views and serializer for boundary detail

6d15649

Update CHANGELOG.md

94b93c5

mstone121 force-pushed the ms/add-submission-serializers-views branch from 5ccc0be to 94b93c5 Compare October 13, 2022 14:20

mstone121 merged commit 929ebb0 into develop Oct 13, 2022

mstone121 deleted the ms/add-submission-serializers-views branch October 13, 2022 14:32

rajadain added a commit that referenced this pull request Oct 13, 2022

Replace submissions with boundaries RTK query

cef9b40

The endpoint is /boundaries/ as of #113, so the RTK query is updated accordingly.

mstone121 mentioned this pull request Oct 13, 2022

Use one-to-one relationships on some models #135

Merged

4 tasks

mstone121 pushed a commit that referenced this pull request Oct 13, 2022

Replace submissions with boundaries RTK query

b634743

The endpoint is /boundaries/ as of #113, so the RTK query is updated accordingly.

rajadain added a commit that referenced this pull request Oct 13, 2022

Replace submissions with boundaries RTK query

3b8c05c

The endpoint is /boundaries/ as of #113, so the RTK query is updated accordingly.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add boundary views and serializers #113

Add boundary views and serializers #113

mstone121 commented Oct 7, 2022 •

edited

Loading

rajadain left a comment

jacobtylerwalls left a comment

jacobtylerwalls left a comment •

edited

Loading

jacobtylerwalls Oct 11, 2022 •

edited

Loading

mstone121 Oct 11, 2022

jacobtylerwalls left a comment

rajadain commented Oct 12, 2022

rajadain commented Oct 12, 2022

rajadain left a comment

rajadain Oct 12, 2022

rajadain Oct 12, 2022

rajadain left a comment

Add boundary views and serializers #113

Add boundary views and serializers #113

Conversation

mstone121 commented Oct 7, 2022 • edited Loading

Overview

Notes

Testing Instructions

Checklist

rajadain left a comment

Choose a reason for hiding this comment

jacobtylerwalls left a comment

Choose a reason for hiding this comment

jacobtylerwalls left a comment • edited Loading

Choose a reason for hiding this comment

jacobtylerwalls Oct 11, 2022 • edited Loading

Choose a reason for hiding this comment

mstone121 Oct 11, 2022

Choose a reason for hiding this comment

jacobtylerwalls left a comment

Choose a reason for hiding this comment

rajadain commented Oct 12, 2022

rajadain commented Oct 12, 2022

rajadain left a comment

Choose a reason for hiding this comment

rajadain Oct 12, 2022

Choose a reason for hiding this comment

rajadain Oct 12, 2022

Choose a reason for hiding this comment

rajadain left a comment

Choose a reason for hiding this comment

mstone121 commented Oct 7, 2022 •

edited

Loading

jacobtylerwalls left a comment •

edited

Loading

jacobtylerwalls Oct 11, 2022 •

edited

Loading