Skip to content
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
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions aleph_message/models/__init__.py
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
Expand All @@ -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"""
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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]):
Copy link
Contributor

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 an isinstance check.

Copy link
Contributor

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.

"""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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not Message.parse_obj(message_raw)? iirc that would avoid the KeyError.

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
Loading