types: add missing enumerations values for TaskStatus #1980
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
In a bug report, Subiquity failed during a refresh because it received
an unexpected status.
File "subiquity/common/api/server.py", line 164, in handler
result = await implementation(**args)
File "subiquity/server/controllers/refresh.py", line 240, in progress_GET
return await self.get_progress(change_id)
File "subiquity/server/controllers/refresh.py", line 224, in get_progress
change = await self.app.snapdapi.v2.changes[change_id].GET()
[...]
File "subiquity/common/serialize.py", line 252, in _deserialize_attr
args[field.name] = self._deserialize(
File "subiquity/common/serialize.py", line 277, in _deserialize
return self._deserialize_enum(annotation, context)
File "subiquity/common/serialize.py", line 261, in _deserialize_enum
return annotation(context.cur)
File "/usr/lib/python3.10/enum.py", line 385, in __call__
return cls.__new__(cls, value)
File "usr/lib/python3.10/enum.py", line 710, in __new__
raise ve_exc
ValueError: 'Undone' is not a valid TaskStatus
According to snapd's upstream repository, "Undone" existed before
"Undoing", so I'm not sure why we didn't have the former but had the
latter. Maybe we just overlooked it because the name is similar.
As for more recently, the "Wait" status was also introduced.
Fixed by adding the two missing values (i.e., "Wait" and "Undone").
Signed-off-by: Olivier Gayot <[email protected]>
Chris-Peterson444
approved these changes
Apr 25, 2024
|
This is one of the pain points of using the style of serialization for enums subiquity uses for an API we do not 100% control. Maybe there should be a way to say that a field can be an enum but if the value seen does not match one of the values of the enum type, just include it as a string or something? |
mwhudson
approved these changes
Apr 26, 2024
|
That said again... what should subiquity do in the case that it sees an Undone change? That's probably a terminal status, right? |
Good question, I have to check what the Undoing / Undone logic means in the snap refresh context.. |
dbungert
approved these changes
May 1, 2024
| @@ -819,9 +819,11 @@ class TaskStatus(enum.Enum): | |||
| DO = "Do" | |||
| DOING = "Doing" | |||
| DONE = "Done" | |||
| WAIT = "Wait" | |||
There was a problem hiding this comment.
Might as well also add Default.
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.
In a bug report, Subiquity failed during a refresh because it received an unexpected status.
According to snapd's upstream repository, "Undone" existed before "Undoing", so I'm not sure why we didn't have the former but had the latter. Maybe we just overlooked it because the name is similar.
As for more recently, the "Wait" status was also introduced [1]
Fixed by adding the two missing values (i.e., "Wait" and "Undone").
[1] canonical/snapd@7734ffd
This relates to LP:#2076233