Report cloud upload errors in a more structured way #582
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
encord/orm/dataset.py
Outdated
| @@ -1008,6 +1026,9 @@ class DatasetDataLongPolling(BaseDTO): | |||
| errors: List[str] | |||
| """Stringified list of exceptions.""" | |||
|
|
|||
| data_units_errors: Optional[List[DataUnitError]] = None | |||
There was a problem hiding this comment.
This is optional mostly "just in case"; the "case" being "we released the SDK but had to roll back the BE so the field is not returned anymore".
We can probably make this type a notch nicer if we wait with merging this until after the BE is firmly out there.
There was a problem hiding this comment.
yeah, i'd vote for this option!
sergei-encord
approved these changes
Apr 23, 2024
|
Not sure why or how has this ended up "closed"; we just need to wait until after 2024-04-24 release before we merge and release this... |
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.
Introduction and Explanation
Right now, we have
.errorsin the upload result object, but it's all just strings. Return a bit more data so that at least the failed URLs are machine readable.JIRA
Fixes https://linear.app/encord/issue/EC-3107/report-upload-errors-to-the-sdk-in-a-reasonably-machine-readable
Documentation
Some dosctrings are there
Tests
Coming together with the BE implementation here: https://github.com/encord-team/cord-backend/pull/3206
Known issues
We'll need to do the same on the
Storageside; will have a follow-up probably next week.