Add event serialization testing #9573
Open
+297
−32
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #9573 +/- ##
==========================================
+ Coverage 91.71% 91.74% +0.02%
==========================================
Files 429 426 -3
Lines 26672 26589 -83
==========================================
- Hits 24463 24393 -70
+ Misses 2209 2196 -13
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
CodSpeed Performance ReportMerging #9573 will degrade performances by 10.59%Comparing Summary
Benchmarks breakdown
|
DanSava
force-pushed
the
test-event-serialization
branch
from
261b703 to
bdac9c6
Compare
oyvindeide
reviewed
Dec 18, 2024
DanSava
force-pushed
the
test-event-serialization
branch
4 times, most recently
from
9281d76 to
7089a3b
Compare
DanSava
force-pushed
the
test-event-serialization
branch
from
7089a3b to
9c6ec15
Compare
DanSava
added
the
release-notes:improvement
oyvindeide
reviewed
Jan 15, 2025
Comment on lines
+404
to
+410
| start_time = source.get("start_time") | ||
| if start_time and isinstance(start_time, str): | ||
| start_time = datetime.fromisoformat(start_time) | ||
| end_time = source.get("end_time") | ||
| if end_time and isinstance(end_time, str): | ||
| end_time = datetime.fromisoformat(end_time) | ||
|
|
There was a problem hiding this comment.
Where does this not happen? Seems like we mostly do:
def convert_iso8601_to_datetime(
timestamp: datetime | str,
) -> datetime:
if isinstance(timestamp, datetime):
return timestamp
return datetime.fromisoformat(timestamp)
Comment on lines
+420
to
+424
| for step in realization["fm_steps"].values(): | ||
| if "start_time" in step and isinstance(step["start_time"], str): | ||
| step["start_time"] = datetime.fromisoformat(step["start_time"]) | ||
| if "end_time" in step and isinstance(step["end_time"], str): | ||
| step["end_time"] = datetime.fromisoformat(step["end_time"]) |
There was a problem hiding this comment.
Same comment here, should perhaps do it on the sender side?
Comment on lines
+110
to
+131
| match event_type: | ||
| case FullSnapshotEvent.__name__: | ||
| snapshot = EnsembleSnapshot.from_nested_dict(json_dict["snapshot"]) | ||
| json_dict["snapshot"] = snapshot | ||
| return FullSnapshotEvent(**json_dict) | ||
| case SnapshotUpdateEvent.__name__: | ||
| snapshot = EnsembleSnapshot.from_nested_dict(json_dict["snapshot"]) | ||
| json_dict["snapshot"] = snapshot | ||
| return SnapshotUpdateEvent(**json_dict) | ||
| case RunModelDataEvent.__name__ | RunModelUpdateEndEvent.__name__: | ||
| if "run_id" in json_dict and isinstance(json_dict["run_id"], str): | ||
| json_dict["run_id"] = UUID(json_dict["run_id"]) | ||
| if json_dict.get("data"): | ||
| json_dict["data"] = DataSection(**json_dict["data"]) | ||
| return EVENT_MAPPING[event_type](**json_dict) | ||
| case _: | ||
| if event_type in EVENT_MAPPING: | ||
| if "run_id" in json_dict and isinstance(json_dict["run_id"], str): | ||
| json_dict["run_id"] = UUID(json_dict["run_id"]) | ||
| return EVENT_MAPPING[event_type](**json_dict) | ||
| else: | ||
| raise TypeError(f"Unknown status event type {event_type}") |
There was a problem hiding this comment.
Think this could also be done by pydantic directly?
for example:
class EventWrapper(BaseModel):
model_config = ConfigDict(arbitrary_types_allowed=True)
event: Annotated[StatusEvents, Field(discriminator='event_type')]| event_dict.update( | ||
| { | ||
| "snapshot": event.snapshot.to_dict(), | ||
| "event_type": event.__class__.__name__, |
There was a problem hiding this comment.
Might be better to add this directly to the events?
event_type: Literal['FullSnapshotEvent'] = 'FullSnapshotEvent'the pro is it is more explicit, but on the flip side it is more verbose and has to be kept in sync for all events 🤔
| raise TypeError(f"Unknown status event type {event_type}") | ||
|
|
||
|
|
||
| def status_event_to_json(event: StatusEvents) -> str: |
There was a problem hiding this comment.
In my PR I did:
await websocket.send_json(event)so did not need a custom function, is that needed? It just takes StatusEvents:
StatusEvents = Union[
FullSnapshotEvent,
SnapshotUpdateEvent,
EndEvent,
AnalysisStatusEvent,
AnalysisTimeEvent,
AnalysisReportEvent,
RunModelErrorEvent,
RunModelStatusEvent,
RunModelTimeEvent,
RunModelUpdateBeginEvent,
RunModelDataEvent,
RunModelUpdateEndEvent,
]
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.
Issue
Resolves #9517
Approach
Add serialization roundtrip for all events generated by EverestRunModel
git rebase -i main --exec 'pytest tests/ert/unit_tests -n logical -m "not integration_test"')When applicable