Ensure type-safe serialization/deserialization of total time #405
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
Under unknown circumstances, the extra `total_time` argument passed to instances of jobs is serialized/deserialized as a string instead of a float. That causes a `TypeError` due to an impossible type conversion. Now the `total_time` argument is coerced to a float number prior its serialization and deserialization, respectively.
|
I have signed the CLA! |
Mangara
reviewed
Jul 21, 2023
| "total_time" => total_time, | ||
| "total_time" => total_time.to_f, |
There was a problem hiding this comment.
This one should not be necessary if we're always casting it on deserialization, right?
There was a problem hiding this comment.
Yeah, not necessary. Simply added for completeness.
| ) | ||
| end | ||
|
|
||
| def deserialize(job_data) # @private | ||
| super | ||
| self.cursor_position = job_data["cursor_position"] | ||
| self.times_interrupted = job_data["times_interrupted"] || 0 | ||
| self.total_time = job_data["total_time"] || 0 | ||
| self.total_time = job_data["total_time"].to_f || 0.0 |
There was a problem hiding this comment.
Should we use Float(...) here, instead of .to_f? It has better error messages when it's fed things that are not floats. We do need to be careful with nil in that case:
Suggested change
| self.total_time = job_data["total_time"].to_f || 0.0 | |
| self.total_time = Float(job_data["total_time"] || 0.0) |
|
Apologies, you'll need to rebase to get CI to run properly, as there were some lint error that I fixed recently. |
|
Closed in favour of #417 |
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.
Under unknown circumstances, the extra
total_timeargument passed to instances of jobs is serialized/deserialized as a string instead of a float. That causes aTypeErrordue to an impossible type conversion.Now the
total_timeargument is coerced to a float number prior its serialization and deserialization, respectively.Fixes #396.