[22202] JSON to DynamicData deserializer by juanlofer-eprosima · Pull Request #5553 · eProsima/Fast-DDS

juanlofer-eprosima · 2025-01-09T13:34:26Z

Description

This PR is a follow-up of #4780, in which a DynamicData to JSON serializer was introduced. Here a new utility method is introduced to perform the inverse transformation, i.e. from JSON to DynamicData. In addition, json_serialize method has been modified to:

Handle enums with base type other that int32
Improve wide characters and strings handling
Increase overall robustness
Decrease 'complexity' through higher encapsulation

Contributor Checklist

Commit messages follow the project guidelines.
The code follows the style guidelines of this project.
Tests that thoroughly check the new feature have been added/Regression tests checking the bug and its fix have been added; the added tests pass locally
Any new/modified methods have been properly documented using Doxygen.
N/A Any new configuration API has an equivalent XML API (with the corresponding XSD extension)
N/A Changes are backport compatible: they do NOT break ABI nor change library core behavior.
Changes are API compatible.
New feature has been added to the versions.md file (if applicable).
New feature has been documented/Current behavior is correctly described in the documentation.
- Related documentation PR: [22202] JSON to DynamicData deserializer Fast-DDS-docs#1093
N/A Applicable backports have been included in the description.

Reviewer Checklist

The PR has a milestone assigned.
The title and description correctly express the PR's purpose.
Check contributor checklist is correct.
If this is a critical bug fix, backports to the critical-only supported branches have been requested.
Check CI results: changes do not issue any warning.
Check CI results: failing tests are unrelated with the changes.

Copilot

Pull Request Overview

This PR introduces a JSON-to-DynamicData deserializer (json_deserialize), integrates it into the public utils API, and adds round-trip tests to verify JSON serialization and deserialization.

Add json_deserialize entry point in utils.hpp/utils.cpp and implement logic in json_dynamic_data.hpp/.cpp.
Update CMakeLists and versions.md to include the new deserializer.
Extend unit and feature tests to cover JSON → DynamicData deserialization and round-trip equality.

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/cpp/fastdds/xtypes/utils.hpp / utils.cpp	Expose and implement `json_deserialize` wrapper
src/cpp/fastdds/xtypes/serializers/json/json_dynamic_data.hpp / `.cpp`	Core JSON → DynamicData logic
src/cpp/fastdds/xtypes/serializers/json/dynamic_data_json.hpp / `.cpp`	Adjust array/element parameter naming and include fixes
test/unittest/dds/xtypes/serializers/json/DynDataJSONTests.cpp	Add deserialization and round-trip assertions
test/feature/dynamic_types/DynamicTypesTests.cpp	Include JSON deserialization in feature tests
src/cpp/CMakeLists.txt / versions.md	Register new source file and document new feature

Comments suppressed due to low confidence (2)

test/unittest/dds/xtypes/serializers/json/DynDataJSONTests.cpp:83

Consider adding negative tests for json_deserialize, such as invalid JSON input and type-mismatch cases, to verify error handling and return codes.

            EXPECT_TRUE(dyn_data->equals(dyn_data_from_json));

versions.md:25

[nitpick] For consistency with other list entries, add a space after the leading asterisk: * Add new JSON to DynamicData deserializer....

* Add new JSON to DynamicData deserializer (`json_deserialize`).

src/cpp/fastdds/xtypes/serializers/json/json_dynamic_data.cpp

src/cpp/fastdds/xtypes/utils.cpp

src/cpp/fastdds/xtypes/serializers/json/json_dynamic_data.cpp

src/cpp/fastdds/xtypes/serializers/json/dynamic_data_json.cpp

test/unittest/dds/xtypes/serializers/json/DynDataJSONTests.cpp

Carlosespicur · 2025-07-08T08:43:03Z

LGTM

Signed-off-by: Juan Lopez Fernandez <juanlopez@eprosima.com>

juanlofer-eprosima mentioned this pull request Jan 9, 2025

[21768] DDS data publication implementation eProsima/DDS-Enabler#2

Closed

juanlofer-eprosima mentioned this pull request Jan 28, 2025

[21768] DDS data publication implementation eProsima/DDS-Enabler#5

Merged

rsanchez15 added this to the v3.3.0 milestone Apr 4, 2025

EugenioCollado force-pushed the feature/json-deserialize branch from b4d628c to 14023a4 Compare April 10, 2025 13:42

EugenioCollado force-pushed the feature/json-deserialize branch from 9dbd70e to d221bcc Compare May 27, 2025 13:25

juanlofer-eprosima force-pushed the feature/json-deserialize branch from d221bcc to a0db432 Compare June 13, 2025 07:16

juanlofer-eprosima force-pushed the feature/json-deserialize branch 2 times, most recently from f0476d3 to dc161bb Compare July 2, 2025 13:57

juanlofer-eprosima marked this pull request as ready for review July 2, 2025 14:10

juanlofer-eprosima requested a review from Copilot July 2, 2025 14:10

github-actions bot added the ci-pending PR which CI is running label Jul 2, 2025

Copilot AI reviewed Jul 2, 2025

View reviewed changes

src/cpp/fastdds/xtypes/serializers/json/json_dynamic_data.cpp Outdated Show resolved Hide resolved

src/cpp/fastdds/xtypes/serializers/json/json_dynamic_data.cpp Outdated Show resolved Hide resolved

juanlofer-eprosima requested review from richiprosima and removed request for richiprosima July 2, 2025 14:46

juanlofer-eprosima force-pushed the feature/json-deserialize branch from 80dfa1b to f7f40ac Compare July 4, 2025 06:12

juanlofer-eprosima requested review from richiprosima and removed request for richiprosima July 4, 2025 06:16

juanlofer-eprosima mentioned this pull request Jul 4, 2025

[22202] JSON to DynamicData deserializer eProsima/Fast-DDS-docs#1093

Merged

7 tasks

juanlofer-eprosima requested review from richiprosima and removed request for richiprosima July 4, 2025 12:14

juanlofer-eprosima force-pushed the feature/json-deserialize branch from 0c4797a to 51c10bb Compare July 7, 2025 09:06

juanlofer-eprosima requested a review from richiprosima July 7, 2025 09:07

juanlofer-eprosima mentioned this pull request Jul 7, 2025

Use Fast-DDS master branch and artifacts eProsima/DDS-Enabler#14

Merged

Carlosespicur suggested changes Jul 7, 2025

View reviewed changes

juanlofer-eprosima requested review from richiprosima and removed request for richiprosima July 8, 2025 08:32

juanlofer-eprosima added 10 commits July 8, 2025 10:44

Refs #22202. Add support for ROS 2 types

5bbdd8b

Signed-off-by: Juan Lopez Fernandez <juanlopez@eprosima.com>

Refs #22202. Support all types

84403a4

Signed-off-by: Juan Lopez Fernandez <juanlopez@eprosima.com>

Refs #22202. Add tests

e866de7

Signed-off-by: Juan Lopez Fernandez <juanlopez@eprosima.com>

Refs #22202. Update versions.md

593ebca

Signed-off-by: Juan Lopez Fernandez <juanlopez@eprosima.com>

Refs #22202. Add missing sources

f28a08b

Signed-off-by: Juan Lopez Fernandez <juanlopez@eprosima.com>

Refs #22202. Remove Windows warnings

a091aa1

Signed-off-by: Juan Lopez Fernandez <juanlopez@eprosima.com>

Refs #22202. Encapsulate complex methods

0c4ed6d

Signed-off-by: Juan Lopez Fernandez <juanlopez@eprosima.com>

Refs #22202. Uncrustify

f9ba70f

Signed-off-by: Juan Lopez Fernandez <juanlopez@eprosima.com>

Refs #22202. Fix null-dereference error

0edbae5

Signed-off-by: Juan Lopez Fernandez <juanlopez@eprosima.com>

Refs #22202. Apply suggestions

9cf2e87

Signed-off-by: Juan Lopez Fernandez <juanlopez@eprosima.com>

juanlofer-eprosima force-pushed the feature/json-deserialize branch from b79ebf9 to 9cf2e87 Compare July 8, 2025 08:45

juanlofer-eprosima requested review from richiprosima and removed request for richiprosima July 8, 2025 08:46

juanlofer-eprosima force-pushed the feature/json-deserialize branch from e7e2849 to 0699742 Compare July 9, 2025 06:32

juanlofer-eprosima requested review from richiprosima and removed request for richiprosima July 9, 2025 06:32

Refs #22202. Fix Windows deadlock in tests closure

161e0f2

Signed-off-by: Juan Lopez Fernandez <juanlopez@eprosima.com>

juanlofer-eprosima force-pushed the feature/json-deserialize branch from 0699742 to 161e0f2 Compare July 9, 2025 06:53

juanlofer-eprosima requested review from richiprosima and removed request for richiprosima July 9, 2025 06:53

Carlosespicur approved these changes Jul 9, 2025

View reviewed changes

rsanchez15 merged commit 9a524da into master Jul 9, 2025
35 of 37 checks passed

rsanchez15 deleted the feature/json-deserialize branch July 9, 2025 14:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[22202] JSON to DynamicData deserializer#5553

[22202] JSON to DynamicData deserializer#5553
rsanchez15 merged 11 commits intomasterfrom
feature/json-deserialize

juanlofer-eprosima commented Jan 9, 2025 •

edited by Carlosespicur

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Carlosespicur commented Jul 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

juanlofer-eprosima commented Jan 9, 2025 • edited by Carlosespicur Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Contributor Checklist

Reviewer Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Carlosespicur commented Jul 8, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

juanlofer-eprosima commented Jan 9, 2025 •

edited by Carlosespicur

Loading