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

Check explicitly for invalid model type in C++ #515

Merged
merged 1 commit into from
Jul 22, 2024
Merged
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
92 changes: 87 additions & 5 deletions aas_core_codegen/cpp/jsonization/_generate.py
Original file line number Diff line number Diff line change
Expand Up @@ -1438,16 +1438,19 @@ def _generate_concretely_deserialize_implementation(
)
)
else:
required_properties = [
prop
names_of_required_properties = [
prop.name
for prop in cls.properties
if not isinstance(prop.type_annotation, intermediate.OptionalTypeAnnotation)
]

if len(required_properties) > 0:
if cls.serialization.with_model_type:
names_of_required_properties.append(Identifier("model_type"))

if len(names_of_required_properties) > 0:
blocks.append(Stripped("// region Check required properties"))
for prop in required_properties:
json_prop_name = naming.json_property(prop.name)
for prop_name in names_of_required_properties:
json_prop_name = naming.json_property(prop_name)
json_prop_name_literal = cpp_common.string_literal(json_prop_name)
blocks.append(
Stripped(
Expand All @@ -1465,6 +1468,7 @@ def _generate_concretely_deserialize_implementation(
}}"""
)
)

blocks.append(Stripped("// endregion Check required properties"))

# region Initialization
Expand Down Expand Up @@ -1515,6 +1519,84 @@ def _generate_concretely_deserialize_implementation(
blocks.append(Stripped(f"// endregion De-serialize {json_prop_name}"))
# endregion

if cls.serialization.with_model_type:
# NOTE (mristin):
# If the serialization requires a model type, we consequently check for it
# here. The model type thus obtained is *not* used for any dispatch. We only
# use this value for verification to make sure that the model type
# of the instances is consistent with the expected value for its concrete
# class. This will be performed even though the code might have had to parse
# model type before for the dispatch. We decided to double-check to cover
# the case where a dispatch is *unnecessary* (*e.g.*, the caller knows the
# expected runtime type), but the model type might still be invalid in the
# input. Hence, when the dispatch is *necessary*, the model type JSON
# property will be parsed twice, which is a cost we currently find
# acceptable.

blocks.append(
Stripped(
"""\
// region Check model type
// This check is intended only for verification, not for dispatch."""
)
)

model_type = naming.json_model_type(cls.name)

blocks.append(
Stripped(
f"""\
common::optional<
{I}std::wstring
> model_type;

std::tie(
{I}model_type,
{I}error
) = DeserializeWstring(
{I}json["modelType"]
);

if (error.has_value()) {{
{I}error->path.segments.emplace_front(
{II}common::make_unique<PropertySegment>(
{III}L"modelType"
{II})
{I});

{I}return std::make_pair<
{II}common::optional<std::shared_ptr<{ok_type}> >,
{II}common::optional<DeserializationError>
{I}>(
{II}common::nullopt,
{II}std::move(error)
{I});
}}

if (*model_type != L"{model_type}") {{
{I}std::wstring message = common::Concat(
{II}L"Expected model type '{model_type}', "
{II}L"but got: ",
{II}*model_type
{I});

{I}error = common::make_optional<DeserializationError>(
{II}message
{I});

{I}return std::make_pair<
{II}common::optional<std::shared_ptr<{ok_type}> >,
{II}common::optional<DeserializationError>
{I}>(
{II}common::nullopt,
{II}std::move(error)
{I});
}}"""
)
)

blocks.append(Stripped("// endregion Check model type"))

# region Pass arguments to the constructor
property_names = [prop.name for prop in cls.properties]
constructor_argument_names = [arg.name for arg in cls.constructor.arguments]
Expand Down
Loading
Loading