-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix: Any invalid message in a response crashed the entire response #27
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
import json | ||
import logging | ||
from copy import copy | ||
from enum import Enum | ||
from hashlib import sha256 | ||
|
@@ -11,12 +12,14 @@ | |
except ImportError: | ||
from typing_extensions import Literal | ||
|
||
from pydantic import BaseModel, Extra, Field, validator | ||
from pydantic import BaseModel, Extra, Field, validator, ValidationError | ||
|
||
from .abstract import BaseContent | ||
from .program import ProgramContent | ||
from ..exceptions import UnknownHashError | ||
|
||
logger = logging.getLogger(__name__) | ||
|
||
|
||
class Chain(str, Enum): | ||
"""Supported chains""" | ||
|
@@ -355,8 +358,10 @@ def check_content(cls, v, values): | |
# Print differences | ||
vdict = v.dict(exclude_none=True) | ||
for key, value in item_content.items(): | ||
if vdict[key] != value: | ||
print(f"{key}: {vdict[key]} != {value}") | ||
if vdict.get(key) != value: | ||
logger.warning( | ||
f"Value differs in field '{key}': '{vdict[key]}' != '{value}'" | ||
) | ||
raise ValueError("Content and item_content differ") | ||
return v | ||
|
||
|
@@ -440,5 +445,22 @@ class MessagesResponse(BaseModel): | |
pagination_per_page: int | ||
pagination_item: str | ||
|
||
@validator("messages", pre=True) | ||
def handle_invalid_messages(cls, v: List[Dict]): | ||
"""The code serving the API may return messages that are not valid | ||
according the latest version of the schemas. Ignore them with a warning | ||
instead of failing the parsing of the entire response. | ||
""" | ||
result = [] | ||
for message_raw in v: | ||
try: | ||
message = Message(**message_raw) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why not |
||
result.append(message) | ||
except KeyError as e: | ||
logger.warning(f"KeyError: Field '{e.args[0]}' not found") | ||
except ValidationError as e: | ||
logger.warning(e, exc_info=False) | ||
return result | ||
|
||
class Config: | ||
extra = Extra.forbid |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You shouldn't assume that v is a list of dicts coming into this function. It should be
Any
with anisinstance
check.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, not 100% sure on this: are we sure that the validator is not run a second time on the return value of this validator? I wouldn't be surprised it it's the case.