FSPT-208 Serialise application date submitted in a guaranteed format #126
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
samuelhwilliams
previously approved these changes
Jan 8, 2025
sfount
force-pushed
the
FSPT-208-patch-date-submitted
branch
from
aca5ea0 to
5cd4518
Compare
|
I'm a bit hesitant to test that marshmallow knows how to serialise JSON but you're right that this addresses a change that caused down stream issues - I've added an assertion on the existing submit tests to avoid that changing without us catching it cf5c9d7 |
sfount
force-pushed
the
FSPT-208-patch-date-submitted
branch
from
5cd4518 to
cf5c9d7
Compare
sfount
force-pushed
the
FSPT-208-patch-date-submitted
branch
from
cf5c9d7 to
5442be2
Compare
samuelhwilliams
approved these changes
Jan 8, 2025
`date_submitted` is stored both in the application table and in the JSON representation of an application used by the assess tool. Marshmallow will serialise the properties from the application model depending on if there is timezone information included or not. Previously the application store was first "submitting" an application (updating the status and setting the `date_submitted` property) in one database transaction and then separately fetching the application and putting in on a queue to be processed by assess. When we changed this behaviour to update the application and write to the assessment table in one transaction we don't fetch a new application from the database. When the `date_submitted` property is set directly in the code we have been including `timezone.utc` on the `datetime` property. When the application is fetched from the database it does not include (or store) the timezone information - I'm assuming everything by default is in UTC. This means that we changed to serialising the JSON with timezone information (`+00.00`) which caused issues when the assessment code tried to serialise it. This is one method of dealing with that and explicitly instructs marshmallow to serialise the JSON (then stored in the `jsonb_blob` property of assessments) using the format that has been used so far.
There are a lot of steps between configuring that date format we would expect to see and JSON being set in a separate (assess) table. Add a regression test against this changing formats.
sfount
force-pushed
the
FSPT-208-patch-date-submitted
branch
from
5442be2 to
7f908b1
Compare
|
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.
date_submittedis stored both in the application table and in the JSON representation of an application used by the assess tool.Marshmallow will serialise the properties from the application model depending on if there is timezone information included or not. Previously the application store was first "submitting" an application (updating the status and setting the
date_submittedproperty) in one database transaction and then separately fetching the application and putting in on a queue to be processed by assess.When we changed this behaviour to update the application and write to the assessment table in one transaction we don't fetch a new application from the database.
When the
date_submittedproperty is set directly in the code we have been includingtimezone.utcon thedatetimeproperty. When the application is fetched from the database it does not include (or store) the timezone information - I'm assuming everything by default is in UTC.This means that we changed to serialising the JSON with timezone information (
+00.00) which caused issues when the assessment code tried to serialise it.This is one method of dealing with that and explicitly instructs marshmallow to serialise the JSON (then stored in the
jsonb_blobproperty of assessments) using the format that has been used so far.